;; Line break decisions.
(define-public (define-bar-line bar-glyph eol-glyph bol-glyph span-glyph)
- "Define a bar glyph @var{bar-glyph} and its substitute at the end of a line
-(@var{eol-glyph}), at the beginning of a new line (@var{bol-glyph})
+ "Define a bar glyph @var{bar-glyph} and its substitute at the end of
+a line (@var{eol-glyph}), at the beginning of a new line (@var{bol-glyph})
and as a span bar (@var{span-glyph}) respectively."
;; the last argument may not include annotations
(check-for-annotation span-glyph)
function for cue clef changes.")
(explicitKeySignatureVisibility ,vector? "@samp{break-visibility}
function for explicit key changes. @samp{\\override} of the
-@code{break-visibility} property will set the visibility for normal
-(i.e., at the start of the line) key signatures.")
+@code{break-visibility} property will set the visibility for
+normal (i.e., at the start of the line) key signatures.")
(extendersOverRests ,boolean? "Whether to continue extenders as
they cross a rest.")
(extraNatural ,boolean? "Whether to typeset an extra natural sign
@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.")
+ (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{instrumentName} property labels the staff in the first system, and
the @code{shortInstrumentName} property labels following lines.")
(tie-configuration ,list? "List of @code{(@var{position} .
@var{dir})} pairs, indicating the desired tie configuration, where
@var{position} is the offset from the center of the staff in staff
-space and @var{dir} indicates the direction of the tie
-(@code{1}=>up, @w{@code{-1}}=>down, @code{0}=>center). A non-pair entry
+space and @var{dir} indicates the direction of the tie (@code{1}=>up,
+@w{@code{-1}}=>down, @code{0}=>center). A non-pair entry
in the list causes the corresponding tie to be formatted
automatically.")
(to-barline ,boolean? "If true, the spanner will stop at the bar
(define-markup-command (markletter layout props num)
(integer?)
#:category other
- "Make a markup letter for @var{num}. The letters start with A to@tie{}Z
-(skipping letter@tie{}I), and continue with double letters.
+ "Make a markup letter for @var{num}. The letters start with A
+to@tie{}Z (skipping letter@tie{}I), and continue with double letters.
@lilypond[verbatim,quote]
\\markup {
"Articulation events specifically for this note.")
(associated-context ,string? "Name of the Voice context associated with
this @code{\\lyricsto} section.")
- (augmented ,boolean? "This figure is for an augmented figured bass
-(with @code{+} sign).")
- (augmented-slash ,boolean? "This figure is for an augmented figured bass
-(back-slashed number).")
+ (augmented ,boolean? "This figure is for an augmented figured
+bass (with @code{+} sign).")
+ (augmented-slash ,boolean? "This figure is for an augmented
+figured bass (back-slashed number).")
(automatically-numbered ,boolean? "Should a footnote be automatically
numbered?")
(autosplit-end ,boolean? "Duration of event was truncated by automatic
(span-direction ,ly:dir? "Does this start or stop a spanner?")
(span-type ,symbol? "What kind of dynamic spanner should be created?
Options are @code{'text} and @code{'hairpin}.")
- (span-text ,markup? "The displayed text for dynamic text spanners
-(e.g., cresc.)")
+ (span-text ,markup? "The displayed text for dynamic text
+spanners (e.g., cresc.)")
(spanner-id ,string? "Identifier to distinguish concurrent spanners.")
(split-list ,list? "Splitting moments for part combiner.")
(start-callback ,procedure? "Function to compute the negative length
offset length thickness stroke-thickness)
"Add the stroke for acciaccatura to the given flag stencil.
The stroke starts for up-flags at `upper-end-of-flag + (0,length/2)'
-and ends at `(0, vertical-center-of-flag-end) -
-(flag-x-width/2, flag-x-width + flag-thickness)'. Here `length' is the
+and ends at `(0, vertical-center-of-flag-end) - (flag-x-width/2,
+flag-x-width + flag-thickness)'. Here `length' is the
whole length, while `flag-x-width' is just the x-extent and thus depends on
the angle! Other combinations don't look as good.
The function also checks if the string has the typical form of three
pedals, then the divider and then the remaining four pedals. If not it
prints out a warning. However, in any case, it will also print each symbol
-in the order as given. This means you can place the divider
-(even multiple dividers) anywhere you want, but you'll have to live with the warnings.
+in the order as given. This means you can place the divider (even
+multiple dividers) anywhere you want, but you'll have to live with the
+warnings.
The appearance of the diagram can be tweaked inter alia using the size property
of the TextScript grob (@code{\\override Voice.TextScript #'size = #0.3}) for
-the overall, the thickness property
-(@code{\\override Voice.TextScript #'thickness = #3}) for the line thickness of
-the horizontal line and the divider. The remaining configuration
-(box sizes, offsets and spaces) is done by the harp-pedal-details list of properties
-(@code{\\override Voice.TextScript #'harp-pedal-details #'box-width = #1}).
-It contains the following settings: @code{box-offset}
-(vertical shift of the box center for up/down pedals),
-@code{box-width}, @code{box-height}, @code{space-before-divider}
-(the spacing between two boxes before the divider) and
-@code{space-after-divider} (box spacing after the divider).
+the overall, the thickness property (@code{\\override Voice.TextScript
+#'thickness = #3}) for the line thickness of
+the horizontal line and the divider. The remaining configuration (box
+sizes, offsets and spaces) is done by the harp-pedal-details list of
+properties (@code{\\override Voice.TextScript #'harp-pedal-details
+#'box-width = #1}).
+It contains the following settings: @code{box-offset} (vertical shift
+of the box center for up/down pedals), @code{box-width},
+@code{box-height}, @code{space-before-divider} (the spacing between
+two boxes before the divider) and @code{space-after-divider} (box
+spacing after the divider).
@lilypond[verbatim,quote]
\\markup \\harp-pedal #\"^-v|--ov^\"
(- 2 (/ (ash 1 dotcount))))
(define-public (duration-length dur)
-"Return the overall length of a duration, as a number of whole notes.
-(Not to be confused with ly:duration-length, which returns a less-useful
-moment object.)"
+"Return the overall length of a duration, as a number of whole
+notes. (Not to be confused with ly:duration-length, which returns a
+less-useful moment object.)"
(ly:moment-main (ly:duration-length dur)))
(define-public (duration-visual dur)
;; be longer than 48 characters per line.
(anti-alias-factor 1
-"Render at higher resolution
-(using given factor) and scale down result to prevent jaggies in
+"Render at higher resolution (using given factor)
+and scale down result to prevent jaggies in
PNG images.")
(aux-files
#t
(relative-includes
#f
"When processing an \\include command, look for
-the included file relative to the current file
-(instead of the root file)")
+the included file relative to the current file\
+\n(instead of the root file)")
(safe
#f
"Run in safer mode.")
(define (make-radius-list x-radius y-radius)
"Makes a list of angle/radius pairs at intervals of PI/2 for
the partial ellipse until 7*PI/2. For example, in pseudo-code:
-> (make-radius-list 2 3)
-((0.0 . 2) (PI/2 . 3) (PI . -2) (3*PI/2 . -3)
-(2*PI . 2) (5*PI/2 . 3) (3*PI . -2) (7*PI/2 . -3))
+> (make-radius-list 2 3)\
+\n((0.0 . 2) (PI/2 . 3) (PI . -2) (3*PI/2 . -3)\
+\n(2*PI . 2) (5*PI/2 . 3) (3*PI . -2) (7*PI/2 . -3))
"
(apply append
(map (lambda (adder)
projects / lilypond.git / commitdiff