]> git.donarmstrong.com Git - lilypond.git/blobdiff - scm/translator-property-description.scm
* Documentation/user/lilypond-book.itely: small cleanups
[lilypond.git] / scm / translator-property-description.scm
index 8cfeb298ca60a868a8a92f483fc60d64545e7913..33b6448e41a320a67857339319409e587cc76cba 100644 (file)
 
 
 
-(translator-property-description 'ExtraVerticalExtent
+(translator-property-description 'extraVerticalExtent
                                 number-pair? "extra vertical extent, same format as  MinimumVerticalExtent")
-(translator-property-description 'Generic_property_list list? "description of the conversion.
-
-Defines names and types for generic properties. These are properties
-than can be plugged into the backend directly. See the init file
-@file{generic-property.scm} for details.  For internal use only,
-deprecated.
-")
-(translator-property-description 'MinimumVerticalExtent number-pair?
+(translator-property-description 'minimumVerticalExtent number-pair?
                                 "minimum vertical extent, same format as VerticalExtent")
-(translator-property-description 'VerticalExtent number-pair?
+(translator-property-description 'verticalExtent number-pair?
                                 "hard coded vertical extent.
 The format is a pair of dimensions, for example, this sets the sizes
 of a staff to 10 (5+5) staffspaces high.
 
 @example
-property Staff.VerticalExtent = #(-5.0 . 5.0)
+property Staff.verticalExtent = #(-5.0 . 5.0)
 @end example
 
 VerticalExtent, MinimumVerticalExtent and ExtraVerticalExtent are
@@ -85,18 +78,23 @@ The head of the list:
 (translator-property-description 'autoAccidentals list? "List of
 different ways to typeset an accidental. All algorithms in the list
 are tried, and the one returning the most accidentals is used.
-Each algorithm-description is a name-value pair.
+Each entry is either a symbol containg a context name or a name-value
+pair containing an algorithm-description.
+The list must begin with a symbol (context name).
+The symbols denote in which context THE FOLLOWING algorithms (until next symbol) 
+will be interpreted. All notes in the interpretation context will share accidentals.
+The contexts must be stated in order, innermost first.
 The algorithms are:
 @table @samp
-@item measure-same-octave:
+@item same-octave:
 This is the default algorithm. Accidentals are typeset if the note changes
 the accidental of that note in that octave. Accidentals lasts to the end of the measure 
 and then as many measures as specified in the value. I.e. 1 means to the end
-of next measure, -1 means to the end of previous measure (that is: no duration at all), etc.
-@item measure-any-octave:
+of next measure, -1 means to the end of previous measure (that is: no duration at all), etc. #t means forever.
+@item any-octave:
 Accidentals are typeset if the note is different from 
 the previous note on the same pitch in any octave. The value has same meaning as in
-measure-same-octave.
+same-octave.
 @end table
 ")
 
@@ -120,8 +118,9 @@ melismata, and align lyrics accordingly.
 
 (translator-property-description 'barAlways boolean? " If set to true a bar line is drawn after each note.
 ")
-(translator-property-description 'barCheckNoSynchronize boolean? "If set, don't reset measurePosition when finding a bbarcheck. This
-makes bar-checks for polyphonic music easier.")
+(translator-property-description 'barCheckSynchronize boolean? "If
+true then reset measurePosition when finding a barcheck. Turn off when
+using barchecks in polyphonic music.")
 (translator-property-description 'barNonAuto boolean? " If set to true then bar lines will not be printed
     automatically; they must be explicitly created with @code{bar}
     keywords.  Unlike with the @code{cadenza} keyword, measures are
@@ -136,18 +135,18 @@ key signatures after the bar lines:
 
 @example
        \\property Score.breakAlignOrder = #'(
-         Span_bar
-         Breathing_sign
-         Clef_item
-         Staff_bar
-         Key_item
-         Time_signature
+         span-bar
+         breathing-sign
+         clef
+         staff-bar
+         key
+         time-signature
        )
 @end example
 ")
 (translator-property-description 'busyGrobs list? "
 a queue of (END-MOMENT . GROB) conses. This is for internal (C++) use only.
-Use at your own risk. 
+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 'changeMoment moment-pair? "duration that voices are examined for differences, when part-combining.  Usually unset or zero when combining threads into one voice, and 1 (or the duration of one measure) when combining voices into one staff.")
@@ -207,7 +206,7 @@ Do nothing.
 
 (translator-property-description 'explicitKeySignatureVisibility
 procedure? "visibility-lambda function for explicit Key changes;
-\override of #'visibility-lambda will set the visibility for normal
+\override of #'break-visibility will set the visibility for normal
 (ie. at the start of the line) key signatures.")
 
 (translator-property-description 'extraNatural boolean? "Whether to typeset an
@@ -249,7 +248,8 @@ signature before a key signature change.")
 (translator-property-description 'localKeySignature list? "the key
 signature at this point in the measure.  The format is the same as for keySignature. Is reset at every bar line."
 ) 
-
+(translator-property-description 'localKeySignatureChanges list? "Experimental.
+ [DOCME]")
 (translator-property-description 'measureLength moment? "Length of one
 measure in the current time signature last?")
 (translator-property-description 'measurePosition moment? " How much
@@ -265,12 +265,14 @@ top of those automatically detected. ")
 MIDI instrument to use ")
 (translator-property-description 'midiMinimumVolume number? "[DOCUMENT-ME]")
 (translator-property-description 'midiMaximumVolume number? "[DOCUMENT-ME]")
-
-
-(translator-property-description 'noAutoBeaming boolean? "If set to true then beams are not generated automatically.
-")
+(translator-property-description 'minimumFret number? "The tablature
+auto string-selecting mechanism selects the highest string with a fret
+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 '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
 this is done with the pedal.")
@@ -310,12 +312,6 @@ r1 r1*3 R1*3  \\\\property Score.skipBars= ##t r1*3 R1*3
                                 "When true, all no typesetting is done at
 this moment, causing  the interpretation phase to go a lot faster. This can
 help with debugging large scores.")
-
-(translator-property-description 'slurBeginAttachment symbol?
-"translates to the car of grob-property 'attachment of NoteColumn. See
-@ref{Slur}.")
-
-(translator-property-description 'slurEndAttachment symbol? "translates to the cdr of grob-property 'attachment of NoteColumn. See @ref{Slur}.")
 (translator-property-description 'slurMelismaBusy boolean? "Signal a slur if automaticMelismata is set.")
 (translator-property-description 'solo boolean? "set if solo is detected by the part combiner.")
 (translator-property-description 'soloADue boolean? "set Solo/A due texts in the part combiner?.")
@@ -336,10 +332,15 @@ Overrides automatic beaming.  The value is only used once, and then it
 is erased.
 .")
 (translator-property-description 'stemRightBeamCount integer? "idem, for the right side.")
+
 (translator-property-description 'stz markup? "Abbreviated form for a stanza, see also Stanza property.")
 (translator-property-description 'subdivideBeams boolean? "If set, multiple beams will be subdivided at beat
 positions - by only drawing one beam over the beat.")
 (translator-property-description 'systemStartDelimiter symbol? "Which grob to make for the start of the system/staff?")
+(translator-property-description 'tablatureFormat procedure?
+                                "Function formatting a tab notehead; it takes
+a string number, a list of string tunings and Pitch object. It returns the text as a string.")
+
 (translator-property-description 'textNonEmpty boolean? " If set
 to true then text placed above or below the staff is not assumed to
 have zero width.  @code{\fatText} and @code{\emptyText} are predefined
@@ -409,4 +410,5 @@ according to values of @code{defaultBarType}, @code{barAlways},
 Valid values are described in @ref{(lilypond-internals)bar-line-interface}.
 
 .")
+(translator-property-description 'stringTunings list? "The tablature strings tuning. Must be a list of the different semitons pitch of each string (starting by the lower one).")