Undocumented functions

[leodf1]

Describe the bug: Several program functions are not or insufficiently documented in the Manual

Steps to reproduce the behavior:

Expected behavior:

System Details:

• OpenShot Version [e.g. 2.4.3]: {{ log_context.openshot_qt_version }}
• Operating System / Distro: [e.g. Windows 10, Linux Mint 17.1]

Log Files: If you are experiencing a crash, please collect and attach logs of the problem. Log files can be found in the .openshot_qt folder in your user home directory. Log files over 2 MB in size will need to be compressed, please attach a ZIP file instead of the raw logs.

Exception / Stacktrace: If you are experiencing a crash or strange output on the command line, please attach a small snippet of the exception here, but please keep it as small as possible (for readability).

Screenshots: (Optional) If applicable, add screenshots to help explain your problem. To include screenshots, copy/paste them here, drag the image(s) into this form, or click the link below this edit field to load images saved to your computer. All images are public, so please don't post screenshots containing personal information.

[leodf1]

Functions that are not documented in the Manual:

1. Align [Aligns multiple clips] - Select multiple clips - Rt-click - Align
2. Marker delete [Delete timeline Markers] - Rt-click marker - Remove marker
3. Delete Keyframe [Delete keyframes] - Rt-click property - Remove keyframe
4. Copy Keyframes [Copy keyframes] - Rt-click clip - Copy - Keyframes..
5. Vertical move [Move clips vertically] - Shift and drag
6. Lock track [Block changes on timeline track] - Track Header - Rt-click or click arrow - Lock Track
7. Rename Project Files [Change name of files in Project Files panel] - Set Details view - Dbl click clip name or press F2
8. Remove Effect [Removing effects applied to clips] - Rt-click Effect icon on clip header - Remove Effect
9. Transform maintain aspect ratio [Maintain aspect ratio during Transform drag] - Select clip - Ctrl-R (show Transform outline) - Shift drag Transform corner
10. 'Clear history' and 'Clear cache' [ No idea what these do] - Edit menu - Clear - History/Waveform and Rt-click playhead - Clear cache
11. Title duration [Default duration of Title] - Preferences - General - Image Length
12. Adjust 'Parent' property [Values selected by Rt-click the property - Should be explicitly stated in 'Parent' section of Manual]
13. Property Editor Dropdown List [Dropdown list at top of Property Editor] - Function and use not documented anywhere...
14. Effect double entry in Property list [Click Effect icon on clip creates a second entry in Property dropdown list of clip] - No idea what this is.....

Performance advice contradictions in the Manual: [at least require clarification]

1.16.1 'Matching Rates' pg.129 'It is very important to match your source assets FPS and Sample Rate with your Project FPS and Project sample rate' AND 1.13.1 Project Profile pg.72 'It is best practice to always switch to your target profile before you begin editing. For example, if you are targeting 1080p 30fps, switch to that profile before you begin editing your project'

COMPARE TO

1.16.1 'Profile' pg.129 '...you can also choose a smaller profile with the same aspect ratio (16x9 in this example) to improve the preview speed on slower computers' AND 1.16.1 'FPS' pg.129 '...it can be helpful to reduce your project's FPS to a lower value'

I'm not sure what to make of these directions. Does this mean Project profile only affects the Preview window, and can be set low to improve editing playback, while only the Export profile should be matched to the source media?

[Colorjet3]

Good catch on all of the missing documentation on existing functions.

Yeah, the Performance advice is all over the place. The lead developer is working hard on the performance issues and there is going to be some major changes. The documentation will properly get addressed after the new performance changes are implemented.

And yes, regarding the Project profile and Performance. As your project gets larger and/or complex, one of the ways to make editing faster is to use a lower resolution profile. This does not impact the Exported project as you are still able to select a higher resolution when you are ready.

[Colorjet3]

Hello @leodf1. This is now in the queue for review: https://trello.com/c/5wTjzdDZ/170-undocumentd-functions