|
Next revision
|
Previous revision
|
doc:roadmap [2009/10/29 20:42]
michael created |
doc:roadmap [2025/07/15 15:24] (current)
tedfelix |
| ====== Road Map ====== | ====== Road Map ====== |
| The help project is well under way now, and a road map is forming. Interested parties should feel free to help, as there is a ton of work to do. | |
| |
| The groundwork is far enough along, and the old Handbook is now in one gigantic page. What we need to do from here is: | * <del>Ilan got all the help buttons done.</del> |
| | * Move pieces of [[doc:manual-en|the manual]] into separate small pages to conserve bandwidth. |
| | * Flesh out these pages from [[doc:manual-en|the manual]]. |
| | *[[doc:audioSplitDialog-en]] |
| | *[[doc:audioManager-en]] |
| | *[[doc:audioMixerWindow-en]] |
| | *[[doc:audioPluginDialog-en]] |
| | *[[doc:bankEditorDialog-en]] |
| | *[[doc:controlEditorDialog-en]] |
| | *[[doc:device-manager-en]] |
| | *[[doc:eventView-en]] |
| | *[[doc:fileMergeDialog-en]] |
| | *[[doc:interpretDialog-en]] |
| | *[[doc:keySignatureDialog-en]] |
| | *[[doc:manual-lilypondoptions-en]] |
| | *[[doc:lyricEditDialog-en]] |
| | *[[doc:markerEditor-en]] |
| | *[[doc:matrix-en]] |
| | *[[doc:midi-filter-en]] |
| | *[[doc:midiMixerWindow-en]] |
| | *[[doc:notation-en]] |
| | *[[doc:pasteNotationDialog-en]] |
| | *[[doc:pitchBendSequenceDialog-en]] |
| | *[[doc:manual-preset-handler-en]] |
| | *[[doc:audio-filenames-en]] |
| | *[[doc:synth-plugin-manager-en]] |
| | *[[doc:tempoDialog-en]] |
| | *[[doc:tempoView-en]] |
| | *[[doc:textEventDialog-en]] |
| | *[[doc:timeSignatureDialog-en]] |
| | *[[doc:triggerSegmentManager-en]] |
| | *[[doc:tupletDialog-en]] |
| | * Include breadcrumbs and/or back buttons on each page. |
| |
| - Add help buttons to all suitable dialogs | * Organize the pages into chapters. |
| - Generate the help content for these buttons (much of it can come from the existing text) | * Create a page per chapter and list all the wiki pages in the appropriate chapter pages. |
| - After all the help buttons are done, move on to the editor-level help menus, which should wrap all related help button pages | * Reduce [[doc:manual-en|the manual]] to a table of contents linking the chapter pages. |
| - After all the editor-level menus are done, everything that's left here on this page should be the main window help | * Fix page breadcrumbs/back buttons to make sure navigation is easy on all pages. |
| |
| ===== Help buttons ===== | |
| |
| * Find a QDialogButtonBox somewhere (usually in dialogs) | **Roadmap for french translation** |
| * If there is not already a QStandardButton::Help then add one | |
| * Hook up the help slot, and provide an unique URL | |
| | |
| **Adding help to LilyPondOptionsDialog:** | |
| <code diff> | |
| </code> | |
| | |
| * Once you have the slot pointing to your unique URL, access that page here on the wiki | |
| * If information on this topic already exists in the big all-in-one manual, cut it out of the main text and paste it on your new page, leaving behind a top level header and a link | |
| | |
| (To be continued... I need to make another diff.) | |
| | |
| | |
| ===== Editor Help Menus ===== | |
| (We'll get here a bit later... Please ignore these for the time being, and work on help buttons!) | |
| |
| | *[[doc:audioSplitDialog-fr]] |
| | *[[doc:audioManager-fr]] |
| | *[[doc:audioMixerWindow-fr]] |
| | *[[doc:audioPluginDialog-fr]] |
| | *[[doc:bankEditorDialog-fr]] |
| | *[[doc:controlEditorDialog-fr]] |
| | *[[doc:device-manager-fr]] |
| | *[[doc:eventView-fr]] |
| | *[[doc:fileMergeDialog-fr]] |
| | *[[doc:interpretDialog-fr]] |
| | *[[doc:keySignatureDialog-fr]] |
| | *[[doc:manual-lilypondoptions-fr]] |
| | *[[doc:lyricEditDialog-fr]] |
| | *[[doc:markerEditor-fr]] |
| | *[[doc:matrix-fr]] |
| | *[[doc:midi-filter-fr]] |
| | *[[doc:midiMixerWindow-fr]] |
| | *[[doc:notation-fr]] |
| | *[[doc:pasteNotationDialog-fr]] |
| | *[[doc:pitchBendSequenceDialog-fr]] |
| | *[[doc:manual-preset-handler-fr]] |
| | *[[doc:audio-filenames-fr]] |
| | *[[doc:manual-fr]] |
| | *[[doc:synth-plugin-manager-fr]] |
| | *[[doc:tempoDialog-fr]] |
| | *[[doc:tempoView-fr]] |
| | *[[doc:textEventDialog-fr]] |
| | *[[doc:timeSignatureDialog-fr]] |
| | *[[doc:triggerSegmentManager-fr]] |
| | *[[doc:tupletDialog-fr]] |
