]> git.donarmstrong.com Git - lilypond.git/blobdiff - scm/translator-property-description.scm
* input/regression/finger-chords.ly (texidoc): new file.
[lilypond.git] / scm / translator-property-description.scm
index 9d55aa3ce779628b98c41ff3f78086c2dae567dc..3d9982067c027d32309b72142e62e61230e159dd 100644 (file)
@@ -4,7 +4,7 @@
 (define (translator-property-description symbol type? description)
  (if (not (equal? #f (object-property symbol 'translation-doc)))
       (begin
-       (ly-warn (string-append "Redefining " (symbol->string symbol) "\n"))
+       (ly:warn (string-append "Redefining " (symbol->string symbol) "\n"))
        (exit 2)
       ))
   
@@ -65,13 +65,13 @@ are given by * *
 The user can override beam begin or end time by pushing a wildcard entries
 '(begin * * * *) or '(end * * * *) resp., eg:
 
-    property Voice.autoBeamSettings push #'(end * * * *) = #(make-moment 1 4)
+    property Voice.autoBeamSettings push #'(end * * * *) = #(ly:make-moment 1 4)
 
 The head of the list:
     '(
-((end * * 3 2) . ,(make-moment 1 2))
-((end 1 16 3 2) . ,(make-moment 1 4))
-((end 1 32 3 2) . ,(make-moment 1 8))
+((end * * 3 2) . ,(ly:make-moment 1 2))
+((end 1 16 3 2) . ,(ly:make-moment 1 4))
+((end 1 32 3 2) . ,(ly:make-moment 1 8))
      ...
     )
 
@@ -114,7 +114,7 @@ file @file{lyrics-multi-stanza.ly}.
 ")
 
 (translator-property-description 'automaticMelismata boolean? " If
-set, \addlyrics will assume that beams, slurs and ties signal
+set, \\addlyrics will assume that beams, slurs and ties signal
 melismata, and align lyrics accordingly.
 ")
 
@@ -131,7 +131,7 @@ using barchecks in polyphonic music.")
 ")
 (translator-property-description 'barNumberVisibility procedure? "Procedure that takes an int and returns whether the corresponding bar number should be printed")
 (translator-property-description 'beamMelismaBusy boolean? "Signal if a beam is set when automaticMelismata is set")
-(translator-property-description 'beatLength moment? "The length of one beat in this time signature.")
+(translator-property-description 'beatLength ly:moment? "The length of one beat in this time signature.")
 (translator-property-description 'breakAlignOrder list? "Defines the order in which
 prefatory matter (clefs, key signatures) appears, eg. this puts the
 key signatures after the bar lines:
@@ -151,7 +151,11 @@ key signatures after the bar lines:
 a queue of (END-MOMENT . GROB) conses. This is for internal (C++) use only.
 Use at your own risk.  This property contains the grobs for which  END-MOMENT >= NOW.
 ")
-(translator-property-description 'centralCPosition number? "Place of the central C. Usually determined by looking at clefPosition and clefGlyph.")
+
+(translator-property-description 'centralCPosition number? "Place of
+the central C, measured in half staffspaces.  Usually determined by
+looking at clefPosition and clefGlyph.")
+
 (translator-property-description
  'changeMoment moment-pair?
  "duration that voices are examined for differences, when
@@ -163,7 +167,13 @@ into one staff.")
 (translator-property-description 'clefGlyph string? "Name of the symbol within the music font")
 (translator-property-description 'clefOctavation integer? "Add
 this much extra octavation. Values of 7 and -7 are common.")
-(translator-property-description 'clefPosition number? "Where should the center of the symbol go?")
+
+(translator-property-description 'clefPosition number? "Where should
+the center of the clef symbol go?  On systems with an odd number of
+stafflines, the value 0 puts the clef on the middle staffline; a
+positive value shifts it up, a negative value shifts it down.  The
+unit of this distance is the half staff space.")
+
 (translator-property-description 'combineParts boolean? "try to combine parts?")
 (translator-property-description 'connectArpeggios boolean? " If
 set, connect all arpeggios that are found.  In this way, you can make
@@ -176,8 +186,8 @@ arpeggios that cross staves.
 (translator-property-description 'currentBarNumber integer? "Contains the current barnumber. This property is incremented at
 every barline.
 ")
-(translator-property-description 'currentCommandColumn ly-grob? "Grob that is X-parent to all current breakable (clef, key signature, etc.) items.")
-(translator-property-description 'currentMusicalColumn ly-grob? "Grob that is X-parent to all non-breakable items (note heads, lyrics, etc.).")
+(translator-property-description 'currentCommandColumn ly:grob? "Grob that is X-parent to all current breakable (clef, key signature, etc.) items.")
+(translator-property-description 'currentMusicalColumn ly:grob? "Grob that is X-parent to all non-breakable items (note heads, lyrics, etc.).")
 (translator-property-description 'defaultBarType string? "Sets the default type of bar line.  Available bar types: [FIXME];
 
 This variable is typically read at Score level, so overriding
@@ -188,7 +198,7 @@ Staff.defaultBarType will have no effect.
 @table @samp
 @item (), or unset
 Behave in normal way: remove one set of grobs when in unisolo.
-@item allways:
+@item always:
 Remove any grob that comes along.
 @item never:
 Do nothing.
@@ -198,7 +208,7 @@ Do nothing.
 @table @samp
 @item (), or unset
 Behave in normal way: remove spanners when in unisolo.
-@item allways:
+@item always:
 Remove any spanners that come along.
 @item never:
 Do nothing.
@@ -232,7 +242,7 @@ in a context. This is done using the @code{Font_size_engraver}.")
 
 (translator-property-description 'forceClef boolean? "Show clef symbol, even if it hasn't changed. Only active for the first clef after the property is set, not for the full staff.")
 (translator-property-description 'graceAccidentalSpace number? "amount space to alot for an accidental")
-(translator-property-description 'graceAlignPosition dir? "put the grace note before or after the main note?")
+(translator-property-description 'graceAlignPosition ly:dir? "put the grace note before or after the main note?")
 (translator-property-description 'highStringOne boolean? "Whether the 1st string is the string with
 highest pitch on the instrument (used by the automatic string selector).")
 (translator-property-description 'instr markup? "see @code{instrument}")
@@ -263,9 +273,9 @@ signature at this point in the measure.  The format is the same as for keySignat
 ) 
 (translator-property-description 'localKeySignatureChanges list? "Experimental.
  [DOCME]")
-(translator-property-description 'measureLength moment? "Length of one
+(translator-property-description 'measureLength ly:moment? "Length of one
 measure in the current time signature last?")
-(translator-property-description 'measurePosition moment? " How much
+(translator-property-description 'measurePosition ly:moment? " How much
 of the current measure (measured in whole notes) have we had.  This
 can be set manually to create incomplete measures (anacrusis, upbeat),
 the start of the music.
@@ -273,7 +283,7 @@ the start of the music.
 (translator-property-description 'melismaBusy boolean? "Signifies
 whether a melisma is active. This can be used to signal melismas on
 top of those automatically detected. ")
-(translator-property-description 'melismaEngraverBusy boolean? "See @ref{(lilypond)melismaBusy}. This is set automatically.")
+(translator-property-description 'melismaEngraverBusy boolean? "See melismaBusy. This is set automatically.")
 (translator-property-description 'midiInstrument string? "Name of the
 MIDI instrument to use ")
 (translator-property-description 'midiMinimumVolume number? "[DOCUMENT-ME]")
@@ -284,7 +294,7 @@ not less than minimumFret")
 (translator-property-description 'autoBeaming boolean? "If set to true
 then beams are generated automatically.")
 (translator-property-description 'noDirection boolean? "Don't set directions by a2-engraver when part-combining.")
-(translator-property-description 'oneBeat moment? "  How long does one beat in the current time signature last?")
+(translator-property-description 'oneBeat ly:moment? "  How long does one beat in the current time signature last?")
 (translator-property-description 'othersolo boolean? "FIXME")
 (translator-property-description 'pedalSustainStrings list? "List of   string to print for sustain-pedal. Format is
  (UP UPDOWN DOWN), where each of the three is the string to print when
@@ -294,16 +304,22 @@ this is done with the pedal.")
 
 (translator-property-description 'phrasingPunctuation string? "")
 (translator-property-description 'rehearsalMark number-or-string? "")
-(translator-property-description 'regularSpacingDelta moment? "TODO")
+(translator-property-description 'regularSpacingDelta ly:moment? "TODO")
 (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")
 (translator-property-description 'scriptDefinitions list? "
 Description of scripts. This is used by Script_engraver for typesetting note-super/subscripts. See @file{scm/script.scm} for more information
 ")
 
+(translator-property-description 'restNumberThreshold number?
+                                "If a multimeasure rest takes less
+than this number of measures, no number is printed. ")
+
 (translator-property-description 'scriptHorizontal boolean? "  Put
 scripts left or right of note heads.  Support for this is limited.
 Accidentals will collide with scripts.
 ")
+(translator-property-description 'fingersHorizontal boolean? "Put the middle fingerings to the
+right side of the note head.")
 
 (translator-property-description 'skipBars boolean? " Set to true to
 skip the empty bars that are produced by multimeasure notes and rests.
@@ -377,7 +393,7 @@ entirely. This has the same effect as setting both
 @code{tupletNumberVisibility} and @code{tupletBracketVisibility} to
 @code{#f}, but as this does not even create any grobs, this setting
 uses less memory and time.")
-(translator-property-description 'tupletSpannerDuration moment? "
+(translator-property-description 'tupletSpannerDuration ly:moment? "
 Normally a tuplet bracket is as wide as the
 @code{ imes} expression that gave rise to it. By setting this
 property, you can make brackets last shorter. Example
@@ -385,7 +401,7 @@ property, you can make brackets last shorter. Example
 @example
 @@lilypond[verbatim,fragment]
 context Voice  imes 2/3 @{
-  property Voice.tupletSpannerDuration = #(make-moment 1 4)
+  property Voice.tupletSpannerDuration = #(ly:make-moment 1 4)
   [c8 c c] [c c c]
 @}
 @@end lilypond
@@ -401,7 +417,7 @@ itself.  .")
 (translator-property-description
  'voltaOnThisStaff boolean?
  "Normally, volta brackets are put only on the topmost staff. Setting this variable to true, will force a bracket to be on this staff as well.")
-(translator-property-description 'voltaSpannerDuration moment? "maximum duration of the volta bracket.
+(translator-property-description 'voltaSpannerDuration ly:moment? "maximum duration of the volta bracket.
 
     Set to a duration to control the size of the brackets printed by
 @code{\\alternative}.  It specifies the number of whole notes duration
@@ -410,7 +426,6 @@ brackets in the situation where one alternative is very large.  It may
 have odd effects if the specified duration is longer than the music
 given in an @code{\\alternative}.
 .")
-(translator-property-description 'weAreGraceContext boolean? ".")
 (translator-property-description 'whichBar string?
                                 "This property is read to determine what type of barline to create.