release: 1.3.145

[lilypond.git] / scm / translator-description.scm

diff --git a/scm/translator-description.scm b/scm/translator-description.scm
index ffb0e485e19d410deb0d9efa4a8b24e2370f762a..7edf9e0455f6b8cebca78babbb9991834afce334 100644 (file)
--- a/scm/translator-description.scm
+++ b/scm/translator-description.scm
@@ -52,7 +52,7 @@ the beam engraver for overriding beaming."
      "Axis_group_engraver"
      "Group all objects created in this context in a VerticalAxisGroup spanner."
      '(VerticalAxisGroup)
-     '(CONTEXTNAMEVerticalExtent CONTEXTNAMEMinimumVerticalExtent CONTEXTNAMExtraVerticalExtent)
+     '(VerticalExtent MinimumVerticalExtent ExtraVerticalExtent)
      ))
 
    (cons
@@ -112,10 +112,20 @@ interesting items (ie. note heads, lyric syllables and normal rests)"
     'A2_engraver
     (engraver-description
      "A2_engraver"
-     "Part combine engraver for orchestral scores."
+     "Part combine engraver for orchestral scores.
+
+The markings @emph{a2}, @emph{Solo} and @emph{Solo II}, are
+created by this engraver.  It also acts upon instructions of the part
+combiner.  Another thing that the this engraver, is forcing of stem,
+slur and tie directions, always when both threads are not identical;
+up for the musicexpr called @code{one}, down for the musicexpr called
+@code{two}.
+
+"
      '(TextScript)
      '(
       combineParts
+      noDirection
       soloADue
       soloText
       soloIIText
@@ -204,7 +214,7 @@ put on top of all staffs, and appears only at  left side of the staff."
     'Break_align_engraver
     (engraver-description
      "Break_align_engraver"
-     "Align graphic elements with corresponding break-align-symbols into groups, and order the groups according to breakAlignOrder"
+     "Align grobs with corresponding break-align-symbols into groups, and order the groups according to breakAlignOrder"
      '(BreakAlignment BreakAlignGroup LeftEdge)
      '(
       breakAlignOrder
@@ -229,10 +239,7 @@ put on top of all staffs, and appears only at  left side of the staff."
      "Catch Note_req's, Tonic_reqs, Inversion_reqs, Bass_req
 and generate the appropriate chordname."
      '(ChordName)
-     '(
-      chordInversion
-      drarnChords
-      )))
+     '(chordChanges)))
 
 
    (cons
@@ -341,15 +348,7 @@ If omitted, then dots appear on top of the notes.
      ""
      '(KeySignature
        )
-     '(
-      
-      keySignature
-      keyOctaviation
-      explicitKeySignatureVisibility
-      createKeyOnClefChange
-      keyAccidentalOrder
-      keySignature
-      )))
+     '( keySignature explicitKeySignatureVisibility createKeyOnClefChange keyAccidentalOrder keySignature )))
 
    (cons 'Lyric_engraver
         (engraver-description
@@ -409,7 +408,7 @@ If omitted, then dots appear on top of the notes.
 measurePosition and currentBarNumber to determine what number to print over the MultiMeasureRest
    "
      '(MultiMeasureRest)
-     '(
+     '(currentBarNumber currentCommandColumn measurePosition
       )))
 
    (cons
@@ -425,10 +424,10 @@ measurePosition and currentBarNumber to determine what number to print over the
     'Note_head_line_engraver
     (engraver-description
      "Note_head_line_engraver"
-     "Engrave a line between two note heads."
-     '(Glissando FollowThread)
-     '(
-      )))
+     "Engrave a line between two note heads, for example a glissando.
+If followVoice is set, staff switches also generate a line."
+     '(Glissando VoiceFollower)
+     '(followVoice)))
 
    (cons
     'Note_name_engraver
@@ -455,15 +454,9 @@ to any Graphic objects that satisfies the predicate."
     'Piano_pedal_engraver
     (engraver-description
      "Piano_pedal_engraver"
-     "engrave Piano pedals symbols."
-     '(SostenutoPedal SustainPedal UnaChordaPedal)
-     '(
-      
-       startSustain
-       stopSustain
-       stopStartSustain
-       startUnaChorda
-       stopUnaChorda
+     "Engrave piano pedal symbols."
+     '(SostenutoPedal SustainPedal UnaCordaPedal)
+     '(pedalSostenutoStrings pedalSustainStrings pedalUnaCordaStrings
       )))
 
    (cons 
@@ -484,7 +477,7 @@ making a single line staff that demonstrates the rhythm of a melody."
     (engraver-description
      "Property_engraver"
 "This is a engraver that converts \property settings into
-back-end element-property settings. Example: Voice.stemLength will set
+back-end grob-property settings. Example: Voice.stemLength will set
 #'length in all Stem objects.
 
 Due to CPU and memory requirements, the use of this engraver is deprecated."
@@ -696,8 +689,15 @@ bar lines, and draws a single span-bar across them."
     'Thread_devnull_engraver
     (engraver-description
      "Thread_devnull_engraver"
-     "Kill elements whenever we are Voice called `two' and
-either unison, unisilence or soloADue is set"
+     "Kill elements whenever we are Voice called `two' and either
+unison, unisilence or soloADue is set.@footnote{On unix systems, the
+file @file{/dev/null} is special device: anything written to it is
+discarded.}. This engraver works closely together with the part
+combiner.  When the part combiner notices that two threads are
+identical, it tells the @code{Thread_devnull_engraver} to discard
+everything in the second thread.
+"
+
      '()
      '()))
 
@@ -753,12 +753,8 @@ either unison, unisilence or soloADue is set"
     (engraver-description
      "Tuplet_engraver"
      "Catch Time_scaled_music and generate appropriate bracket  "
-     '(
-       TupletBracket)
-     '(
-      tupletSpannerDuration
-      tupletInvisible
-      )))
+     '( TupletBracket)
+     '(tupletNumberFormatFunction tupletSpannerDuration tupletInvisible)))
 
 
    (cons