10. Available functions

\paragraph "text" \piece-titlepage "markup" \orchestralScoreStructure ’(structure list) \orchestralVoiceTypes ’(voice type list) (oly:register_staff_type_handler type func) (oly:register_voice_type_handler type func) \setUseBook #t/#f \setCreateMIDI #t/#f \setCreatePDF #t/#f \createScore #"Piece" ’("Instrument"...) \createNoCuesScore #"Piece" ’("Instrument"...) \createHeadline "text of the headline"

\setCue "cueString" \setClefCue "cueString" clef \namedCueDuring "CueVoice" #DIR "InstrCue" "Instr" music \namedTransposedCueDuring "CueVoice" #DIR "InstrCue" "Instr" Transposition music \cleffedCueDuring "CueVoice" #DIR "InstrCue" ClefCue "Instr" ClefInst Transposition music

\tempoMark ’(padding . padding) #"Marktext" \shiftDynamics #x #y

Dynamic text: \ffz, \pf, \sempp, \parenf, \parenp Dynamic spanners: \setDim, \dim, \enddim, \setDecresc, \decresc, \enddecresc, \setCresc, \cresc, \endcresc

\newOrOldClef "new" "old" (depending on (ly:get-option ’old-clefs)) \filterArticulations music (removed all articulations, dynamics, text scripts and multi-measure text events)

\when-property symbol markup \vspace #space

\markupWithHeader markupVariable \columns markup-list

\newInstrument "instrumentName" (set cue name with "+") \cueText (= \setCue !!!!!)

\scoreNumber nr

Settings: \contentsTitle (title for the TOC) \titlePageMarkup (book title as header) \titleHeaderMarkup (book title as title page) \titleScoreMarkup (score title as markup)


Generates the score for the given piece and the given instrument(s). If no appropriate *Staff or *Music can be found, a header with the *PieceName (or the *PieceNameTacet) string will be printed.

createScore #"PieceID" #'("Instrument1" "Instrument2" ...) 


Like \createScore, except that \killCues and \removeWithTag 'cued is applied to all the music/staves

createNoCuesScore #"PieceID" #'("Instrument1" "Instrument2" ...)


orchestralScoreStructure #'( ("ID" 'StaffType ("List" "Of" "Instruments"))... ))

* Typical call:

orchestralScoreStructure #'(
; Part-combined staves (one staff with two voices)
  ("Fl" #t ("FlI" "FlII"))
; Grouped staves (multiple staves either in a StaffGroup, or parallel without a bracket)
  ("Str" 'StaffGroup ("V" "Va"))
  ("Solo" 'ParallelMusic ("SSolo" "TSolo"))
  ("Ch" 'ChoirStaff ("S" "A" "T" "B"))
  ("Vocal" 'SimultaneousMusic ("Solo" "Ch"))
; full scores, again as grouped staves, no over-all bracket
  ("FullScore" 'ParallelMusic ("Fl" "Str" "Solo" "Ch"))

* Description: Defines the hierarchy tree of the score. Each staff group (or part-combined staff with two voices) is identified by an ID (the first element of each entry). * Parameters: Score structure ... A list of group descriptions. Each entry describes such a group and has three possible forms: ("Identifier" StaffGroupType ("List" "of" "child" "identifiers")) ; Staff group of given type ("Identifier" SimultaneousMusic|ParallelMusic ("List" "children" )) ; Staves connected without a bracket ("Identifier" #f ("List" "of" "voices")) ; One staff with multiple voices (not yet implemented!) ("Identifier" #t ("Two" "voices")) ; Staff with two part-combined voices The list can contain each identifier only once, but they do not have to form only one tree, you can define several different hierarchy trees in one list!


setUseBook ##t

* Typical call: \setUseBook ##t * Description: Declare whether the scores are called within a \book section or as top-level. * Explanation: Internally, a score needs to be created differently if it should be printed inside a \book environment. Unfortunately, it is not possible in lilypond to detect the current environment, so this function is needed to explicitly declare that the following scores are inserted inside a \book environment. * Parameters: * inside book ... ##t if the following scores are inside a \book environment, ##f if not (default) setUseBook = #(define-music-function (parser location usebook) (boolean?)


Set a flag to determine whether MIDI output should be generated (default: NO). If YES, then an empty \midi{} block is generated in the score to trigger the creation of the midi file.

setCreateMIDI ##t

* Typical call: \setCreateMidi ##t


Set a flag to determine whether PDF output should be generated (default: YES). If no, no \layout{} block will be generated in the score. If create MIDI == #t, then only MIDI will be created. If create MIDI == #f, then the PDF output will still be generated (similar to the existence/non-existence of a \midi and \layout block in a score!).

setCreatePDF ##t

* Typical call: \setCreatePDF ##t


Like \cueDuring, but also adds the instrument name of the cue instrument at the beginning of the cue notes and the original instrument name after the cue notes.

namedCueDuring #"QuoteName" #DIR #"cue instrument" #"original instrument"  music

* Typical call: \namedCueDuring #"vIQuote" #UP #"V.I" #"Sop." { R1*3 } * Parameters: * quote name, direction, music ... Parameters of \cueDuring * cue instrument, original instrument ... Instrument names (strings) to be printed as cue instrument name at the beginning of the cues and as original instrument name after the cue notes


Like \namedCueDuring, but uses \transposedCueDuring instead of \cueDuring.

namedTransposedCueDuring #"QuoteName" #DIR #"cue instrument" #"original instrument" centralCNote music

* Typical call: \namedTransposedCueDuring #"vIQuote" #UP #"Piccolo" #"Sop." c' { R1*3 }


Like \namedCudDuring, but shows the cue notes with a different clef.

cleffedCueDuring NameOfQuote CueDirection CueInstrument CueClef OriginalInstrument OriginalClef music

* Typical call: \cleffedCueDuring #"vIQuote" #UP #"V.I" {\clef "treble"} #"Basso" {\clef "bass"} { R1*3 }

% Parameters: \cleffedCueDuring NameOfQuote CueDirection CueInstrument CueClef OriginalInstrument OriginalClef music % -) NameOfQuote CueDirection music are the parameters for \cueDuring % -) CueInstrument and OriginalInstrument are the displayed instrument names % -) CueClef and OriginalClef are the clefs for the the cue notes and the clef of the containing voice

% This adds the notes from vIQuote (defined via \addQuote) to three measures, prints "V.I" at % the beginning of the cue notes and "Basso" at the end. The clef is changed to treble at the % beginning of the cue notes and reset to bass at the end


piece-title pieceTitleString



Other functions

FIXME: not yet documented

Table of Contents

This document was generated by Reinhold Kainhofer on June, 4 2008 using texi2html 1.79.