+\version "2.1.22"
@c Note: -*-texinfo-*-
-@c
+@c This file is part of lilypond.tely
+
@c A menu is needed before every deeper *section nesting of @node's; run
@c M-x texinfo-all-menus-update
@c to automagically fill in these menus before saving changes
* Contemporary notation::
* Special notation::
* Tuning output::
+* Text markup::
* Global layout::
* Sound::
@end menu
a half note is entered using a @code{2} (since it is a 1/2 note). For notes
longer than a whole you must use variables:
-@c FIXME: what is an identifier? I do not think it's been introduced yet.
-@c and if it has, I obviously skipped that part. - Graham
-
@example
c'\breve
c'1 c'2 c'4 c'8 c'16 c'32 c'64 c'64
\translator {
\StaffContext
\remove "Clef_engraver"
- \remove "Staff_symbol_engraver"
- \remove "Time_signature_engraver"
+ StaffSymbol \set #'transparent = ##t
+ TimeSignature \set #'transparent = ##t
\consists "Pitch_squash_engraver"
}
}
used once:
@lilypond[fragment,relative,raggedright,verbatim]
-\property Voice.tupletSpannerDuration = #(ly:make-moment 1 4)
+\set tupletSpannerDuration = #(ly:make-moment 1 4)
\times 2/3 { c'8 c c c c c }
@end lilypond
@lilypond[fragment,raggedright,verbatim]
\relative c'' { c8 d
-\property Score.skipTypesetting = ##t
+\set Score.skipTypesetting = ##t
e f g a g c, f e d
-\property Score.skipTypesetting = ##f
+\set Score.skipTypesetting = ##f
c d b bes a g c2 }
@end lilypond
In the following examples, notes crossing the barline are split and tied.
-@lilypond[noindent,verbatim]
+@lilypond[noindent,verbatim,relative=1]
\new Voice \with {
\remove "Note_heads_engraver"
\consists "Completion_heads_engraver"
@seealso
-Examples: @inputfileref{input/regression,completion-heads.ly}
+Examples: @inputfileref{input/regression,completion-heads.ly}.
-Internals: @internalsref{Completion_heads_engraver}
+Internals: @internalsref{Completion_heads_engraver}.
@node Staff notation
@seealso
-Internals: @internalsref{StaffSymbol},
+Internals: @internalsref{StaffSymbol}.
Examples: @inputfileref{input/test,staff-lines.ly},
-@inputfileref{input/test,staff-size.ly}
+@inputfileref{input/test,staff-size.ly}.
@refbugs
@example
#(set-octavation 1)
- \property Staff.ottavation = #"8"
+ \set Staff.ottavation = #"8"
@end example
@seealso
@end example
This is internally translated into
@example
- \property Timing.measurePosition = -@var{length of duration}
+ \set Timing.measurePosition = -@var{length of duration}
@end example
@cindex @code{|}
The property @code{measurePosition} contains a rational number
The command @code{\bar @var{bartype}} is a short cut for doing
-@code{\property Score.whichBar = @var{bartype}} Whenever
+@code{\set Score.whichBar = @var{bartype}} Whenever
@code{whichBar} is set to a string, a bar line of that type is
created. At the start of a measure it is set to
@code{defaultBarType}. The contents of @code{repeatCommands} are used
@lilypond[verbatim,fragment,raggedright]
\relative c'' \context Voice << {
g8 g8
- \property Staff.NoteCollision \override
+ \override Staff.NoteCollision
#'merge-differently-dotted = ##t
g8 g8
} \\ { g8.[ f16] g8.[ f16] }
@lilypond[fragment,relative=2,verbatim]
\context Voice << {
c8 c4.
- \property Staff.NoteCollision
- \override #'merge-differently-headed = ##t
+ \override Staff.NoteCollision
+ #'merge-differently-headed = ##t
c8 c4. } \\ { c2 c2 } >>
@end lilypond
Normally, beaming patterns within a beam are determined automatically.
When this mechanism fouls up, the properties
-@code{Voice.stemLeftBeamCount} and @code{Voice.stemRightBeamCount} can
+@code{stemLeftBeamCount} and @code{stemRightBeamCount} can
be used to control the beam subdivision on a stem. If either property
is set, its value will be used only once, and then it is erased.
@lilypond[fragment,relative,verbatim]
\context Staff {
f8[ r16 f g a]
- f8[ r16 \property Voice.stemLeftBeamCount = #1 f g a]
+ f8[ r16 \set stemLeftBeamCount = #1 f g a]
}
@end lilypond
@cindex @code{stemRightBeamCount}
@lilypond[relative=1,verbatim,noindent]
c16[ c c c c c c c]
- \property Voice.subdivideBeams = ##t
+ \set subdivideBeams = ##t
c16[ c c c c c c c]
- \property Score.beatLength = #(ly:make-moment 1 8)
+ \set Score.beatLength = #(ly:make-moment 1 8)
c16[ c c c c c c c]
@end lilypond
@cindex subdivideBeams
In normal time signatures, automatic beams can start on any note but can
only end in a few positions within the measure: beams can end on a beat,
or at durations specified by the properties in
-@code{Voice.autoBeamSettings}. The defaults for @code{autoBeamSettings}
+@code{autoBeamSettings}. The defaults for @code{autoBeamSettings}
are defined in @file{scm/auto-beam.scm}.
The value of @code{autoBeamSettings} is changed using
@code{\override} and restored with @code{\revert}:
@example
-\property Voice.autoBeamSettings \override #'(@var{BE} @var{P} @var{Q} @var{N} @var{M}) = @var{dur}
-\property Voice.autoBeamSettings \revert #'(@var{BE} @var{P} @var{Q} @var{N} @var{M})
+\override autoBeamSettings #'(@var{BE} @var{P} @var{Q} @var{N} @var{M}) = @var{dur}
+\property autoBeamSettings \revert #'(@var{BE} @var{P} @var{Q} @var{N} @var{M})
@end example
Here, @var{BE} is the symbol @code{begin} or @code{end}. It determines
whether the rule applies to begin or end-points. The quantity
For example, if automatic beams should end on every quarter note, use
the following:
@example
-\property Voice.autoBeamSettings \override
+\override autoBeamSettings
#'(end * * * *) = #(ly:make-moment 1 4)
@end example
Since the duration of a quarter note is 1/4 of a whole note, it is
The same syntax can be used to specify beam starting points. In this
example, automatic beams can only end on a dotted quarter note:
@example
-\property Voice.autoBeamSettings \override
+\override autoBeamSettings
#'(end * * * *) = #(ly:make-moment 3 8)
@end example
In 4/4 time signature, this means that automatic beams could end only on
replacing the second asterisks by @var{N} and @var{M}. For example, a
rule for 6/8 time exclusively looks like
@example
-\property Voice.autoBeamSettings \override
+\override autoBeamSettings
#'(begin * * 6 8) = ...
@end example
@cindex automatic beam generation
@cindex autobeam
-@cindex @code{Voice.autoBeaming}
+@cindex @code{autoBeaming}
@cindex lyrics
For melodies that have lyrics, you may want to switch off
-automatic beaming. This is done by setting @code{Voice.autoBeaming} to
+automatic beaming. This is done by setting @code{autoBeaming} to
@code{#f}.
@refcommands
manual beaming.
@lilypond[raggedright,fragment,relative,noverbatim,quote]
- \property Voice.autoBeamSettings
- \override #'(end * * * *) = #(ly:make-moment 3 8)
+ \override autoBeamSettings
+ #'(end * * * *) = #(ly:make-moment 3 8)
% rather show case where it goes wrong
%\time 12/8 c'8 c c c16 c c c c c c[ c c c] c8[ c] c4
\time 12/8 c'8 c c c16 c c c c c c c c c c8 c c4
@var{context} is @internalsref{Score} then all staves share
accidentals, and if @var{context} is @internalsref{Staff} then all
voices in the same staff share accidentals, but staves do not.
+
@item octavation:
Whether the accidental changes all octaves or only the current
- octave.
-@item lazyness:
- Over how many barlines the accidental lasts.
- If @var{lazyness} is @code{-1} then the accidental is forget
- immediately, and if @var{lazyness} is @code{#t} then the accidental
- lasts forever.
-
-@c [TODO: should use +infinity for this case?]
-
+ octave. Valid choices are
+
+ @table @samp
+ @item same-octave:
+ This is the default algorithm. Accidentals are typeset if the note changes
+ the accidental of that note in that octave. Accidentals lasts to the end of the measure
+ and then as many measures as specified in the value. I.e. 1 means to the end
+ of next measure, -1 means to the end of previous measure (that is: no duration at all), etc. #t means forever.
+ @item any-octave:
+ Accidentals are typeset if the note is different from
+ the previous note on the same pitch in any octave. The value has same meaning as in
+ same-octave.
+ @end table
+
+@item lazyness
+
+ Over how many barlines the accidental lasts.
+ If @var{lazyness} is @code{-1} then the accidental is forget
+ immediately, and if @var{lazyness} is @code{#t} then the accidental
+ lasts forever.
@end table
+
@refcommands
@cindex @code{\defaultAccidentals}
input file:
@lilypond[raggedright,fragment,verbatim]
-\property Staff.autoAccidentals = #'( Staff (any-octave . 0) )
+\set Staff.autoAccidentals = #'( Staff (any-octave . 0) )
cis'4 <c'' c'> r2 | cis'4 <c' c''> r2
| <cis' c''> r | <c'' cis'> r |
@end lilypond
@lilypond[fragment,relative,verbatim]
\slurUp
- \property Voice.Stem \set #'length = #5.5
+ \override Stem #'length = #5.5
g'8(g g4)
- \property Voice.Slur \set #'attachment = #'(stem . stem)
+ \override Slur #'attachment = #'(stem . stem)
g8( g g4)
@end lilypond
@lilypond[fragment,relative,verbatim]
\stemUp \slurUp
d32( d'4 d8..)
- \property Voice.Slur \set #'attachment = #'(stem . stem)
+ \override Slur #'attachment = #'(stem . stem)
d,32( d'4 d8..)
@end lilypond
any markup text. For example,
@lilypond[fragment,verbatim,relative]
c'4
-\property Voice.BreathingSign \override #'text
+\override BreathingSign #'text
= #(make-musicglyph-markup "scripts-rvarcomma")
\breathe
d4
@seealso
Internals: @internalsref{BreathingSign},
-@internalsref{BreathingSignEvent}
+@internalsref{BreathingSignEvent}.
Examples: @inputfileref{input/regression,breathing-sign.ly}.
@lilypond[fragment,relative,verbatim]
\relative c' { c1
- \property Voice.TextSpanner \set #'direction = #-1
- \property Voice.TextSpanner \set #'edge-text = #'("rall " . "")
+ \override TextSpanner #'direction = #-1
+ \override TextSpanner #'edge-text = #'("rall " . "")
c2\startTextSpan b c\stopTextSpan a }
@end lilypond
@seealso
Internals: @internalsref{HorizontalBracket},
-@internalsref{NoteGroupingEvent}
+@internalsref{NoteGroupingEvent}.
Examples: @inputfileref{input/regression,note-group-bracket.ly}.
by adding a dash and the character signifying the
articulation. They are demonstrated here:
-@lilypondfile[notexidoc]{script-abbreviations.ly}
+@lilypondfile[]{script-abbreviations.ly}
The meanings of these shorthands can be changed: see
@file{ly/script-init.ly} for examples.
@cindex coda
@cindex varcoda
-@lilypondfile[notexidoc]{script-chart.ly}
+@lilypondfile[]{script-chart.ly}
@refcommands
to note heads:
@lilypond[verbatim,raggedright,fragment,relative=1]
- \property Voice.fingeringOrientations = #'(left down)
+ \set fingeringOrientations = #'(left down)
<c-1 es-2 g-4 bes-5 > 4
- \property Voice.fingeringOrientations = #'(up right down)
+ \set fingeringOrientations = #'(up right down)
<c-1 es-2 g-4 bes-5 > 4
@end lilypond
Internals: @internalsref{FingerEvent}, and @internalsref{Fingering}.
-Examples: @inputfileref{input/regression,finger-chords.ly}
+Examples: @inputfileref{input/regression,finger-chords.ly}.
@node Text scripts
@subsection Text scripts
In this manual: @ref{Text markup}.
-Internals: @internalsref{TextScriptEvent}, @internalsref{TextScript}
+Internals: @internalsref{TextScriptEvent}, @internalsref{TextScript}.
@lilypond[fragment,verbatim,relative=1]
\new Voice {
\acciaccatura {
- \property Voice.Stem \override #'direction = #-1
+ \override Stem #'direction = #-1
f16->
- \property Voice.Stem \revert #'direction
+ \revert Stem #'direction
}
g4
}
Another option is to change the variables @code{startGraceMusic},
@code{stopGraceMusic}, @code{startAccacciaturaMusic},
@code{stopAccacciaturaMusic}, @code{startAppoggiaturaMusic},
-@code{stopAppoggiaturaMstuic}. More information is in the file
+@code{stopAppoggiaturaMusic}. More information is in the file
@file{ly/grace-init.ly}
example:
@example
- \property Staff.Hairpin \override #'minimum-length = #5
+ \override Staff.Hairpin #'minimum-length = #5
@end example
You can also use a text saying @emph{cresc.} instead of hairpins. Here
You can also supply your own texts:
@lilypond[fragment,relative,verbatim]
\context Voice {
- \property Voice.crescendoText = \markup { \italic "cresc. poco" }
- \property Voice.crescendoSpanner = #'dashed-line
+ \set crescendoText = \markup { \italic "cresc. poco" }
+ \set crescendoSpanner = #'dashed-line
a'2\< a a a\!\mf
}
@end lilypond
@lilypond[verbatim,fragment,relative=2]
c4
- \property Score.repeatCommands = #'((volta "93") end-repeat)
+ \set Score.repeatCommands = #'((volta "93") end-repeat)
c4 c4
- \property Score.repeatCommands = #'((volta #f))
+ \set Score.repeatCommands = #'((volta #f))
c4 c4
@end lilypond
Internals: tremolo beams are @internalsref{Beam} objects. Single stem
tremolos are @internalsref{StemTremolo}s. The music expression is
-@internalsref{TremoloEvent},
+@internalsref{TremoloEvent}.
Example files: @inputfileref{input/regression,chord-tremolo.ly},
@inputfileref{input/regression,stem-tremolo.ly}.
`@code{:}[@var{length}]' after the note. The length must be at least 8.
A @var{length} value of 8 gives one line across the note stem. If the
length is omitted, then then the last value (stored in
-@code{Voice.tremoloFlags}) is used:
+@code{tremoloFlags}) is used:
@lilypond[verbatim,fragment,center]
c'2:8 c':32 | c': c': |
@menu
* Showing melody rhythms::
+* Entering percussion::
* Percussion staves::
@end menu
Examples: @inputfileref{input/regression,rhythmic-staff.ly}.
-@node Percussion staves
-@subsection Percussion staves
+@node Entering percussion
+@subsection Entering percussion
+
@cindex percussion
@cindex drums
-A percussion part for more than one instrument typically uses a
-multiline staff where each position in the staff refers to one piece
-of percussion.
-
@syntax
Percussion notes may be entered in @code{\drums} mode, which is
\drums { hihat4 hh4 }
@end lilypond
+The complete list of drum names is in the init file
+@file{ly/drumpitch-init.ly}.
+@c TODO: properly document this.
+
+@seealso
+
+Internals: @internalsref{DrumNoteEvent}.
+
+@node Percussion staves
+@subsection Percussion staves
+@cindex percussion
+@cindex drums
+
+A percussion part for more than one instrument typically uses a
+multiline staff where each position in the staff refers to one piece
+of percussion.
+
+
To typeset the music, the notes must be interpreted in a
@internalsref{DrumStaff} and @internalsref{DrumVoice} contexts:
Stem \set #'Y-extent-callback = ##f
minimumVerticalExtent = #'(-4.0 . 5.0)
} \mus
- \context LyricsVoice \nam
+ \context Lyrics \nam
>>
\paper {
%% need to do this, because of indented @itemize
minimumVerticalExtent = #'(-3.0 . 4.0)
drumStyleTable = #timbales-style
} \mus
- \context LyricsVoice \nam
+ \context Lyrics \nam
>>
}
@end lilypond
Stem \set #'transparent = ##t
Stem \set #'Y-extent-callback = ##f
} \mus
- \context LyricsVoice \nam
+ \context Lyrics \nam
>>
}
@end lilypond
Stem \set #'transparent = ##t
Stem \set #'Y-extent-callback = ##f
} \mus
- \context LyricsVoice \nam
+ \context Lyrics \nam
>>
}
@end lilypond
Stem \set #'transparent = ##t
Stem \set #'Y-extent-callback = ##f
} \mus
- \context LyricsVoice \nam
+ \context Lyrics \nam
>>
}
@end lilypond
down = \drums { bd4 sn bd toml8 toml }
\score {
\new DrumStaff <<
- \property DrumStaff.drumStyleTable
- = #(alist->hash-table mydrums)
+ \set DrumStaff.drumStyleTable
+ = #(alist->hash-table mydrums)
\new DrumVoice { \voiceOne \up }
\new DrumVoice { \voiceTwo \down }
>>
@seealso
-Init files: @file{ly/drumpitch-init.ly}
+Init files: @file{ly/drumpitch-init.ly}.
-Internals: @internalsref{DrumStaff}, @internalsref{DrumVoice}
+Internals: @internalsref{DrumStaff}, @internalsref{DrumVoice}.
@refbugs
@seealso
-In this manual: @ref{Manual staff switches}
+In this manual: @ref{Manual staff switches}.
Internals: @internalsref{AutoChangeMusic}.
@code{pedalSustainStyle} property to @code{bracket} objects:
@lilypond[fragment,verbatim]
- \property Staff.pedalSustainStyle = #'bracket
+ \set Staff.pedalSustainStyle = #'bracket
c''4\sustainDown d''4 e''4
a'4\sustainUp\sustainDown
f'4 g'4 a'4\sustainUp
@code{mixed}:
@lilypond[fragment,verbatim]
- \property Staff.pedalSustainStyle = #'mixed
+ \set Staff.pedalSustainStyle = #'mixed
c''4\sustainDown d''4 e''4
c'4\sustainUp\sustainDown
f'4 g'4 a'4\sustainUp
bracket may be extended to the end of the note head:
@lilypond[fragment,verbatim]
-\property Staff.PianoPedalBracket \override
+\override Staff.PianoPedalBracket
#'shorten-pair = #'(0 . -1.0)
c''4\sostenutoDown d''4 e''4 c'4
f'4 g'4 a'4\sostenutoUp
@lilypond[fragment,relative,verbatim]
\context PianoStaff <<
- \property PianoStaff.connectArpeggios = ##t
+ \set PianoStaff.connectArpeggios = ##t
\new Staff { <c' e g c>\arpeggio }
\new Staff { \clef bass <c,, e g>\arpeggio }
>>
@lilypond[fragment,relative,verbatim]
\context Voice {
- \property Voice.Arpeggio \set #'arpeggio-direction = #1
+ \override Arpeggio #'arpeggio-direction = #1
<c e g c>\arpeggio
- \property Voice.Arpeggio \set #'arpeggio-direction = #-1
+ \override Arpeggio #'arpeggio-direction = #-1
<c e g c>\arpeggio
}
@end lilypond
A square bracket on the left indicates that the player should not
arpeggiate the chord. To draw these brackets, set the
-@code{molecule-callback} property of @code{Arpeggio} or
+@code{print-function} property of @code{Arpeggio} or
@code{PianoStaff.Arpeggio} objects to @code{\arpeggioBracket}, and use
@code{\arpeggio} statements within the chords as before:
@lilypond[fragment,relative,verbatim]
- \property PianoStaff.Arpeggio \override
- #'molecule-callback = \arpeggioBracket
+ \override PianoStaff.Arpeggio
+ #'print-function = \arpeggioBracket
<c' e g c>\arpeggio
@end lilypond
@lilypond[fragment,relative,verbatim]
\context PianoStaff <<
- \property PianoStaff.followVoice = ##t
+ \set PianoStaff.followVoice = ##t
\context Staff \context Voice {
c1
\change Staff=two
resulting string. As a consequence, spaces must be inserted around
@code{\property} commands:
@example
- \property Lyrics . LyricText \set #'font-shape = #'italic
+ \override Lyrics .LyricText #'font-shape = #'italic
@end example
@cindex @code{_}
Internals: @internalsref{LyricEvent}, @internalsref{HyphenEvent}, and
@internalsref{ExtenderEvent}.
+Examples: @inputfileref{input/test,lyric-hyphen-retain.ly}.
+
@refbugs
The definition of lyrics mode is too complex.
@node The Lyrics context
@subsection The Lyrics context
-Lyrics are printed by interpreting them in a @internalsref{LyricsVoice} context:
+Lyrics are printed by interpreting them in a @internalsref{Lyrics} context:
@example
- \context LyricsVoice \lyrics @dots{}
+ \context Lyrics \lyrics @dots{}
@end example
@cindex automatic syllable durations
correct duration for each syllable. This is achieved by combining the
melody and the lyrics with the @code{\lyricsto} expression:
@example
-\lyricsto @var{name} \new LyricsVoice @dots{}
+\lyricsto @var{name} \new Lyrics @dots{}
@end example
This aligns the lyrics to the
hierarchy of staves and lyrics first, e.g.
@example
\context ChoirStaff \notes <<
- \context LyricsVoice = sopranoLyrics @{ s1 @}
+ \context Lyrics = sopranoLyrics @{ s1 @}
\context Voice = soprano @{ @emph{music} @}
- \context LyricsVoice = tenor @{ s1 @}
+ \context Lyrics = tenor @{ s1 @}
\context Voice = tenorLyrics @{ @emph{music} @}
>>
@end example
and then combine the appropriate melodies and lyric lines:
@example
- \lyricsto "soprano" \new LyricsVoice @emph{the lyrics}
+ \lyricsto "soprano" \new Lyrics @emph{the lyrics}
@end example
@noindent
f e f
\melismaEnd
e2 }
- \lyricsto "lala" \new LyricsVoice \lyrics {
+ \lyricsto "lala" \new Lyrics \lyrics {
la di __ daah
} >>
@end lilypond
When multiple stanzas are put on the same melody, it can happen that
two stanzas have melismata in different locations. This can be
remedied by switching off melismata for one
-@internalsref{LyricsVoice}. This is achieved by setting
+@internalsref{Lyrics}. This is achieved by setting
the @code{ignoreMelismata} property to @code{#t}. An example is shown
in @inputfileref{input/regression,lyric-combine-new.ly}.
A complete example of a SATB score setup is in the file
@inputfileref{input/template,satb.ly}.
+
@refcommands
@code{\melisma}, @code{\melismaEnd}
@seealso
Internals: Music expressions: @internalsref{LyricCombineMusic},
-Contexts: @internalsref{LyricsVoice}, @internalsref{Melisma_engraver}.
+Contexts: @internalsref{Lyrics}, @internalsref{Melisma_engraver}.
Examples: @inputfileref{input/template,satb.ly},
@inputfileref{input/regression,lyric-combine-new.ly}.
For proper processing of extender lines, the
-@internalsref{LyricsVoice} and @internalsref{Voice} should be
+@internalsref{Lyrics} and @internalsref{Voice} should be
linked. This can be achieved either by using @code{\lyricsto} or by
setting corresponding names for both contexts. The latter is explained
in @ref{More stanzas}.
g2 e4 a2 f4 g2. @}
@end example
-Then set the @internalsref{LyricsVoice} contexts to names starting with
+Then set the @internalsref{Lyrics} contexts to names starting with
that identity followed by a dash. In the preceding example, the
@internalsref{Voice} identity is @code{duet}, so the identities of the
-@internalsref{LyricsVoice}s are marked @code{duet-1} and @code{duet-2}:
+@internalsref{Lyrics}s are marked @code{duet-1} and @code{duet-2}:
@example
- \context LyricsVoice = "duet-1" @{
+ \context Lyrics = "duet-1" @{
Hi, my name is bert. @}
- \context LyricsVoice = "duet-2" @{
+ \context Lyrics = "duet-2" @{
Ooooo, ch\'e -- ri, je t'aime. @}
@end example
\score {
<< \notes \relative c'' \context Voice = duet { \time 3/4
g2 e4 a2 f4 g2. }
- \lyrics << \lyricsto "duet" \new LyricsVoice {
- \property LyricsVoice . stanza = "1"
+ \lyrics << \lyricsto "duet" \new Lyrics {
+ \set stanza = "1"
Hi, my name is bert. }
- \lyricsto "duet" \new LyricsVoice {
- \property LyricsVoice . stanza = "2"
+ \lyricsto "duet" \new Lyrics {
+ \set stanza = "2"
Ooooo, ch\'e -- ri, je t'aime. }
>> >>
}
@cindex singer's names
@cindex name of singer
-Stanza numbers can be added by setting @code{LyricsVoice.stanza}, e.g.
+Stanza numbers can be added by setting @code{stanza}, e.g.
@example
- \property LyricsVoice . stanza = "Bert"
+ \set stanza = "Bert"
@dots{}
- \property LyricsVoice . stanza = "Ernie"
+ \set stanza = "Ernie"
@end example
Notice how dots are surrounded with spaces in @code{\lyrics} mode, to
-prevent @code{LyricsVoice.stanza} being interpreted as a single
+prevent @code{stanza} being interpreted as a single
string.
-Names of the singers should be added using @code{LyricsVoice
-. vocalName} and @code{LyricsVoice . vocNam}, analogous to instrument
+Names of the singers should be added using @code{Lyrics
+. vocalName} and @code{Lyrics . vocNam}, analogous to instrument
annotations for staves.
To make empty spaces in lyrics, use @code{\skip}.
@end example
This results in the following output:
+
@lilypond[raggedright]
upper = \notes \relative c {
\clef "treble"
@seealso
-Internals: @internalsref{Ambitus}
+Internals: @internalsref{Ambitus}.
Examples: @inputfileref{input/regression,ambitus.ly},
@inputfileref{input/test,ambitus-mixed.ly}.
@example
e8 fis gis a b cis' dis' e'
-\property TabStaff.minimumFret = #8
+\set TabStaff.minimumFret = #8
e8 fis gis a b cis' dis' e'
@end example
@lilypond[noindent]
frag = \notes {
\key e \major
e8 fis gis a b cis' dis' e'
- \property TabStaff.minimumFret = #8
+ \set TabStaff.minimumFret = #8
e8 fis gis a b cis' dis' e'
}
\score {
@lilypond[fragment,verbatim]
\context TabStaff <<
- \property TabStaff.stringTunings = #'(-5 -10 -15 -20)
+ \set TabStaff.stringTunings = #'(-5 -10 -15 -20)
\notes {
a,4 c' a e' e c' a e'
\score {
\notes <<
\context ChordNames {
- \property ChordNames.chordChanges = ##t
+ \set chordChanges = ##t
\scheme }
\context Staff \transpose c c' \scheme
>>
@lilypond[fragment,verbatim]
\context ChordNames \chords {
c:7sus4
- \property ChordNames.chordNameSeparator
- = \markup { \typewriter "|" }
+ \set chordNameSeparator
+ = \markup { \typewriter "|" }
c:7sus4 }
@end lilypond
few measures, it is set to function that produces a boxed number.
@lilypond[verbatim,fragment,relative=1]
- \property Score.markFormatter = #format-mark-numbers
+ \set Score.markFormatter = #format-mark-numbers
c1 \mark \default
c1 \mark \default
- \property Score.markFormatter
- = #(lambda (mark context)
+ \set Score.markFormatter
+ = #(lambda (mark context)
(make-bold-markup (make-box-markup (number->string mark))))
c1 \mark \default
c1 \mark \default
end of the line, and not at the beginning. Use the following to force
that behavior:
@example
-\property Score.RehearsalMark \override
+\override Score.RehearsalMark
#'break-visibility = #begin-of-line-invisible
@end example
whose source is available as
@inputfileref{input/test,bar-number-regular-interval.ly}:
-@lilypondfile[notexidoc]{bar-number-regular-interval.ly}
+@lilypondfile[]{bar-number-regular-interval.ly}
@seealso
@quotation
@lilypond[verbatim,raggedright]
- \property Staff.instrument = "ploink " { c''4 }
+ \set Staff.instrument = "ploink " { c''4 }
@end lilypond
@end quotation
@quotation
@lilypond[fragment,verbatim,raggedright]
\notes {
- \property Staff.instrument = \markup {
+ \set Staff.instrument = \markup {
\column < "Clarinetti"
{ "in B"
\smaller \musicglyph #"accidentals--1"
@lilypond[fragment,verbatim]
\time 4/4 r1 | R1 | R1*2
- \property Score.skipBars = ##t R1*17 R1*4
+ \set Score.skipBars = ##t R1*17 R1*4
@end lilypond
The @code{1} in @code{R1} is similar to the duration notation used for
durations. This can be done with augmentation dots or fractions:
@lilypond[fragment,verbatim]
- \property Score.skipBars = ##t
+ \set Score.skipBars = ##t
\time 3/4
R2. | R2.*2
\time 13/8
@lilypond[verbatim,raggedright,fragment]
\new Staff <<
- \property Staff.soloADue = ##f
+ \set Staff.soloADue = ##f
\partcombine
{
g a( b) r
off, the part combiner may typeset @code{a2} more than once in a
measure.
+@code{\partcombine} can not be inside @code{\times}.
+
@node Hiding staves
In orchestral scores, staff lines that only have rests are usually
removed. This saves some space. This style is called `French Score'.
-For @internalsref{Lyrics}, @internalsref{LyricsVoice},
+For @internalsref{Lyrics}, @internalsref{Lyrics},
@internalsref{ChordNames} and @internalsref{FiguredBass}, this is
switched on by default. When these line of these contexts turn out
empty after the line-breaking process, they are removed.
\tag #'part <<
R1 \\
@{
- \property Voice.fontSize = #-1
+ \set fontSize = #-1
c4_"cue" f2 g4 @}
>>
\tag #'score R1
@end example
would yield
-@lilypondfile[notexidoc]{tag-filter.ly}
+@lilypondfile[]{tag-filter.ly}
The argument of the @code{\tag} command should be a symbol, or a list
of symbols, for example,
@seealso
-Examples: @inputfileref{input/regression,tag-filter.ly}
+Examples: @inputfileref{input/regression,tag-filter.ly}.
@node Sound output for transposing instruments
@cindex @code{transposing}
@example
- \property Staff.instrument = #"Cl. in B-flat"
- \property Staff.transposing = #-2
+ \set Staff.instrument = #"Cl. in B-flat"
+ \set Staff.transposing = #-2
@end example
The following example demonstrates the @code{neo_mensural} style:
@lilypond[fragment,raggedright,verbatim]
- \property Voice.NoteHead \set #'style = #'neo_mensural
+ \override NoteHead #'style = #'neo_mensural
a'\longa a'\breve a'1 a'2 a'4 a'8 a'16
@end lilypond
accidentals. @ref{Key signature} gives a general introduction into
the use of key signatures.
-Internals: @internalsref{KeySignature}
+Internals: @internalsref{KeySignature}.
Examples: @inputfileref{input/test,ancient-accidentals.ly}.
The following example demonstrates the @code{neo_mensural} style:
@lilypond[fragment,raggedright,verbatim]
- \property Voice.Rest \set #'style = #'neo_mensural
+ \override Rest #'style = #'neo_mensural
r\longa r\breve r1 r2 r4 r8 r16
@end lilypond
@code{neo_mensural_c1}, @code{neo_mensural_c2},
@code{neo_mensural_c3}, @code{neo_mensural_c4} @tab
@lilypond[relative,notime]
-\property Staff.TimeSignature \set #'transparent = ##t
+\override Staff.TimeSignature #'transparent = ##t
\clef "neo_mensural_c2" c
@end lilypond
@tab
@lilypond[relative,notime]
-\property Staff.TimeSignature \set #'transparent = ##t
+\override Staff.TimeSignature #'transparent = ##t
\clef "petrucci_c2" c
@end lilypond
petrucci style mensural F clef @tab
@code{petrucci_f} @tab
@lilypond[relative,notime]
-\property Staff.TimeSignature \set #'transparent = ##t
+\override Staff.TimeSignature #'transparent = ##t
\clef "petrucci_f" c
@end lilypond
petrucci style mensural G clef @tab
@code{petrucci_g} @tab
@lilypond[relative,notime]
-\property Staff.TimeSignature \set #'transparent = ##t
+\override Staff.TimeSignature #'transparent = ##t
\clef "petrucci_g" c
@end lilypond
@code{mensural_c1}, @code{mensural_c2}, @code{mensural_c3},
@code{mensural_c4} @tab
@lilypond[relative,notime]
-\property Staff.TimeSignature \set #'transparent = ##t
+\override Staff.TimeSignature #'transparent = ##t
\clef "mensural_c2" c
@end lilypond
historic style mensural F clef @tab
@code{mensural_f} @tab
@lilypond[relative,notime]
-\property Staff.TimeSignature \set #'transparent = ##t
+\override Staff.TimeSignature #'transparent = ##t
\clef "mensural_f" c
@end lilypond
historic style mensural G clef @tab
@code{mensural_g} @tab
@lilypond[relative,notime]
-\property Staff.TimeSignature \set #'transparent = ##t
+\override Staff.TimeSignature #'transparent = ##t
\clef "mensural_g" c
@end lilypond
Editio Vaticana style do clef @tab
@code{vaticana_do1}, @code{vaticana_do2}, @code{vaticana_do3} @tab
@lilypond[relative,notime]
- \property Staff.StaffSymbol \set #'line-count = #4
-\property Staff.TimeSignature \set #'transparent = ##t
+ \override Staff.StaffSymbol #'line-count = #4
+\override Staff.TimeSignature #'transparent = ##t
\clef "vaticana_do2" c
@end lilypond
Editio Vaticana style fa clef @tab
@code{vaticana_fa1}, @code{vaticana_fa2} @tab
@lilypond[relative,notime]
- \property Staff.StaffSymbol \set #'line-count = #4
-\property Staff.TimeSignature \set #'transparent = ##t
+ \override Staff.StaffSymbol #'line-count = #4
+\override Staff.TimeSignature #'transparent = ##t
\clef "vaticana_fa2" c
@end lilypond
Editio Medicaea style do clef @tab
@code{medicaea_do1}, @code{medicaea_do2}, @code{medicaea_do3} @tab
@lilypond[relative,notime]
- \property Staff.StaffSymbol \set #'line-count = #4
-\property Staff.TimeSignature \set #'transparent = ##t
+ \override Staff.StaffSymbol #'line-count = #4
+\override Staff.TimeSignature #'transparent = ##t
\clef "medicaea_do2" c
@end lilypond
Editio Medicaea style fa clef @tab
@code{medicaea_fa1}, @code{medicaea_fa2} @tab
@lilypond[relative,notime]
- \property Staff.StaffSymbol \set #'line-count = #4
-\property Staff.TimeSignature \set #'transparent = ##t
+ \override Staff.StaffSymbol #'line-count = #4
+\override Staff.TimeSignature #'transparent = ##t
\clef "medicaea_fa2" c
@end lilypond
historic style hufnagel do clef @tab
@code{hufnagel_do1}, @code{hufnagel_do2}, @code{hufnagel_do3} @tab
@lilypond[relative,notime]
- \property Staff.StaffSymbol \set #'line-count = #4
-\property Staff.TimeSignature \set #'transparent = ##t
+ \override Staff.StaffSymbol #'line-count = #4
+\override Staff.TimeSignature #'transparent = ##t
\clef "hufnagel_do2" c
@end lilypond
historic style hufnagel fa clef @tab
@code{hufnagel_fa1}, @code{hufnagel_fa2} @tab
@lilypond[relative,notime]
- \property Staff.StaffSymbol \set #'line-count = #4
-\property Staff.TimeSignature \set #'transparent = ##t
+ \override Staff.StaffSymbol #'line-count = #4
+\override Staff.TimeSignature #'transparent = ##t
\clef "hufnagel_fa2" c
@end lilypond
historic style hufnagel combined do/fa clef @tab
@code{hufnagel_do_fa} @tab
@lilypond[relative,notime]
-\property Staff.TimeSignature \set #'transparent = ##t
+\override Staff.TimeSignature #'transparent = ##t
\clef "hufnagel_do_fa" c
@end lilypond
@c Supported clefs:
@c @code{percussion}
@c
-@c @lilypond{\property Staff.TimeSignature \set #'transparent = ##t \clef "percussion" c'}
+@c @lilypond{\override Staff.TimeSignature #'transparent = ##t \clef "percussion" c'}
@c
@c @item modern style tab clef (glyph: @code{clefs-tab})
@c
@c Supported clefs:
@c @code{tab}
@c
-@c @lilypond{\context Staff \outputproperty #(make-type-checker 'staff-symbol-interface) #'line-count = #6 \property Staff.TimeSignature \set #'transparent = ##t \clef "tab" c'}
+@c @lilypond{\context Staff \outputproperty #(make-type-checker 'staff-symbol-interface) #'line-count = #6 \override Staff.TimeSignature #'transparent = ##t \clef "tab" c'}
@emph{Modern style} means ``as is typeset in contemporary editions of
transcribed mensural music''.
only @code{mensural} style is supported:
@lilypond[fragment,raggedright,verbatim]
- \property Voice.Stem \set #'flag-style = #'mensural
- \property Voice.Stem \set #'thickness = #1.0
- \property Voice.NoteHead \set #'style = #'mensural
+ \override Stem #'flag-style = #'mensural
+ \override Stem #'thickness = #1.0
+ \override NoteHead #'style = #'mensural
\autoBeamOff
c'8 d'8 e'8 f'8 c'16 d'16 e'16 f'16 c'32 d'32 e'32 f'32 s8
c''8 d''8 e''8 f''8 c''16 d''16 e''16 f''16 c''32 d''32 e''32 f''32
notes between staff lines:
@lilypond[fragment,raggedright]
- \property Voice.Stem \set #'flag-style = #'mensural
- \property Voice.Stem \set #'thickness = #1.0
- \property Voice.Stem \set #'adjust-if-on-staffline = ##f
- \property Voice.NoteHead \set #'style = #'mensural
+ \override Stem #'flag-style = #'mensural
+ \override Stem #'thickness = #1.0
+ \override Stem #'adjust-if-on-staffline = ##f
+ \override NoteHead #'style = #'mensural
\autoBeamOff
c'8 d'8 e'8 f'8 c'16 d'16 e'16 f'16 c'32 d'32 e'32 f'32 s8
c''8 d''8 e''8 f''8 c''16 d''16 e''16 f''16 c''32 d''32 e''32 f''32
@lilypond
\score {
\notes {
- \property Score.timing = ##f
- \property Score.barAlways = ##t
+ \set Score.timing = ##f
+ \set Score.barAlways = ##t
s_\markup { "$\\backslash$time 4/4" }
^\markup { " " \musicglyph #"timesig-neo_mensural4/4" }
s
\score {
\notes {
a'1
- \property Staff.Custos \set #'style = #'mensural
+ \override Staff.Custos #'style = #'mensural
\break
g'
}
@seealso
-Internals: @internalsref{Custos}
+Internals: @internalsref{Custos}.
Examples: @inputfileref{input/regression,custos.ly}.
Therefore, @code{gregorian-init.ly} also defines @code{\virgula} and
@code{\caesura}:
-@lilypondfile[notexidoc]{divisiones.ly}
+@lilypondfile[]{divisiones.ly}
@refcommands
In this manual: @ref{Breath marks}.
-Internals: @internalsref{BreathingSign}, @internalsref{BreathingSignEvent},
+Internals: @internalsref{BreathingSign}, @internalsref{BreathingSignEvent}.
-Examples: @inputfileref{input/test,divisiones.ly}
+Examples: @inputfileref{input/test,divisiones.ly}.
@node Ligatures
@subsection Ligatures
For example,
@example
- \property Score.timing = ##f
- \property Score.defaultBarType = "empty"
- \property Voice.NoteHead \set #'style = #'neo_mensural
- \property Staff.TimeSignature \set #'style = #'neo_mensural
+ \set Score.timing = ##f
+ \set Score.defaultBarType = "empty"
+ \override NoteHead #'style = #'neo_mensural
+ \override Staff.TimeSignature #'style = #'neo_mensural
\clef "petrucci_g"
\[ g\longa c\breve a\breve f\breve d'\longa \]
s4
@lilypond[raggedright]
\score {
\notes \transpose c c' {
- \property Score.timing = ##f
- \property Score.defaultBarType = "empty"
- \property Voice.NoteHead \set #'style = #'neo_mensural
- \property Staff.TimeSignature \set #'style = #'neo_mensural
+ \set Score.timing = ##f
+ \set Score.defaultBarType = "empty"
+ \override NoteHead #'style = #'neo_mensural
+ \override Staff.TimeSignature #'style = #'neo_mensural
\clef "petrucci_g"
\[ g\longa c\breve a\breve f\breve d'\longa \]
s4
@lilypond[raggedright]
\score {
\notes \transpose c c' {
- \property Score.timing = ##f
- \property Score.defaultBarType = "empty"
- \property Voice.NoteHead \set #'style = #'neo_mensural
- \property Staff.TimeSignature \set #'style = #'neo_mensural
+ \set Score.timing = ##f
+ \set Score.defaultBarType = "empty"
+ \override NoteHead #'style = #'neo_mensural
+ \override Staff.TimeSignature #'style = #'neo_mensural
\clef "petrucci_g"
\[ g\longa c\breve a\breve f\breve d'\longa \]
s4
\score {
<<
\context VaticanaVoice = "cantus" {
- \property Score.BarNumber \set #'transparent = ##t
+ \override Score.BarNumber #'transparent = ##t
\notes {
\[ c'\melisma c' \flexa a \] \[ a \flexa \deminutum g\melismaEnd \] f \divisioMinima
\[ f\melisma \pes a c' c' \pes d'\melismaEnd \] c' \divisioMinima \break
\[ c'\melisma c' \flexa a \] \[ a \flexa \deminutum g\melismaEnd \] f \divisioMinima
}
}
- \lyricsto "cantus" \new LyricsVoice \lyrics {
+ \lyricsto "cantus" \new Lyrics \lyrics {
San- ctus, San- ctus, San- ctus
} >>
@inputfileref{input/regression,cluster.ly}) shows what the result
looks like:
-@lilypondfile[notexidoc]{cluster.ly}
+@lilypondfile[]{cluster.ly}
By default, @internalsref{Cluster_spanner_engraver} is in the
@internalsref{Voice} context. This allows putting ordinary notes and
_\verylongfermata
r
}
- \context LyricsVoice \lyrics {
+ \context Lyrics \lyrics {
"shortfermata" "fermata" "longfermata" "verylongfermata"
} >>
}
@seealso
-Internals: @internalsref{text-balloon-interface}
+Internals: @internalsref{text-balloon-interface}.
-Examples: @inputfileref{input/regression,balloon.ly}
+Examples: @inputfileref{input/regression,balloon.ly}.
@node Easy Notation note heads
@subsection Easy Notation note heads
properties. Translation properties always use a mixed caps style
naming, and are manipulated using @code{\property}:
@example
- \property Context.propertyName = @var{value}
+ \set Context.propertyName = @var{value}
@end example
Layout properties are use Scheme style variable naming, i.e. lower
* Constructing a tweak::
* Applyoutput::
* Font selection::
-* Text markup::
@end menu
@code{\once}:
@example
-\once \property @var{context}.@var{objectname}
- \override @var{symbol} = @var{value}
+\once \override @var{context}.@var{objectname}
+ @var{symbol} = @var{value}
@end example
Here @var{symbol} is a Scheme expression of symbol type, @var{context}
and @var{objectname} is a string and @var{value} is a Scheme expression.
@lilypond[verbatim,fragment,relative=1]
c4
- \once \property Voice.Stem \set #'thickness = #4
+ \once \override Stem #'thickness = #4
c4
c4
@end lilypond
For changing more objects, the same command, without @code{\once} can
be used:
@example
-\property @var{context}.@var{objectname} \override @var{symbol} = @var{value}
+\override @var{context}.@var{objectname} @var{symbol} = @var{value}
@end example
This command adds @code{@var{symbol} = @var{value}} to the definition
of @var{objectname} in the context @var{context}, and this definition
and is often more convenient to use
@example
-\property @var{context}.@var{objectname} \set @var{symbol} = @var{value}
+\override @var{context}.@var{objectname} @var{symbol} = @var{value}
@end example
Some examples:
@lilypond[verbatim,quote]
-c'4 \property Voice.Stem \override #'thickness = #4.0
+c'4 \override Stem #'thickness = #4.0
c'4
-c'4 \property Voice.Stem \revert #'thickness
+c'4 \revert Stem #'thickness
c'4
@end lilypond
one (assuming the system default for stem thickness is 1.3):
@c
@lilypond[verbatim,quote]
- c'4 \property Voice.Stem \set #'thickness = #4.0
+ c'4 \override Stem #'thickness = #4.0
c'4
- c'4 \property Voice.Stem \set #'thickness = #1.3
+ c'4 \override Stem #'thickness = #1.3
c'4
@end lilypond
@code{\override} and @code{\revert} are push and pop operations. The
association list is stored in a normal context property, hence
@example
- \property Voice.NoteHead = #'()
+ \set NoteHead = #'()
@end example
will effectively erase @internalsref{NoteHead}s from the current
@internalsref{Voice}. Typically, this will blank the object. However,
crashes. Reverting properties that are system defaults may also lead
to crashes.
-A property tweak of modifies a local copy of the object definition.
-After such a tweak, the definition is independent of the objects in
-enclosing contexts. For example
-
-@lilypond[verbatim,fragment]
- \property Voice.Stem \set #'direction = #UP
- d''4
- \property Staff.Stem \set #'thickness = #4.0
- d''8
- \new Voice { d'32 }
-@end lilypond
-
-In this fragment, @code{direction} is tweaked. As a result, the
-current @internalsref{Voice} gets a private version of the
-@internalsref{Stem} object. The following tweak modifies the
-definition at @internalsref{Staff} level. Since it a different
-definition, the thickness of the first @code{d'} is unaffected. For
-the third note, a new Voice is created, which inherits the new
-definition, including the changed thickness, but excluding the new
-neutral direction.
-
-
-
@menu
* Constructing a tweak::
* Applyoutput::
fingering. The following command inserts 3 staff spaces of white
between the note and the fingering:
@example
-\once \property Voice.Fingering \set #'padding = #3
+\once \override Fingering #'padding = #3
@end example
Inserting this command before the Fingering object is created,
i.e. before @code{c2}, yields the following result:
@lilypond[relative=2,fragment,verbatim]
-\once \property Voice.Fingering
- \set #'padding = #3
+\once \override Fingering
+ #'padding = #3
c-2
\stemUp
f
@end example
so tuning the settings for Fingering should be done with
@example
- \property Voice.Fingering \set @dots{}
+ \override Fingering @dots{}
@end example
Of course, the tweak may also done in a larger context than
example is given below:
@c
@lilypond[fragment,relative=1,verbatim,quote]
- c4 c4 \property Voice.fontSize = #-1
+ c4 c4 \set fontSize = #-1
f4 g4
@end lilypond
This command will set @code{font-size} (see below), and does
The font used for printing a object can be selected by setting
@code{font-name}, e.g.
@example
- \property Staff.TimeSignature
- \set #'font-name = #"cmr17"
+ \override Staff.TimeSignature
+ #'font-name = #"cmr17"
@end example
@noindent
@code{*}, entered as @code{#'*}), acts as a wildcard. This can be used
to override default setting, which are always present. For example:
@example
- \property Lyrics . LyricText \override #'font-series = #'bold
- \property Lyrics . LyricText \override #'font-family = #'typewriter
- \property Lyrics . LyricText \override #'font-shape = #'*
+ \override Lyrics .LyricText #'font-series = #'bold
+ \override Lyrics .LyricText #'font-family = #'typewriter
+ \override Lyrics .LyricText #'font-shape = #'*
@end example
@cindex @code{font-style}
@node Text markup
-@subsection Text markup
+@section Text markup
@cindex text markup
@cindex markup text
@noindent
For clarity, you can also do this for single arguments, e.g.
-@example
- \markup @{ is \italic @{ anyone @} home @}
-@end example
-
-@cindex font size, texts
-
-The following size commands set absolute sizes:
-
-@cindex @code{\teeny}
-@cindex @code{\tiny}
-@cindex @code{\small}
-@cindex @code{\large}
-@cindex @code{\huge}
-
-@table @code
-@item \teeny
-@item \tiny
-@item \small
-@item \large
-@item \huge
-@end table
-
-You can also make letter larger or smaller relative to their neighbors,
-with the commands @code{\larger} and @code{\smaller}.
-@cindex smaller
-@cindex larger
-
-@cindex font style, for texts
-@cindex @code{\bold}
-@cindex @code{\dynamic}
-@cindex @code{\number}
-@cindex @code{\italic}
-
-The following font change commands are defined:
-@table @code
-@item \dynamic
-changes to the font used in dynamic signs. This font does not
-contain all characters of the alphabet, so when producing ``piu f'',
-the ``piu'' should be done in a different font.
-
-
-@item \number
-changes to the font used in time signatures. It only contains
-numbers and a few punctuation marks.
-@item \italic
-changes @code{font-shape} to @code{italic}.
-@item \bold
-changes @code{font-series} to @code{bold}.
-@end table
-
-@cindex raising text
-@cindex lowering text
-@cindex moving text
-@cindex translating text
-
-@cindex @code{\sub}
-@cindex @code{\super}
-
-Raising and lowering texts can be done with @code{\super} and
-@code{\sub}:
-
-@lilypond[verbatim,fragment,relative=1]
- c1^\markup { E "=" mc \super "2" }
-@end lilypond
-
-@cindex @code{\raise}
-
-If you want to give an explicit amount for lowering or raising, use
-@code{\raise}. This command takes a Scheme valued first argument, and
-a markup object as second argument:
-@c
-@lilypond[verbatim,fragment,relative=1,quote]
- c1^\markup { C \small \raise #1.0 \bold { "9/7+" }}
-@end lilypond
-The argument to @code{\raise} is the vertical displacement amount,
-measured in (global) staff spaces. @code{\raise} and @code{\super}
-raise objects in relation to their surrounding markups. They cannot be
-used to move a single text up or down, when it is above or below a
-note, since the mechanism that positions it next to the note cancels
-any vertical shift. For vertical positioning, use the @code{padding}
-and/or @code{extra-offset} properties.
-
-Other commands taking single arguments include
-@table @code
-
-@item \bracket, \hbracket
- Bracket the argument markup with normal and horizontal brackets
-respectively.
-
-@item \musicglyph
-@cindex @code{\musicglyph}
- This is converted to a musical symbol, e.g. @code{\musicglyph
-#"accidentals-0"} will select the natural sign from the music font.
-See @ref{The Feta font} for a complete listing of the possible glyphs.
-
-@item \char
-This produces a single character, e.g. @code{\char #65} produces the
-letter 'A'.
-
-@item \note @var{duration} @var{dir}
-@cindex @code{\note}
-
-This produces a note with a stem pointing in @var{dir} direction, with
-the @var{duration} for the note head type and augmentation dots. For
-example, @code{\note #"4." #-0.75} creates a dotted quarter note, with
-a shortened down stem.
-
-@item \hspace #@var{amount}
-@cindex @code{\hspace}
-This produces a invisible object taking horizontal space.
-@example
-\markup @{ A \hspace #2.0 B @}
-@end example
-will put extra space between A and B, on top of the space that is
-normally inserted before elements on a line.
-
-@item \fontsize #@var{size}
-@cindex @code{\fontsize}
-This sets the relative font size, eg.
-@example
-A \fontsize #2 @{ B C @} D
-@end example
-
-This will enlarge the B and the C by two steps.
-@item \translate #(cons @var{x} @var{y})
-@cindex \translate
-This translates an object. Its first argument is a cons of numbers
-@example
-A \translate #(cons 2 -3) @{ B C @} D
-@end example
-This moves `B C' 2 spaces to the right, and 3 down, relative to its
-surroundings. This command cannot be used to move isolated scripts
-vertically, for the same reason that @code{\raise} cannot be used for
-that.
-
-@item \magnify #@var{mag}
-@cindex @code{\magnify}
-This sets the font magnification for the its argument. In the following
-example, the middle A will be 10% larger:
-@example
-A \magnify #1.1 @{ A @} A
-@end example
+@verbatim
+ \markup { is \italic { anyone } home }
+@end verbatim
+@cindex font size, texts
-@item \override #(@var{key} . @var{value})
-@cindex @code{\override}
-This overrides a formatting property for its argument. The argument
-should be a key/value pair, e.g.
-@example
- m \override #'(font-family . math) m m
-@end example
-@end table
In markup mode you can compose expressions, similar to mathematical
expressions, XML documents and music expressions. The braces group
\notes { a^\allegro b c d }
@end verbatim
-The markup mechanism is extensible. Refer to
-@file{scm/new-markup.scm} for more information.
-
Some objects have alignment procedures of their own, which cancel out
any effects of alignments applied to their markup arguments as a
with @code{\raise}. For moving and aligning complete objects, grob
properties should be used.
-@seealso
-Internals: @internalsref{Markup-functions} contains a complete list of
-all markup commands.
-Init files: @file{scm/new-markup.scm}.
+@seealso
-@refbugs
+Init files: @file{scm/new-markup.scm}.
-@cindex kerning
+@refbugs
Text layout is ultimately done by @TeX{}, which does kerning of
letters. LilyPond does not account for kerning, so texts will be
+@menu
+* Overview of text markup commands::
+* Markup construction in scheme::
+* Markup command definition::
+@end menu
+
+@node Overview of text markup commands
+@subsection Overview of text markup commands
+
+@include markup-commands.tely
+
+@node Markup construction in scheme
+@subsection Markup construction in scheme
+
+@cindex defining markup commands
+
+The @code{markup} macro builds markup expressions in Scheme while
+providing a LilyPond-like syntax. For example,
+@example
+(markup #:column (#:line (#:bold #:italic "hello" #:raise 0.4 "world")
+ #:bigger #:line ("foo" "bar" "baz")))
+@end example
+
+@noindent
+is equivalent to:
+@example
+\markup \column < @{ \bold \italic "hello" \raise #0.4 "world" @}
+ \bigger @{ foo bar baz @} >
+@end example
+
+@noindent
+This example exposes the main translation rules between regular
+LilyPond markup syntax and scheme markup syntax, which are summed up
+is this table:
+@multitable @columnfractions .5 .5
+@item @b{LilyPond} @tab @b{Scheme}
+@item @code{\command} @tab @code{#:command}
+@item @code{\variable} @tab @code{variable}
+@item @code{@{ ... @}} @tab @code{#:line ( ... )}
+@item @code{\center < ... >} @tab @code{#:center ( ... )}
+@item @code{string} @tab @code{"string"}
+@item @code{#scheme-arg} @tab @code{scheme-arg}
+@end multitable
+
+Besides, the whole scheme language is accessible inside the
+@code{markup} macro: thus, one may use function calls inside
+@code{markup} in order to manipulate character strings for
+instance. This proves useful when defining new markup commands (see
+@ref{Markup command definition}).
+
+@refbugs
+
+One can not feed the @code{#:line} (resp @code{#:center},
+@code{#:column}) command with a variable or the result of a function
+call. Eg:
+@lisp
+(markup #:line (fun-that-returns-markups))
+@end lisp
+is illegal. One should use the @code{make-line-markup} (resp
+@code{make-center-markup}, @code{make-column-markup}) function
+instead:
+@lisp
+(markup (make-line-markup (fun-that-returns-markups)))
+@end lisp
+
+@node Markup command definition
+@subsection Markup command definition
+
+New markup commands can be defined thanks to the @code{def-markup-command} scheme macro.
+@lisp
+(def-markup-command (@var{command-name} @var{paper} @var{props} @var{arg1} @var{arg2} ...)
+ (@var{arg1-type?} @var{arg2-type?} ...)
+ ..command body..)
+
+ @var{argi}: i@var{th} command argument
+ @var{argi-type?}: a type predicate for the i@var{th} argument
+ @var{paper}: the `paper' definition
+ @var{props}: a list of alists, containing all active properties.
+@end lisp
+
+As a simple example, we show how to add a @code{\smallcaps} command,
+which selects @TeX{}'s small caps font. Normally, we could select the
+small caps font as follows:
+
+@verbatim
+ \markup { \override #'(font-shape . caps) Text-in-caps }
+@end verbatim
+
+This selects the caps font by setting the @code{font-shape} property to
+@code{#'caps} for interpreting @code{Text-in-caps}.
+
+To make the above available as @code{\smallcaps} command, we have to
+define a function using @code{def-markup-command}. The command should
+take a single argument, of markup type. Therefore, the start of the
+definition should read
+@example
+ (def-markup-command (smallcaps paper props argument) (markup?)
+@end example
+
+@noindent
+
+What follows is the content of the command: we should interpret
+the @code{argument} as a markup, i.e.
+
+@example
+ (interpret-markup paper @dots{} argument)
+@end example
+
+@noindent
+This interpretation should add @code{'(font-shape . caps)} to the active
+properties, so we substitute the the following for the @dots{} in the
+above example:
+
+@example
+ (cons (list '(font-shape . caps) ) props)
+@end example
+
+@noindent
+The variable @code{props} is a list of alists, and we prepend to it by
+consing a list with the extra setting.
+
+However, suppose that we are using a font that does not have a
+small-caps variant. In that case, we have to fake the small caps font,
+by setting a string in upcase, with the first letter a little larger:
+
+@example
+#(def-markup-command (smallcaps paper props str) (string?)
+ "Print the string argument in small caps. Syntax: \\smallcaps #\"string\""
+ (interpret-markup paper props
+ (make-line-markup
+ (map (lambda (s)
+ (if (= (string-length s) 0)
+ s
+ (markup #:large (string-upcase (substring s 0 1))
+ #:translate (cons -0.6 0)
+ #:tiny (string-upcase (substring s 1)))))
+ (string-split str #\Space)))))
+@end example
+
+The @code{smallcaps} command first splits its string argument into
+tokens separated by spaces (@code{(string-split str #\Space)}); for
+each token, a markup is built with the first letter made large and
+upcased (@code{#:large (string-upcase (substring s 0 1))}), and a
+second markup built with the following letters made tiny and upcased
+(@code{#:tiny (string-upcase (substring s 1))}). As LilyPond
+introduces a space between markups on a line, the second markup is
+translated to the left (@code{#:translate (cons -0.6 0) ...}). Then,
+the markups built for each token are put in a line
+(@code{(make-line-markup ...)}). Finally, the resulting markup is
+passed to the @code{interpret-markup} function, with the @code{paper}
+and @code{props} arguments.
+
+Finally, suppose that we are typesetting a recitative in an opera, and
+we would like to define a command that will show character names in a
+custom manner. Names should be printed with small caps and translated a
+bit to the left and top. We will define a @code{\character} command
+that takes into account the needed translation, and uses the newly
+defined @code{\smallcaps} command:
+
+@verbatim
+#(def-markup-command (character paper props name) (string?)
+ "Print the character name in small caps, translated to the left and
+ top. Syntax: \\character #\"name\""
+ (interpret-markup paper props
+ (markup "" #:translate (cons -4 2) #:smallcaps name)))
+@end verbatim
+
+There is one complication that needs explanation: texts above and below
+the staff are moved vertically to be at a certain distance (the
+@code{padding} property) from the staff and the notes. To make sure
+that this mechanism does not annihilate the vertical effect of our
+@code{#:translate}, we add an empty string (@code{""}) before the
+translated text. Now the @code{""} will be put above the notes, and the
+@code{name} is moved in relation to that empty string. The net effect is
+that the text is moved to the upper left.
+
+The final result is as follows:
+@verbatim
+\score {
+ \notes { \fatText
+ c''^\markup \character #"Cleopatra"
+ e'^\markup \character #"Giulio Cesare"
+ }
+}
+@end verbatim
+
+@lilypond[raggedright]
+#(def-markup-command (smallcaps paper props str) (string?)
+ "Print the string argument in small caps. Syntax: \\smallcaps #\"string\""
+ (interpret-markup paper props
+ (make-line-markup
+ (map (lambda (s)
+ (if (= (string-length s) 0)
+ s
+ (markup #:large (string-upcase (substring s 0 1))
+ #:translate (cons -0.6 0)
+ #:tiny (string-upcase (substring s 1)))))
+ (string-split str #\Space)))))
+
+#(def-markup-command (character paper props name) (string?)
+ "Print the character name in small caps, translated to the left and
+ top. Syntax: \\character #\"name\""
+ (interpret-markup paper props
+ (markup "" #:translate (cons -4 0) #:smallcaps name)))
+
+\score {
+ \notes { \fatText
+ c''^\markup \character #"Cleopatra"
+ e'^\markup \character #"Giulio Cesare"
+ }
+}
+@end lilypond
of numbers, so if you want to make it smaller from its, then you could
set
@example
- \property Staff.minimumVerticalExtent = #'(-4 . 4)
+ \set Staff.minimumVerticalExtent = #'(-4 . 4)
@end example
This sets the vertical size of the current staff to 4 staff spaces on
either side of the center staff line. The argument of
\score { \notes {
c'4 e''4 e'4 b'4 |
b'4 e''4 b'4 e''4|
- \property Staff.NoteSpacing \override #'stem-spacing-correction
+ \override Staff.NoteSpacing #'stem-spacing-correction
= #1.5
- \property Staff.StaffSpacing \override #'stem-spacing-correction
+ \override Staff.StaffSpacing #'stem-spacing-correction
= #1.5
c'4 e''4 e'4 b'4 |
b'4 e''4 b'4 e''4|
@seealso
-In this manual @ref{Invoking lilypond}
+In this manual: @ref{Invoking lilypond}.
-Examples: @inputfileref{input/regression,between-systems.ly}
+Examples: @inputfileref{input/regression,between-systems.ly}.
Internals: @internalsref{NonMusicalPaperColumn}.
The MIDI output allocates a channel for each Staff, and one for global
settings. Hence, the MIDI file should not have more than 15 staves
-(or 14 if you do not use drums).
+(or 14 if you do not use drums).
@menu
projects / lilypond.git / blobdiff