]> git.donarmstrong.com Git - lilypond.git/blobdiff - scm/define-translator-properties.scm
* lily/parser.yy (part_combined_music): remove old PC cruft.
[lilypond.git] / scm / define-translator-properties.scm
index f40bb957edddd3581d4a9480432ead873121b209..617a51fa268c23c335dd639f55c5daf382483d68 100644 (file)
@@ -35,6 +35,7 @@ context. Don't mess with this.")
                                 "If true allow line breaks during beams.")
 (translator-property-description 'associatedVoice string? "Name of the
 Voice that has the melody for this LyricsVoice.")
+(translator-property-description 'associatedVoiceContext ly:context? "The context object of the Voice that has the melody for this LyricsVoice.")
 (translator-property-description 'autoBeamSettings list? "Specifies
 when automatically generated beams should begin and end.  The elements
 have the format:
@@ -108,12 +109,14 @@ wins. In case of draw, a normal accidental is typeset.
 
 (translator-property-description 'barAlways boolean? "If set to true a bar line is drawn after each note.
 ")
+(translator-property-description 'barCheckLastFail ly:moment? "Where in  the measurze did the last barcheck fail?") 
+
 (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 'barNumberVisibility procedure? "Procedure that takes an int and returns whether the corresponding bar number should be printed")
 (translator-property-description 'bassFigureFormatFunction procedure? "DOCME")
-(translator-property-description 'beamMelismaBusy boolean? "Signal if a beam is set when automaticMelismata is set")
+(translator-property-description 'beamMelismaBusy boolean? "Signal if a beam is present.")
 (translator-property-description 'beatLength ly:moment? "The length of one beat in this time signature.")
 (translator-property-description 'beatGrouping list?
                                 "List of beatgroups. Eg. in 5/8 time #(list 2 3).")
@@ -146,13 +149,6 @@ Use at your own risk.  This property contains the grobs for which  END-MOMENT >=
 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
-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.")
-
 (translator-property-description
  'chordNameFunction procedure?
  "The function that converts lists of pitches to chord names.")
@@ -186,7 +182,6 @@ 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
 arpeggios that cross staves.
@@ -206,26 +201,7 @@ This variable is typically read at Score level, so overriding
 Staff.defaultBarType will have no effect.
 
 ")
-(translator-property-description 'devNullThread symbol? "User control of Thread_devnull_engraver: one of
-@table @samp
-@item (), or unset
-Behave in normal way: remove one set of grobs when in unisolo.
-@item always:
-Remove any grob that comes along.
-@item never:
-Do nothing.
-@end table
-")
-(translator-property-description 'devNullVoice symbol? "User control of Voice_devnull_engraver: one of
-@table @samp
-@item (), or unset
-Behave in normal way: remove spanners when in unisolo.
-@item always:
-Remove any spanners that come along.
-@item never:
-Do nothing.
-@end table
-")
+
 (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.")
 
 (translator-property-description 'dynamicAbsoluteVolumeFunction procedure? "
@@ -235,7 +211,7 @@ Do nothing.
 
 (translator-property-description 'explicitKeySignatureVisibility
 procedure? "visibility-lambda function for explicit Key changes;
-\override of #'break-visibility 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
@@ -250,7 +226,7 @@ another non-natural.
 (translator-property-description 'finalizations list? "List of expressions to evaluate before proceeding to next time step. Internal variable.")
 (translator-property-description 'followVoice boolean?
                                 "if set, note heads are tracked  across staff switches by a thin line")
-(translator-property-description 'fontSize integer?
+(translator-property-description 'fontSize number?
                                 "Used to set the relative size of all grobs
 in a context. This is done using the @code{Font_size_engraver}.")
 
@@ -268,6 +244,9 @@ function.")
 (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 'ignoreMelismata boolean?
+                                "Ignore melismata for this @ref{LyricsVoice}.")
 (translator-property-description 'instr markup? "see @code{instrument}")
 (translator-property-description 'instrument markup? " If @code{Instrument_name_engraver}
 @cindex Instrument_name_engraver
@@ -296,8 +275,13 @@ 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 'majorSevenSymbol markup? "How should
 the major7 be formatted in a chord name?")
+(translator-property-description 'markFormatter procedure? "Procedure
+taking as arguments context and rehearsal mark. It should return the
+formatted mark as a markup object.")
+
 (translator-property-description 'measureLength ly:moment? "Length of one
 measure in the current time signature last?")
 (translator-property-description 'measurePosition ly:moment? "How much
@@ -309,8 +293,16 @@ the start of the music.
 whether a melisma is active. This can be used to signal melismas on
 top of those automatically detected. ")
 (translator-property-description 'melismaBusyProperties list?
-                                "List of  properties (symbols) to
-determine whether a melisma  is playing.")
+                                "List of properties (symbols) to
+determine whether a melisma is playing.  Setting this property will
+influence how lyrics are aligned to notes.  For example, if set to
+@code{#'(melismaBusy beamMelismaBusy)}, only manual melismata
+(i.e. setting @code{melismaBusy} to @code{#t}) and manual beams are
+considered. Possible values include @code{melismaBusy},
+@code{slurMelismaBusy}, @code{tieMelismaBusy}, and
+@code{beamMelismaBusy}")
+
+
 (translator-property-description 'metronomeMarkFormatter procedure?
                                 "How to produce a metronome markup.
 Called with 2 arguments,  event and context.")
@@ -329,7 +321,6 @@ this function is called with current context and a list of music
 objects.  The list of contains entries with start times, music objects
 and whether they're processed in this context.")
 
-(translator-property-description 'noDirection boolean? "Don't set directions by a2-engraver when part-combining.")
 (translator-property-description
  'originalCentralCPosition integer?
  "Used for temporary overriding central C in octavation brackets. ")
@@ -347,7 +338,7 @@ that indicates how to print sustain pedals: text, bracket or mixed
 (translator-property-description 'pedalUnaCordaStyle symbol? "see pedalSustainStyle.")
 (translator-property-description 'pedalSostenutoStyle symbol? "see pedalSustainStyle.")
 
-(translator-property-description 'rehearsalMark number-or-string? "The
+(translator-property-description 'rehearsalMark integer? "The
 last rehearsal mark printed.")
 (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? "
@@ -358,10 +349,6 @@ Description of scripts. This is used by Script_engraver for typesetting note-sup
                                 "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 'skipBars boolean? "If set to true, then
 skip the empty bars that are produced by multimeasure notes and rests.
 These bars will not appear on the printed output.  If not set (the
@@ -382,14 +369,12 @@ 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 'slurMelismaBusy boolean? "Signal a slur if automaticMelismata is set.")
+(translator-property-description 'slurMelismaBusy boolean? "Signal if a slur is present.")
 (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?.")
 (translator-property-description 'soloIIText string? "text for begin of solo for voice ``two'' when part-combining.")
 (translator-property-description 'soloText string? "text for begin of solo when part-combining.")
 (translator-property-description 'sparseTies boolean? "only create one tie per chord.")
-(translator-property-description 'splitInterval number-pair? "part-combiner will separate its two voices (or threads) when interval between the two voices is contained in this range.")
-(translator-property-description 'split-interval boolean? "set if part-combiner separated voices based on splitInterval.")
 (translator-property-description 'squashedPosition integer? " Vertical position of
 squashing for Pitch_squash_engraver.")
 (translator-property-description 'stringOneTopmost boolean? "Whether the 1st string is printed on the
@@ -411,9 +396,11 @@ positions - by only drawing one beam over the beat.")
                                 "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 'tieMelismaBusy boolean? "Signal ties when automaticMelismata is set.")
-(translator-property-description 'timeSignatureFraction number-pair? "
-pair of numbers,  signifying the time signature. For example #'(4 . 4) is a 4/4time signature.")
+(translator-property-description 'tieMelismaBusy boolean? "Signal whether a tie is present.")
+(translator-property-description 'timeSignatureFraction number-pair?
+"pair of numbers, signifying the time signature. For example #'(4 . 4)
+is a 4/4 time signature.")
+
 (translator-property-description 'timing boolean? " Keep administration of measure length, position, bar number, etc?
 Switch off for cadenzas.")
 (translator-property-description 'tonic ly:pitch?
@@ -446,9 +433,6 @@ context Voice       imes 2/3 @{
 @@end lilypond
 @end example
 .")
-(translator-property-description 'unirhythm boolean? "set if unirhythm is detected by the part combiner.")
-(translator-property-description 'unisilence boolean? "set if unisilence is detected by the part combiner.")
-(translator-property-description 'unison boolean? "set if unisono is detected  by the part combiner. .")
 (translator-property-description 'verticalAlignmentChildCallback
 procedure? "what callback to add to children of a vertical alignment.
 It determines what alignment procedure is used on the alignment
@@ -470,6 +454,11 @@ and therefore only work in contexts which contain an
 @code{Axis_group_engraver}.
 ")
 
+(translator-property-description 'vocalName markup?
+                                "Name of a vocal line.")
+(translator-property-description 'vocNam markup?
+                                "Name of a vocal line, short version.")
+
 (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
@@ -494,10 +483,15 @@ Example:
 
 This will create a start-repeat bar in this staff only.
 
-If not set explicitly (by property or @code{\bar}), this is set
+If not set explicitly (by property or @code{\\bar}), this is set
 according to values of @code{defaultBarType}, @code{barAlways},
 @code{barNonAuto} and @code{measurePosition}.
 
 Valid values are described in @ref{(lilypond-internals)bar-line-interface}.
 
 .")
+
+
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
+(define-public default-melisma-properties '(melismaBusy slurMelismaBusy tieMelismaBusy beamMelismaBusy))