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 'chordInversion boolean? " Determines whether LilyPond should look for chord inversions when
 104     translating from notes to chord names.  Set to 1 to find
 105     inversions.  The default is 0 which does not look for
 106     inversions.")
 107 (translator-property-description 'clefGlyph string? "Name of the symbol within the music font")
 108 (translator-property-description 'clefOctavation integer? "Add
 109 this much extra octavation. Values of 7 and -7 are common.")
 110 (translator-property-description 'clefPitches list? "an alist mapping GLYPHNAME to the position of the central C for that symbol")
 111 (translator-property-description 'clefPosition number? "Where should the center of the symbol go?")
 112 (translator-property-description 'combineParts boolean? "try to combine parts?")
 113 (translator-property-description 'connectArpeggios boolean? " If
 114 set, connect all arpeggios that are found.  In this way, you can make
 115 arpeggios that cross staffs.
 116 ")
 117 (translator-property-description 'createKeyOnClefChange boolean? "Print a key signature whenever the clef is changed.")
 118 (translator-property-description 'currentBarNumber integer? "Contains the current barnumber. This property is incremented at
 119 every barline.
 120 ")
 121 (translator-property-description 'currentCommandColumn ly-grob? "Grob that is X-parent to all current breakable (clef, key signature, etc.) items.")
 122 (translator-property-description 'currentMusicalColumn ly-grob? "Grob that is X-parent to all non-breakable items (note heads, lyrics, etc.).")
 123 (translator-property-description 'defaultBarType string? "Sets the default type of bar line.  Available bar types: [FIXME]
 124 ")
 125 (translator-property-description 'drarnChords boolean? "")
 126 (translator-property-description 'explicitClefVisibility procedure? "visibility-lambda function for clef changes.")
 127 (translator-property-description 'explicitKeySignatureVisibility procedure? "visibility-lambda function for explicit Key changes.")
 128 (translator-property-description 'forceClef boolean? "Show clef symbol, even if it hasn't changed.")
 129 (translator-property-description 'forgetAccidentals boolean? "do
 130 not set localKeySignature when a note alterated differently from
 131 localKeySignature is found.
 132
 133 Causes accidentals to be printed at every note instead of
 134 remembered for the duration of a measure.
 135 ")
 136 (translator-property-description 'graceAccidentalSpace number? "amount space to alot for an accidental")
 137 (translator-property-description 'graceAlignPosition dir? "put the grace note before or after the main note?")
 138 (translator-property-description 'instr markup? "see @code{instrument}")
 139 (translator-property-description 'instrument markup? " If @code{Instrument_name_engraver}
 140 @cindex Instrument_name_engraver
 141  is
 142     added to the Staff translator, then the @code{instrument} property
 143     is used to label the first line of the staff and the @code{instr}
 144     property is used to label subsequent lines.  If the
 145     @code{midiInstrument} property is not set, then @code{instrument}
 146     is used to determine the instrument for MIDI output.")
 147 (translator-property-description 'keyAccidentalOrder list? "
 148 Alist that defines in what order  alterations should be printed.
 149 The format is (NAME . ALTER), where NAME is from 0 .. 6 and ALTER from  -1, 1.
 150 ")
 151 (translator-property-description 'keyOctaviation boolean? "")
 152 (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 ")
 153
 154 (translator-property-description 'localKeySignature list? "the key
 155 signature at this point in the measure.  The format is an alist with
 156 entries of the form (NAME . ALTER)
 157 or ((OCTAVE . NAME)  . ALTER),
 158 where NAME is from 0.. 6 and ALTER from -2,-1,0,1,2"
 159 )
 160
 161 (translator-property-description 'measureLength moment? "Length of one
 162 measure in the current time signature last?")
 163 (translator-property-description 'measurePosition moment? " How much
 164 of the current measure (measured in whole notes) have we had.  This
 165 can be set manually to create incomplete measures (anacrusis, upbeat),
 166 the start of the music.
 167 ")
 168 (translator-property-description 'melismaBusy boolean? "Signifies
 169 whether a melisma is active. This can be used to signal melismas on
 170 top of those automatically detected. ")
 171 (translator-property-description 'melismaEngraverBusy boolean? "See @ref{(lilypond)melismaBusy}. This is set automatically.")
 172 (translator-property-description 'midiInstrument string? "Name of the
 173 MIDI instrument to use ")
 174 (translator-property-description 'noAutoBeaming boolean? "If set to true then beams are not generated automatically.
 175 ")
 176 (translator-property-description 'noResetKey boolean? "Do not
 177 reset local key to the value of keySignature at the start of a measure,
 178 as determined by measurePosition.
 179
 180 Do not reset the key at the start of a measure.  Accidentals will be
 181 printed only once and are in effect until overridden, possibly many
 182 measures later.
 183 ")
 184 (translator-property-description 'oneBeat moment? "  How long does one beat in the current time signature last?")
 185 (translator-property-description 'pedalSustainStrings list? "List of   string to print for sustain-pedal. Format is
 186  (UP UPDOWN DOWN), where each of the three is the string to print when
 187 this is done with the pedal.")
 188 (translator-property-description 'pedalUnaChordaStrings string? "see pedalSustainStrings.")
 189 (translator-property-description 'pedalSostenutoStrings string? "see pedalSustainStrings.")
 190
 191 (translator-property-description 'phrasingPunctuation string? "")
 192 (translator-property-description 'rehearsalMark number-or-string? "")
 193 (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")
 194 (translator-property-description 'repeatCommands list? "")
 195 (translator-property-description 'scriptDefinitions list? "
 196 Description of scripts. This is used by Script_engraver for typesetting note-super/subscripts. See @file{scm/script.scm} for more information
 197 ")
 198
 199 (translator-property-description 'scriptHorizontal boolean? "  Put
 200 scripts left or right of note heads.  Support for this is limited.
 201 Accidentals will collide with scripts.
 202 ")
 203 (translator-property-description 'scriptHorizontal boolean? "  Put
 204 scripts left or right of note heads.  Support for this is limited.
 205 Accidentals will collide with scripts.
 206 ")
 207
 208 (translator-property-description 'skipBars boolean? " Set to true to
 209 skip the empty bars that are produced by multimeasure notes and rests.
 210 These bars will not appear on the printed output.  If not set (the
 211 default) multimeasure notes and rests expand into their full length,
 212 printing the appropriate number of empty bars so that synchronization
 213 with other voices is preserved.
 214
 215
 216 @example
 217 @@lilypond[fragment,verbatim,center]
 218 r1 r1*3 R1*3  \\\\property Score.skipBars= ##t r1*3 R1*3
 219
 220 @@end lilypond
 221 @end example
 222
 223 ")
 224 (translator-property-description 'slurBeginAttachment symbol?
 225 "translates to the car of grob-property 'attachment of NoteColumn. See
 226 @ref{Grob Slur}.")
 227
 228 (translator-property-description 'slurEndAttachment symbol? "translates to the cdr of grob-property 'attachment of NoteColumn. See @ref{Grob Slur}.")
 229 (translator-property-description 'slurMelismaBusy boolean? "Signal a slur if automaticMelismata is set")
 230 (translator-property-description 'solo boolean? "set if solo is detected by the part combiner")
 231 (translator-property-description 'soloADue boolean? "set Solo/A due texts in the part combiner?")
 232 (translator-property-description 'soloIIText string? "text for begin of solo for voice ``two'' when part-combining")
 233 (translator-property-description 'soloText string? "text for begin of solo when part-combining")
 234 (translator-property-description 'sparseTies boolean? "only create one tie per chord.")
 235 (translator-property-description 'split-interval number-pair? "always split into two voices for contained intervals when part-combining")
 236 (translator-property-description 'squashedPosition integer? " Vertical position of
 237 squashing for Pitch_squash_engraver.")
 238 (translator-property-description 'staffsFound list? "list of all staff-symbols found.")
 239 (translator-property-description 'stanza string? "Stanza `number' to print at start of a verse. Use in LyricsVoice context.")
 240
 241
 242 (translator-property-description 'stemLeftBeamCount integer? "
 243 Specify the number of beams to draw on the left side of the next note.
 244 Overrides automatic beaming.  The value is only used once, and then it
 245 is erased.
 246 ")
 247 (translator-property-description 'stemRightBeamCount integer? "idem, for the right side")
 248 (translator-property-description 'stz string? "Abbreviated form for a stanza, see also Stanza property.")
 249 (translator-property-description 'textNonEmpty boolean? " If set
 250 to true then text placed above or below the staff is not assumed to
 251 have zero width.  @code{\fatText} and @code{\emptyText} are predefined
 252 settings.
 253 ")
 254 (translator-property-description 'tieMelismaBusy boolean? "Signal ties when automaticMelismata is set")
 255 (translator-property-description 'timeSignatureFraction number-pair? "
 256 pair of numbers,  signifying the time signature. For example #'(4 . 4) is a 4/4time signature.")
 257 (translator-property-description 'timing boolean? " Keep administration of measure length, position, bar number, etc?
 258 Switch off for cadenzas.")
 259 (translator-property-description 'tremoloFlags integer? "Number of tremolo flags to add if none is specified.")
 260 (translator-property-description 'tupletInvisible boolean? "
 261     If set to true, tuplet bracket creation is switched off
 262 entirely. This has the same effect as setting both
 263 @code{tupletNumberVisibility} and @code{tupletBracketVisibility} to
 264 @code{#f}, but as this does not even create any grobs, this setting
 265 uses less memory and time.")
 266 (translator-property-description 'tupletSpannerDuration moment? "
 267 Normally a tuplet bracket is as wide as the
 268 @code{  imes} expression that gave rise to it. By setting this
 269 property, you can make brackets last shorter. Example
 270
 271 @example
 272 @@lilypond[verbatim,fragment]
 273 context Voice   imes 2/3 @{
 274   property Voice.tupletSpannerDuration = #(make-moment 1 4)
 275   [c8 c c] [c c c]
 276 @}
 277 @@end lilypond
 278 @end example
 279 ")
 280 (translator-property-description 'unirhythm boolean? "set if unirhythm is detected by the part combiner.")
 281 (translator-property-description 'unisilence boolean? "set if unisilence is detected by the part combiner.")
 282 (translator-property-description 'unison boolean? "set if unisono is detected  by the part combiner. ")
 283 (translator-property-description 'verticalAlignmentChildCallback
 284 procedure? "what callback to add to children of a vertical alignment.
 285 It determines what alignment procedure is used on the alignment
 286 itself.  ")
 287 (translator-property-description 'voltaSpannerDuration moment? "maximum duration of the volta bracket.
 288
 289     Set to a duration to control the size of the brackets printed by
 290 @code{\\alternative}.  It specifies the number of whole notes duration
 291 to use for the brackets.  This can be used to shrink the length of
 292 brackets in the situation where one alternative is very large.  It may
 293 have odd effects if the specified duration is longer than the music
 294 given in an @code{\\alternative}.
 295 ")
 296 (translator-property-description 'weAreGraceContext boolean? "")
 297 (translator-property-description 'whichBar string?
 298                                  "This property is read to determine what type of barline to create.
 299
 300 Example:
 301 @example
 302 \\property Staff.whichBar = \"|:\"
 303 @end example
 304
 305 This will create a start-repeat bar in this staff only.
 306
 307 If not set explicitly (by property or @code{\bar}), this is set
 308 according to values of @code{defaultBarType}, @code{barAlways},
 309 @code{barNonAuto} and @code{measurePosition}.
 310
 311 Legal values are described in @ref{(lilypond-internals)bar-line-interface}.
 312
 313 ")
 314