scm/translator-property-description.scm

   1
   2 (define all-translation-properties '())
   3
   4 (define (translator-property-description symbol type? description)
   5   (set-object-property! symbol 'translation-type? type?)
   6   (set-object-property! symbol 'translation-doc description)
   7   (set! all-translation-properties (cons symbol all-translation-properties))
   8   )
   9
  10
  11
  12 (translator-property-description 'CONTEXTNAMEMinimumVerticalExtent number-pair? "minimum vertical extent, same format as CONTEXTNAMEVerticalExtent [fixme, naming]")
  13 (translator-property-description 'CONTEXTNAMEVerticalExtent number-pair? "hard coded vertical extent.
  14 The format is a pair of dimensions, for example, this sets the sizes
  15 of a staff to 10 (5+5) staffspaces high.
  16
  17 @example
  18 property Staff.StaffVerticalExtent = #(-5.0 . 5.0)
  19 @end example
  20
  21  [fixme, naming]")
  22 (translator-property-description 'CONTEXTNAMExtraVerticalExtent number-pair? "extra vertical extent, same format
  23 CONTEXTNAMEMinimumVerticalExtent [fixme, naming]")
  24 (translator-property-description 'Generic_property_list list? "description of the conversion.
  25
  26 Defines names and types for generic properties. These are properties
  27 than can be plugged into the backend directly. See the init file
  28 @file{generic-property.scm} for details.  For internal use only,
  29 deprecated.
  30 ")
  31 (translator-property-description 'aDueText string? "text for begin of a due")
  32 (translator-property-description 'associatedVoice string? "Name of the Voice that has the melody for this LyricsVoice.")
  33 (translator-property-description 'autoBeamSettings list? "
  34 Specifies when automatically generated beams should begin and end.  The elements have the format:
  35
  36 @example
  37
  38    function shortest-duration-in-beam time-signature
  39
  40 where
  41
  42     function = begin or end
  43     shortest-duration-in-beam = numerator denominator; eg: 1 16
  44     time-signature = numerator denominator, eg: 4 4
  45
  46 unspecified or wildcard entries for duration or time-signature
  47 are given by * *
  48
  49 The user can override beam begin or end time by pushing a wildcard entries
  50 '(begin * * * *) or '(end * * * *) resp., eg:
  51
  52     property Voice.autoBeamSettings push #'(end * * * *) = #(make-moment 1 4)
  53
  54 The head of the list:
  55     '(
  56 ((end * * 3 2) . ,(make-moment 1 2))
  57 ((end 1 16 3 2) . ,(make-moment 1 4))
  58 ((end 1 32 3 2) . ,(make-moment 1 8))
  59      ...
  60     )
  61
  62 @end example")
  63
  64 (translator-property-description 'automaticPhrasing boolean? " If set,
  65 the @ref{Lyric_phrasing_engraver} will match note heads of context
  66 called Voice X to syllables from LyricsVoice called
  67 X-<something>. This feature is turned on by default. See the example
  68 file @file{lyrics-multi-stanza.ly}.
  69
  70 ")
  71 (translator-property-description 'automaticMelismata boolean? " If
  72 set, \addlyrics will assume that beams, slurs and ties signal
  73 melismata, and align lyrics accordingly.
  74 ")
  75
  76 (translator-property-description 'barAlways boolean? " If set to true a bar line is drawn after each note.
  77 ")
  78 (translator-property-description 'barCheckNoSynchronize boolean? "If set, don't reset measurePosition when finding a bbarcheck. This
  79 makes bar-checks for polyphonic music easier.")
  80 (translator-property-description 'barNonAuto boolean? " If set to true then bar lines will not be printed
  81     automatically; they must be explicitly created with @code{bar}
  82     keywords.  Unlike with the @code{cadenza} keyword, measures are
  83     still counted.  Bar generation will resume according to that
  84     count if this property is set to zero.
  85 ")
  86 (translator-property-description 'beamMelismaBusy boolean? "Signal if a beam is set when automaticMelismata is set")
  87 (translator-property-description 'breakAlignOrder list? "Defines the order in which
  88 prefatory matter (clefs, key signatures) appears, eg. this puts the
  89 key signatures after the bar lines:
  90
  91 @example
  92         \\property Score.breakAlignOrder = #'(
  93           Span_bar
  94           Breathing_sign
  95           Clef_item
  96           Staff_bar
  97           Key_item
  98           Time_signature
  99         )
 100 @end example
 101 ")
 102 (translator-property-description 'centralCPosition number? "Place of the central C. Usually determined by looking at clefPosition and clefGlyph.")
 103 (translator-property-description 'chordChanges boolean? "Only show changes in chords scheme?")
 104 (translator-property-description 'clefGlyph string? "Name of the symbol within the music font")
 105 (translator-property-description 'clefOctavation integer? "Add
 106 this much extra octavation. Values of 7 and -7 are common.")
 107 (translator-property-description 'clefPitches list? "an alist mapping GLYPHNAME to the position of the central C for that symbol")
 108 (translator-property-description 'clefPosition number? "Where should the center of the symbol go?")
 109 (translator-property-description 'combineParts boolean? "try to combine parts?")
 110 (translator-property-description 'connectArpeggios boolean? " If
 111 set, connect all arpeggios that are found.  In this way, you can make
 112 arpeggios that cross staffs.
 113 ")
 114 (translator-property-description 'createKeyOnClefChange boolean? "Print a key signature whenever the clef is changed.")
 115 (translator-property-description 'crescendoText string? "Text to print at start of non-hairpin crecscendo, ie: @samp{cresc.}")
 116 (translator-property-description 'crescendoSpanner symbol? "Type of spanner to be used for crescendi.  One of: @samp{hairpin}, @samp{line}, @samp{dashed-line}, @samp{dotted-line}.  If unset, hairpin type is used.")
 117 (translator-property-description 'decrescendoText string? "Text to print at start of non-hairpin decrecscendo, ie: @samp{dim.}")
 118 (translator-property-description 'decrescendoSpanner symbol? "Type of spanner to be used for decrescendi.  One of: @samp{hairpin}, @samp{line}, @samp{dashed-line}, @samp{dotted-line}.  If unset, hairpin type is used.")
 119 (translator-property-description 'currentBarNumber integer? "Contains the current barnumber. This property is incremented at
 120 every barline.
 121 ")
 122 (translator-property-description 'currentCommandColumn ly-grob? "Grob that is X-parent to all current breakable (clef, key signature, etc.) items.")
 123 (translator-property-description 'currentMusicalColumn ly-grob? "Grob that is X-parent to all non-breakable items (note heads, lyrics, etc.).")
 124 (translator-property-description 'defaultBarType string? "Sets the default type of bar line.  Available bar types: [FIXME];
 125
 126 This variable is typically read at Score level, so overriding
 127 Staff.defaultBarType will have no effect.
 128
 129 ")
 130 (translator-property-description 'drarnChords boolean? "")
 131 (translator-property-description 'explicitClefVisibility procedure? "visibility-lambda function for clef changes.")
 132 (translator-property-description 'explicitKeySignatureVisibility procedure? "visibility-lambda function for explicit Key changes.")
 133 (translator-property-description 'followThread boolean?
 134                                  "if set, note heads are tracked  across staff switches by a thin line")
 135 (translator-property-description 'forceClef boolean? "Show clef symbol, even if it hasn't changed.")
 136 (translator-property-description 'forgetAccidentals boolean? "do
 137 not set localKeySignature when a note alterated differently from
 138 localKeySignature is found.
 139
 140 Causes accidentals to be printed at every note instead of
 141 remembered for the duration of a measure.
 142 ")
 143 (translator-property-description 'graceAccidentalSpace number? "amount space to alot for an accidental")
 144 (translator-property-description 'graceAlignPosition dir? "put the grace note before or after the main note?")
 145 (translator-property-description 'instr markup? "see @code{instrument}")
 146 (translator-property-description 'instrument markup? " If @code{Instrument_name_engraver}
 147 @cindex Instrument_name_engraver
 148  is
 149     added to the Staff translator, then the @code{instrument} property
 150     is used to label the first line of the staff and the @code{instr}
 151     property is used to label subsequent lines.  If the
 152     @code{midiInstrument} property is not set, then @code{instrument}
 153     is used to determine the instrument for MIDI output.")
 154 (translator-property-description 'keyAccidentalOrder list? "
 155 Alist that defines in what order  alterations should be printed.
 156 The format is (NAME . ALTER), where NAME is from 0 .. 6 and ALTER from  -1, 1.
 157 ")
 158 (translator-property-description 'keyOctaviation boolean? "")
 159 (translator-property-description 'keySignature list? "The current key signature. This is an alist containing (NAME . ALTER) pairs, where NAME is from 0.. 6 and ALTER from -2,-1,0,1,2 ")
 160
 161 (translator-property-description 'localKeySignature list? "the key
 162 signature at this point in the measure.  The format is an alist with
 163 entries of the form (NAME . ALTER)
 164 or ((OCTAVE . NAME)  . ALTER),
 165 where NAME is from 0.. 6 and ALTER from -2,-1,0,1,2"
 166 )
 167
 168 (translator-property-description 'measureLength moment? "Length of one
 169 measure in the current time signature last?")
 170 (translator-property-description 'measurePosition moment? " How much
 171 of the current measure (measured in whole notes) have we had.  This
 172 can be set manually to create incomplete measures (anacrusis, upbeat),
 173 the start of the music.
 174 ")
 175 (translator-property-description 'melismaBusy boolean? "Signifies
 176 whether a melisma is active. This can be used to signal melismas on
 177 top of those automatically detected. ")
 178 (translator-property-description 'melismaEngraverBusy boolean? "See @ref{(lilypond)melismaBusy}. This is set automatically.")
 179 (translator-property-description 'midiInstrument string? "Name of the
 180 MIDI instrument to use ")
 181 (translator-property-description 'noAutoBeaming boolean? "If set to true then beams are not generated automatically.
 182 ")
 183 (translator-property-description 'noResetKey boolean? "Do not
 184 reset local key to the value of keySignature at the start of a measure,
 185 as determined by measurePosition.
 186
 187 Do not reset the key at the start of a measure.  Accidentals will be
 188 printed only once and are in effect until overridden, possibly many
 189 measures later.
 190 ")
 191 (translator-property-description 'oneBeat moment? "  How long does one beat in the current time signature last?")
 192 (translator-property-description 'pedalSustainStrings list? "List of   string to print for sustain-pedal. Format is
 193  (UP UPDOWN DOWN), where each of the three is the string to print when
 194 this is done with the pedal.")
 195 (translator-property-description 'pedalUnaChordaStrings string? "see pedalSustainStrings.")
 196 (translator-property-description 'pedalSostenutoStrings string? "see pedalSustainStrings.")
 197
 198 (translator-property-description 'phrasingPunctuation string? "")
 199 (translator-property-description 'rehearsalMark number-or-string? "")
 200 (translator-property-description 'repeatCommands list? "This property is read to find any command of the form (volta . X), where X is a string or #f")
 201 (translator-property-description 'repeatCommands list? "")
 202 (translator-property-description 'scriptDefinitions list? "
 203 Description of scripts. This is used by Script_engraver for typesetting note-super/subscripts. See @file{scm/script.scm} for more information
 204 ")
 205
 206 (translator-property-description 'scriptHorizontal boolean? "  Put
 207 scripts left or right of note heads.  Support for this is limited.
 208 Accidentals will collide with scripts.
 209 ")
 210 (translator-property-description 'scriptHorizontal boolean? "  Put
 211 scripts left or right of note heads.  Support for this is limited.
 212 Accidentals will collide with scripts.
 213 ")
 214
 215 (translator-property-description 'skipBars boolean? " Set to true to
 216 skip the empty bars that are produced by multimeasure notes and rests.
 217 These bars will not appear on the printed output.  If not set (the
 218 default) multimeasure notes and rests expand into their full length,
 219 printing the appropriate number of empty bars so that synchronization
 220 with other voices is preserved.
 221
 222
 223 @example
 224 @@lilypond[fragment,verbatim,center]
 225 r1 r1*3 R1*3  \\\\property Score.skipBars= ##t r1*3 R1*3
 226
 227 @@end lilypond
 228 @end example
 229
 230 ")
 231 (translator-property-description 'slurBeginAttachment symbol?
 232 "translates to the car of grob-property 'attachment of NoteColumn. See
 233 @ref{Slur}.")
 234
 235 (translator-property-description 'slurEndAttachment symbol? "translates to the cdr of grob-property 'attachment of NoteColumn. See @ref{Slur}.")
 236 (translator-property-description 'slurMelismaBusy boolean? "Signal a slur if automaticMelismata is set.")
 237 (translator-property-description 'solo boolean? "set if solo is detected by the part combiner.")
 238 (translator-property-description 'soloADue boolean? "set Solo/A due texts in the part combiner?.")
 239 (translator-property-description 'soloIIText string? "text for begin of solo for voice ``two'' when part-combining.")
 240 (translator-property-description 'soloText string? "text for begin of solo when part-combining.")
 241 (translator-property-description 'sparseTies boolean? "only create one tie per chord.")
 242 (translator-property-description 'split-interval number-pair? "always split into two voices for contained intervals when part-combining.")
 243 (translator-property-description 'squashedPosition integer? " Vertical position of
 244 squashing for Pitch_squash_engraver.")
 245 (translator-property-description 'staffsFound list? "list of all staff-symbols found.")
 246 (translator-property-description 'stanza string? "Stanza `number' to print at start of a verse. Use in LyricsVoice context.")
 247
 248
 249 (translator-property-description 'stemLeftBeamCount integer? "
 250 Specify the number of beams to draw on the left side of the next note.
 251 Overrides automatic beaming.  The value is only used once, and then it
 252 is erased.
 253 .")
 254 (translator-property-description 'stemRightBeamCount integer? "idem, for the right side.")
 255 (translator-property-description 'stz string? "Abbreviated form for a stanza, see also Stanza property.")
 256 (translator-property-description 'textNonEmpty boolean? " If set
 257 to true then text placed above or below the staff is not assumed to
 258 have zero width.  @code{\fatText} and @code{\emptyText} are predefined
 259 settings.
 260 .")
 261 (translator-property-description 'tieMelismaBusy boolean? "Signal ties when automaticMelismata is set.")
 262 (translator-property-description 'timeSignatureFraction number-pair? "
 263 pair of numbers,  signifying the time signature. For example #'(4 . 4) is a 4/4time signature.")
 264 (translator-property-description 'timing boolean? " Keep administration of measure length, position, bar number, etc?
 265 Switch off for cadenzas.")
 266 (translator-property-description 'transposing integer? "Transpose the MIDI output.  Set this property to the number of half-steps to transpose by.")
 267 (translator-property-description 'tremoloFlags integer? "Number of tremolo flags to add if none is specified.")
 268 (translator-property-description 'tupletInvisible boolean? "
 269     If set to true, tuplet bracket creation is switched off
 270 entirely. This has the same effect as setting both
 271 @code{tupletNumberVisibility} and @code{tupletBracketVisibility} to
 272 @code{#f}, but as this does not even create any grobs, this setting
 273 uses less memory and time.")
 274 (translator-property-description 'tupletSpannerDuration moment? "
 275 Normally a tuplet bracket is as wide as the
 276 @code{  imes} expression that gave rise to it. By setting this
 277 property, you can make brackets last shorter. Example
 278
 279 @example
 280 @@lilypond[verbatim,fragment]
 281 context Voice   imes 2/3 @{
 282   property Voice.tupletSpannerDuration = #(make-moment 1 4)
 283   [c8 c c] [c c c]
 284 @}
 285 @@end lilypond
 286 @end example
 287 .")
 288 (translator-property-description 'unirhythm boolean? "set if unirhythm is detected by the part combiner.")
 289 (translator-property-description 'unisilence boolean? "set if unisilence is detected by the part combiner.")
 290 (translator-property-description 'unison boolean? "set if unisono is detected  by the part combiner. .")
 291 (translator-property-description 'verticalAlignmentChildCallback
 292 procedure? "what callback to add to children of a vertical alignment.
 293 It determines what alignment procedure is used on the alignment
 294 itself.  .")
 295 (translator-property-description 'voltaSpannerDuration moment? "maximum duration of the volta bracket.
 296
 297     Set to a duration to control the size of the brackets printed by
 298 @code{\\alternative}.  It specifies the number of whole notes duration
 299 to use for the brackets.  This can be used to shrink the length of
 300 brackets in the situation where one alternative is very large.  It may
 301 have odd effects if the specified duration is longer than the music
 302 given in an @code{\\alternative}.
 303 .")
 304 (translator-property-description 'weAreGraceContext boolean? ".")
 305 (translator-property-description 'whichBar string?
 306                                  "This property is read to determine what type of barline to create.
 307
 308 Example:
 309 @example
 310 \\property Staff.whichBar = \"|:\"
 311 @end example
 312
 313 This will create a start-repeat bar in this staff only.
 314
 315 If not set explicitly (by property or @code{\bar}), this is set
 316 according to values of @code{defaultBarType}, @code{barAlways},
 317 @code{barNonAuto} and @code{measurePosition}.
 318
 319 Legal values are described in @ref{(lilypond-internals)bar-line-interface}.
 320
 321 .")
 322