]> git.donarmstrong.com Git - lilypond.git/blobdiff - scm/define-context-properties.scm
Don't let lyrics interfere with StaffGrouper.
[lilypond.git] / scm / define-context-properties.scm
index a46e8b5d0819b97f857ab53888ab3cefb38be3fe..1da05b637a1e2f5c8215ac2deb21235d9bccb47c 100644 (file)
@@ -1,6 +1,6 @@
 ;;;; This file is part of LilyPond, the GNU music typesetter.
 ;;;;
-;;;; Copyright (C) 1998--2009  Han-Wen Nienhuys <hanwen@xs4all.nl>
+;;;; Copyright (C) 1998--2010  Han-Wen Nienhuys <hanwen@xs4all.nl>
 ;;;;                  Jan Nieuwenhuizen <janneke@gnu.org>
 ;;;;
 ;;;; LilyPond is free software: you can redistribute it and/or modify
@@ -146,6 +146,7 @@ exceptions.  Contains @code{(@var{chord} . (@var{prefix-markup}
 @var{suffix-markup}))} entries.")
      (chordNameFunction ,procedure? "The function that converts lists
 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.")
      (chordNoteNamer ,procedure? "A function that converts from a pitch
@@ -241,6 +242,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.")
+     (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
@@ -264,14 +268,16 @@ string selector for tablature notation.")
 printed as numbers, but only as extender lines.")
      (implicitTimeSignatureVisibility ,vector? "break visibility for
 the default time signature.")
+     (includeGraceNotes ,boolean? "Do not ignore grace notes for
+@rinternals{Lyrics}.")
      (instrumentCueName ,markup? "The name to print if another
 instrument is to be taken.")
      (instrumentEqualizer ,procedure? "A function taking a string
 (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
@@ -344,8 +350,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.")
-     (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.
@@ -377,12 +385,6 @@ shortest-playing duration.  This is used for switching on proportional
 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
@@ -397,7 +399,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.")
-     (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
@@ -451,8 +453,11 @@ the nesting of a start delimiters.")
 
 
      (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.")
@@ -564,10 +569,6 @@ should be manipulated through the @code{add-grace-property} function.")
 @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
@@ -581,14 +582,12 @@ This can be used to signal melismas on top of those automatically
 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
-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.")