Merge branch 'lilypond/translation' of ssh://git.sv.gnu.org/srv/git/lilypond

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

diff --git a/scm/define-context-properties.scm b/scm/define-context-properties.scm
index 6c8b01881ac89b6ec989b3704fdede6f549f7dc3..99eef2ec5d6c5545ed8a424312f7cfa3f04917c0 100644 (file)
--- a/scm/define-context-properties.scm
+++ b/scm/define-context-properties.scm
@@ -1,6 +1,6 @@
 ;;;; This file is part of LilyPond, the GNU music typesetter.
 ;;;;
 ;;;; 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
 ;;;;                  Jan Nieuwenhuizen <janneke@gnu.org>
 ;;;;
 ;;;; LilyPond is free software: you can redistribute it and/or modify


@@ -273,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


@@ -347,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.


@@ -380,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


@@ -400,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


@@ -454,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.")


@@ -567,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


@@ -594,8 +589,6 @@ event types that should be duplicated for @code{\\cueDuring} commands.")
 event types that should be duplicated for @code{\\quoteDuring} commands.
 This is also a fallback for @code{\\cueDuring} if @code{quotedCueEventTypes}
 is not set")
 event types that should be duplicated for @code{\\quoteDuring} commands.
 This is also a fallback for @code{\\cueDuring} if @code{quotedCueEventTypes}
 is not set")

-;    (quotes ,hash-table? "A hash table, mapping names to
-;@code{music-event} vectors.")

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