Kdenlive/Workgroup/Documentation
Kdenlive is a powerful tool with a lot of features but all the different menu entries, buttons and shortcuts can be sometimes confusing. The User Manual is important for beginners as well as advanced users searching for a specific feature. However maintaining the manual is a big task the small Kdenlive Core Team can't handle alone...
And that’s were you come in! If you are an advanced user it we need you to update old sections or write explanations of new features. But even if you have the feeling you are not experienced enough to write something, you can still update screenshots! If you benefit from the work others did on Kdenlive it is a great (and easy) opportunity to give something back to the project and the community!
Join the Kdenlive Main Matrix Room to get in touch.
Getting Started
The new Kdenlive Manual (moved from the wiki in November 2021 to docs.kdenlive.org) is based on Sphinx and lives in a git repository.
Some useful information for the start can by found in the Krita Contributor Manual, since the Krita Manual is based on Sphinx too.
Take and Upload Screenshots
Here are some general tips on how to take screenshots.
If you want to add or update a screenshot in the Kdenlive manual you should follow these rules:
- Use the the Breeze Dark Theme ( → → )
- Use the the Breeze Icons ( → )
- The preferred format is lossless webp as it offers the best quality:size ratio and is widely supported
- Animated gifs are a great way to show how things work. Use https://ezgif.com/video-to-gif to convert your screen recordings to high-quality animated gifs.
- The naming convention for screenshots is <chapter>-<kdenlive_feature>-<kdenlive_main_release>.webp. For example: effects-dblur-2412.webp or interface-clip_monitor-2412.webp.
TODO List
The manual has received several updates and overhauls over the last two years but still has several chapters that need more TLC. Translating the manual is also high on the list.
- Review the manual and identify outdated content and screenshots
- 2021-05-14 - Updated screenshots and content to UI 21.04 from the start to "Effects and Transitions list"
- Cutting and Assembling needs an overhaul: separate .rst files, updated screenshots, wording, etc.
- Exporting needs updating
- Move (and update) content from the website https://kdenlive.org to the manual (maybe create a "Howto" and "Behind the scene" chapter): see section "Texts we want to move from the website" below.
- Tutorials https://kdenlive.org/en/project/
- Toolbox https://kdenlive.org/en/toolbox/ -> finished (see below)
- Working on updating the list of Effects and compositions: https://userbase.kde.org/Kdenlive/Manual/Effects_And_Transitions.
- Putting together the source data here: https://cryptpad.fr/sheet/#/2/sheet/edit/UeG3XmhEsPzZRaXWpLQUzJZp/
- List has been completed and changes documented
- The Effects and Filters chapter has been updated and a list of available effects has been added to the manual for easy reference. This needs to be revised from time to time.
List of Features
Clip Monitor, Project Monitor
| Feature | Comment | Status |
|---|---|---|
| Zoombar (Clip Monitor) | https://userbase.kde.org/index.php?title=Kdenlive/Manual/Monitors#Monitor_zoombar | 21.04 |
| Edit Mode (Effects) | current | |
| Preview Resolution | https://userbase.kde.org/index.php?title=Kdenlive/Manual/Monitors#Preview_resolution | current |
| Overlayer | https://userbase.kde.org/index.php?title=Kdenlive/Manual/Monitors#Monitor_toolbar | current |
| Multi Track View (Project Monitor) | I assume this is meant https://userbase.kde.org/index.php?title=Kdenlive/Manual/Monitors#Multicam_Editing | current |
| Extract Frame | current | |
| Interpolation | ? | |
| Deinterlacer | ? | |
| Monitor Gamma | ? | |
| Realtime | ? |
Effects
| Feature | Comment | Status |
|---|---|---|
| Rotoscoping | https://userbase.kde.org/Draft:Appname | current |
| LUT | https://userbase.kde.org/Draft:Appname/Manual | current |
Project Bin
| Feature | Comment | Status |
|---|---|---|
| View mode | ? | |
| Tags | https://userbase.kde.org/Kdenlive/Manual/Projects_and_Files/Project_Tree | current |
| Rating | https://userbase.kde.org/Kdenlive/Manual/Projects_and_Files/Project_Tree | current |
| Filter | https://userbase.kde.org/Kdenlive/Manual/Projects_and_Files/Project_Tree | current |
| Sorting | current | |
| Video Preview | current | |
| Subclips | ? | |
| Clip Guides | ? | |
| Replace, Locate Clip | https://userbase.kde.org/Kdenlive/Manual/Clip_Menu/Replace_Clip | current |
| Detect Scene Job | ? | |
| Speedchange Job | https://userbase.kde.org/Kdenlive/Manual/Clip_Menu/Duplicate_Clip_with_speed_change | to be checked if outdated |
| Stabilization Job | https://userbase.kde.org/Kdenlive/Manual/Clip_Menu/Stabilize | replaced with Clip Job |
| Proxies (and external Proxies) | https://userbase.kde.org/Kdenlive/Manual/Projects_and_Files/Clips#Proxy_clips | current (part of Asset Management |
Timeline
| Feature | Comment | Status |
|---|---|---|
| Tools: Selection, Razor, Spacer | ? | |
| Modes: Normal, Overwrite, Insert | ? | |
| Timeline Guides | https://userbase.kde.org/Kdenlive/Manual/Timeline/Editing | to be checked outdated |
| Selection: rubberband,… | ? | |
| Mixes (Inline Transitions) | https://userbase.kde.org/Kdenlive/Manual/Timeline/Editing#Same_track_transitions | actual version |
| Change Speed | ? | |
| Tracks: Order, Rename, Insert, Delete | ? | |
| Master Track | https://userbase.kde.org/Kdenlive/Manual/Timeline_Menu/Tracks#Master_effects | to be checked maybe outdated |
| Composition Mode | current | |
| Zoombar | https://userbase.kde.org/Kdenlive/Manual/Timeline | actual version |
| Thumbnails: All, only in/out,… | https://userbase.kde.org/Kdenlive/Manual/Timeline#Configurable_thumbnails_for_each_track | actual version |
| Snapping | ? | |
| Align Audio | ? | |
| Remove Space | ? |
Global Settings
| Feature | Comment | Status |
|---|---|---|
| Misc | current | |
| Timeline Settings | current | |
| Project Defaults | current | |
| Environment | current | |
| Colors | current | |
| Capture | current | |
| Jog Shuttle | current | |
| Playback | current | |
| Transcode | current |
| Feature | Comment | Status |
|---|---|---|
| Project Settings (=New Project) | current | |
| DVD Wizard | Maybe removed soon | current (moved to Earlier Version |
| Transcode Clip | current | |
| OpentimelineIO | current (new version coming with 25.04) | |
| Layouts | Save, Load (& Chooser in the Mainwindow), Manage, Dock Area Orientation, Show Title Bars | current |
| Audio Mixer | ? | |
| Audio Spectrum | ? | |
| Clip Properties | current | |
| Compositions | current | |
| Effect / Composition Stack | current | |
| Scopes: Histogram, Waveform, Vectorscope, RGB Parade |
current | |
| Library | current | |
| Media Browser / Import Dialog | current | |
| Color Clips | current | |
| Slideshows | current | |
| Generators | current | |
| Online Resources | https://userbase.kde.org/Kdenlive/Manual/Project_Menu/Online_Resources | current |
| Project Notes | current | |
| Speech-to-Text: Subtitles and Text Edit | https://userbase.kde.org/Kdenlive/Manual/Timeline/Editing#Speech_to_text | current |
| Undo history | current | |
| Archive Project | current | |
| Backup / Autosave System | current | |
| Rendering | current | |
| Cache Management | current | |
| Config Wizard | current | |
| Style, Theme, Icons | current | |
| Configure Keyboard Shortcuts | current | |
| Reset Config | current | |
| Subtitles: Track, Dock Widget, Im- / Export | https://userbase.kde.org/Kdenlive/Manual/Timeline/Editing#Subtitle | current |
| Keymap Information | current |
Texts we want to move from the website
These texts in the list below should be moved to the user manual:
- Check if the text is still relevant.
- If the text is not relevant anymore change the status in the table to DEPRECATED: NO MOVE
- If the text is still relevant look if there is already a similar instruction in the manual
- Either create a new page and move copy the text or merge the text to the existing one. Change Status to MOVED and add the new (wiki) url
Technical that stuff should go to the community wiki page: