Jump to content

Kdenlive/Workgroup/Documentation: Difference between revisions

From KDE Community Wiki
← Older edit
Joseph (talk | contribs)
KDEDevelopers
662 edits
Removed Telegram info and link
m Updated the tables, some minor corrections, updated the screenshot section
 
Line 14: Line 14:
Here are some general tips on how to [https://userbase.kde.org/Taking_Screenshots/ take screenshots].
Here are some general tips on how to [https://userbase.kde.org/Taking_Screenshots/ take screenshots].


If you want to add or update a screenshot in the Kdenlive manual you should follow this rules:
If you want to add or update a screenshot in the Kdenlive manual you should follow these rules:
* Use the the Breeze Dark Theme (<menuchoice>Settings</menuchoice> &rarr; <menuchoice>Color Theme</menuchoice>  &rarr; <menuchoice>Breeze Dark</menuchoice>)
* Use the the Breeze Dark Theme (<menuchoice>Settings</menuchoice> &rarr; <menuchoice>Color Theme</menuchoice>  &rarr; <menuchoice>Breeze Dark</menuchoice>)
* Use the the Breeze Icons (<menuchoice>Settings</menuchoice> &rarr; <menuchoice>Force Breeze Icon Theme</menuchoice>)
* Use the the Breeze Icons (<menuchoice>Settings</menuchoice> &rarr; <menuchoice>Force Breeze Icon Theme</menuchoice>)
* 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 ==
== TODO List ==


The manual hasn't got much love in the past years. The main goal is to complete, update and translate the manual.
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
* 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"  
** 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.
* 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/
** Tutorials https://kdenlive.org/en/project/
** Toolbox https://kdenlive.org/en/toolbox/ -> finished (see below)
** 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.   
* 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/
** Putting together the source data here: https://cryptpad.fr/sheet/#/2/sheet/edit/UeG3XmhEsPzZRaXWpLQUzJZp/
** list is now complete.  I've removed all the effects/compositions no longer in Kdenlive -- documented in the wiki change notes and the link above, 2nd tab in the spreadsheet.   I'm now working on adding new effects/compositions and updating existing ones.  
** 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 ===
=== List of Features ===
Line 42: Line 48:
| Zoombar (Clip Monitor) ||https://userbase.kde.org/index.php?title=Kdenlive/Manual/Monitors#Monitor_zoombar  || 21.04
| Zoombar (Clip Monitor) ||https://userbase.kde.org/index.php?title=Kdenlive/Manual/Monitors#Monitor_zoombar  || 21.04
|-
|-
| Edit Mode (Effects) ||  || ?
| Edit Mode (Effects) ||  || current
|-
|-
| Preview Resolution ||https://userbase.kde.org/index.php?title=Kdenlive/Manual/Monitors#Preview_resolution  || 21.04
| 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  || actual version
| 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  || actual version
| 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 ||  || ?
| Extract Frame ||  || current
|-
|-
| Interpolation ||  || ?
| Interpolation ||  || ?
Line 68: Line 74:
! Feature !! Comment !! Status
! Feature !! Comment !! Status
|-
|-
| Rotoscoping || https://userbase.kde.org/Draft:Appname ||Update
| Rotoscoping || https://userbase.kde.org/Draft:Appname || current
|-
|-
| LUT || https://userbase.kde.org/Draft:Appname/Manual || User manual update
| LUT || https://userbase.kde.org/Draft:Appname/Manual || current
|}
|}


Line 82: Line 88:
| View mode ||  || ?
| View mode ||  || ?
|-
|-
| Tags ||https://userbase.kde.org/Kdenlive/Manual/Projects_and_Files/Project_Tree  || actual status
| 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  || actual status
| 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  || actual status
| Filter ||https://userbase.kde.org/Kdenlive/Manual/Projects_and_Files/Project_Tree  || current
|-
|-
| Sorting ||  || ?
| Sorting ||  || current
|-
|-
| Video Preview ||  || ?
| Video Preview ||  || current
|-
|-
| Subclips||  || ?
| Subclips||  || ?
Line 96: Line 102:
| Clip Guides||  || ?
| Clip Guides||  || ?
|-
|-
| Replace, Locate Clip ||https://userbase.kde.org/Kdenlive/Manual/Clip_Menu/Replace_Clip  || actual status
| Replace, Locate Clip ||https://userbase.kde.org/Kdenlive/Manual/Clip_Menu/Replace_Clip  || current
|-
|-
| Detect Scene Job ||  || ?
| Detect Scene Job ||  || ?
Line 102: Line 108:
| Speedchange Job ||https://userbase.kde.org/Kdenlive/Manual/Clip_Menu/Duplicate_Clip_with_speed_change  || to be checked if outdated
| 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  || 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  || to be checked if outdated
| Proxies (and external Proxies) ||https://userbase.kde.org/Kdenlive/Manual/Projects_and_Files/Clips#Proxy_clips  || current (part of ''Asset Management''
|}
|}


