Skip to content
Snippets Groups Projects
Commit 3b1b62ed authored by Reinhold Kainhofer's avatar Reinhold Kainhofer
Browse files

Some more work on the docs

parent 8ed8f154
No related branches found
No related tags found
No related merge requests found
...@@ -14,8 +14,8 @@ PDF_FILE = $(DOC_DIR)/orchestrallily.pdf ...@@ -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 all: $(TELY_FILE) pathes $(TEXI_FILE) $(HTML_FILE) $(HTML_BIG_FILE) $(DOC_DIR)/makeinfo.html $(PDF_FILE) links
pathes: pathes:
mkdir -p orchestrallily/ texi/ mkdir -p $(DOC_DIR) $(TEXI_DIR) $(DOC_DIR)/releases/
cp -r images/score_structure.pdf texi/ cp -r images/score_structure.pdf $(TEXI_DIR)
$(TEXI_FILE): $(TELY_FILE) $(TEXI_FILE): $(TELY_FILE)
echo "Running lilypond-book:" echo "Running lilypond-book:"
...@@ -42,6 +42,7 @@ $(PDF_FILE): $(TEXI_FILE) ...@@ -42,6 +42,7 @@ $(PDF_FILE): $(TEXI_FILE)
links: links:
echo "Creating soft links for html links image and lilypond files:" 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 -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: clean:
rm -rf $(DOC_DIR) $(TEXI_DIR) rm -rf $(DOC_DIR) $(TEXI_DIR)
...@@ -16,6 +16,10 @@ ...@@ -16,6 +16,10 @@
@end quotation @end quotation
@end macro @end macro
@macro bs
\\
@end macro
@c ******************************************************* @c *******************************************************
@c ** COPYRIGHT INFORMATION ** @c ** COPYRIGHT INFORMATION **
@c ******************************************************* @c *******************************************************
...@@ -24,7 +28,7 @@ ...@@ -24,7 +28,7 @@
This is the documentation of the OrchestralLily package for Lilypond, the GNU music This is the documentation of the OrchestralLily package for Lilypond, the GNU music
typesetting application. 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 @end copying
...@@ -35,7 +39,7 @@ Copyright @copyright{} 2008 Reinhold Kainhofer, @email{reinhold@@kainhofer.com} ...@@ -35,7 +39,7 @@ Copyright @copyright{} 2008 Reinhold Kainhofer, @email{reinhold@@kainhofer.com}
@titlepage @titlepage
@title OrchestralLily @title OrchestralLily
@subtitle A Lilypond package for orchestral scores. @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. @c The following two commands start the copyright page.
@page @page
...@@ -53,7 +57,7 @@ Copyright @copyright{} 2008 Reinhold Kainhofer, @email{reinhold@@kainhofer.com} ...@@ -53,7 +57,7 @@ Copyright @copyright{} 2008 Reinhold Kainhofer, @email{reinhold@@kainhofer.com}
@c ** TOP NODE ** @c ** TOP NODE **
@c ******************************************************* @c *******************************************************
@ifnottex @comment @ifnottex
@node Top @node Top
@top The OrchestralLily Package @top The OrchestralLily Package
...@@ -61,13 +65,19 @@ Copyright @copyright{} 2008 Reinhold Kainhofer, @email{reinhold@@kainhofer.com} ...@@ -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{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{Author}: @uref{http://reinhold.kainhofer.com/,Reinhold Kainhofer}, @email{reinhold@@kainhofer.com}
@item @b{Date}: June 2008 @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 itemize
@end ifnottex @comment @end ifnottex
@menu @menu
* About OrchestralLily and Download:: @comment * About OrchestralLily and Download::
* Motivation:: * Motivation::
* Simple example:: * Simple example::
* Extended example:: * Extended example::
...@@ -90,15 +100,15 @@ Copyright @copyright{} 2008 Reinhold Kainhofer, @email{reinhold@@kainhofer.com} ...@@ -90,15 +100,15 @@ Copyright @copyright{} 2008 Reinhold Kainhofer, @email{reinhold@@kainhofer.com}
@c ** CONTENT ** @c ** CONTENT **
@c ******************************************************* @c *******************************************************
@node About OrchestralLily and Download @comment @node About OrchestralLily and Download
@chapter About OrchestralLily and Download @comment @chapter About OrchestralLily and Download
@comment
@itemize @comment @itemize
@item @b{Description}: A @uref{http://www.lilypond.org/, Lilypond} package to easily generate orchestral scores and other complex scores. @comment @comment @comment @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} @comment @item @b{Author}: @uref{http://reinhold.kainhofer.com/,Reinhold Kainhofer}, @email{reinhold@@kainhofer.com}
@item @b{Date}: February 2008 @comment @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 @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
@end itemize @comment @end itemize
@node Motivation @node Motivation
...@@ -311,7 +321,7 @@ Similarly, "Choir" is a ChoirStaff and consists of the individual staves "S", "A ...@@ -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 @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: 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")) ("FullScore" "SimultaneousMusic" ("Woodwinds" "Strings" "Vocal" "VcB"))
("Woodwinds" "StaffGroup" ("Fl" "Ob")) ("Woodwinds" "StaffGroup" ("Fl" "Ob"))
("Fl" "PartCombinedStaff" ("FlI" "FlII")) ("Fl" "PartCombinedStaff" ("FlI" "FlII"))
...@@ -370,7 +380,7 @@ be inside a @code{DrumVoice}, @code{\figuremode} inside @code{FiguredBass}, etc. ...@@ -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 To set the type of context used for a voice in Orchestrallily, simply call
@code{\orchestralVoiceTypes} with an association list defining the voice type @code{\orchestralVoiceTypes} with an association list defining the voice type
for each voice ID. For example: for each voice ID. For example:
@lilyverb{\orchestralVoiceTypes #'( @lilyverb{@bs{}orchestralVoiceTypes #'(
("Ix" "DrumVoice") ("Ix" "DrumVoice")
("Iix" "FiguredBass") ("Iix" "FiguredBass")
)} )}
...@@ -393,9 +403,9 @@ One of the advantages of assigning each group a name is that you can now tell Or ...@@ -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: Say you have the following structure of your score:
@lilyverb{'( @lilyverb{'(
("V" GrandStaff ("VI" "VII")) ("V" "GrandStaff" ("VI" "VII"))
("Strings" StaffGroup ("V" "Va")) ("Strings" "StaffGroup" ("V" "Va"))
("FullScore" ParallelMusic ("Strings" "SSolo")) ("FullScore" "ParallelMusic" ("Strings" "SSolo"))
)} )}
in you score structure definition. This means you have two violins, one viola and a soprano solo. 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 ...@@ -404,15 +414,15 @@ in you score structure definition. This means you have two violins, one viola an
@section How a score is generated @section How a score is generated
If you call 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: 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 @bs{}PieceAStringsStaff
\PieceASSoloStaff @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 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: 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 ...@@ -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, 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. 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} @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 ...@@ -959,26 +1000,28 @@ If you redefine this function, you have complete control about the decision when
@chapter Version History @chapter Version History
@table @asis @table @asis
@item 0.01 (2008-03-02): @item @uref{releases/orchestrallily_0.01.ly, 0.01 (2008-03-02)}:
Initial Version 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) Added basic MIDI support (...MidiInstrument and \setCreateMIDI)
@item 0.03 (2008-03-??): @item @uref{releases/orchestrallily_0.03.ly, 0.03 (2008-06-??)}:
-) Add *TimeSignature variable, split settings for full/vocal/instrumental scores @itemize
-) [Piece][Instrument]TransposeTo, if set, now specifies the pitch where c' should be shown in the applicable voices. @item Add *TimeSignature variable, split settings for full/vocal/instrumental scores
-) interpreting markup using header fields @item [Piece][Instrument]TransposeTo, if set, now specifies the pitch where c' should be shown in the applicable voices.
-) Automatically add score title to TOC @item interpreting markup using header fields
-) \createHeadline to create a headline and add it to the TOC @item Automatically add score title to TOC
-) Adapted cresc spanners to new syntax @item \createHeadline to create a headline and add it to the TOC
-) Nice title page (full page) and nicer title header (for instrumental scores) @item Adapted cresc spanners to new syntax
-) Default clefs and Instrument names for lots of common abbreviations @item Nice title page (full page) and nicer title header (for instrumental scores)
-) Default cue names fo lots of instruments, function to show cue name @item Default clefs and Instrument names for lots of common abbreviations
-) Default score numbers for each instrument @item Default cue names fo lots of instruments, function to show cue name
-) one can also specify voice types @item Default score numbers for each instrument
-) parallel voices in one staff work, @item one can also specify voice types
-) Group types are given as strings @item parallel voices in one staff work,
-) Adding handlers for new group/staff or voice types supported @item Group types are given as strings
-) Support for Drum staves/voices and figured bass @item Adding handlers for new group/staff or voice types supported
@item Support for Drum staves/voices and figured bass
@end itemize
@end table @end table
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment