Kdenlive/Workgroup/Documentation

From KDE Community Wiki

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 this rules:

  • Use the the Breeze Dark Theme (SettingsColor ThemeBreeze Dark)
  • Use the the Breeze Icons (SettingsForce Breeze Icon Theme)

TODO List

The manual hasn't got much love in the past years. The main goal is to complete, update and translate the manual.

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) ?
Preview Resolution https://userbase.kde.org/index.php?title=Kdenlive/Manual/Monitors#Preview_resolution 21.04
Overlayer https://userbase.kde.org/index.php?title=Kdenlive/Manual/Monitors#Monitor_toolbar actual version
Multi Track View (Project Monitor) I assume this is meant https://userbase.kde.org/index.php?title=Kdenlive/Manual/Monitors#Multicam_Editing actual version
Extract Frame ?
Interpolation ?
Deinterlacer ?
Monitor Gamma ?
Realtime ?

Effects

Effects
Feature Comment Status
Rotoscoping https://userbase.kde.org/Draft:Appname Update
LUT https://userbase.kde.org/Draft:Appname/Manual User manual update

Project Bin

Project Bin
Feature Comment Status
View mode ?
Tags 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 actual status
Filter https://userbase.kde.org/Kdenlive/Manual/Projects_and_Files/Project_Tree actual status
Sorting ?
Video Preview ?
Subclips ?
Clip Guides ?
Replace, Locate Clip https://userbase.kde.org/Kdenlive/Manual/Clip_Menu/Replace_Clip actual status
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 to be checked if outdated
Proxies (and external Proxies) https://userbase.kde.org/Kdenlive/Manual/Projects_and_Files/Clips#Proxy_clips to be checked if outdated

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 ?
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 ?
Timeline Settings ?
Project Defaults ?
Environment ?
Colors ?
Capture ?
Jog Shuttle ?
Playback ?
Transcode ?
Unordered Features
Feature Comment Status
Project Settings (=New Project)
DVD Wizard Maybe removed soon ?
Transcode Clip ?
OpentimelineIO ?
Layouts Save, Load (& Chooser in the Mainwindow), Manage, Dock Area Orientation, Show Title Bars ?
Audio Mixer ?
Audio Spectrum ?
Clip Properties ?
Compositions ?
Effect / Composition Stack ?
Scopes:
Histogram, Waveform, Vectorscope, RGB Parade
?
Library ?
Media Browser / Import Dialog ?
Color Clips ?
Slideshows ?
Generators ?
Online Resources https://userbase.kde.org/Kdenlive/Manual/Project_Menu/Online_Resources to be checked if all actual
Project Notes ?
Speech-to-Text: Subtitles and Text Edit https://userbase.kde.org/Kdenlive/Manual/Timeline/Editing#Speech_to_text actual version
Undo history ?
Archive Project ?
Backup / Autosave System ?
Rendering ?
Cache Management ?
Config Wizard ?
Style, Theme, Icons ?
Configure Keyboard Shortcuts ?
Reset Config ?
Subtitles: Track, Dock Widget, Im- / Export https://userbase.kde.org/Kdenlive/Manual/Timeline/Editing#Subtitle actual version
Keymap Information ?

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