]> git.donarmstrong.com Git - lilypond.git/blobdiff - scm/define-context-properties.scm
*** empty log message ***
[lilypond.git] / scm / define-context-properties.scm
index 85e926711a0313c4be06a850f072fe98e26ca506..3d13d2fe1f178ea150c5f43b36f405d725e37fc5 100644 (file)
@@ -11,7 +11,7 @@
 (define (translator-property-description symbol type? description)
  (if (not (equal? #f (object-property symbol 'translation-doc)))
       (begin
-       (ly:warn (string-append "Redefining " (symbol->string symbol) "\n"))
+       (ly:warn  "Redefining ~S " symbol)
        (exit 2)
       ))
   
@@ -71,7 +71,7 @@ voices in the same staff share accidentals, but staves do not.
 @item laziness
 
 Over how many bar lines the accidental lasts.
-If @var{laziness} is @code{-1} then the accidental is forget
+If @var{laziness} is @code{-1} then the accidental is forgotten
 immediately, and if @var{laziness} is @code{#t} then the accidental
 lasts forever.
 @end table
@@ -99,6 +99,10 @@ when finding a barcheck.")
 
      (barNumberVisibility ,procedure? "Procedure that takes an int and
 returns whether the corresponding bar number should be printed")
+     (bassStaffProperties ,list? "Alist of property settings to apply
+for the down staff of PianoStaff. Used by @code{\\autochange}")
+     (trebleStaffProperties ,list? "Alist of property settings to apply
+for the up staff of PianoStaff. Used by @code{\\autochange}")
      (bassFigureFormatFunction ,procedure? "Procedure that is called
 to produce the formatting for a @code{BassFigure} grob. It takes a
 list of @code{BassFigureEvent}s, a context, and the grob to format.")
@@ -120,14 +124,14 @@ staffspaces.  Usually determined by looking at @code{clefPosition} and
      (chordRootNamer ,procedure?
                     "Function that converts from a pitch object to a text markup. Used for chords.")
      (chordNameExceptions ,list?
-                         "Alist of chord exceptions.
+                         "An alist of chord exceptions.
 Contains (@var{chord} . @var{markup}) entries.")
      (chordNameExceptionsFull ,list?
-                             "Alist of chord exceptions.
+                             "An alist of chord exceptions.
 Contains (@var{chord} . @var{markup}) entries.")
      (chordNameExceptionsPartial
       ,list?
-      "Alist of partial chord exceptions. Contains (@var{chord} . (@var{prefix-markup} @var{suffix-markup})) entries.")
+      "An alist of partial chord exceptions. Contains (@var{chord} . (@var{prefix-markup} @var{suffix-markup})) entries.")
      
      (chordNameSeparator ,markup?
                         "The markup object used to separate
@@ -143,7 +147,8 @@ symbol go, measured in half staff spaces from the center of the staff.")
      (connectArpeggios ,boolean? " If set, connect arpeggios across
 piano staff.")
      (createKeyOnClefChange ,boolean? "Print a key signature whenever the clef is changed.")
-     (createSpacing ,boolean? "Create StaffSpacing objects? Should be set for staves.")
+     (createSpacing ,boolean? "Create @code{StaffSpacing} objects?
+Should be set for staves.")
      (crescendoText ,markup? "Text to print at start of non-hairpin crescendo, i.e.: @samp{cresc.}")
      (crescendoSpanner ,symbol? "Type of spanner to be used for crescendi.
 One of: @samp{hairpin}, @samp{line}, @samp{dashed-line},
@@ -173,12 +178,14 @@ This variable is  read by @internalsref{Timing_engraver} at
 ")
 
      (decrescendoSpanner ,symbol? "See @code{crescendoSpanner}.")
-
+     (doubleSlurs ,boolean?
+                 "When set, two slurs are created for every slurred
+note, one above and one below the chord.")
      (explicitClefVisibility ,procedure? "@samp{break-visibility} function for clef changes.")
 
      (explicitKeySignatureVisibility ,procedure?
 "@samp{break-visibility} function for explicit key
-changes. @samp{\\override} of @samp{#'break-visibility} will set the
+changes. @samp{\\override} of the @code{break-visibility} property will set the
 visibility for normal (i.e. at the start of the line) key signatures.")
 
      (extraNatural ,boolean? "Whether to typeset an
@@ -189,7 +196,7 @@ another non-natural.")
                          "extra vertical extent, same format as @var{minimumVerticalExtent}")
 
 
-     (followVoice ,boolean? "if set, note heads are tracked across staff
+     (followVoice ,boolean? "If set, note heads are tracked across staff
 switches by a thin line")
 
      (fontSize ,number?
@@ -220,11 +227,14 @@ the @code{instr} property labels following lines.")
      (instrumentEqualizer ,procedure? "
 Function taking a string (instrument name), and returning a (@var{min} . @var{max}) pair of numbers for the loudness range of the instrument.
 ")
-     (instrumentTransposition ,ly:pitch? "Define the transposition of the instrument. This is used to transpose the MIDI output, and @code{\\quote}s.")
+     (instrumentTransposition ,ly:pitch? "Defines the transposition of
+the instrument. Its value is the pitch that sounds like middle C. This
+is used to transpose the MIDI output, and @code{\\quote}s.")
 
      (keyAccidentalOrder ,list? " Alist that defines in what order
 alterations should be printed.  The format is (@var{name}
-. @var{alter}), where @var{name} is from 0 .. 6 and @var{alter} from -1, 1.
+. @var{alter}), where @var{name} is from 0 .. 6 and @var{alter} from
+-2 (sharp) and 2 (flat).
 ")
 
      (keySignature ,list? "The current key signature. This is an alist
@@ -261,7 +271,7 @@ markup.  Called with 2 arguments, event and context.")
      (midiMinimumVolume ,number? "Sets the minimum loudness for MIDI. Ranges from 0 to 1.")
      (midiMaximumVolume ,number? "Analogous to @code{midiMinimumVolume}.")
      (minimumFret ,number? "The tablature auto string-selecting mechanism
-selects the highest string with a fret at least @var{minimumFret}")
+selects the highest string with a fret at least @code{minimumFret}")
      (minimumVerticalExtent ,number-pair? "minimum vertical extent, same
 format as @var{verticalExtent}")
      (ottavation ,string? "If set, the text for an ottava spanner. Changing
@@ -277,6 +287,7 @@ sustain pedals: @code{text}, @code{bracket} or @code{mixed} (both).")
      (pedalUnaCordaStyle ,symbol? "see @code{pedalSustainStyle}.")
      (pedalSostenutoStyle ,symbol? "see @code{pedalSustainStyle}.")
      (printKeyCancellation ,boolean? "Print restoration alterations before a key signature change. ")
+     (printPartCombineTexts ,boolean? "set Solo/A due texts in the part combiner?")
      (printOctaveNames ,boolean? "Print octave marks for the NoteNames context.")
      (recordEventSequence ,procedure? "When
 @internalsref{Recording_group_engraver} is in this context, then upon
@@ -289,9 +300,10 @@ context.")
      (rehearsalMark ,integer? "The last rehearsal mark printed.")
      (repeatCommands ,list? "This property is read to find any command of the form @code{(volta . @var{x})}, where @var{x} is a string or @code{#f}")
      (restNumberThreshold ,number?
-                         "If a multimeasure rest takes less
-than this number of measures, no number is printed. ")
-
+                         "If a multimeasure rest has more measures
+than this, a number is printed. ")
+     (shapeNoteStyles ,vector? "Vector of symbols, listing style for each note
+head relative to the tonic (qv.) of the scale.")
      (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
@@ -309,7 +321,6 @@ r1 r1*3 R1*3  \\\\property Score.skipBars= ##t r1*3 R1*3
      (skipTypesetting ,boolean?
                      "When true, all no typesetting is done, speeding
 up  the interpretation phase. This speeds up debugging large scores.")
-     (soloADue ,boolean? "set Solo/A due texts in the part combiner?")
      (soloIIText ,string? "text for begin of solo for voice ``two'' when part-combining.")
      (soloText ,string? "text for begin of solo when part-combining.")
      (squashedPosition ,integer? " Vertical position of
@@ -387,14 +398,18 @@ to 10 (5+5) staffspaces high.
 
 This does not work for Voice or any other context  that doesn't form a
 vertical group.")
-
+     
+     (verticallySpacedContexts ,list? "List of symbols, containing
+context names whose vertical axis groups should be taken into account for
+vertical spacing of systems.")
+     
      (vocalName ,markup? "Name of a vocal line.")
      (vocNam ,markup? "Name of a vocal line, short version.")
 
      (voltaOnThisStaff ,boolean?
                       "Normally, volta brackets are put only on the
-topmost staff. Setting this variable will create a bracket on
-this staff as well.")
+topmost staff.  This variable overrides this behavior, when set to
+@code{#t} or @code{#f}.")
 
      (voltaSpannerDuration ,ly:moment? "This specifies the maximum duration
 to use for the brackets printed for @code{\\alternative}.  This can be
@@ -430,7 +445,7 @@ Valid values are described in @internalsref{bar-line-interface}.
      (melismaBusy ,boolean? "Signifies
 whether a melisma is active. This can be used to signal melismas on
 top of those automatically detected. ")
-     (graceSettings ,vector?
+     (graceSettings ,list?
                    "Overrides for grace notes. This property should
 be manipulated through the @code{add-grace-property} function.")
      (currentCommandColumn ,ly:grob? "Grob that is X-parent to all
@@ -472,11 +487,16 @@ signature change.")
 Script_engraver for typesetting note-super/subscripts. See
 @file{scm/script.scm} for more information
 ")
-     (quotes ,hash-table? "Hash table, mapping names to music-event vectors.")
+     (quotedEventTypes ,list? "List of symbols, representing the
+event types that should be duplicated for @code{\\quote} commands.")
+
+;     (quotes ,hash-table? "Hash table, mapping names to music-event vectors.")
      (stavesFound ,grob-list? "list of all staff-symbols found.")
      (instrumentSupport ,grob-list? "list of grobs to attach instrument name
 to.")
      (tieMelismaBusy ,boolean? "Signal whether a tie is present.")
+     (tweakCount ,number? "Number of otherwise unique Contexts.")
+     (tweakRank ,number? "Identify otherwise unique Contexts.")
      )
    ))