diff --git a/Documentation/Makefile b/Documentation/Makefile index 85386b69716829fedf58e4f1b4bd21599f02181f..c74448574270084fdfd83da23f01f183c104ae96 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -14,8 +14,8 @@ PDF_FILE = $(DOC_DIR)/orchestrallily.pdf all: $(TELY_FILE) pathes $(TEXI_FILE) $(HTML_FILE) $(HTML_BIG_FILE) $(DOC_DIR)/makeinfo.html $(PDF_FILE) links pathes: - mkdir -p orchestrallily/ texi/ - cp -r images/score_structure.pdf texi/ + mkdir -p $(DOC_DIR) $(TEXI_DIR) $(DOC_DIR)/releases/ + cp -r images/score_structure.pdf $(TEXI_DIR) $(TEXI_FILE): $(TELY_FILE) echo "Running lilypond-book:" @@ -42,6 +42,7 @@ $(PDF_FILE): $(TEXI_FILE) links: echo "Creating soft links for html links image and lilypond files:" cp -r $(TEXI_DIR)/*.ly orchestrallily.css images/score_structure.png $(TEXI_DIR)/[a-f0-9][a-f0-9]/ $(DOC_DIR) + cp ../releases/* $(DOC_DIR)/releases/ clean: rm -rf $(DOC_DIR) $(TEXI_DIR) diff --git a/Documentation/orchestrallily.tely b/Documentation/orchestrallily.tely index 098b248b659aed7d1e780eb3906ee8f514435025..68a9403f4fa1ebd5ff68c8ba41bfec43a570c315 100644 --- a/Documentation/orchestrallily.tely +++ b/Documentation/orchestrallily.tely @@ -16,6 +16,10 @@ @end quotation @end macro +@macro bs +\\ +@end macro + @c ******************************************************* @c ** COPYRIGHT INFORMATION ** @c ******************************************************* @@ -24,7 +28,7 @@ This is the documentation of the OrchestralLily package for Lilypond, the GNU music typesetting application. -Copyright @copyright{} 2008 Reinhold Kainhofer, @email{reinhold@@kainhofer.com} +Copyright @copyright{} 2008 @uref{http://reinhold.kainhofer.com,Reinhold Kainhofer}, @email{reinhold@@kainhofer.com} @end copying @@ -35,7 +39,7 @@ Copyright @copyright{} 2008 Reinhold Kainhofer, @email{reinhold@@kainhofer.com} @titlepage @title OrchestralLily @subtitle A Lilypond package for orchestral scores. -@author Reinhold Kainhofer, @email{reinhold@@kainhofer.com} +@author @uref{http://reinhold.kainhofer.com,Reinhold Kainhofer}, @email{reinhold@@kainhofer.com} @c The following two commands start the copyright page. @page @@ -53,7 +57,7 @@ Copyright @copyright{} 2008 Reinhold Kainhofer, @email{reinhold@@kainhofer.com} @c ** TOP NODE ** @c ******************************************************* -@ifnottex +@comment @ifnottex @node Top @top The OrchestralLily Package @@ -61,13 +65,19 @@ Copyright @copyright{} 2008 Reinhold Kainhofer, @email{reinhold@@kainhofer.com} @item @b{Description}: A @uref{http://www.lilypond.org/, Lilypond} package to easily generate orchestral scores and other complex scores. @item @b{Author}: @uref{http://reinhold.kainhofer.com/,Reinhold Kainhofer}, @email{reinhold@@kainhofer.com} @item @b{Date}: June 2008 -@item @b{Download}: @uref{http://wiki.kainhofer.com/_media/lilypond/orchestrallily.ly,orchestrallily.ly, (Version 0.03@comma{} 2008-06-03)}, licensed under the GPL v3.0 +@item @b{Download}: @uref{http://wiki.kainhofer.com/_media/lilypond/orchestrallily.ly,orchestrallily.ly, (Version 0.03@comma{} 2008-06-24)}, licensed under the GPL v3.0 +@item @b{Development version}: +@itemize +@item Web-Frontend: @uref{http://repo.or.cz/w/orchestrallily.git} +@item read-only git URL: git://repo.or.cz/orchestrallily.git (use git clone URL) +@end itemize +@item @b{Documentation}: @uref{index.html,HTML (one page per section)}, @uref{orchestrallily-bigpage.html,HTML (Single page)}, @uref{orchestrallily.pdf,PDF} @end itemize -@end ifnottex +@comment @end ifnottex @menu -* About OrchestralLily and Download:: +@comment * About OrchestralLily and Download:: * Motivation:: * Simple example:: * Extended example:: @@ -90,15 +100,15 @@ Copyright @copyright{} 2008 Reinhold Kainhofer, @email{reinhold@@kainhofer.com} @c ** CONTENT ** @c ******************************************************* -@node About OrchestralLily and Download -@chapter About OrchestralLily and Download - -@itemize -@item @b{Description}: A @uref{http://www.lilypond.org/, Lilypond} package to easily generate orchestral scores and other complex scores. -@item @b{Author}: @uref{http://reinhold.kainhofer.com/,Reinhold Kainhofer}, @email{reinhold@@kainhofer.com} -@item @b{Date}: February 2008 -@item @b{Download}: @uref{http://wiki.kainhofer.com/_media/lilypond/orchestrallily.ly,orchestrallily.ly, (Version 0.02@comma{} 2008-03-06)}, licensed under the GPL v3.0 -@end itemize +@comment @node About OrchestralLily and Download +@comment @chapter About OrchestralLily and Download +@comment +@comment @itemize +@comment @comment @comment @item @b{Description}: A @uref{http://www.lilypond.org/, Lilypond} package to easily generate orchestral scores and other complex scores. +@comment @item @b{Author}: @uref{http://reinhold.kainhofer.com/,Reinhold Kainhofer}, @email{reinhold@@kainhofer.com} +@comment @item @b{Date}: February 2008 +@comment @item @b{Download}: @uref{http://wiki.kainhofer.com/_media/lilypond/orchestrallily.ly,orchestrallily.ly, (Version 0.02@comma{} 2008-03-06)}, licensed under the GPL v3.0 +@comment @end itemize @node Motivation @@ -311,7 +321,7 @@ Similarly, "Choir" is a ChoirStaff and consists of the individual staves "S", "A @section How to define this hierarchy in OrchestralLily This structure can be easily defined in OrchestralLily by calling @code{\orchestral-score-structure} with a simple list describing the hierarchy: -@lilyverb{\orchestral-score-structure #'( +@lilyverb{\bd{}orchestral-score-structure #'( ("FullScore" "SimultaneousMusic" ("Woodwinds" "Strings" "Vocal" "VcB")) ("Woodwinds" "StaffGroup" ("Fl" "Ob")) ("Fl" "PartCombinedStaff" ("FlI" "FlII")) @@ -370,7 +380,7 @@ be inside a @code{DrumVoice}, @code{\figuremode} inside @code{FiguredBass}, etc. To set the type of context used for a voice in Orchestrallily, simply call @code{\orchestralVoiceTypes} with an association list defining the voice type for each voice ID. For example: -@lilyverb{\orchestralVoiceTypes #'( +@lilyverb{@bs{}orchestralVoiceTypes #'( ("Ix" "DrumVoice") ("Iix" "FiguredBass") )} @@ -393,9 +403,9 @@ One of the advantages of assigning each group a name is that you can now tell Or Say you have the following structure of your score: @lilyverb{'( - ("V" GrandStaff ("VI" "VII")) - ("Strings" StaffGroup ("V" "Va")) - ("FullScore" ParallelMusic ("Strings" "SSolo")) + ("V" "GrandStaff" ("VI" "VII")) + ("Strings" "StaffGroup" ("V" "Va")) + ("FullScore" "ParallelMusic" ("Strings" "SSolo")) )} in you score structure definition. This means you have two violins, one viola and a soprano solo. @@ -404,15 +414,15 @@ in you score structure definition. This means you have two violins, one viola an @section How a score is generated If you call -@lilyverb{\createScore #"PieceA" #"FullScore"} +@lilyverb{@bs{}createScore #"PieceA" #"FullScore"} in your lilypond file, OrchestralLily will generate a score for you that is similar to the following hand-written score: -@lilyverb{\score { +@lilyverb{@bs{}score { << - \PieceAStringsStaff - \PieceASSoloStaff + @bs{}PieceAStringsStaff + @bs{}PieceASSoloStaff >> - \header { piece = \PieceA[FullScore]PieceName @} -@}} + @bs{}header { piece = @bs{}PieceA[FullScore]PieceName } +}} If there exists e.g. a variable @code{\PieceAStringsStaff}, it is used, otherwise the staff (group) will be generated by OrchestralLily as described below. If none of the sub-staves (and their sub-staves, etc.) contains any music, OrchestralLily will instead create a title to indicate no music is to be played: @@ -621,11 +631,42 @@ a DrumStaff and a RhythmicStaff can easily be generated by a proper score structure definition. As the voice of a DrumStaff needs to be a DrumVoice, we also have to set this voice type once in our definitions. -The supported staff group types are: ''GrandStaff, PianoStaff, ChoirStaff, StaffGroup, InnerChoirStaff, InnerStaffGroup, ParallelMusic'' and its equivalent ''SimultaneousMusic''. +The supported staff group types are: +@itemize +@item "GrandStaff" +@item "PianoStaff" +@item "ChoirStaff" +@item "StaffGroup" +@item "InnerChoirStaff" +@item "InnerStaffGroup" +@item "ParallelMusic" and its equivalent "SimultaneousMusic". +@end itemize -The supported staff types are: ''Staff, DrumStaff, RhythmicStaff, TabStaff, GregorianTranscriptionStaff, MensuralStaff, VaticanaStaff, PartCombinedStaff, ParallelVoicesStaff'' and ''FiguredBass''. +The supported staff types are: +@itemize +@item "Staff" +@item "DrumStaff" +@item "RhythmicStaff" +@item "TabStaff" +@item "GregorianTranscriptionStaff" +@item "MensuralStaff" +@item "VaticanaStaff" +@item "PartCombinedStaff" +@item "ParallelVoicesStaff" +@item "FiguredBass" +@end itemize -The supported voice types are: ''Voice, CueVoice'' (for smaller notes), ''DrumVoice, FiguredBass, GregorianTranscriptionVoice, NoteNames, TabVoice'' and ''VaticanaVoice''. +The supported voice types are: +@itemize +@item "Voice" +@item "CueVoice" (for smaller notes) +@item "DrumVoice" +@item "FiguredBass" +@item "GregorianTranscriptionVoice" +@item "NoteNames" +@item "TabVoice" +@item "VaticanaVoice" +@end itemize @lilypondfile[quote,verbatim,line-width=10\cm]{../testsuite/non-standard-staff-voice-types.ly} @@ -959,26 +1000,28 @@ If you redefine this function, you have complete control about the decision when @chapter Version History @table @asis -@item 0.01 (2008-03-02): +@item @uref{releases/orchestrallily_0.01.ly, 0.01 (2008-03-02)}: Initial Version -@item 0.02 (2008-03-06): +@item @uref{releases/orchestrallily_0.02.ly, 0.02 (2008-03-06)}: Added basic MIDI support (...MidiInstrument and \setCreateMIDI) -@item 0.03 (2008-03-??): - -) Add *TimeSignature variable, split settings for full/vocal/instrumental scores - -) [Piece][Instrument]TransposeTo, if set, now specifies the pitch where c' should be shown in the applicable voices. - -) interpreting markup using header fields - -) Automatically add score title to TOC - -) \createHeadline to create a headline and add it to the TOC - -) Adapted cresc spanners to new syntax - -) Nice title page (full page) and nicer title header (for instrumental scores) - -) Default clefs and Instrument names for lots of common abbreviations - -) Default cue names fo lots of instruments, function to show cue name - -) Default score numbers for each instrument - -) one can also specify voice types - -) parallel voices in one staff work, - -) Group types are given as strings - -) Adding handlers for new group/staff or voice types supported - -) Support for Drum staves/voices and figured bass +@item @uref{releases/orchestrallily_0.03.ly, 0.03 (2008-06-??)}: +@itemize +@item Add *TimeSignature variable, split settings for full/vocal/instrumental scores +@item [Piece][Instrument]TransposeTo, if set, now specifies the pitch where c' should be shown in the applicable voices. +@item interpreting markup using header fields +@item Automatically add score title to TOC +@item \createHeadline to create a headline and add it to the TOC +@item Adapted cresc spanners to new syntax +@item Nice title page (full page) and nicer title header (for instrumental scores) +@item Default clefs and Instrument names for lots of common abbreviations +@item Default cue names fo lots of instruments, function to show cue name +@item Default score numbers for each instrument +@item one can also specify voice types +@item parallel voices in one staff work, +@item Group types are given as strings +@item Adding handlers for new group/staff or voice types supported +@item Support for Drum staves/voices and figured bass +@end itemize @end table