Help menu, correct handbook link to WIKI
Open, Needs TriagePublic

Description

Bug 399543

The Help>Kdenlive Handbook menu item sends you to this very old page:
https://docs.kde.org/stable5/en/kdemultimedia/kdenlive/index.html

Should perhaps rather link to this?:
https://userbase.kde.org/Kdenlive/Manual

emohr created this task.Oct 10 2018, 6:22 PM
davidc added a subscriber: davidc.Oct 25 2018, 8:09 PM

The handbook relies on KHelpCenter, which always points to https://docs.kde.org/.

I'll see if I can get track down someone to let me in there. It would be trivial to at least update the Quick Start guide a drop a link to the full manual.

Can we work again on having the reference manual on docs.kde.org?
If you notice, the manual on docs.kde.org was original exported from the wiki. The other problem with the manual on the wiki is that it's not versioned with the code.

davidc added a subscriber: yurchor.Oct 25 2018, 8:29 PM

Would @yurchor be willing to help me out with restarting the conversion process from the wiki to docbook? It seems like this would make the whole process easier for everyone.

Would @yurchor be willing to help me out with restarting the conversion process from the wiki to docbook? It seems like this would make the whole process easier for everyone.

No problems. What exactly do you need to make the conversion (apart from the existing wiki page on this)? For me, it works as before but it worth to remember that all YouTube tutorials will not work offline for sure.

I think the goal of this task was to get the complete manual moved over to the docs. Currently, there is only the Quick Start guide.

Even the Quick Start guide has problems with the conversion. It looks like the static images are out of date.

I also added a new section to the Quick Start guide linking people back to the full manual, but I don't know when the updated wiki will be sent to the docs page.

I think the goal of this task was to get the complete manual moved over to the docs. Currently, there is only the Quick Start guide.

Even the Quick Start guide has problems with the conversion. It looks like the static images are out of date.

I also added a new section to the Quick Start guide linking people back to the full manual, but I don't know when the updated wiki will be sent to the docs page.

Ok. The quickstart guide is synced now (with very minor editing, actually I have replaced the date and the Kdenlive entity):

https://commits.kde.org/kdenlive/3837bd71c6a4ad89e49a8a1f3161839bd534d9d6

As I said, the "complete" manual has many youtube inclusions which are better stay as is, connected to UserBase pages. On the other hand, should someone wants a really full content manual, here's my (incomplete, because of the low quality of the page content) list of pages that can be fed to our conversion script:

