]> git.donarmstrong.com Git - lilypond.git/blobdiff - scm/translator-description.scm
patch::: 1.5.4.jcn3
[lilypond.git] / scm / translator-description.scm
index 3f2816cd8ba041096d3081af736704e48c48d316..ef856df0487711f3ec33e5ac8c7e4230767c2e29 100644 (file)
     'Stem_engraver
     (engraver-description
      "Stem_engraver"
-     "Create stems and single-stem tremolos"
+     "Create stems and single-stem tremolos.  It also works together with
+the beam engraver for overriding beaming."
      '(Stem StemTremolo)
-     '(
-      tremoloFlags
+     '(tremoloFlags
       stemLeftBeamCount
       stemRightBeamCount    
       )))
@@ -52,7 +52,7 @@
      "Axis_group_engraver"
      "Group all objects created in this context in a VerticalAxisGroup spanner."
      '(VerticalAxisGroup)
-     '(CONTEXTNAMEVerticalExtent CONTEXTNAMEMinimumVerticalExtent CONTEXTNAMExtraVerticalExtent)
+     '(VerticalExtent MinimumVerticalExtent ExtraVerticalExtent)
      ))
 
    (cons
@@ -98,24 +98,26 @@ interesting items (ie. note heads, lyric syllables and normal rests)"
      "Clef_engraver"
      "Determine and set reference point for pitches"
      '(Clef OctavateEight)
-     '(
-      clefPosition
-      clefGlyph
-      centralCPosition
-      clefOctavation
-      explicitClefVisibility
-      clefPitches
-
-      )))
+     '( clefPosition clefGlyph centralCPosition clefOctavation explicitClefVisibility )))
    
    (cons
     '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
@@ -127,18 +129,6 @@ interesting items (ie. note heads, lyric syllables and normal rests)"
       unirhythm
       )))
 
-   (cons
-    'Align_note_column_engraver
-    (engraver-description
-     "Align_note_column_engraver"
-     "Generate object to put grace notes from left to right."
-     '(GraceAlignment)
-     '(
-      
-      graceAlignPosition
-      graceAccidentalSpace
-      )))
-   
    (cons
     'Arpeggio_engraver
     (engraver-description
@@ -149,11 +139,14 @@ interesting items (ie. note heads, lyric syllables and normal rests)"
       )))
 
    (cons
-    'Auto_beam_engraver
+   'Auto_beam_engraver
     (engraver-description
      "Auto_beam_engraver"
-     "Generate beams based on measure characteristics and observed Stems.
-Uses beatLength, measureLength and measurePosition to decide when to start and stop a beam.
+     "Generate beams based on measure characteristics and observed
+Stems.  Uses beatLength, measureLength and measurePosition to decide
+when to start and stop a beam.  Overriding beaming is done through
+@ref{Stem_engraver} properties stemLeftBeamCount and
+stemRightBeamCount.
 "
      '(
        Beam)
@@ -170,7 +163,7 @@ Uses beatLength, measureLength and measurePosition to decide when to start and s
      '(BarLine)
      '(
       whichBar
-      staffsFound
+      stavesFound
       )))
 
 
@@ -179,7 +172,7 @@ Uses beatLength, measureLength and measurePosition to decide when to start and s
     (engraver-description
      "Bar_number_engraver"
      "A bar number is created whenever measurePosition is zero. It is
-put on top of all staffs, and appears only at  left side of the staff."
+put on top of all staves, and appears only at  left side of the staff."
      '(BarNumber)
      '(
       currentBarNumber
@@ -201,7 +194,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
@@ -226,10 +219,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
@@ -282,7 +272,7 @@ If omitted, then dots appear on top of the notes.
      "Dynamic_engraver"
      ""
      '(DynamicLineSpanner
-       DynamicText Crescendo
+       DynamicText Hairpin
        TextSpanner)
      '(
       )))
@@ -290,23 +280,6 @@ If omitted, then dots appear on top of the notes.
 
 
 