Line 130: Line 136:
| Master Track ||https://userbase.kde.org/Kdenlive/Manual/Timeline_Menu/Tracks#Master_effects  || to be checked maybe outdated
| Master Track ||https://userbase.kde.org/Kdenlive/Manual/Timeline_Menu/Tracks#Master_effects  || to be checked maybe outdated
|-
|-
| Composition Mode ||  || ?
| Composition Mode ||  || current
|-
|-
| Zoombar ||https://userbase.kde.org/Kdenlive/Manual/Timeline || actual version
| Zoombar ||https://userbase.kde.org/Kdenlive/Manual/Timeline || actual version
Line 150: Line 156:
! Feature !! Comment !! Status
! Feature !! Comment !! Status
|-
|-
| Misc ||  || ?
| Misc ||  || current
|-
|-
| Timeline Settings ||  || ?
| Timeline Settings ||  || current
|-
|-
| Project Defaults ||  || ?
| Project Defaults ||  || current
|-
|-
| Environment ||  || ?
| Environment ||  || current
|-
|-
| Colors ||  || ?
| Colors ||  || current
|-
|-
| Capture ||  || ?
| Capture ||  || current
|-
|-
| Jog Shuttle ||  || ?
| Jog Shuttle ||  || current
|-
|-
| Playback ||  || ?
| Playback ||  || current
|-
|-
| Transcode ||  || ?
| Transcode ||  || current
|}
|}


Line 174: Line 180:
! Feature !! Comment !! Status
! Feature !! Comment !! Status
|-
|-
| Project Settings (=New Project) ||  ||  
| Project Settings (=New Project) ||  || current
|-
|-
| DVD Wizard || Maybe removed soon || ?
| DVD Wizard || Maybe removed soon || current (moved to ''Earlier Version''
|-
|-
| Transcode Clip ||  || ?
| Transcode Clip ||  || current
|-
|-
| OpentimelineIO ||  || ?
| OpentimelineIO ||  || current (new version coming with 25.04)
|-
|-
| Layouts || Save, Load (& Chooser in the Mainwindow), Manage, Dock Area Orientation, Show Title Bars || ?
| Layouts || Save, Load (& Chooser in the Mainwindow), Manage, Dock Area Orientation, Show Title Bars || current
|-
|-
| Audio Mixer ||  || ?
| Audio Mixer ||  || ?
Line 188: Line 194:
| Audio Spectrum ||  || ?
| Audio Spectrum ||  || ?
|-
|-
| Clip Properties ||  || ?
| Clip Properties ||  || current
|-
|-
| Compositions ||  || ?
| Compositions ||  || current
|-
|-
| Effect / Composition Stack ||  || ?
| Effect / Composition Stack ||  || current
|-
|-
| Scopes: </br> Histogram, Waveform, Vectorscope, RGB Parade ||  || ?
| Scopes: </br> Histogram, Waveform, Vectorscope, RGB Parade ||  || current
|-
|-
| Library ||  || ?
| Library ||  || current
|-
|-
| Media Browser / Import Dialog ||  || ?
| Media Browser / Import Dialog ||  || current
|-
|-
| Color Clips ||  || ?
| Color Clips ||  || current
|-
|-
| Slideshows ||  || ?
| Slideshows ||  || current
|-
|-
| Generators ||  || ?
| Generators ||  || current
|-
|-
| Online Resources ||https://userbase.kde.org/Kdenlive/Manual/Project_Menu/Online_Resources  || to be checked if all actual
| Online Resources ||https://userbase.kde.org/Kdenlive/Manual/Project_Menu/Online_Resources  || current
|-
|-
| Project Notes ||  || ?
| Project Notes ||  || current
|-
|-
| Speech-to-Text: Subtitles and Text Edit ||https://userbase.kde.org/Kdenlive/Manual/Timeline/Editing#Speech_to_text  || actual version
| Speech-to-Text: Subtitles and Text Edit ||https://userbase.kde.org/Kdenlive/Manual/Timeline/Editing#Speech_to_text  || current
|-
|-
| Undo history ||  || ?
| Undo history ||  || current
|-
|-
| Archive Project ||  || ?
| Archive Project ||  || current
|-
|-
| Backup / Autosave System ||  || ?
| Backup / Autosave System ||  || current
|-
|-
| Rendering ||  || ?
| Rendering ||  || current
|-
|-
| Cache Management ||  || ?
| Cache Management ||  || current
|-
|-
| Config Wizard ||  || ?
| Config Wizard ||  || current
|-
|-
| Style, Theme, Icons ||  || ?
| Style, Theme, Icons ||  || current
|-
|-
| Configure Keyboard Shortcuts ||  || ?
| Configure Keyboard Shortcuts ||  || current
|-
|-
| Reset Config ||  || ?
| Reset Config ||  || current
|-
|-
| Subtitles: Track, Dock Widget, Im- / Export ||https://userbase.kde.org/Kdenlive/Manual/Timeline/Editing#Subtitle  || actual version
| Subtitles: Track, Dock Widget, Im- / Export ||https://userbase.kde.org/Kdenlive/Manual/Timeline/Editing#Subtitle  || current
|-
|-
| Keymap Information ||  || ?
| Keymap Information ||  || current
|}
|}


