Fix ordering of property ops in display method for \with.

[lilypond.git] / scm / define-context-properties.scm

diff --git a/scm/define-context-properties.scm b/scm/define-context-properties.scm
index b6a5becfb56561fb2dca7bce283b26911d447379..16b2538ed36c6b054a7bac76f863923b4976daee 100644 (file)
--- a/scm/define-context-properties.scm
+++ b/scm/define-context-properties.scm
@@ -1,9 +1,20 @@
-;;;; define-context-properties.scm -- part of backend documentation
+;;;; This file is part of LilyPond, the GNU music typesetter.

 ;;;;
 ;;;;

-;;;;  source file of the GNU LilyPond music typesetter
-;;;;
-;;;; (c) 1998--2009  Han-Wen Nienhuys <hanwen@xs4all.nl>
+;;;; Copyright (C) 1998--2010  Han-Wen Nienhuys <hanwen@xs4all.nl>

 ;;;;                  Jan Nieuwenhuizen <janneke@gnu.org>
 ;;;;                  Jan Nieuwenhuizen <janneke@gnu.org>

+;;;;
+;;;; LilyPond is free software: you can redistribute it and/or modify
+;;;; it under the terms of the GNU General Public License as published by
+;;;; the Free Software Foundation, either version 3 of the License, or
+;;;; (at your option) any later version.
+;;;;
+;;;; LilyPond is distributed in the hope that it will be useful,
+;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;;;; GNU General Public License for more details.
+;;;;
+;;;; You should have received a copy of the GNU General Public License
+;;;; along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.

 
 
 (define-public all-translation-properties '())
 
 
 (define-public all-translation-properties '())


@@ -230,6 +241,9 @@ 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
 for the full staff.")
      (forceClef ,boolean? "Show clef symbol, even if it has not
 changed.  Only active for the first clef after the property is set, not
 for the full staff.")

+     (fretLabels ,list? "A list of strings or Scheme-formatted markups
+containing, in the correct order, the labels to be used for lettered
+frets in tablature.")

 
 
      (gridInterval ,ly:moment? "Interval for which to generate
 
 
      (gridInterval ,ly:moment? "Interval for which to generate


@@ -259,8 +273,8 @@ instrument is to be taken.")
 (instrument name), and returning a @code{(@var{min} . @var{max})} pair
 of numbers for the loudness range of the instrument.")
      (instrumentName ,markup? "The name to print left of a staff.  The
 (instrument name), and returning a @code{(@var{min} . @var{max})} pair
 of numbers for the loudness range of the instrument.")
      (instrumentName ,markup? "The name to print left of a staff.  The

-@code{instrument} property labels the staff in the first system, and
-the @code{instr} property labels following lines.")
+@code{instrumentName} property labels the staff in the first system, and
+the @code{shortInstrumentName} property labels following lines.")

      ;; the definition is reversed wrt traditional transposition
      ;; otherwise \transpose { \transposition .. } won't work
      (instrumentTransposition ,ly:pitch? "Define the transposition of
      ;; the definition is reversed wrt traditional transposition
      ;; otherwise \transpose { \transposition .. } won't work
      (instrumentTransposition ,ly:pitch? "Define the transposition of


@@ -333,8 +347,10 @@ repeated section for a page turn to be allowed within that section.")
 
      (noChordSymbol ,markup? "Markup to be displayed for rests in a
 ChordNames context.")
 
      (noChordSymbol ,markup? "Markup to be displayed for rests in a
 ChordNames context.")

-     (noteToFretFunction ,procedure? "How to produce a fret diagram.
-Parameters: A list of note events and a list of tabstring events.")
+     (noteToFretFunction ,procedure? "Convert list of notes and list of
+defined strings to full list of strings and fret numbers.
+Parameters: The context, a list of note events, a list of
+tabstring events, and the fretboard grob if a fretboard is desired.")

 
 
      (ottavation ,markup? "If set, the text for an ottava spanner.
 
 
      (ottavation ,markup? "If set, the text for an ottava spanner.


@@ -366,12 +382,6 @@ shortest-playing duration.  This is used for switching on proportional
 notation.")
 
 
 notation.")
 
 

-     (recordEventSequence ,procedure? "When
-@code{Recording_group_engraver} is in this context, then upon
-termination of the context, this function is called with current
-context and a list of music objects.  The list of contains entries with
-start times, music objects and whether they are processed in this
-context.")

      (rehearsalMark ,integer? "The last rehearsal mark printed.")
      (repeatCommands ,list? "This property is a list of commands
 of the form @code{(list 'volta @var{x})}, where @var{x} is a string or
      (rehearsalMark ,integer? "The last rehearsal mark printed.")
      (repeatCommands ,list? "This property is a list of commands
 of the form @code{(list 'volta @var{x})}, where @var{x} is a string or


@@ -386,7 +396,7 @@ 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.")
 
      (shapeNoteStyles ,vector? "Vector of symbols, listing style for
 each note head relative to the tonic (qv.) of the scale.")

-     (shortInstrumentName ,markup? "See @code{instrument}.")
+     (shortInstrumentName ,markup? "See @code{instrumentName}.")

      (shortVocalName ,markup? "Name of a vocal line, short version.")
      (skipBars ,boolean? "If set to true, then skip the empty bars
 that are produced by multimeasure notes and rests.  These bars will
      (shortVocalName ,markup? "Name of a vocal line, short version.")
      (skipBars ,boolean? "If set to true, then skip the empty bars
 that are produced by multimeasure notes and rests.  These bars will


@@ -440,8 +450,11 @@ the nesting of a start delimiters.")
 
 
      (tablatureFormat ,procedure? "A function formatting a tablature
 
 
      (tablatureFormat ,procedure? "A function formatting a tablature

-note head.  Called with three arguments: string number, context and event.
-It returns the text as a string.")
+note head.  Called with three arguments: context, string number and,
+fret number.  It returns the text as a markup.")
+     (tabStaffLineLayoutFunction ,procedure? "A function determining the
+staff position of a tablature note head.  Called with two arguments:
+the context and the string.")

      (tempoHideNote ,boolean? "Hide the note=count in tempo marks.")
      (tempoText ,markup? "Text for tempo marks.")
      (tempoUnitCount ,number? "Count for specifying tempo.")
      (tempoHideNote ,boolean? "Hide the note=count in tempo marks.")
      (tempoText ,markup? "Text for tempo marks.")
      (tempoUnitCount ,number? "Count for specifying tempo.")


@@ -524,8 +537,6 @@ are described in @rinternals{bar-line-interface}.")
      (barCheckLastFail ,ly:moment? "Where in the measure did the last
 barcheck fail?")
      (beamMelismaBusy ,boolean? "Signal if a beam is present.")
      (barCheckLastFail ,ly:moment? "Where in the measure did the last
 barcheck fail?")
      (beamMelismaBusy ,boolean? "Signal if a beam is present.")

-     (breakableSeparationItem ,ly:grob? "The breakable items in this
-time step, for this staff.")

      (busyGrobs ,list? "A queue of @code{(@var{end-moment} .
 @var{GROB})} cons cells.  This is for internal (C++) use only.  This
 property contains the grobs which are still busy (e.g. note heads,
      (busyGrobs ,list? "A queue of @code{(@var{end-moment} .
 @var{GROB})} cons cells.  This is for internal (C++) use only.  This
 property contains the grobs which are still busy (e.g. note heads,


@@ -555,10 +566,6 @@ should be manipulated through the @code{add-grace-property} function.")
 @code{CommandColumn} contains items that will affect spacing.")
 
 
 @code{CommandColumn} contains items that will affect spacing.")
 
 

-     (instrumentSupport ,grob-list? "A list of grobs to attach the
-instrument name to.")
-
-

      (lastKeySignature ,list? "Last key signature before a key
 signature change.")
      (localKeySignature ,list? "The key signature at this point in the
      (lastKeySignature ,list? "Last key signature before a key
 signature change.")
      (localKeySignature ,list? "The key signature at this point in the


@@ -572,14 +579,12 @@ This can be used to signal melismas on top of those automatically
 detected.")
 
 
 detected.")
 
 

-     (originalMiddleCPosition ,integer? "Used for temporary overriding
-middle@tie{}C in octavation brackets.")
-
-
+     (quotedCueEventTypes ,list? "A list of symbols, representing the
+event types that should be duplicated for @code{\\cueDuring} commands.")

      (quotedEventTypes ,list? "A list of symbols, representing the
      (quotedEventTypes ,list? "A list of symbols, representing the

-event types that should be duplicated for @code{\\quote} commands.")
-;    (quotes ,hash-table? "A hash table, mapping names to
-;@code{music-event} vectors.")
+event types that should be duplicated for @code{\\quoteDuring} commands.
+This is also a fallback for @code{\\cueDuring} if @code{quotedCueEventTypes}
+is not set")

 
 
      (rootSystem ,ly:grob? "The System object.")
 
 
      (rootSystem ,ly:grob? "The System object.")