Rosegarden Wiki

 

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
Next revision Both sides next revision
doc:roadmap [2009/10/29 21:00]
michael 		doc:roadmap [2010/01/17 20:59]
michael
Line 1: Line 1:
 ====== 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.+Ilan got all the help buttons done.  I figure the plan of attack from here is to flesh out these pages first.  When possible, **cut out** existing text from the [[doc:manual-en|main entry page]] first, and **move it** (don't copy it, but do leave a link in its place) into these pages as appropriate:
  
-The groundwork is far enough along, and the old Handbook is now in one gigantic page.  What we need to do from here is:+  *[[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:manual-en]] 
 +  *[[doc:synth-plugin-manager-en]] 
 +  *[[doc:tempoDialog-en]] 
 +  *[[doc:tempoView-en]] 
 +  *[[doc:textEventDialog-en]] 
 +  *[[doc:timeSignatureDialog-en]] 
 +  *[[doc:triggerSegmentManager-en]] 
 +  *[[doc:tupletDialog-en]]
  
-  - Add help buttons to all suitable dialogs +After all that's done, we need to figure out what to leave on the main page itself, and I'm thinking we probably want to fork most of the remainder of its contents off onto more sub-pages, leaving the main entry page as a brief intro with an index linking to everything else.
-  - Generate the help content for these buttons (much of it can come from the existing text) +
-  - After all the help buttons are done, move on to the editor-level help menus, which should wrap all related help button pages +
-  - After all the editor-level menus are done, everything that's left here on this page should be the main window help +
- +
-===== Help buttons ===== +
- +
-* Find a QDialogButtonBox somewhere (usually in dialogs) +
-* 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> +
-Index: src/gui/dialogs/LilyPondOptionsDialog.cpp                           +
-===================================================================        +
---- src/gui/dialogs/LilyPondOptionsDialog.cpp   (revision 11134)           +
-+++ src/gui/dialogs/LilyPondOptionsDialog.cpp   (working copy)             +
-@@ -29,6 +29,8 @@                                                          +
- #include <QComboBox>                                                      +
- #include <QDialog>                                                        +
- #include <QDialogButtonBox>                                               +
-+#include <QUrl>                                                           +
-+#include <QDesktopServices>                                               +
- #include <QFrame>                                                         +
- #include <QGridLayout>                                                    +
- #include <QGroupBox>                                                      +
-@@ -55,8 +57,6 @@                                                          +
-         QDialog(parent),                                                  +
-        m_doc(doc)                                                         +
- {                                                                         +
--    //setHelp("file-printing");                                           +
--                                                                          +
-     setModal(true);                                                       +
-     setWindowTitle((windowCaption = "" ? tr("LilyPond Export/Preview") : windowCaption)); +
-                                                                                           +
-@@ -250,7 +250,7 @@                                                                        +
-                                                                                           +
-     mainbox->setLayout(mainboxLayout);                                                    +
-                                                                                           +
--    QDialogButtonBox *buttonBox = new QDialogButtonBox(QDialogButtonBox::Apply | QDialogButtonBox::Ok | QDialogButtonBox::Cancel); +
-+    QDialogButtonBox *buttonBox = new QDialogButtonBox(QDialogButtonBox::Apply | QDialogButtonBox::Ok | QDialogButtonBox::Cancel | QDialogButtonBox::Help); +
-     metaGridLayout->addWidget(buttonBox, 1, 0); +
-     metaGridLayout->setRowStretch(0, 10); +
- +
-@@ -259,6 +259,7 @@ +
- +
-     connect(buttonBox, SIGNAL(accepted()), this, SLOT(accept())); +
-     connect(buttonBox, SIGNAL(rejected()), this, SLOT(reject())); +
-+    connect(buttonBox, SIGNAL(helpRequested()), this, SLOT(help())); +
- +
-     populateDefaultValues(); +
- +
-@@ -266,6 +267,19 @@ +
- } +
- +
- void +
-+LilyPondOptionsDialog::help() +
-+{ +
-+    // TRANSLATORS: if the manual is translated into your language, you can +
-+    // change the two-letter language code in this URL to point to your language +
-+    // version, eg. "http://rosegardenmusic.com/wiki/doc:manual-es" for the +
-+    // Spanish version. If your language doesn't yet have a translation, feel +
-+    // free to create one. +
-+    QString helpURL = tr("http://rosegardenmusic.com/wiki/doc:manual-lilypondoptions-en"); +
-+    QDesktopServices::openUrl(QUrl(helpURL)); +
-+} +
-+ +
-+ +
-+void +
- LilyPondOptionsDialog::populateDefaultValues() +
- { +
-     QSettings settings; +
-Index: src/gui/dialogs/LilyPondOptionsDialog.h +
-=================================================================== +
---- src/gui/dialogs/LilyPondOptionsDialog.h     (revision 11134) +
-+++ src/gui/dialogs/LilyPondOptionsDialog.h     (working copy) +
-@@ -48,6 +48,7 @@ +
- public slots: +
-     void slotApply(); +
-     void accept(); +
-+    void help(); +
- +
- protected: +
-     RosegardenDocument *m_doc; +
-</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: +
- +
-<code diff> +
-- ===== LilyPond options ===== +
-[content omitted for clarity...] +
-+ ====== LilyPond options ====== +
-+ [[doc:manual-lilypondoptions-en|LilyPond Options]] +
-</code> +
- +
-* Test that the link works from Rosegarden (this one does) and away we go.  Don't worry about editing the content so much on this first pass, as it's most important to get the help links done and get the big gigantic manual cut into chunks so we can get the overall structure into place first +
- +
- +
-===== Editor Help Menus ===== +
-(We'll get here a bit later...  Please ignore these for the time being, and work on help buttons!)+
  
  
 
doc/roadmap.txt · Last modified: 2022/05/06 16:07 (external edit)
Recent changes RSS feed Creative Commons License Valid XHTML 1.0 Valid CSS Driven by DokuWiki