Latest revision as of 23:46, 11 February 2025

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 (Settings → Color Theme → Breeze Dark)
  • Use the the Breeze Icons (Settings → Force Breeze Icon Theme)
  • 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.

List of Features

Clip Monitor, Project Monitor

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

Effects
Feature Comment Status
Rotoscoping https://userbase.kde.org/Draft:Appname current
LUT https://userbase.kde.org/Draft:Appname/Manual current

Project Bin

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

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

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
Unordered Features
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
"Project" Stuff from https://kdenlive.org/en/project
Website Url Wiki Url / Comment Status
https://kdenlive.org/en/project/3-point-editing-intro/ https://userbase.kde.org/Kdenlive/Manual/Timeline/Editing#3_point_editing MOVED
https://kdenlive.org/en/project/working-with-extracted-frames-in-higher-resolution-than-project-profile/ moved to Sphinx MOVED
https://kdenlive.org/en/project/color-hell-ffmpeg-transcoding-and-preserving-bt-601/ moved to Sphinx MOVED
https://kdenlive.org/en/project/fixing-unwanted-slow-audio-fade-ins-with-some-usb-audio-cards/ moved to Sphinx MOVED
https://kdenlive.org/en/project/the-smooth-keyframe-interpolation/ moved to Sphinx MOVED
https://kdenlive.org/en/project/insert-overwrite-advanced-timeline-editing/ moved to Sphinx MOVED
https://kdenlive.org/en/project/howto-fading-inout-kdenlive-titles/ moved to Sphinx. Keep the video on the homepage (Sphinx has a link to this video MOVED
https://kdenlive.org/en/project/editing-audio-volume-with-keyframes/ moved to Sphinx. Keep the video on the homepage (Sphinx has a link to this video MOVED
https://kdenlive.org/en/project/adding-meta-data-to-mp4-video/ moved to Sphinx MOVED
https://kdenlive.org/en/project/compositing-with-transparency/ moved to Sphinx MOVED
https://kdenlive.org/en/project/kdenlive-transitions/ moved to Sphinx MOVED
https://kdenlive.org/en/project/timeline-preview-rendering/ moved to Sphinx MOVED
https://kdenlive.org/en/project/library-clips-with-image-sequences-titles-color-clips/ moved to Sphinx MOVED
https://kdenlive.org/en/project/the-library-copy-paste-between-projects/ moved to Sphinx MOVED
https://kdenlive.org/en/project/automatically-raising-the-properties-pane/ moved to Sphinx MOVED
https://kdenlive.org/en/project/extract-frame-to-project/ moved to Sphinx MOVED
https://kdenlive.org/en/project/timeline-track-header-improvements/ only Track Compositing moved to Sphinx moved Track Compositing only
https://kdenlive.org/en/project/cure-projects-with-odd-audio-mixing-behavior/ moved to Sphinx MOVED
https://kdenlive.org/en/project/timeline-track-compositing/ Not moved as info are suitable for Kdenlive pre 19.04 version only DEPRECATED: NO MOVE
https://kdenlive.org/en/project/cure-projects-with-oddly-behaving-transparent-tracks/ Not moved as info are suitable for Kdenlive pre 19.04 version only DEPRECATED: NO MOVE
https://kdenlive.org/en/project/selective-timeline-clip-disabling/ Not moved as info are not suitable for actual Kdenlive version. Disable clip: Hint added in Sphinx how to disable A/V clips. DEPRECATED: NO MOVE
https://kdenlive.org/en/project/manage-cached-data/ moved to Sphinx MOVED
https://kdenlive.org/en/project/disable-all-timeline-effects/ moved to Sphinx MOVED
https://kdenlive.org/en/project/timeline-track-leds/ Not moved as info are suitable for Kdenlive pre 19.04 version only DEPRECATED: NO MOVE
https://kdenlive.org/en/project/effects-everywhere/ moved to Sphinx MOVED
https://kdenlive.org/en/project/configuring-the-default-transition-duration/ moved to Sphinx MOVED
https://kdenlive.org/en/project/timeline-clips-transitions-appearance/ Not moved as info are suitable for Kdenlive pre 19.04 version only DEPRECATED: NO MOVE

Technical that stuff should go to the community wiki page:

Technical stuff
Website Url Wiki Url / Comment Status
https://kdenlive.org/en/project/mlt-concepts/ https://invent.kde.org/multimedia/kdenlive/-/blob/master/dev-docs/mlt-intro.md MOVED
https://kdenlive.org/en/project/mlt-basic-producers/ https://invent.kde.org/multimedia/kdenlive/-/blob/master/dev-docs/mlt-intro.md MOVED
https://kdenlive.org/en/project/kdenlive-proxy-clips/
https://kdenlive.org/en/project/kdenlive-project-file-format/ and https://kdenlive.org/en/project/kdenlive-projects/ https://community.kde.org/Kdenlive/Development/File_format MOVED
Retrieved from "https://community.kde.org/index.php?title=Kdenlive/Workgroup/Documentation&oldid=102867"