Kdenlive/Workgroup/Documentation - KDE Community Wiki
Jump to content
From KDE Community Wiki
Kdenlive
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
to convert your screen recordings to high-quality animated gifs.
The naming convention for screenshots is
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
to the manual (maybe create a "Howto" and "Behind the scene" chapter): see section "Texts we want to move from the website" below.
Tutorials
Toolbox
-> finished (see below)
Working on updating the list of Effects and compositions:
Putting together the source data here:
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
Clip Monitor, Project Monitor
Feature
Comment
Status
Zoombar (Clip Monitor)
21.04
Edit Mode (Effects)
current
Preview Resolution
current
Overlayer
current
Multi Track View (Project Monitor)
I assume this is meant
current
Extract Frame
current
Interpolation
Deinterlacer
Monitor Gamma
Realtime
Effects
Effects
Feature
Comment
Status
Rotoscoping
current
LUT
current
Project Bin
Project Bin
Feature
Comment
Status
View mode
current
Tags
current
Rating
current
Filter
current
Sorting
current
Video Preview
current
Subclips
Clip Guides
current
Replace, Locate Clip
current
Detect Scene Job
current
Speedchange Job
to be checked if outdated
Stabilization Job
replaced with Clip Job
Proxies (and external Proxies)
current (part of
Asset Management
Timeline
Timeline
Feature
Comment
Status
Tools: Selection, Razor, Spacer
current
Modes: Normal, Overwrite, Insert
current
Timeline Guides
to be checked outdated
Selection: rubberband,…
current
Mixes (Inline Transitions)
actual version
Change Speed
current
Tracks: Order, Rename, Insert, Delete
current
Master Track
to be checked maybe outdated
Composition Mode
current
Zoombar
actual version
Thumbnails: All, only in/out,…
actual version
Snapping
current
Align Audio
current
Remove Space
current
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
current
Audio Spectrum
current
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
current
Project Notes
current
Speech-to-Text: Subtitles and Text Edit
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
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
Website Url
Wiki Url / Comment
Status
MOVED
moved to Sphinx
MOVED
moved to Sphinx
MOVED
moved to Sphinx
MOVED
moved to Sphinx
MOVED
moved to Sphinx
MOVED
moved to Sphinx. Keep the video on the homepage (Sphinx has a link to this video
MOVED
moved to Sphinx. Keep the video on the homepage (Sphinx has a link to this video
MOVED
moved to Sphinx
MOVED
moved to Sphinx
MOVED
moved to Sphinx
MOVED
moved to Sphinx
MOVED
moved to Sphinx
MOVED
moved to Sphinx
MOVED
moved to Sphinx
MOVED
moved to Sphinx
MOVED
only Track Compositing moved to Sphinx
moved Track Compositing only
moved to Sphinx
MOVED
Not moved as info are suitable for Kdenlive pre 19.04 version only
DEPRECATED: NO MOVE
Not moved as info are suitable for Kdenlive pre 19.04 version only
DEPRECATED: NO MOVE
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
moved to Sphinx
MOVED
moved to Sphinx
MOVED
Not moved as info are suitable for Kdenlive pre 19.04 version only
DEPRECATED: NO MOVE
moved to Sphinx
MOVED
moved to Sphinx
MOVED
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
MOVED
MOVED
and
MOVED
Retrieved from "
US