* input/regression/rehearsal-mark-number.ly: new file.

[lilypond.git] / scm / define-translator-properties.scm

diff --git a/scm/define-translator-properties.scm b/scm/define-translator-properties.scm
index 6df9e9bf92f92e6fc19e1ab94e9f2dbe03a72b2e..3f11acf9d6b942afde0817658ef650d84588c6a0 100644 (file)
--- a/scm/define-translator-properties.scm
+++ b/scm/define-translator-properties.scm
@@ -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:
@@ -115,7 +116,7 @@ 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).")
@@ -270,6 +271,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
@@ -298,8 +302,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
@@ -311,8 +320,14 @@ 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?
@@ -351,7 +366,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? "
@@ -386,7 +401,7 @@ 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.")
@@ -415,9 +430,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?