]> git.donarmstrong.com Git - lilypond.git/blobdiff - scm/define-context-properties.scm
Imported Upstream version 2.16.0
[lilypond.git] / scm / define-context-properties.scm
index dab5211f14372444171626f23fb0ef3120175ee8..16a1b21b1ead90d461c8671c8ee9716d47819b71 100644 (file)
@@ -1,6 +1,6 @@
 ;;;; This file is part of LilyPond, the GNU music typesetter.
 ;;;;
-;;;; Copyright (C) 1998--2011  Han-Wen Nienhuys <hanwen@xs4all.nl>
+;;;; Copyright (C) 1998--2012  Han-Wen Nienhuys <hanwen@xs4all.nl>
 ;;;;                  Jan Nieuwenhuizen <janneke@gnu.org>
 ;;;;
 ;;;; LilyPond is free software: you can redistribute it and/or modify
      ;; TODO FIXME
 
      (aDueText ,markup? "Text to print at a unisono passage.")
+     (additionalPitchPrefix ,string? "Text with which to prefix
+additional pitches within a chord name.")
      (alignAboveContext ,string? "Where to insert newly created context in
 vertical alignment.")
      (alignBassFigureAccidentals ,boolean? "If true, then the accidentals
 are aligned in bass figure context.")
      (alignBelowContext ,string? "Where to insert newly created context in
 vertical alignment.")
+     (alternativeNumberingStyle ,symbol? "The style of an alternative's bar
+numbers.  Can be @code{numbers} for going back to the same number or
+@code{numbers-with-letters} for going back to the same number with letter
+suffixes.  No setting will not go back in measure-number time.")
      (associatedVoice ,string? "Name of the @code{Voice} that has the
 melody for this @code{Lyrics} line.")
      (autoAccidentals ,list? "List of different ways to typeset an
@@ -98,7 +104,7 @@ printed.  @code{(#t . #f)} does not make sense.
 
 @end table")
      (autoBeamCheck ,procedure? "A procedure taking three
-arguments, @var{context}, @var{dir} [start/stop (-1 or 1)], and
+arguments, @var{context}, @var{dir} [start/@/stop (-1 or 1)], and
 @var{test} [shortest note in the beam].  A non-@code{#f} return value
 starts or stops the auto beam.")
      (autoBeaming ,boolean? "If set to true then beams are generated
@@ -118,9 +124,12 @@ count if this property is unset.")
 each note.")
      (barCheckSynchronize ,boolean? "If true then reset
 @code{measurePosition} when finding a bar check.")
-     (barNumberVisibility ,procedure? "A Procedure that takes an
-integer and returns whether the corresponding bar number should be
-printed.")
+     (barNumberFormatter ,procedure? "A procedure that takes a bar
+number, measure position, and alternative number and returns a markup
+of the bar number to print.")
+     (barNumberVisibility ,procedure? "A procedure that takes a bar
+number and a measure position and returns whether the corresponding
+bar number should be printed.")
      (baseMoment ,ly:moment? "Smallest unit of time that will stand on its
 own as a subdivided section.")
      (bassFigureFormatFunction ,procedure? "A procedure that is
@@ -132,6 +141,8 @@ apply for the down staff of @code{PianoStaff}.  Used by
 @code{\\autochange}.")
      (beamExceptions ,list? "An alist of exceptions to autobeam rules
 that normally end on beats.")
+     (beamHalfMeasure ,boolean? "Whether to allow a beam to begin
+halfway through the measure in triple time, which could look like 6/8.")
      (beatStructure ,list? "List of @code{baseMoment}s that are combined
 to make beats.")
 
@@ -148,6 +159,9 @@ of pitches to chord names.")
      (chordNameLowercaseMinor ,boolean? "Downcase roots of minor chords?")
      (chordNameSeparator ,markup? "The markup object used to
 separate parts of a chord name.")
+     (slashChordSeparator ,markup? "The markup object used to separate
+a chord name from its root note in case of inversions or slash
+chords.")
      (chordNoteNamer ,procedure? "A function that converts from a pitch
 object to a text markup.  Used for single pitches.")
      (chordPrefixSpacer ,number? "The space added between the root
@@ -161,6 +175,7 @@ Values of 7 and -7 are common.")
 symbol go, measured in half staff spaces from the center of the
 staff.")
      (completionBusy ,boolean? "Whether a completion-note head is playing.")
+     (completionUnit ,ly:moment? "Sub-bar unit of completion.")
      (connectArpeggios ,boolean? "If set, connect arpeggios across
 piano staff.")
      (countPercentRepeats ,boolean? "If set, produce counters for
@@ -197,6 +212,8 @@ This variable is read by @rinternals{Timing_translator} at
      (defaultStrings ,list? "A list of strings to use in calculating
 frets for tablatures and fretboards if no strings are provided in
 the notes for the current moment.")
+     (doubleRepeatSegnoType ,string? "Set the default bar line for
+the combinations double repeat with segno. Default is @samp{:|S|:}.")
      (doubleRepeatType ,string? "Set the default bar line for double
 repeats.")
      (doubleSlurs ,boolean? "If set, two slurs are created for every
@@ -213,7 +230,10 @@ the symbol @samp{hihat}) as keys, and a list
 @code{(@var{notehead-style} @var{script} @var{vertical-position})} as
 values.")
 
-
+     (endRepeatSegnoType ,string? "Set the default bar line for the
+combinations ending of repeat with segno. Default is @samp{:|S}.")
+     (endRepeatType ,string? "Set the default bar line for the ending
+of repeats.")
      (explicitClefVisibility ,vector? "@samp{break-visibility}
 function for clef changes.")
      (explicitCueClefVisibility ,vector? "@samp{break-visibility}
@@ -225,8 +245,7 @@ function for explicit key changes.  @samp{\\override} of the
      (extendersOverRests ,boolean? "Whether to continue extenders as
 they cross a rest.")
      (extraNatural ,boolean? "Whether to typeset an extra natural sign
-before accidentals changing from a non-natural to another
-non-natural.")
+before accidentals that reduce the effect of a previous alteration.")
 
 
      (figuredBassAlterationDirection ,ly:dir? "Where to put alterations
@@ -239,7 +258,7 @@ for a bass figure.")
      (figuredBassPlusDirection ,ly:dir? "Where to put plus signs
 relative to the main figure.")
      (fingeringOrientations ,list? "A list of symbols, containing
-@samp{left}, @samp{right}, @samp{up} and/or @samp{down}.  This list
+@samp{left}, @samp{right}, @samp{up} and/@/or @samp{down}.  This list
 determines where fingerings are put relative to the chord being
 fingered.")
      (firstClef ,boolean? "If true, create a new clef when starting a
@@ -247,7 +266,7 @@ staff.")
      (followVoice ,boolean? "If set, note heads are tracked across
 staff switches by a thin line.")
      (fontSize ,number? "The relative size of all grobs in a context.")
-     (forbidBreak ,boolean? "If set to @code{##t}, prevent a line break
+     (forbidBreak ,boolean? "If set to @code{#t}, prevent a line break
 at this point.")
      (forceClef ,boolean? "Show clef symbol, even if it has not
 changed.  Only active for the first clef after the property is set, not
@@ -322,7 +341,7 @@ containing @code{(@var{step} . @var{alter})} or @code{((@var{octave} .
 alterations, use symbols, e.g. @code{keySignature = #`((6 . ,FLAT))}.")
 
 
-     (lyricMelismaAlignment ,ly:dir? "Alignment to use for a melisma syllable.")
+     (lyricMelismaAlignment ,number? "Alignment to use for a melisma syllable.")
 
 
      (majorSevenSymbol ,markup? "How should the major 7th be formatted
@@ -339,7 +358,7 @@ we had.  This can be set manually to create incomplete measures.")
      (melismaBusyProperties ,list? "A 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 and
+@code{'(melismaBusy beamMelismaBusy)}, only manual melismata and
 manual beams are considered.  Possible values include
 @code{melismaBusy}, @code{slurMelismaBusy}, @code{tieMelismaBusy}, and
 @code{beamMelismaBusy}.")
@@ -373,6 +392,8 @@ page turn to be allowed.")
      (minimumRepeatLengthForPageTurn ,ly:moment? "Minimum length of a
 repeated section for a page turn to be allowed within that section.")
 
+     (minorChordModifier ,markup? "Markup displayed following the root
+for a minor chord")
 
      (noChordSymbol ,markup? "Markup to be displayed for rests in a
 ChordNames context.")
@@ -424,10 +445,14 @@ is set.")
      (restCompletionBusy ,boolean? "Signal whether a completion-rest is active.")
      (restNumberThreshold ,number? "If a multimeasure rest has more
 measures than this, a number is printed.")
+     (restrainOpenStrings ,boolean? "Exclude open strings from the
+automatic fret calculator.")
 
      (searchForVoice ,boolean? "Signal whether a search should be made
 of all contexts in the context hierarchy for a voice to provide rhythms
 for the lyrics.")
+     (segnoType ,string? "Set the default bar line for a requested segno.
+Default is @samp{S}.")
      (shapeNoteStyles ,vector? "Vector of symbols, listing style for
 each note head relative to the tonic (qv.) of the scale.")
      (shortInstrumentName ,markup? "See @code{instrumentName}.")
@@ -459,10 +484,16 @@ part-combining.")
 @code{traditional}, or @code{semitone}.")
      (stanza ,markup? "Stanza @q{number} to print before the start of a
 verse.  Use in @code{Lyrics} context.")
+     (startRepeatSegnoType ,string? "Set the default bar line for the
+combinations beginning of repeat with segno. Default is @samp{.S|:}.")
+     (startRepeatType ,string? "Set the default bar line for the beginning
+of repeats.")
      (stemLeftBeamCount ,integer? "Specify the number of beams to draw
 on the left side of the next note.  Overrides automatic beaming.  The
 value is only used once, and then it is erased.")
      (stemRightBeamCount ,integer? "See @code{stemLeftBeamCount}.")
+     (strictBeatBeaming ,boolean? "Should partial beams reflect the
+beat structure even if it causes flags to hang out?")
      (stringNumberOrientations ,list? "See
 @code{fingeringOrientations}.")
      (stringOneTopmost ,boolean? "Whether the first string is
@@ -477,7 +508,7 @@ subdivided at @code{baseMoment} positions by only drawing one beam over the beat
      (suggestAccidentals ,boolean? "If set, accidentals are typeset as
 cautionary suggestions over the note.")
      (systemStartDelimiter ,symbol? "Which grob to make for the start
-of the system/staff?  Set to @code{SystemStartBrace},
+of the system/@/staff?  Set to @code{SystemStartBrace},
 @code{SystemStartBracket} or @code{SystemStartBar}.")
      (systemStartDelimiterHierarchy ,pair? "A nested list, indicating
 the nesting of a start delimiters.")
@@ -495,8 +526,8 @@ minute.")
      (tieWaitForNote ,boolean? "If true, tied notes do not have to
 follow each other directly.  This can be used for writing out
 arpeggios.")
-     (timeSignatureFraction ,number-pair? "A pair of numbers,
-signifying the time signature.  For example, @code{#'(4 . 4)} is a
+     (timeSignatureFraction ,fraction? "A pair of numbers,
+signifying the time signature.  For example, @code{'(4 . 4)} is a
 4/4 time signature.")
      (timeSignatureSettings ,cheap-list? "A nested alist of settings for
 time signatures.  Contains elements for various time signatures.  The
@@ -561,6 +592,7 @@ are described in @rinternals{bar-line-interface}.")
      (apply translator-property-description x))
 
    `(
+     (EventClasses ,cheap-list? "The initial list of event classes.")
 
      (associatedVoiceContext ,ly:context? "The context object of the
 @code{Voice} that has the melody for this @code{Lyrics}.")
@@ -570,7 +602,7 @@ are described in @rinternals{bar-line-interface}.")
 barcheck fail?")
      (beamMelismaBusy ,boolean? "Signal if a beam is present.")
      (busyGrobs ,list? "A queue of @code{(@var{end-moment} .
-@var{GROB})} cons cells.  This is for internal (C++) use only.  This
+@var{grob})} cons cells.  This is for internal (C++) use only.  This
 property contains the grobs which are still busy (e.g. note heads,
 spanners, etc.).")
 
@@ -624,7 +656,7 @@ is not set")
 
      (scriptDefinitions ,list? "The description of scripts.  This is
 used by the @code{Script_engraver} for typesetting note-superscripts
-and subscripts.  See @file{scm/script.scm} for more information.")
+and subscripts.  See @file{scm/@/script.scm} for more information.")
      (slurMelismaBusy ,boolean? "Signal if a slur is present.")
      (stavesFound ,grob-list? "A list of all staff-symbols found.")