scm/translator-description.scm

   1 (define (number-or-string? x) (or (number? x) (string? x)))
   2 (define (engraver-description name description created-elts properties)
   3   (list name description created-elts properties)
   4   )
   5
   6 (define (translator-property-description symbol type? description)
   7   (list symbol type? description)
   8   )
   9
  10 (define engraver-description-alist
  11   (list
  12    (cons
  13     'Stem_engraver
  14     (engraver-description
  15      "Stem_engraver"
  16      "Create stems and single-stem tremolos"
  17      '(Stem StemTremolo)
  18      (list
  19       (translator-property-description 'tremoloFlags integer? "")
  20       (translator-property-description 'stemLeftBeamCount integer? "
  21 Specify the number of beams to draw on the left side of the next note.
  22 Overrides automatic beaming.  The value is only used once, and then it
  23 is erased.
  24 ")
  25       (translator-property-description 'stemRightBeamCount integer? "idem, for the right side")
  26       )))
  27
  28    (cons
  29     'Hyphen_engraver
  30     (engraver-description
  31      "Hyphen_engraver"
  32      "Create lyric hyphens"
  33      '(LyricHyphen)
  34      (list
  35       )))
  36
  37    (cons
  38     'Extender_engraver
  39     (engraver-description
  40      "Extender_engraver"
  41      "Create lyric extenders"
  42      '(LyricExtender)
  43      (list
  44       )))
  45
  46
  47    (cons
  48     'Separating_line_group_engraver
  49     (engraver-description
  50      "Separating_line_group_engraver"
  51      "Generates objects for computing spacing parameters."
  52      '(SeparationItem SeparatingGroupSpanner)
  53      (list
  54       )))
  55
  56    (cons
  57     'Axis_group_engraver
  58     (engraver-description
  59      "Axis_group_engraver"
  60      "Group all objects created in this context in a VerticalAxisGroup spanner."
  61      '(VerticalAxisGroup)
  62      (list
  63       (translator-property-description
  64        'CONTEXTNAMEVerticalExtent number-pair? "hard coded vertical extent.
  65 The format is a pair of dimensions, for example, this sets the sizes
  66 of a staff to 10 (5+5) staffspaces high.
  67
  68 @example
  69 \property Staff.StaffVerticalExtent = #(-5.0 . 5.0)
  70 @end example
  71
  72  [fixme, naming]")
  73       (translator-property-description
  74        'CONTEXTNAMEMinimumVerticalExtent number-pair?
  75        "minimum vertical extent, same format as CONTEXTNAMEVerticalExtent [fixme, naming]")
  76       (translator-property-description
  77        'CONTEXTNAMExtraVerticalExtent number-pair?
  78        "extra vertical extent, same format
  79 CONTEXTNAMEMinimumVerticalExtent [fixme, naming]") )))
  80
  81    (cons
  82     'Hara_kiri_engraver
  83     (engraver-description
  84      "Hara_kiri_engraver"
  85      "Like Axis_group_engraver, but make a hara kiri spanner, and add
  86 interesting items (ie. note heads, lyric syllables and normal rests)"
  87      '(HaraKiriVerticalGroup)
  88      '()
  89      ))
  90
  91
  92    (cons
  93     'Local_key_engraver
  94     (engraver-description
  95      "Local_key_engraver"
  96      "Make accidentals.  Catches note heads, ties and notices key-change
  97    events.  Due to interaction with ties (which don't come together
  98    with note heads), this needs to be in a context higher than Tie_engraver.
  99    (FIXME)."
 100      '(Accidentals)
 101      (list
 102       (translator-property-description 'localKeySignature list? "the key signature at this point  in the measure")
 103       (translator-property-description 'forgetAccidentals boolean? "do
 104 not set localKeySignature when a note alterated differently from
 105 localKeySignature is found.
 106
 107 Causes accidentals to be printed at every note instead of
 108 remembered for the duration of a measure.
 109 ")
 110       (translator-property-description 'noResetKey boolean? "Do not
 111 reset local key to the value of keySignature at the start of a measure,
 112 as determined by measurePosition.
 113
 114 Do not reset the key at the start of a measure.  Accidentals will be
 115 printed only once and are in effect until overridden, possibly many
 116 measures later.
 117 ")
 118
 119       )))
 120
 121
 122    (cons
 123     'Volta_engraver
 124     (engraver-description
 125      "Volta_engraver"
 126      "Make volta brackets"
 127      '(VoltaBracket)
 128      (list
 129       (translator-property-description 'repeatCommands list?
 130                                        "This property is read to find any command of the form (volta . X), where X is a string or #f")
 131       (translator-property-description 'voltaSpannerDuration moment?
 132                                        "maximum duration of the volta bracket.
 133
 134     Set to a duration to control the size of the brackets printed by
 135 @code{\alternative}.  It specifies the number of whole notes duration
 136 to use for the brackets.  This can be used to shrink the length of
 137 brackets in the situation where one alternative is very large.  It may
 138 have odd effects if the specified duration is longer than the music
 139 given in an @code{\alternative}.
 140 ")
 141       )
 142      ))
 143
 144    (cons
 145     'Clef_engraver
 146     (engraver-description
 147      "Clef_engraver"
 148      "Determine and set reference point for pitches"
 149      '(Clef OctavateEight)
 150      (list
 151       (translator-property-description 'supportedClefTypes
 152                                        list? "Clef settings supported. The value is an association list contain entries (NAME . (GLYPH . POSITION)), where  NAME is the clef name (alto, baritone, etc.), GLYPH the glyph name, POSITION an integer where the center symbol should go.")
 153       (translator-property-description 'clefPosition number? " where the center of the symbol should go")
 154       (translator-property-description 'clefGlyph string? "name of the symbol within the music font")
 155       (translator-property-description 'centralCPosition number? "place of the central C. ")
 156       (translator-property-description 'defaultClef string? "generate this clef at the very start of this staff. If not set, don't generate a clef")
 157       (translator-property-description 'explicitClefVisibility procedure? "visibility-lambda function for clefs entered as \clef.")
 158       (translator-property-description 'clefPitches list? "alist mapping GLYPHNAME to the position of the central C for that symbol")
 159
 160       )))
 161
 162    (cons
 163     'A2_engraver
 164     (engraver-description
 165      "A2_engraver"
 166      "Part combine engraver for orchestral scores."
 167      '(TextScript)
 168      (list
 169       (translator-property-description 'combineParts boolean? "try to combine parts?")
 170       (translator-property-description 'soloADue  boolean? "set Solo/A due texts?")
 171       (translator-property-description 'soloText  string? "text for begin of solo")
 172       (translator-property-description 'soloIIText  string? "text for begin of solo for voice ``two''")
 173       (translator-property-description 'aDueText string? "text for begin of a due")
 174       (translator-property-description 'split-interval number-pair? "always split into two voices for contained intervals")
 175       (translator-property-description 'unison  boolean? "set if unisono is detected  ")
 176       (translator-property-description 'solo  boolean? "set if solo is detected")
 177       (translator-property-description 'unisilence  boolean? "set if unisilence is detected")
 178       (translator-property-description 'unirhythm  boolean? "set if unirhythm is detected")
 179       )))
 180
 181    (cons
 182     'Align_note_column_engraver
 183     (engraver-description
 184      "Align_note_column_engraver"
 185      "Generate object to put grace notes from left to right."
 186      '(GraceAlignment)
 187      (list
 188
 189       (translator-property-description 'graceAlignPosition dir? "put the grace note before or after the main note?")
 190       (translator-property-description 'graceAccidentalSpace number? "amount space to alot for an accidental")
 191       )))
 192
 193    (cons
 194     'Arpeggio_engraver
 195     (engraver-description
 196      "Arpeggio_engraver"
 197      "Generate an Arpeggio from a Arpeggio_req"
 198      '(Arpeggio)
 199      (list
 200       )))
 201
 202    (cons
 203     'Auto_beam_engraver
 204     (engraver-description
 205      "Auto_beam_engraver"
 206      "Generate beams based on measure characteristics and observed Stems.
 207 Uses beatLength, measureLength and measurePosition to decide when to start and stop a beam.
 208 "
 209      '(
 210        Beam)
 211      (list
 212       (translator-property-description 'noAutoBeaming boolean? "  If set to true then beams are not generated automatically.
 213 ")
 214       (translator-property-description 'autoBeamSettings list? "
 215 Specifies when automatically generated beams should begin and end.  The elements have the format:
 216
 217 @example
 218
 219    function shortest-duration-in-beam time-signature
 220
 221 where
 222
 223     function = begin or end
 224     shortest-duration-in-beam = numerator denominator; eg: 1 16
 225     time-signature = numerator denominator, eg: 4 4
 226
 227 unspecified or wildcard entries for duration or time-signature
 228 are given by * *
 229
 230 The user can override beam begin or end time by pushing a wildcard entries
 231 '(begin * * * *) or '(end * * * *) resp., eg:
 232
 233     \property Voice.autoBeamSettings \push #'(end * * * *) = #(make-moment 1 4)
 234
 235 The head of the list:
 236     '(
 237      ((end * * 3 2) . ,(make-moment 1 2))
 238      ((end 1 16 3 2) . ,(make-moment 1 4))
 239      ((end 1 32 3 2) . ,(make-moment 1 8))
 240      ...
 241     )
 242
 243 @end example"))))
 244
 245    (cons
 246     'Bar_engraver
 247     (engraver-description
 248      "Bar_engraver"
 249      "Create barlines."
 250      '(BarLine)
 251      (list
 252       (translator-property-description 'whichBar string? "This property is read to determine what type of barline to create.
 253 Example:
 254 @example
 255 \\property Staff.whichBar = \"|:\"
 256 @end example
 257 will create a start-repeat bar in this staff only
 258 ")
 259       (translator-property-description 'staffsFound list? "list of all staff-symbols found.")
 260       )))
 261
 262
 263    (cons
 264     'Bar_number_engraver
 265     (engraver-description
 266      "Bar_number_engraver"
 267      "A bar number is created whenever measurePosition is zero. It is
 268 put on top of all staffs, and appears only at  left side of the staff."
 269      '(BarNumber)
 270      (list
 271       (translator-property-description 'currentBarNumber integer? "this is read to determine
 272  the number to put on the bar ")
 273       )))
 274
 275
 276    (cons
 277     'Beam_engraver
 278     (engraver-description
 279      "Beam_engraver"
 280      "Handles Beam_requests by engraving Beams.    If omitted, then notes will be
 281     printed with flags instead of beams."
 282      '(Beam)
 283      (list
 284       (translator-property-description 'beamMelismaBusy boolean? "Signal if a beam is set when automaticMelismata is set")
 285       )))
 286
 287    (cons
 288     'Break_align_engraver
 289     (engraver-description
 290      "Break_align_engraver"
 291      "Align graphic elements with corresponding break-align-symbols into groups, and order the groups according to breakAlignOrder"
 292      '(BreakAlignment BreakAlignGroup LeftEdge)
 293      (list
 294       (translator-property-description 'breakAlignOrder list?
 295                                        "Defines the order in which
 296 prefatory matter (clefs, key signatures) appears, eg. this puts the
 297 key signatures after the bar lines:
 298
 299 @example
 300         \\property Score.breakAlignOrder = #'(
 301           Span_bar
 302           Breathing_sign
 303           Clef_item
 304           Staff_bar
 305           Key_item
 306           Time_signature
 307         )
 308 @end example
 309 ")
 310       )))
 311
 312
 313    (cons
 314     'Breathing_sign_engraver
 315     (engraver-description
 316      "Breathing_sign_engraver"
 317      ""
 318      '(BreathingSign)
 319      (list
 320       )))
 321
 322
 323    (cons
 324     'Chord_name_engraver
 325     (engraver-description
 326      "Chord_name_engraver"
 327      "Catch Note_req's, Tonic_reqs, Inversion_reqs, Bass_req
 328 and generate the appropriate chordname."
 329      '(ChordName)
 330      (list
 331       (translator-property-description 'chordInversion boolean? " Determines whether LilyPond should look for chord inversions when
 332     translating from notes to chord names.  Set to 1 to find
 333     inversions.  The default is 0 which does not look for
 334     inversions.")
 335       (translator-property-description 'drarnChords boolean? "")
 336       )))
 337
 338
 339    (cons
 340     'Chord_tremolo_engraver
 341     (engraver-description
 342      "Chord_tremolo_engraver"
 343      "Generates beams for the \repeat X tremolo ... construct"
 344      '(Beam)
 345      (list
 346       )))
 347
 348
 349
 350    (cons
 351     'Collision_engraver
 352     (engraver-description
 353      "Collision_engraver"
 354      ""
 355      '(NoteCollision
 356        )
 357      (list
 358       )))
 359
 360    (cons
 361     'Custos_engraver
 362     (engraver-description
 363      "Custos_engraver"
 364      ""
 365      '(Custos)
 366      (list
 367       )))
 368
 369
 370    (cons
 371     'Dot_column_engraver
 372     (engraver-description
 373      "Dot_column_engraver"
 374      " Engraves dots on dotted notes shifted to the right of the note.
 375 If omitted, then dots appear on top of the notes.
 376 "
 377      '(DotColumn
 378        )
 379      (list
 380       )))
 381
 382
 383    (cons
 384     'Dynamic_engraver
 385     (engraver-description
 386      "Dynamic_engraver"
 387      ""
 388      '(DynamicLineSpanner
 389        DynamicText Crescendo
 390        TextSpanner)
 391      (list
 392       )))
 393
 394
 395
 396
 397    (cons
 398     'Grace_position_engraver
 399     (engraver-description
 400      "Grace_position_engraver"
 401      "Attach a grace note alignment to a note-column "
 402      '()
 403      (list
 404       )))
 405
 406    (cons
 407     'Grace_engraver_group
 408     (engraver-description
 409      "Grace_engraver_group"
 410      "An engraver that creates a `shielded' context-tree with separate notion of time"
 411      '()
 412      (list
 413       )))
 414
 415
 416    (cons
 417     'Instrument_name_engraver
 418     (engraver-description
 419      "Instrument_name_engraver"
 420      " Prints the name of the instrument (specified by
 421     @code{Staff.instrument} and @code{Staff.instr}) at the left of the
 422     staff."
 423      '(InstrumentName)
 424      (list
 425       (translator-property-description 'instrument string? " If @code{Instrument_name_engraver}
 426 @cindex Instrument_name_engraver
 427  is
 428     added to the Staff translator, then the @code{instrument} property
 429     is used to label the first line of the staff and the @code{instr}
 430     property is used to label subsequent lines.  If the
 431     @code{midiInstrument} property is not set, then @code{instrument}
 432     is used to determine the instrument for MIDI output.")
 433       (translator-property-description 'instr string? "see @code{instrument}")
 434       )))
 435
 436    (cons
 437     'Engraver_group_engraver
 438     (engraver-description
 439      "Engraver_group_engraver"
 440      "A group of engravers taken together"
 441      '()
 442      (list
 443       )))
 444
 445    (cons
 446     'Key_engraver
 447     (engraver-description
 448      "Key_engraver"
 449      ""
 450      '(KeySignature
 451        )
 452      (list
 453
 454       (translator-property-description 'keySignature list? "")
 455       (translator-property-description 'keyOctaviation boolean? "")
 456       (translator-property-description 'explicitKeySignatureVisibility procedure? "")
 457       (translator-property-description 'createKeyOnClefChange boolean? "")
 458       (translator-property-description 'keyAccidentalOrder list? "")
 459       (translator-property-description 'keySignature list? "")
 460       )))
 461
 462    (cons 'Lyric_phrasing_engraver
 463          (engraver-description
 464           "Lyric_phrasing_engraver"
 465           ""
 466           '()
 467           (list
 468            (translator-property-description 'automaticPhrasing boolean? "")
 469            (translator-property-description 'weAreGraceContext boolean? "")
 470            (translator-property-description 'melismaEngraverBusy boolean? "")
 471            (translator-property-description 'associatedVoice string? "")
 472            (translator-property-description 'phrasingPunctuation string? "")
 473            )))
 474
 475    (cons
 476     'Mark_engraver
 477     (engraver-description
 478      "Mark_engraver"
 479      ""
 480      '(RehearsalMark)
 481      (list
 482
 483       (translator-property-description 'rehearsalMark number-or-string? "")
 484       (translator-property-description 'staffsFound list? "")
 485       )))
 486
 487
 488    (cons
 489     'Melisma_engraver
 490     (engraver-description
 491      "Melisma_engraver"
 492      ""
 493      '()
 494      (list
 495
 496       (translator-property-description 'melismaBusy boolean? "")
 497       (translator-property-description 'slurMelismaBusy boolean? "")
 498       (translator-property-description 'tieMelismaBusy boolean? "")
 499       (translator-property-description 'beamMelismaBusy boolean? "")
 500       )))
 501
 502
 503    (cons
 504     'Multi_measure_rest_engraver
 505     (engraver-description
 506      "Multi_measure_rest_engraver"
 507      "Engraves multi-measure rests that are produced with @code{R}.  Reads
 508 measurePosition and currentBarNumber to determine what number to print over the MultiMeasureRest
 509    "
 510      '(MultiMeasureRest)
 511      (list
 512       )))
 513
 514
 515    (cons
 516     'Note_heads_engraver
 517     (engraver-description
 518      "Note_heads_engraver"
 519      "Generate one or more noteheads from Music of type Note_req."
 520      '(NoteHead Dots)
 521      (list
 522       )))
 523
 524
 525    (cons
 526     'Note_name_engraver
 527     (engraver-description
 528      "Note_name_engraver"
 529      ""
 530      '(NoteName)
 531      (list
 532       )))
 533
 534
 535    (cons
 536     'Output_property_engraver
 537     (engraver-description
 538      "Output_property_engraver"
 539      "Interpret Music of Output_property type, and apply a function
 540 to any Graphic objects that satisfies the predicate."
 541      '()
 542      (list
 543       )))
 544
 545
 546    (cons
 547     'Piano_pedal_engraver
 548     (engraver-description
 549      "Piano_pedal_engraver"
 550      "engrave Piano pedals symbols."
 551      '(SostenutoPedal SustainPedal UnaChordaPedal)
 552      (list
 553
 554         (translator-property-description 'startSustain string? "")
 555         (translator-property-description 'stopSustain  string? "")
 556         (translator-property-description 'stopStartSustain  string? "")
 557         (translator-property-description 'startUnaChorda  string? "")
 558         (translator-property-description 'stopUnaChorda string? "")
 559       )))
 560
 561    (cons
 562     'Pitch_squash_engraver
 563     (engraver-description
 564      "Pitch_squash_engraver"
 565      "Treat all pitches as middle C.  Note that the notes move, but
 566 the locations of accidentals stay the same.
 567 Set the position field of all note heads to zero. This useful for
 568 making a single line staff that demonstrates the rhythm of a melody."
 569      '()
 570      (list
 571       (translator-property-description 'squashedPosition integer? " Vertical position of
 572 squashing.")
 573       )))
 574
 575    (cons
 576     'Property_engraver
 577     (engraver-description
 578      "Property_engraver"
 579 "This is a engraver that converts \property settings into
 580 back-end element-property settings. Example: Voice.stemLength will set
 581 #'length in all Stem objects.
 582
 583 Due to CPU and memory requirements, the use of this engraver is deprecated."
 584      '()
 585      (list
 586       (translator-property-description 'Generic_property_list list? "description of the conversion.
 587
 588 Defines names and types for generic properties. These are properties
 589 than can be plugged into the backend directly. See the init file
 590 @file{generic-property.scm} for details.  For internal use only,
 591 deprecated.
 592 ")
 593       )))
 594
 595
 596    (cons
 597     'Repeat_acknowledge_engraver
 598     (engraver-description
 599      "Repeat_acknowledge_engraver"
 600
 601      "Acknowledge repeated music, and convert the contents of
 602 repeatCommands ainto an appropriate setting for whichBar"
 603      '()
 604      (list
 605       (translator-property-description 'repeatCommands list? "")
 606       (translator-property-description 'whichBar string? "")
 607
 608       )))
 609
 610
 611    (cons
 612     'Rest_collision_engraver
 613     (engraver-description
 614      "Rest_collision_engraver"
 615      "Handles collisions of rests."
 616      '(RestCollision)
 617      (list
 618       )))
 619
 620
 621    (cons
 622     'Rest_engraver
 623     (engraver-description
 624      "Rest_engraver"
 625      ""
 626       '(Rest Dots)
 627    (list
 628       )))
 629
 630
 631    (cons
 632     'Rhythmic_column_engraver
 633     (engraver-description
 634      "Rhythmic_column_engraver"
 635      "Generates NoteColumn, an objects that groups stems, noteheads and rests."
 636      '(NoteColumn)
 637      (list
 638       )))
 639
 640
 641    (cons
 642     'Script_column_engraver
 643     (engraver-description
 644      "Script_column_engraver"
 645      ""
 646      '(ScriptColumn)
 647      (list
 648       )))
 649
 650
 651    (cons
 652     'Script_engraver
 653     (engraver-description
 654      "Script_engraver"
 655      "    Handles note ornaments generated by @code{\script}.
 656 "
 657      '(Script)
 658      (list
 659       (translator-property-description 'scriptDefinitions list? "
 660 Description of scripts to use.  (fixme)
 661 ")
 662
 663       (translator-property-description 'scriptHorizontal boolean? "    Put scripts left or right of note heads.  Support for this is
 664     limited.  Accidentals will collide with scripts.
 665
 666 ")
 667       )))
 668
 669    (cons
 670     'Score_engraver
 671     (engraver-description
 672      "Score_engraver"
 673      "Top level engraver. Takes care of generating columns and the complete  system (ie. LineOfScore)"
 674      '(LineOfScore PaperColumn NonMusicalPaperColumn)
 675      (list
 676       (translator-property-description 'currentMusicalColumn ly-element? "")
 677       (translator-property-description 'currentCommandColumn ly-element? "")
 678       )))
 679
 680    (cons
 681     'Slur_engraver
 682     (engraver-description
 683      "Slur_engraver"
 684      "Build slurs from Slur_reqs"
 685      '(Slur)
 686
 687      (list
 688       (translator-property-description 'slurBeginAttachment symbol? "translates to the car of Slur.element-property 'attachment.")
 689       (translator-property-description 'slurEndAttachment symbol? "translates to the cdr of Slur.element-property 'attachment.")
 690       (translator-property-description 'slurMelismaBusy boolean? "Signal a slur if automaticMelismata is set")
 691       )))
 692
 693
 694    (cons
 695     'Spacing_engraver
 696     (engraver-description
 697      "Spacing_engraver"
 698      "make a SpacingSpanner and do bookkeeping of shortest starting and playing notes  "
 699      '(SpacingSpanner)
 700      (list
 701       )))
 702
 703
 704    (cons
 705     'Span_arpeggio_engraver
 706     (engraver-description
 707      "Span_arpeggio_engraver"
 708      ""
 709      '(Arpeggio)
 710      (list
 711       (translator-property-description 'connectArpeggios boolean? " If
 712 set, connect all arpeggios that are found.  In this way, you can make
 713 arpeggios that cross staffs.
 714 ")
 715       )))
 716
 717
 718    (cons
 719     'Span_bar_engraver
 720     (engraver-description
 721      "Span_bar_engraver"
 722      "This engraver makes cross-staff barlines: It catches all normal
 723 bar lines, and draws a single span-bar across them."
 724
 725      '(SpanBar)
 726      (list
 727       )))
 728
 729
 730    (cons
 731     'Staff_symbol_engraver
 732     (engraver-description
 733      "Staff_symbol_engraver"
 734      "create the constellation of five (default) staff lines."
 735      '(StaffSymbol)
 736      (list
 737       )))
 738
 739
 740    (cons
 741     'Stanza_number_engraver
 742     (engraver-description
 743      "Stanza_number_engraver"
 744      ""
 745      '(StanzaNumber
 746        )
 747      (list
 748       (translator-property-description 'stz string? "")
 749       (translator-property-description 'stanza string? "Stanza `number' to print at start of a verse")
 750       )))
 751
 752
 753
 754    (cons
 755     'System_start_delimiter_engraver
 756     (engraver-description
 757      "System_start_delimiter_engraver"
 758      "creates a SystemStartDelimiter spanner"
 759      '(SystemStartDelimiter)
 760      (list
 761       )))
 762
 763
 764    (cons
 765     'Text_engraver
 766     (engraver-description
 767      "Text_engraver"
 768      "Create text-scripts"
 769      '(TextScript)
 770      (list
 771       (translator-property-description 'scriptHorizontal boolean? "    Put scripts left or right of note heads.  Support for this is
 772     limited.  Accidentals will collide with scripts.
 773
 774 ")
 775       (translator-property-description 'textNonEmpty boolean? " If set
 776 to true then text placed above or below the staff is not assumed to
 777 have zero width.  @code{fatText} and @code{emptyText} are predefined
 778 settings.
 779 ")
 780       )))
 781
 782
 783    (cons
 784     'Text_spanner_engraver
 785     (engraver-description
 786      "Text_spanner_engraver"
 787      "Create text spanner from a  Span_req "
 788      '(TextSpanner)
 789      (list
 790       )))
 791
 792
 793    (cons
 794     'Thread_devnull_engraver
 795     (engraver-description
 796      "Thread_devnull_engraver"
 797      "Kill elements whenever we are Voice called `two' and
 798 either unison, unisilence or soloADue is set"
 799      '()
 800      '()))
 801
 802
 803    (cons
 804     'Tie_engraver
 805     (engraver-description
 806      "Tie_engraver"
 807      "Generate ties between noteheads of equal pitch."
 808      '(Tie TieColumn)
 809      (list
 810
 811
 812       (translator-property-description 'sparseTies boolean? "only create one tie per chord.")
 813       (translator-property-description 'tieMelismaBusy boolean? "Signal ties when automaticMelismata is set")
 814       )))
 815
 816
 817    (cons
 818     'Time_signature_engraver
 819     (engraver-description
 820      "Time_signature_engraver"
 821      "Create a TimeSignature whenever @code{timeSignatureFraction} changes"
 822      '(TimeSignature)
 823      (list
 824       )))
 825
 826
 827    (cons
 828     'Timing_engraver
 829     (engraver-description
 830      "Timing_engraver"
 831      " Responsible for synchronizing timing information from staffs.
 832     Normally in @code{Score}.  In order to create polyrhythmic music,
 833     this engraver should be removed from @code{Score} and placed in
 834     @code{Staff}."
 835      '()
 836      (list
 837       (translator-property-description 'timeSignatureFraction number-pair? "
 838 pair of numbers,  signifying the time signature. For example #'(4 . 4) is a 4/4 time signature.")
 839
 840       (translator-property-description 'barNonAuto boolean? " If set to true then bar lines will not be printed
 841     automatically; they must be explicitly created with @code{\bar}
 842     keywords.  Unlike with the @code{\cadenza} keyword, measures are
 843     still counted.  Bar generation will resume according to that
 844     count if this property is set to zero.
 845 ")
 846       (translator-property-description 'whichBar string? "if not set
 847 explicitly (by \property or \bar), this is set according to values of
 848 defaultBarType, barAlways, barNonAuto and measurePosition.
 849  ")
 850
 851       (translator-property-description 'barAlways boolean? " If set to true a bar line is drawn after each note.
 852 ")
 853       (translator-property-description 'defaultBarType string? "Sets the default type of bar line. See Section XREF-barlines [FIXME]
 854     for a list of available bar types.
 855 ")
 856       (translator-property-description 'skipBars boolean? " Set to true to skip the empty bars that are produced by
 857     multimeasure notes and rests.  These bars will not appear on the
 858     printed output.  If not set (the default)  multimeasure
 859     notes and rests expand into their full length, printing the appropriate
 860     number of empty bars so that synchronization with other voices is
 861     preserved.
 862
 863 @c my @vebatim patch would help...
 864 @example
 865 @@mudela[fragment,verbatim,center]
 866 r1 r1*3 R1*3\property Score.skipBars=1 r1*3 R1*3
 867
 868 @@end mudela
 869 @end example
 870
 871 ")
 872       (translator-property-description 'timing boolean? " Keep administration of measure length, position, bar number, etc?
 873 Switch off for cadenzas.")
 874       (translator-property-description 'oneBeat moment? "  How long does one beat in the current time signature last?")
 875       (translator-property-description 'measureLength moment? "  How long does one measure in the current time signature last?")
 876       (translator-property-description 'measurePosition moment? "
 877   How much of the current measure (measured in whole notes) have we had?
 878 ")
 879       (translator-property-description 'currentBarNumber integer? "Contains the current barnumber. This property is incremented at
 880 every barline.
 881 ")
 882       )))
 883
 884
 885    (cons
 886     'Tuplet_engraver
 887     (engraver-description
 888      "Tuplet_engraver"
 889      "Catch Time_scaled_music and generate appropriate bracket  "
 890      '(
 891        TupletBracket)
 892      (list
 893       (translator-property-description 'tupletSpannerDuration moment? "
 894 Normally a tuplet bracket is as wide as the
 895 @code{\times} expression that gave rise to it. By setting this
 896 property, you can make brackets last shorter. Example
 897
 898 @example
 899 @@mudela[verbatim,fragment]
 900 \context Voice \times 2/3 @{
 901   \property Voice.tupletSpannerDuration = #(make-moment 1 4)
 902   [c8 c c] [c c c]
 903 @}
 904 @@end mudela
 905 @end example
 906 ")
 907       (translator-property-description 'tupletInvisible boolean? "
 908     If set to true, tuplet bracket creation is switched off
 909 entirely. This has the same effect as setting both
 910 @code{tupletNumberVisibility} and @code{tupletBracketVisibility} to
 911 @code{#f}, but as this does not even create elements, this setting
 912 uses less memory and time.")
 913       )))
 914
 915
 916    (cons
 917     'Vertical_align_engraver
 918     (engraver-description
 919      "Vertical_align_engraver"
 920      "Catch Vertical axis groups and stack them."
 921      '(VerticalAlignment)
 922      (list
 923       )))
 924
 925
 926    (cons
 927     'Voice_devnull_engraver
 928     (engraver-description
 929      "Voice_devnull_engraver"
 930      "Kill off certain items and spanners if we're Voice `two' and unison or unisilence is set."
 931      '()
 932      (list
 933       )))
 934    ))
 935
 936
 937
 938
 939 (define context-description-alist
 940   '(
 941 (Grace . "
 942     The context for handling grace notes.  It is instantiated
 943     automatically when you use @code{\grace}.  Basically, it is an
 944     `embedded' miniature of the Score context.  Since this context
 945     needs special interaction with the rest of LilyPond, you should
 946     not explicitly instantiate it.
 947 ")
 948 (LyricVoice . "
 949     Corresponds to a voice with lyrics.  Handles the printing of a
 950     single line of lyrics.
 951 ")
 952 (Thread . "
 953     Handles note heads, and is contained in the Voice context.  You
 954     have to instantiate this explicitly if you want to adjust the
 955     style of individual note heads.
 956 ")
 957 (Voice . "
 958     Corresponds to a voice on a staff.  This context handles the
 959     conversion of dynamic signs, stems, beams, super- and subscripts,
 960     slurs, ties, and rests.
 961
 962     You have to instantiate this explicitly if you want to have
 963     multiple voices on the same staff.")
 964
 965 (ChordNamesVoice . "
 966     A voice with chord names.  Handles printing of a line of chord
 967     names.")
 968
 969 (ChordNames . "
 970     Typesets chord names.  Can contain @code{ChordNamesVoice}
 971     contexts.")
 972
 973 (Lyrics . "
 974     Typesets lyrics.  It can contain @code{LyricVoice} contexts.
 975 ")
 976 (Staff . "
 977     Handles clefs, bar lines, keys, accidentals.  It can contain
 978     @code{Voice} contexts.
 979 ")
 980 (RhythmicStaff . "
 981     A context like @code{Staff} but for printing rhythms.  Pitches are
 982     ignored; the notes are printed on one line.  It can contain
 983     @code{Voice} contexts.
 984 ")
 985 (GrandStaff . "
 986     Contains @code{Staff} or @code{RhythmicStaff} contexts.  It adds a
 987     brace on the left side, grouping the staffs together.  The bar
 988     lines of the contained staffs are connected vertically.  It can
 989     contain @code{Staff} contexts.")
 990
 991 (PianoStaff . "
 992     Just like @code{GrandStaff} but with @code{minVerticalAlign} set
 993     equal to @code{maxVerticalAlign} so that interstaff beaming and
 994     slurring can be used.")
 995
 996 (StaffGroup . "
 997     Contains @code{Staff} or @code{RhythmicStaff} contexts.  Adds a
 998     bracket on the left side, grouping the staffs together.  The bar
 999     lines of the contained staffs are connected vertically.  It can
1000     contain @code{Staff}, @code{RhythmicStaff}, @code{GrandStaff}, or
1001     @code{Lyrics} contexts.
1002 ")
1003 (ChoirStaff . "
1004     Identical to @code{StaffGroup} except that the contained staffs
1005     are not connected vertically.
1006 ")
1007 (Score . "
1008     This is the top level notation context.  No other context can
1009     contain a @code{Score} context.  This context handles the
1010     administration of time signatures.  It also makes sure that items
1011     such as clefs, time signatures, and key-signatures are aligned
1012     across staffs.  It can contain @code{Lyrics}, @code{Staff},
1013     @code{RhythmicStaff}, @code{GrandStaff}, @code{StaffGroup}, and
1014     @code{ChoirStaff} contexts.
1015
1016     You cannot explicitly instantiate a Score context (since it is
1017     not contained in any other context).  It is instantiated
1018     automatically when an output definition (a @code{\score} or
1019     @code{\paper} block) is processed.
1020 ")
1021 )
1022 )