X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdefine-context-properties.scm;h=43079859c638b83acba705060a6eba9413a85d2f;hb=b51ccf16e888af1e16b5c6fe733a04e7349de06a;hp=a813f1421f6b90ae8d8d9e7fba41000e8ebcb84a;hpb=4133b4e0ec939a427a70361ad838c65a84a0dfda;p=lilypond.git diff --git a/scm/define-context-properties.scm b/scm/define-context-properties.scm index a813f1421f..43079859c6 100644 --- 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. ;;;; -;;;; Copyright (C) 1998--2011 Han-Wen Nienhuys +;;;; Copyright (C) 1998--2012 Han-Wen Nienhuys ;;;; Jan Nieuwenhuizen ;;;; ;;;; LilyPond is free software: you can redistribute it and/or modify @@ -45,12 +45,18 @@ ;; 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 @@ -148,6 +157,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 @@ -225,8 +237,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 +250,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 +258,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 @@ -257,6 +268,11 @@ containing, in the correct order, the labels to be used for lettered frets in tablature.") + (glissandoMap ,list? "A map in the form of '((source1 . target1) +(source2 . target2) (sourcen . targetn)) showing the glissandi to +be drawn for note columns. The value '() will default to '((0 . 0) +(1 . 1) (n . n)), where n is the minimal number of note-heads in +the two note columns between which the glissandi occur.") (gridInterval ,ly:moment? "Interval for which to generate @code{GridPoint}s.") @@ -317,7 +333,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 @@ -334,7 +350,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}.") @@ -353,6 +369,8 @@ is used for ottava brackets.") half staff-spaces. Usually determined by looking at @code{middleCClefPosition} and @code{middleCOffset}.") (midiInstrument ,string? "Name of the MIDI instrument to use.") + (midiMergeUnisons ,boolean? "If true, output only one MIDI note-on +event when notes with the same pitch, in the same MIDI-file track, overlap.") (midiMaximumVolume ,number? "Analogous to @code{midiMinimumVolume}.") (midiMinimumVolume ,number? "Set the minimum loudness for MIDI. @@ -366,6 +384,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.") @@ -456,6 +476,8 @@ verse. Use in @code{Lyrics} context.") 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 @@ -470,7 +492,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.") @@ -488,8 +510,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 @@ -563,7 +585,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.).") @@ -617,7 +639,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.")