-   (cons
-    'Grace_position_engraver
-    (engraver-description
-     "Grace_position_engraver"
-     "Attach a grace note alignment to a note-column "
-     '()
-     '(
-      )))
-
-   (cons
-    'Grace_engraver_group
-    (engraver-description
-     "Grace_engraver_group"
-     "An engraver that creates a `shielded' context-tree with separate notion of time"
-     '()
-     '(
-      )))
 
 
    (cons
@@ -338,15 +311,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
@@ -364,7 +329,7 @@ If omitted, then dots appear on top of the notes.
          '()
          '(
           automaticPhrasing
-          weAreGraceContext
+
           melismaEngraverBusy
           associatedVoice
           phrasingPunctuation
@@ -379,7 +344,7 @@ If omitted, then dots appear on top of the notes.
      '(
 
       rehearsalMark
-      staffsFound
+      stavesFound
       )))
 
 
@@ -406,7 +371,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
@@ -422,10 +387,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
@@ -452,15 +417,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 
@@ -481,7 +440,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."
@@ -693,8 +652,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.
+"
+
      '()
      '()))
 
@@ -724,7 +690,7 @@ either unison, unisilence or soloADue is set"
     'Timing_engraver
     (engraver-description
      "Timing_engraver"
-     " Responsible for synchronizing timing information from staffs. 
+     " Responsible for synchronizing timing information from staves. 
     Normally in @code{Score}.  In order to create polyrhythmic music,
     this engraver should be removed from @code{Score} and placed in
     @code{Staff}."
@@ -750,12 +716,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
@@ -785,11 +747,13 @@ either unison, unisilence or soloADue is set"
 (define context-description-alist
   '(
 (Grace . "
-    The context for handling grace notes.  It is instantiated
+    The context for handling grace notes.  It used to be instantiated
     automatically when you use @code{\grace}.  Basically, it is an
     `embedded' miniature of the Score context.  Since this context
     needs special interaction with the rest of LilyPond, you should
     not explicitly instantiate it.
+
+   DEPRECATED.
 ")
 (LyricsVoice . "
     Corresponds to a voice with lyrics.  Handles the printing of a
@@ -830,8 +794,8 @@ either unison, unisilence or soloADue is set"
 ")
 (GrandStaff . "
     Contains @code{Staff} or @code{RhythmicStaff} contexts.  It adds a
-    brace on the left side, grouping the staffs together.  The bar
-    lines of the contained staffs are connected vertically.  It can
+    brace on the left side, grouping the staves together.  The bar
+    lines of the contained staves are connected vertically.  It can
     contain @code{Staff} contexts.")
 
 (PianoStaff . "
@@ -841,13 +805,13 @@ either unison, unisilence or soloADue is set"
 
 (StaffGroup . "
     Contains @code{Staff} or @code{RhythmicStaff} contexts.  Adds a
-    bracket on the left side, grouping the staffs together.  The bar
-    lines of the contained staffs are connected vertically.  It can
+    bracket on the left side, grouping the staves together.  The bar
+    lines of the contained staves are connected vertically.  It can
     contain @code{Staff}, @code{RhythmicStaff}, @code{GrandStaff}, or
     @code{Lyrics} contexts.
 ")
 (ChoirStaff . "
-    Identical to @code{StaffGroup} except that the contained staffs
+    Identical to @code{StaffGroup} except that the contained staves
     are not connected vertically.
 ")
 (Score . "
@@ -855,7 +819,7 @@ either unison, unisilence or soloADue is set"
     contain a @code{Score} context.  This context handles the
     administration of time signatures.  It also makes sure that items
     such as clefs, time signatures, and key-signatures are aligned
-    across staffs.  It can contain @code{Lyrics}, @code{Staff},
+    across staves.  It can contain @code{Lyrics}, @code{Staff},
     @code{RhythmicStaff}, @code{GrandStaff}, @code{StaffGroup}, and
     @code{ChoirStaff} contexts.