Both sides previous revision
Previous revision
Next revision
|
Previous revision
Next revision
Both sides next revision
|
dev:development [2012/08/19 22:29] tedfelix [Documents in Subversion] Cleanup |
dev:development [2013/09/04 18:52] tehom Added link |
* **See also: [[http://rosegarden.sourceforge.net/code_doc|Doxygen code documentation]]** (NOTE: This is broken. Not sure that we generate doxygen docs anymore. To generate doxygen docs, run doxygen in the rosegarden dir. The docs will appear in /tmp/html/index.html per the OUTPUT_DIRECTORY value in Doxyfile.) | * **See also: [[http://rosegarden.sourceforge.net/code_doc|Doxygen code documentation]]** (NOTE: This is broken. Not sure that we generate doxygen docs anymore. To generate doxygen docs, run doxygen in the rosegarden dir. The docs will appear in /tmp/html/index.html per the OUTPUT_DIRECTORY value in Doxyfile.) |
| |
====Explanatory Snippets==== | =====Explanatory Snippets===== |
| |
These are short explanations that have come up on the Rosegarden developers' mailing list at one time or another, sometimes with a bit more detail added in the wiki. | These are short explanations that have come up on the Rosegarden developers' mailing list at one time or another, sometimes with a bit more detail added in the wiki. |
See also the [[http://sourceforge.net/mailarchive/forum.php?forum_name=rosegarden-devel|rosegarden-devel archives]]. | See also the [[http://sourceforge.net/mailarchive/forum.php?forum_name=rosegarden-devel|rosegarden-devel archives]]. |
| |
===Basics=== | ====Basics==== |
| |
* [[Manipulating the document]] | * [[Manipulating the document]] |
| * [[MIDI dataflows]] |
| |
===GUI=== | ====GUI==== |
| |
* [[Loading the Studio or other partial documents from XML]] | * [[Loading the Studio or other partial documents from XML]] |
* [[Keeping GUI elements updated]] | * [[Keeping GUI elements updated]] |
| |
===Sequencer=== | ====Sequencer==== |
| |
* [[How A Note Becomes A Sound]] | * [[How A Note Becomes A Sound]] |
* [[Instruments and Devices]] | * [[Instruments and Devices]] |
| |
===Translations=== | ====Translations==== |
| |
* [[Making strings translatable]] | * [[Making strings translatable]] |
====Documents in Subversion==== | =====Documents in Subversion===== |
| |
There are several plain-text documents found in the Rosegarden source code repository ([[http://rosegarden.svn.sourceforge.net/viewvc/rosegarden/trunk/docs/|browse]]). | There are several plain-text documents found in the Rosegarden source code repository ([[http://rosegarden.svn.sourceforge.net/viewvc/rosegarden/trunk/docs/|browse]]). |
**NOTE I didn't realize this page simply linked to SVN. These documents are no longer available. We should just move them into the wiki and update them as we go, but I am not going to finish that anytime soon. The documents that have not yet been rescued can be found in http://rosegarden.svn.sourceforge.net/viewvc/rosegarden/branches/obsolete/docs/ ** | **NOTE I didn't realize this page simply linked to SVN. These documents are no longer available. We should just move them into the wiki and update them as we go, but I am not going to finish that anytime soon. The documents that have not yet been rescued can be found in http://rosegarden.svn.sourceforge.net/viewvc/rosegarden/branches/obsolete/docs/ ** |
| |
===Basics=== | ====Basics==== |
| |
* [[Overall code structure]] | * [[Overall code structure]] |
* [[dev:creating_events.txt|Creating Events and their properties]] | * [[dev:creating_events.txt|Creating Events and their properties]] |
| * [[dev:how_a_note_becomes_a_sound|How a note becomes a sound]] |
* [[dev:units.txt|Pitch and time units for Events]] | * [[dev:units.txt|Pitch and time units for Events]] |
* [[http://rosegarden.svn.sourceforge.net/viewvc/rosegarden/trunk/docs/code/iterators.txt?view=markup|Iterating over Events in segments and compositions]] (Need to rescue from svn. See NOTE above.) | * [[http://rosegarden.svn.sourceforge.net/viewvc/rosegarden/trunk/docs/code/iterators.txt?view=markup|Iterating over Events in segments and compositions]] (Need to rescue from svn. See NOTE above.) |
| ====Notation==== |
===Notation=== | |
| |
* [[http://rosegarden.svn.sourceforge.net/viewvc/rosegarden/trunk/docs/data_struct/tuplets.txt?view=markup|Triplet/tuplet event storage properties]] (Need to rescue from svn. See NOTE above.) | * [[http://rosegarden.svn.sourceforge.net/viewvc/rosegarden/trunk/docs/data_struct/tuplets.txt?view=markup|Triplet/tuplet event storage properties]] (Need to rescue from svn. See NOTE above.) |
* [[http://rosegarden.svn.sourceforge.net/viewvc/rosegarden/trunk/docs/code/notation_layout.txt?view=markup|Notation layout procedure]] (Need to rescue from svn. See NOTE above.) | * [[http://rosegarden.svn.sourceforge.net/viewvc/rosegarden/trunk/docs/code/notation_layout.txt?view=markup|Notation layout procedure]] (Need to rescue from svn. See NOTE above.) |
| |
===Sequencer=== | ====Sequencer==== |
| |
* [[http://rosegarden.svn.sourceforge.net/viewvc/rosegarden/trunk/docs/code/multiport_recording.txt?view=markup|Recording from multiple MIDI ports]] (but not onto multiple tracks simultaneously - this document predates that work) (Need to rescue from svn. See NOTE above.) | |
| |
| * [[Recording from multiple MIDI ports]] (but not onto multiple tracks simultaneously - this document predates that work) (was branches/obsolete/docs/code/multiport_recording.txt) |
| |