Kdenlive/Manual/Introduction
Kdenlive/Manual/Installation
Kdenlive/Manual/QuickStart
Kdenlive/Manual/Tutorials
Kdenlive/Manual/Projects_and_Files
Kdenlive/Manual/Projects_and_Files/Project_Tree
Kdenlive/Manual/Projects_and_Files/Project
Kdenlive/Manual/Projects_and_Files/Project_Settings
Kdenlive/Manual/Projects_and_Files/Notes
Kdenlive/Manual/Projects_and_Files/Archiving
Kdenlive/Manual/Projects_and_Files/Backup
Kdenlive/Manual/Projects_and_Files/Clips
Kdenlive/Manual/Full_Luma
Kdenlive/Manual/Projects_and_Files/Importing
Kdenlive/Manual/Projects_and_Files/Management
Kdenlive/Manual/Timeline
Kdenlive/Manual/Timeline/Editing
Kdenlive/Manual/Timeline/Grouping
Kdenlive/Manual/Timeline/Guides
Kdenlive/Manual/Timeline/Right_Click_Menu
Kdenlive/Manual/Effects_And_Transitions
Kdenlive/Manual/Transitions
Kdenlive/Manual/Transitions/Affine
Kdenlive/Manual/Transitions/Composite
Kdenlive/Manual/Transitions/Dissolve
Kdenlive/Manual/Transitions/Hue
Kdenlive/Manual/Transitions/Regionalize
Kdenlive/Manual/Transitions/Saturation
Kdenlive/Manual/Transitions/Slide
Kdenlive/Manual/Transitions/UV_Map
Kdenlive/Manual/Transitions/Wipe
Kdenlive/Manual/Transitions/Xfade0r
Kdenlive/Manual/Transitions/Xfade0r
Kdenlive/Manual/Transitions/addition
Kdenlive/Manual/Transitions/addition_alpha
Kdenlive/Manual/Transitions/alpha_over
Kdenlive/Manual/Transitions/alphaatop
Kdenlive/Manual/Transitions/alphain
Kdenlive/Manual/Transitions/alphaout
Kdenlive/Manual/Transitions/alphaxor
Kdenlive/Manual/Transitions/blend
Kdenlive/Manual/Transitions/burn
Kdenlive/Manual/Transitions/color_only
Kdenlive/Manual/Transitions/darken
Kdenlive/Manual/Transitions/difference
Kdenlive/Manual/Transitions/dodge
Kdenlive/Manual/Transitions/grain_extract
Kdenlive/Manual/Transitions/hardlight
Kdenlive/Manual/Transitions/lighten
Kdenlive/Manual/Transitions/multiply
Kdenlive/Manual/Transitions/overlay
Kdenlive/Manual/Transitions/screen
Kdenlive/Manual/Transitions/softlight
Kdenlive/Manual/Transitions/value
Kdenlive/Manual/alpha_operation_transitions
Kdenlive/Manual/Effects
Kdenlive/Manual/Effects/Alpha_manipulation
Kdenlive/Manual/Effects/Audio
Kdenlive/Manual/Effects/Audio_channels
Kdenlive/Manual/Effects/Audio_Correction
Kdenlive/Manual/Effects/Blur_and_hide
Kdenlive/Manual/Effects/Colour
Kdenlive/Manual/Effects/Colour_Correction
Kdenlive/Manual/Effects/Crop_and_transform
Kdenlive/Manual/Effects/Custom
Kdenlive/Manual/Effects/Distort
Kdenlive/Manual/Effects/Enhancement
Kdenlive/Manual/Effects/Fade
Kdenlive/Manual/Effects/Fun
Kdenlive/Manual/Effects/Misc
Kdenlive/Manual/Effects/Motion
Kdenlive/Manual/Effects/Alpha_manipulation
Kdenlive/Manual/Effects/Alpha_manipulation/Alpha_gradient
Kdenlive/Manual/Effects/Alpha_manipulation/Alpha_operations
Kdenlive/Manual/Effects/Alpha_manipulation/Alpha_shapes
Kdenlive/Manual/Effects/Alpha_manipulation/Blue_Screen
Kdenlive/Manual/Effects/Alpha_manipulation/Color_Selection
Kdenlive/Manual/Effects/Alpha_manipulation/Mask0Mate
Kdenlive/Manual/Effects/Alpha_manipulation/Rotoscoping
Kdenlive/Manual/Effects/Audio
Kdenlive/Manual/Effects/Audio_channels
Kdenlive/Manual/Effects/Audio_channels/Balance
Kdenlive/Manual/Effects/Audio_channels/Copy_Channels
Kdenlive/Manual/Effects/Audio_channels/Mono_to_stereo
Kdenlive/Manual/Effects/Audio_channels/Mono_to_Stereo_splitter
Kdenlive/Manual/Effects/Audio_channels/Pan
Kdenlive/Manual/Effects/Audio_channels/Swap_channels
Kdenlive/Manual/Effects/Audio_Correction
Kdenlive/Manual/Effects/Audio_Correction/Gain
Kdenlive/Manual/Effects/Audio_Correction/Hard_Limiter
Kdenlive/Manual/Effects/Audio_Correction/Mute
Kdenlive/Manual/Effects/Audio_Correction/Normalise
Kdenlive/Manual/Effects/Audio_Correction/Volume_(keyframable)
Kdenlive/Manual/Effects/Blur_and_hide
Kdenlive/Manual/Effects/Blur_and_hide/Auto_Mask
Kdenlive/Manual/Effects/Blur_and_hide/Blur
Kdenlive/Manual/Effects/Blur_and_hide/Box_Blur
Kdenlive/Manual/Effects/Blur_and_hide/Glow
Kdenlive/Manual/Effects/Blur_and_hide/Obscure
Kdenlive/Manual/Effects/Blur_and_hide/Square_Blur
Kdenlive/Manual/Effects/Colour
Kdenlive/Manual/Effects/Colour/B
Kdenlive/Manual/Effects/Colour/Chroma_Hold
Kdenlive/Manual/Effects/Colour/Contrast
Kdenlive/Manual/Effects/Colour/Greyscale
Kdenlive/Manual/Effects/Colour/Hue_shift
Kdenlive/Manual/Effects/Colour/Invert
Kdenlive/Manual/Effects/Colour/Primaries
Kdenlive/Manual/Effects/Colour/RGB_Parade
Kdenlive/Manual/Effects/Colour/Saturation
Kdenlive/Manual/Effects/Colour/Sepia
Kdenlive/Manual/Effects/Colour/Techicolor
Kdenlive/Manual/Effects/Colour/Tint
Kdenlive/Manual/Effects/Colour_Correction
Kdenlive/Manual/Effects/Colour_Correction/3_point_balance
Kdenlive/Manual/Effects/Colour_Correction/Bezier_Curves
Kdenlive/Manual/Effects/Colour_Correction/Brightness
Kdenlive/Manual/Effects/Colour_Correction/Brightness_(keyframable)
Kdenlive/Manual/Effects/Colour_Correction/Curves
Kdenlive/Manual/Effects/Colour_Correction/Gamma
Kdenlive/Manual/Effects/Colour_Correction/Levels
Kdenlive/Manual/Effects/Colour_Correction/RGB_adjustment
Kdenlive/Manual/Effects/Colour_Correction/SOP/Sat
Kdenlive/Manual/Effects/Colour_Correction/White_Balance
Kdenlive/Manual/Effects/Colour_Correction/White_Balance(LMS)
Kdenlive/Manual/Effects/Crop_and_transform
Kdenlive/Manual/Effects/Crop_and_transform/Crop
Kdenlive/Manual/Effects/Crop_and_transform/LetterB0xed
Kdenlive/Manual/Effects/Crop_and_transform/Pan_and_Zoom
Kdenlive/Manual/Effects/Crop_and_transform/Rotate_(keyframable)
Kdenlive/Manual/Effects/Crop_and_transform/Rotate_and_Shear
Kdenlive/Manual/Effects/Crop_and_transform/Scale_and_Tilt
Kdenlive/Manual/Effects/Custom
Kdenlive/Manual/Effects/Distort
Kdenlive/Manual/Effects/Distort/Corners
Kdenlive/Manual/Effects/Distort/Defish
Kdenlive/Manual/Effects/Distort/Distort
Kdenlive/Manual/Effects/Distort/Lens_Correction
Kdenlive/Manual/Effects/Distort/Mirror
Kdenlive/Manual/Effects/Distort/Pixelize
Kdenlive/Manual/Effects/Distort/Wave
Kdenlive/Manual/Effects/Enhancement
Kdenlive/Manual/Effects/Enhancement/Denoiser
Kdenlive/Manual/Effects/Enhancement/Nikon_D90_Stairstepping_fix
Kdenlive/Manual/Effects/Enhancement/Sharpen
Kdenlive/Manual/Effects/Fade
Kdenlive/Manual/Effects/Fade/Fade_from_Black
Kdenlive/Manual/Effects/Fade/Fade_in
Kdenlive/Manual/Effects/Fade/Fade_out
Kdenlive/Manual/Effects/Fade/Fade_to_Black
Kdenlive/Manual/Effects/Fun
Kdenlive/Manual/Effects/Fun/Charcoal
Kdenlive/Manual/Effects/Fun/Dust
Kdenlive/Manual/Effects/Fun/Grain
Kdenlive/Manual/Effects/Fun/Oldfilm
Kdenlive/Manual/Effects/Fun/Scratchlines
Kdenlive/Manual/Effects/Fun/Vignette_Effect
Kdenlive/Manual/Effects/Misc
Kdenlive/Manual/Effects/Misc/Audio_Wave
Kdenlive/Manual/Effects/Misc/Baltan
Kdenlive/Manual/Effects/Misc/Cartoon
Kdenlive/Manual/Effects/Misc/Color_Distance
Kdenlive/Manual/Effects/Misc/Delay_grab
Kdenlive/Manual/Effects/Misc/delay0r
Kdenlive/Manual/Effects/Misc/Dynamic_Text
Kdenlive/Manual/Effects/Misc/Edge_glow
Kdenlive/Manual/Effects/Misc/Equaliz0r
Kdenlive/Manual/Effects/Misc/Flippo
Kdenlive/Manual/Effects/Misc/K-Means_Clustering
Kdenlive/Manual/Effects/Misc/keysplillm0pup
Kdenlive/Manual/Effects/Misc/Light_Graffiti
Kdenlive/Manual/Effects/Misc/Luminance
Kdenlive/Manual/Effects/Misc/Nervous
Kdenlive/Manual/Effects/Misc/nosync0r
Kdenlive/Manual/Effects/Misc/pr0be
Kdenlive/Manual/Effects/Misc/pr0file
Kdenlive/Manual/Effects/Misc/Regionalize
Kdenlive/Manual/Effects/Misc/rgbnoise
Kdenlive/Manual/Effects/Misc/scanline0r
Kdenlive/Manual/Effects/Misc/Sobel
Kdenlive/Manual/Effects/Misc/TehRoxx0r
Kdenlive/Manual/Effects/Misc/threelay0r
Kdenlive/Manual/Effects/Misc/Threshold
Kdenlive/Manual/Effects/Misc/Threshold0r
Kdenlive/Manual/Effects/Misc/twolay0r
Kdenlive/Manual/Effects/Misc/Vectorscope
Kdenlive/Manual/Effects/Misc/Vertigo
Kdenlive/Manual/Effects/Misc/Vignette
Kdenlive/Manual/Effects/Misc/3dflippo
Kdenlive/Manual/Effects/Misc/Color_Effect
Kdenlive/Manual/Effects/Misc/Colorhalftone
Kdenlive/Manual/Effects/Misc/colorize
Kdenlive/Manual/Effects/Misc/Color_Effect
Kdenlive/Manual/Effects/Misc/dither
Kdenlive/Manual/Effects/Misc/emboss
Kdenlive/Manual/Effects/Misc/posterize
Kdenlive/Manual/Effects/Misc/sigmoidaltransfer
Kdenlive/Manual/Effects/Misc/softglow
Kdenlive/Manual/Effects/Misc/spillsupress
Kdenlive/Manual/Effects/Misc/timeout indicator
Kdenlive/Manual/Effects/Motion
Kdenlive/Manual/Effects/Motion/Freeze
Kdenlive/Manual/Effects/Motion/Speed
Kdenlive/Manual/Titles
Kdenlive/Manual/Monitors
Kdenlive/Manual/Monitors/Clip_Monitor_RightClick
Kdenlive/Manual/Monitors/Project_Monitor_RightClick
Kdenlive/Manual/Menu
Kdenlive/Manual/File_Menu
Kdenlive/Manual/File_Menu/New
Kdenlive/Manual/File_Menu/Open
Kdenlive/Manual/File_Menu/Open_Recent
Kdenlive/Manual/File_Menu/Save
Kdenlive/Manual/File_Menu/Save_As
Kdenlive/Manual/File_Menu/Revert
Kdenlive/Manual/File_Menu/DVD_Wizard
Kdenlive/Manual/File_Menu/Transcode_Clips
Kdenlive/Manual/File_Menu/Close
Kdenlive/Manual/File_Menu/Quit
Kdenlive/Manual/Edit_Menu
Kdenlive/Manual/Edit_Menu/Copy
Kdenlive/Manual/Edit_Menu/Find
Kdenlive/Manual/Edit_Menu/Find_Next
Kdenlive/Manual/Edit_Menu/Paste
Kdenlive/Manual/Edit_Menu/Paste_Effects
Kdenlive/Manual/Edit_Menu/Redo
Kdenlive/Manual/Edit_Menu/Undo
Kdenlive/Manual/Edit_Menu/Paste_Effects
Kdenlive/Manual/Project_Menu
Kdenlive/Manual/Project_Menu/Extract_Audio
Kdenlive/Manual/Project_Menu/Stabilize
Kdenlive/Manual/Project_Menu/AutomaticSceneSplit_
Kdenlive/Manual/Project_Menu/Transcode
Kdenlive/Manual/Project_Menu/Stop_Motion_Capture
Kdenlive/Manual/Project_Menu/Reload_Clip
Kdenlive/Manual/Project_Menu/Clip_in_Timeline
Kdenlive/Manual/Project_Menu/Edit_Clip
Kdenlive/Manual/Project_Menu/Delete_Clip
Kdenlive/Manual/Project_Menu/Clean_Project
Kdenlive/Manual/Project_Menu/Render
Kdenlive/Manual/Project_Menu/Adjust_Profile_to_Current_Clip
Kdenlive/Manual/Timeline/Editing
Kdenlive/Manual/Clip_Menu
Kdenlive/Manual/Timeline_Menu
Kdenlive/Manual/Monitor_Menu
Kdenlive/Manual/View_Menu
Kdenlive/Manual/View_Menu/Save_Layout_As
Kdenlive/Manual/View_Menu/Load_Layout
Kdenlive/Manual/View_Menu/Show_Title_Bars
Kdenlive/Manual/View_Menu/Show_Timeline
Kdenlive/Manual/View_Menu/Project_Tree
Kdenlive/Manual/View_Menu/Clip_Monitor
Kdenlive/Manual/View_Menu/Project_Monitor
Kdenlive/Manual/View_Menu/Effect_Stack
Kdenlive/Manual/View_Menu/Transition
Kdenlive/Manual/View_Menu/Effect_List
Kdenlive/Manual/View_Menu/Vectorscope
Kdenlive/Manual/View_Menu/Waveform
Kdenlive/Manual/View_Menu/RGB_Parade
Kdenlive/Manual/View_Menu/Histogram
Kdenlive/Manual/View_Menu/Audio_Signal
Kdenlive/Manual/View_Menu/Audio_Spectrum
Kdenlive/Manual/View_Menu/Spectogram
Kdenlive/Manual/View_Menu/Undo_History
Kdenlive/Manual/Settings_Menu
Kdenlive/Manual/Settings_Menu/Manage_Project_Profiles
Kdenlive/Manual/Settings_Menu/Download_New_Wipes
Kdenlive/Manual/Settings_Menu/Download_New_Render_Profiles
Kdenlive/Manual/Settings_Menu/Download_New_Project_Profiles
Kdenlive/Manual/Settings_Menu/Download_New_Title_Templates
Kdenlive/Manual/Settings_Menu/Run_Config_Wizard
Kdenlive/Manual/Settings_Menu/Themes
Kdenlive/Manual/Settings_Menu/Toolbars_Shown
Kdenlive/Manual/Settings_Menu/Full_Screen_Mode
Kdenlive/Manual/Settings_Menu/Configure_Shortcuts
Kdenlive/Manual/Settings_Menu/Configure_Notifications
Kdenlive/Manual/Settings_Menu/Configure_Kdenlive
Kdenlive/Manual/Rendering
Kdenlive/Manual/Project_Menu/Render/Render_Profile_Parameters
Kdenlive/Manual/Capturing
Kdenlive/Manual/Toolbars
Kdenlive/Manual/ShootingHints
Kdenlive/Manual/Troubleshooting_and_Common_Problems
Kdenlive/Manual/KdenliveOnOtherPlatforms
Kdenlive/Manual/KdenliveOnOtherPlatforms/Non-KDE_Desktops
Kdenlive/Manual/KdenliveOnOtherPlatforms/OSX
Kdenlive/Manual/Useful_Information
Kdenlive/Manual/Useful_Information/FAQ
Kdenlive/Manual/Useful_Information/Shortcuts
Kdenlive/Manual/Useful_Information/Tips_Tricks
Kdenlive/Manual/Useful_Information/Useful_Resources
Kdenlive/Manual/Credits_and_License

@yurchor

Think I could contribute an edit or two to the documentation. What you think is missing from the manual?

@yurchor

Think I could contribute an edit or two to the documentation. What you think is missing from the manual?

  1. It should be correctly structured and formatted [1]
  1. It should be up-to-date. For example, [2] is outdated.
  1. Some pages are missing (red links). For example [3].
  1. It might be a personal preference, but I do not like some screenshots [4]. They look childish.

[1] https://userbase.kde.org/Typographical_Guidelines

[2] https://userbase.kde.org/Kdenlive/Manual/Settings_Menu/Configure_Kdenlive#Misc

[3] https://userbase.kde.org/Kdenlive/Manual/Effects/Colour_Correction

[4] https://userbase.kde.org/Kdenlive/Manual/Effects/Custom

@yurchor

Should I be concerned with the refactoring version at the time being, or just 18.12.1?

afarid added a subscriber: afarid.Mar 15 2019, 3:00 AM

Folks, thanks for the effort. FYI, we have merged the refactoring branch to master so 19.04 will be completely new. So focus should be on the refactoring (which is now master.)