diff options
author | John Mandereau <john.mandereau@gmail.com> | 2008-02-26 19:05:26 +0100 |
---|---|---|
committer | John Mandereau <john.mandereau@gmail.com> | 2008-02-26 19:05:26 +0100 |
commit | af7c2aee31efc83b9c0ff67cf2dfeea9fbaf937c (patch) | |
tree | 078add77e988904451c88cc04d71a885cb82b5d3 /Documentation | |
parent | 3960071c37deae72403c4f54146bbdc67fcc9abe (diff) | |
parent | dc437ea5cbbf9aa9a1c406596d088bcd70032b35 (diff) |
Merge branch 'master' into lilypond/translation
* master:
Revert lys-to-tely changes
Add stub for - subsection.
Linking to ^_ section.
Update from Patrick.
Typo.
Typo.
Updates from Trevor.
Disable version macro.
Revert "Always use Lily current version number in docs"
Fix 554.
Fix 550.
Fix 577.
Thinko: compare abs of both positions.
Take git diff from src-dir for test target.
Use \addlyrics for lyric-hyphen.ly
Use \addlyrics for lyric-hyphen-break.ly
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/user/README.txt | 2 | ||||
-rw-r--r-- | Documentation/user/expressive.itely | 201 | ||||
-rw-r--r-- | Documentation/user/fundamental.itely | 13 | ||||
-rw-r--r-- | Documentation/user/input.itely | 16 | ||||
-rw-r--r-- | Documentation/user/lilypond-book.itely | 3 | ||||
-rw-r--r-- | Documentation/user/lilypond-learning.tely | 25 | ||||
-rw-r--r-- | Documentation/user/lilypond-program.tely | 25 | ||||
-rw-r--r-- | Documentation/user/lilypond.tely | 25 | ||||
-rw-r--r-- | Documentation/user/macros.itexi | 3 | ||||
-rw-r--r-- | Documentation/user/pitches.itely | 2 | ||||
-rw-r--r-- | Documentation/user/policy.txt | 5 | ||||
-rw-r--r-- | Documentation/user/rhythms.itely | 7 | ||||
-rw-r--r-- | Documentation/user/tutorial.itely | 6 | ||||
-rw-r--r-- | Documentation/user/tweaks.itely | 123 | ||||
-rw-r--r-- | Documentation/user/working.itely | 4 | ||||
-rw-r--r-- | Documentation/user/writing-texinfo.txt | 13 |
16 files changed, 288 insertions, 185 deletions
diff --git a/Documentation/user/README.txt b/Documentation/user/README.txt index ae345e03d0..6b39a974a3 100644 --- a/Documentation/user/README.txt +++ b/Documentation/user/README.txt @@ -11,7 +11,7 @@ General policy: policy.txt convert-ly -e --from=... --to=... --no-version *.itely % to find the current version number, -grep "version \"" fundamental.itely +grep "version \"" tutorial.itely Please don't forget updating translated docs (in LANGS/user) too! diff --git a/Documentation/user/expressive.itely b/Documentation/user/expressive.itely index 211e84d67a..c1c1771828 100644 --- a/Documentation/user/expressive.itely +++ b/Documentation/user/expressive.itely @@ -38,69 +38,42 @@ A variety of symbols can appear above and below notes to indicate different characteristics of the performance. All these symbols can be attached to a note using the syntax -@var{note}@code{\}@var{name}. +@var{note}@tie{}@code{\}@var{name}. + +@c Add a LilyPond example here soon. -pm The possible values for @var{name} are listed in @ref{List of articulations}. +@cindex marcato +@cindex stopped +@cindex tenuto +@cindex staccatissimo +@cindex accent +@cindex staccato +@cindex portato + Some of these articulations have shorthands for easier entry. Shorthands are appended to the note name, and their syntax -consists of a dash (@code{-}) followed by a symbol signifying the -articulation. The available shorthands are: - -@itemize -@item -@code{-^} (@notation{marcato}) - -@item -@code{-+} (@notation{stopped}) - -@item -@code{--} (@notation{tenuto}) - -@item -@code{-|} (@notation{staccatissimo}) - -@item -@code{->} (@notation{accent}) - -@item -@code{-.} (@notation{staccato}) - -@item -@code{-_} (@notation{portato}) - -@end itemize - -and their corresponding output: +consists of a dash (@tie{}@code{-}) followed by a symbol +signifying the articulation. Predefined shorthands exist for +@notation{marcato}, @notation{stopped}, @notation{tenuto}, +@notation{staccatissimo}, @notation{accent}, @notation{staccato}, +and @notation{portato}. Their corresponding output appears as +follows: @lilypond[verbatim,quote,ragged-right,fragment,relative=2] c4-^ c-+ c-- c-| c-> c-. c-_ @end lilypond -The marks are automatically placed, but the direction can be -forced as well. Like other pieces of LilyPond code, -@code{_}@tie{}will place them below the staff, and@tie{}@code{^} -will place them above. This applies both to the shorthands and -the fully named articulations. For the shorthands, the dash -itself should be omitted; the direction signs replace it: - -@lilypond[verbatim,quote,ragged-right,fragment,relative=2] -c4^^ c4_^ -c\fermata c^\fermata c_\fermata -@end lilypond +The marks are placed automatically by default (either above or +below the note), but their positions can be manually @q{forced} +above or below notes as well. For details, see +@ref{Controlling direction and placement}. - -@cindex accent -@cindex marcato -@cindex staccatissimo @cindex espressivo @cindex fermata -@cindex stopped -@cindex staccato -@cindex portato -@cindex tenuto @cindex upbow @cindex downbow @cindex foot marks @@ -125,6 +98,8 @@ c\fermata c^\fermata c_\fermata @snippets +@c Send these snippets to Valentin for the LSR. + The shorthands are defined in @file{ly/@/script@/-init@/.ly}, where the variables @code{dashHat}, @code{dashPlus}, @code{dashDash}, @code{dashBar}, @code{dashLarger}, @@ -162,6 +137,10 @@ a4^\prall^\markup { \sharp } @seealso +Music Glossary: @rglos{marcato}, @rglos{stopped}, @rglos{tenuto}, +@rglos{staccatissimo}, @rglos{accent}, @rglos{staccato}, +@rglos{portato}. + Snippets: @lsrdir{Expressive,Expressive-marks} Internals Reference: @internalsref{Script}, @@ -202,8 +181,8 @@ like @code{c4\ff}. The available dynamic marks are @code{\ppppp}, @code{\mf}, @code{\f}, @code{\ff}, @code{\fff}, @code{\ffff}, @code{\fp}, @code{\sf}, @code{\sff}, @code{\sp}, @code{\spp}, @code{\sfz}, and @code{\rfz}. The dynamic marks can be placed -above or below the staff with@tie{}@code{_} and@tie{}@code{^}, -just like articulation marks. +above or below the staff: For details, see +@ref{Controlling direction and placement}. @lilypond[verbatim,quote,ragged-right,fragment,relative=2] c2\ppp c\mp @@ -211,17 +190,20 @@ c\rfz c^\mf c_\spp c_\staccato^\ff @end lilypond +@cindex hairpin @funindex \< @funindex \> @funindex \! +@funindex \cr +@funindex \decr A @notation{crescendo} mark is started with @code{\<} and terminated with @code{\!} or an absolute dynamic. A @notation{decrescendo} is started with @code{\>} and is also terminated with @code{\!} or an absolute dynamic. @code{\cr} and @code{\decr} may be used instead of @code{\<} and @code{\>}. They -can be engraved either using a graphical sign (a @q{hairpin}), or -with textual signs. +can be engraved either using a graphical sign (a +@notation{hairpin}), or with textual signs. Because these marks are bound to notes, you must use spacer notes if multiple marks are needed during one note. @@ -240,12 +222,11 @@ for example @code{minimum-length} in @end example @noindent -A hairpin normally starts at the left edge of the beginning note -and ends on the right edge of the ending note. If the ending note -falls on the downbeat, the hairpin ends on the immediately -preceding bar line. This may be modified by setting the -@code{hairpinToBarline} property: -@cindex hairpin +A @notation{hairpin} normally starts at the left edge of the +beginning note and ends on the right edge of the ending note. If +the ending note falls on the downbeat, the @notation{hairpin} ends +on the immediately preceding bar line. This may be modified by +setting the @code{hairpinToBarline} property: @lilypond[verbatim,quote,ragged-right,fragment,relative=2] e4\< e2. e1\! @@ -254,6 +235,7 @@ e4\< e2. e1\! @end lilypond @cindex espressivo, articulation + In some situations the @code{\espressivo} articulation mark may be suitable to indicate a crescendo and decrescendo on the one note: @@ -276,12 +258,19 @@ c4\> c\< c2\! @cindex crescendo @cindex decrescendo @cindex diminuendo +@funindex \setTextCresc +@funindex \setTextDim +@funindex \setTextDecresc +@funindex \setHairpinCresc +@funindex \setHairpinDim +@funindex \setHairpinDecresc You can use text saying @emph{cresc.}, @emph{decr.}, or -@emph{dim.} instead of hairpins with the commands \setTextCresc, -\setTextDim, and \setTextDecresc. The corresponding -\setHairpinCresc, \setHairpinDim, and \setHairpinDecresc will -revert to hairpins again: +@emph{dim.} instead of hairpins with the commands +@code{\setTextCresc}, @code{\setTextDim}, and +@code{\setTextDecresc}. The corresponding +@code{\setHairpinCresc}, @code{\setHairpinDim}, and +@code{\setHairpinDecresc} will revert to hairpins again: @lilypond[verbatim,quote,ragged-right,fragment,relative=2] \setTextCresc @@ -388,7 +377,7 @@ handled by @internalsref{DynamicLineSpanner}. @cindex slurs -A slur indicates that notes are to be played bound or +A @notation{slur} indicates that notes are to be played bound or @emph{legato}. They are entered using parentheses: @lilypond[verbatim,quote,ragged-right,fragment,relative=2] @@ -398,17 +387,16 @@ f( g a) a8 b( a4 g2 f4) Just as with ties, the direction of a slur can be specified with @code{\slur@emph{DIR}}, where @code{@emph{DIR}} is either -@code{Up}, @code{Down}, or @code{Neutral} (automatically -selected). The shorthands are also available: by -adding@tie{}@code{_} or@tie{}@code{^} before the opening -parentheses, the direction is also set. +@code{Up}, @code{Down}, or @code{Neutral} (@code{Neutral} is the +default). The shorthands are also available: For details, see +@ref{Controlling direction and placement}. @lilypond[verbatim,quote,ragged-right,fragment,relative=2] c4_( c) c^( c) @end lilypond -Only one slur can be printed at once. If you need to print a long -slur over a few small slurs, please see @ref{Phrasing slurs}. +Using this method, only one slur can be printed at once. To print +a long slur over a few small slurs, see @ref{Phrasing slurs}. @predefined @@ -440,6 +428,8 @@ can be achieved in LilyPond by setting @code{doubleSlurs}, @seealso +Music Glossary: @rglos{slur} + Snippets: @lsrdir{Expressive,Expressive-marks} Internals Reference: @internalsref{Slur}. @@ -450,6 +440,8 @@ Internals Reference: @internalsref{Slur}. @cindex phrasing slurs @cindex phrasing marks +@funindex \( +@funindex \) A phrasing slur (or phrasing mark) connects notes and is used to indicate a musical sentence. It is written using @code{\(} and @@ -463,8 +455,8 @@ Typographically, the phrasing slur behaves almost exactly like a normal slur. However, they are treated as different objects. A @code{\slurUp} will have no effect on a phrasing slur; instead, use @code{\phrasingSlurUp}, @code{\phrasingSlurDown}, and -@code{\phrasingSlurNeutral}, or use the shorthands@tie{}@code{_} -and@tie{}@code{^}. +@code{\phrasingSlurNeutral}. The shorthands work for phrasing +slurs as well: For details, see @ref{Controlling direction and placement}. You cannot have simultaneous phrasing slurs. @@ -483,12 +475,15 @@ You cannot have simultaneous phrasing slurs. Snippets: @lsrdir{Expressive,Expressive-marks} -Internals Reference: @internalsref{PhrasingSlur}. +Internals Reference: @internalsref{PhrasingSlur} @node Breath marks @subsubsection Breath marks +@cindex breath marks +@funindex \breathe + Breath marks are entered using @code{\breathe}: @lilypond[verbatim,quote,ragged-right,fragment,relative=1] @@ -512,17 +507,21 @@ d4 @seealso -Snippets: @lsrdir{Expressive,Expressive-marks}, +Snippets: @lsrdir{Expressive,Expressive-marks} @c @lsr{expressive,breathing-sign.ly}. -Internals Reference: @internalsref{BreathingSign}. +Internals Reference: @internalsref{BreathingSign} @node Falls and doits @subsubsection Falls and doits -Falls and doits can be added to notes using the @code{\bendAfter} -command, +@cindex falls +@cindex doits +@funindex \bendAfter + +@notation{Falls} and @notation{doits} can be added to notes using +the @code{\bendAfter} command, @lilypond[verbatim,quote,ragged-right,fragment,relative=2] \override Score.SpacingSpanner #'shortest-duration-space = #3.0 @@ -530,6 +529,14 @@ c4-\bendAfter #+5 c4-\bendAfter #-3 @end lilypond + +@seealso + +Music Glossary: @rglos{falls}, @rglos{doits}. + +Snippets: @lsrdir{Expressive,Expressive-marks} + + @node Lines @subsection Lines @@ -545,9 +552,10 @@ c4-\bendAfter #-3 @cindex glissando @funindex \glissando -A glissando is a smooth change in pitch. It is denoted by a line -or a wavy line between two notes. It is requested by attaching -@code{\glissando} to a note: +A @notation{glissando} is a smooth change in pitch. It is denoted +by a line or a wavy line between two notes. A +@notation{glissando} is created by attaching @code{\glissando} to +a note: @lilypond[verbatim,quote,ragged-right,fragment,relative=2] c2\glissando c' @@ -555,8 +563,8 @@ c2\glissando c' c2\glissando c, @end lilypond -@snippets +@snippets @lilypond[verbatim,quote,ragged-right] I = \once \override NoteColumn #'ignore-collision = ##t @@ -568,18 +576,17 @@ I = \once \override NoteColumn #'ignore-collision = ##t @end lilypond - @seealso -Music Glossary: @rglos{falls}, @rglos{doits}. +Music Glossary: @rglos{glissando} -Snippets: @lsrdir{Expressive,Expressive-marks}. +Snippets: @lsrdir{Expressive,Expressive-marks} @c FIXME: I need to figure out what's up with these. -gp @c @lsr{expressive,glissando.ly}, @c @lsr{expressive,line-styles.ly} -Internals Reference: @internalsref{Glissando}. +Internals Reference: @internalsref{Glissando} @knownissues @@ -595,15 +602,17 @@ supported. @cindex broken chord @funindex \arpeggio -You can specify an arpeggio sign (also known as broken chord) on a -chord by attaching an @code{\arpeggio} to the chord: +You can specify an @notation{arpeggio} (also known as a +@notation{broken chord}) on a chord by attaching an +@code{\arpeggio} to the chord: @lilypond[verbatim,quote,ragged-right,fragment,relative=1] <c e g c>\arpeggio @end lilypond -A square bracket on the left is used to indicate that the chord -should @emph{not} be arpeggiated: +A square bracket on the left, denoted by @code{\arpeggioBracket}, +is used to indicate that the chord should @emph{not} be +arpeggiated: @lilypond[verbatim,quote,ragged-right,fragment,relative=1] \arpeggioBracket @@ -629,7 +638,6 @@ reverts to the arrow-less version: @predefined -@code{\arpeggio}, @funindex \arpeggioUp @code{\arpeggioUp}, @funindex \arpeggioDown @@ -702,6 +710,8 @@ moved to the Staff context: @seealso +Music Glossary: @rglos{arpeggio}, @rglos{broken chord}. + Notation Reference: @ref{Ties}, for writing out arpeggios. Snippets: @lsrdir{Expressive,Expressive-marks} @@ -720,7 +730,10 @@ time. @node Trills @subsubsection Trills -Short trills are printed with @code{\trill} like normal +@cindex trills +@funindex \trill + +Short @notation{trills} are printed with @code{\trill} like normal articulation; see @ref{Articulations and ornamentations}. Long running trills are made with @code{\startTrillSpan} and @@ -738,8 +751,8 @@ c4 @cindex pitched trills Trills that should be executed on an explicitly specified pitch -can be typeset with the command @code{pitchedTrill}, and the -syntax @code{\pitchedTrill} @var{mainnote}@code{\startTrillSpan} +can be typeset with the command @code{\pitchedTrill}, and the +syntax @code{\pitchedTrill} @var{mainnote} @code{\startTrillSpan} @var{trillnote} @var{endnote} @code{\stopTrillSpan}. @lilypond[verbatim,quote,ragged-right,fragment,relative=1] @@ -762,6 +775,8 @@ printed as a stemless note head in parentheses. @seealso +Music Glossary: @rglos{trill} + Snippets: @lsrdir{Expressive,Expressive-marks} -Internals Reference: @internalsref{TrillSpanner}. +Internals Reference: @internalsref{TrillSpanner} diff --git a/Documentation/user/fundamental.itely b/Documentation/user/fundamental.itely index 1ccf9bcf02..1e56b0e4f2 100644 --- a/Documentation/user/fundamental.itely +++ b/Documentation/user/fundamental.itely @@ -40,7 +40,7 @@ description of the input format, see @ruser{File structure}. A basic example of a lilypond input file is @example -\version @w{"@version{}"} +\version "2.11.38" \score @{ @var{...compound music expression...} % all the music goes here! \header @{ @} @@ -1739,7 +1739,7 @@ cello. In this case, we would start with @q{Notes and lyrics} (for the soprano part). @example -\version @w{"@version{}"} +\version "2.11.38" melody = \relative c' @{ \clef treble \key c \major @@ -1767,7 +1767,7 @@ text = \lyricmode @{ Now we want to add a cello part. Let's look at the @q{Notes only} example: @example -\version @w{"@version{}"} +\version "2.11.38" melody = \relative c' @{ \clef treble \key c \major @@ -1804,7 +1804,7 @@ celli normally use bass clef. We'll also give the cello some different notes. @example -\version @w{"@version{}"} +\version "2.11.38" sopranoMusic = \relative c' @{ \clef treble \key c \major @@ -1873,7 +1873,7 @@ This looks a bit messy; the indentation is messed up now. That is easily fixed. Here's the complete soprano and cello template. @lilypond[quote,verbatim,ragged-right] -\version "2.11.38" +\version "2.11.37" sopranoMusic = \relative c' { \clef treble \key c \major @@ -1921,6 +1921,7 @@ from Handel's Messiah: @c The following should appear as music without code @lilypond[quote,ragged-right] +\version "2.11.38" global = { \key d \major \time 4/4 } sopMusic = \relative c'' { \clef "treble" @@ -2192,7 +2193,7 @@ music definitions and one to define the time signature and key: @example -\version @w{"@version{}"} +\version "2.11.38" \header @{ title = "Jesu, meine Freude" composer = "J S Bach" diff --git a/Documentation/user/input.itely b/Documentation/user/input.itely index a9ad9a80dd..5f2b84131a 100644 --- a/Documentation/user/input.itely +++ b/Documentation/user/input.itely @@ -511,12 +511,13 @@ sections. @section Common syntax issues TODO name? @menu -* Controlling direction:: +* Controlling direction and placement:: * Distances and measurements MAYBE MOVE:: +* When to add a -:: @end menu -@node Controlling direction -@subsection Controlling direction +@node Controlling direction and placement +@subsection Controlling direction and placement TODO: everything @@ -550,7 +551,16 @@ DISCUSS after working on other sections. TODO: staff spaces, #UP #DOWN #LEFT #RIGHT. Maybe move into tweaks? +@node When to add a - +@subsection When to add a - +One of these works, the other doesn't. + +@verbatim +\version "2.11.38" +{ c'\mp\fermata\accent-\markup { "forcefully"} } +% { c'\mp\fermata\accent\markup { "forcefully"} } +@end verbatim @node Other stuffs TODO move? diff --git a/Documentation/user/lilypond-book.itely b/Documentation/user/lilypond-book.itely index f0af1fcf17..86b274f9cf 100644 --- a/Documentation/user/lilypond-book.itely +++ b/Documentation/user/lilypond-book.itely @@ -105,10 +105,9 @@ directory as this file.) Save the code above to a file called @file{lilybook.lytex}, then in a terminal run -@c keep space after @version{} so TeX doesn't choke @example lilypond-book --output=out --pdf lilybook.lytex -@emph{lilypond-book (GNU LilyPond) @version{} } +@emph{lilypond-book (GNU LilyPond) 2.11.37} @emph{Reading lilybook.lytex...} @emph{..lots of stuff deleted..} @emph{Compiling lilybook.tex...} diff --git a/Documentation/user/lilypond-learning.tely b/Documentation/user/lilypond-learning.tely index fac164092e..c1e811970a 100644 --- a/Documentation/user/lilypond-learning.tely +++ b/Documentation/user/lilypond-learning.tely @@ -10,8 +10,6 @@ @documentencoding UTF-8 @documentlanguage en -@include macros.itexi - @iftex @afourpaper @c don't replace quotes with directed quotes @@ -66,7 +64,21 @@ Free Documentation License''. @vskip 20pt -For LilyPond version @version{} +@lilypond[ragged-right] +\score { + \context Lyrics { + \override Score.RehearsalMark #'self-alignment-X = #LEFT + \override Score.RehearsalMark #'font-size = #-2 + \mark #(ly:export (string-append + "(For LilyPond version " (lilypond-version) ")")) + s2 + } + \layout { + indent = 0.0\pt + } +} +@end lilypond + @end titlepage @copying @@ -102,7 +114,10 @@ Free Documentation License''. @top GNU LilyPond --- learning manual @c HJJ: Info needs `@top', which is a synonym for `@unnumbered' in TeX. -This is the learning manual for GNU LilyPond version @version{}. +This is the learning manual for GNU LilyPond 2.11.x series. +@ifhtml +(See the bottom of this page for the exact version number). +@end ifhtml @cindex web site @cindex URL @@ -132,6 +147,8 @@ Appendices @contents +@include macros.itexi + @include preface.itely @include introduction.itely @include tutorial.itely diff --git a/Documentation/user/lilypond-program.tely b/Documentation/user/lilypond-program.tely index 18ced37734..6fa9f3900b 100644 --- a/Documentation/user/lilypond-program.tely +++ b/Documentation/user/lilypond-program.tely @@ -10,8 +10,6 @@ @documentencoding UTF-8 @documentlanguage en -@include macros.itexi - @iftex @afourpaper @c don't replace quotes with directed quotes @@ -66,7 +64,21 @@ Free Documentation License''. @vskip 20pt -For LilyPond version @version{} +@lilypond[ragged-right] +\score { + \context Lyrics { + \override Score.RehearsalMark #'self-alignment-X = #LEFT + \override Score.RehearsalMark #'font-size = #-2 + \mark #(ly:export (string-append + "(For LilyPond version " (lilypond-version) ")")) + s2 + } + \layout { + indent = 0.0\pt + } +} +@end lilypond + @end titlepage @copying @@ -102,7 +114,10 @@ Free Documentation License''. @top GNU LilyPond --- program usage @c HJJ: Info needs `@top', which is a synonym for `@unnumbered' in TeX. -This is the program usage manual for GNU LilyPond version @version{}. +This is the program usage manual for GNU LilyPond 2.11.x series. +@ifhtml +(See the bottom of this page for the exact version number). +@end ifhtml @cindex web site @cindex URL @@ -128,6 +143,8 @@ Appendices @contents +@include macros.itexi + @include install.itely @include setup.itely @include running.itely diff --git a/Documentation/user/lilypond.tely b/Documentation/user/lilypond.tely index 7c203800d7..0631951f5a 100644 --- a/Documentation/user/lilypond.tely +++ b/Documentation/user/lilypond.tely @@ -10,8 +10,6 @@ @documentencoding UTF-8 @documentlanguage en -@include macros.itexi - @iftex @afourpaper @c don't replace quotes with directed quotes @@ -100,7 +98,21 @@ Free Documentation License''. @vskip 20pt -For LilyPond version @version{} +@lilypond[ragged-right] +\score { + \context Lyrics { + \override Score.RehearsalMark #'self-alignment-X = #LEFT + \override Score.RehearsalMark #'font-size = #-2 + \mark #(ly:export (string-append + "(For LilyPond version " (lilypond-version) ")")) + s2 + } + \layout { + indent = 0.0\pt + } +} +@end lilypond + @end titlepage @copying @@ -136,7 +148,10 @@ Free Documentation License''. @top GNU LilyPond --- The music typesetter @c HJJ: Info needs `@top', which is a synonym for `@unnumbered' in TeX. -This is the user manual for GNU LilyPond version @version{}. +This is the user manual for GNU LilyPond 2.11.x series. +@ifhtml +(See the bottom of this page for the exact version number). +@end ifhtml @cindex web site @cindex URL @@ -172,6 +187,8 @@ Appendices @contents +@include macros.itexi + @include notation.itely @include specialist.itely diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi index 40905c2333..b0dafefd95 100644 --- a/Documentation/user/macros.itexi +++ b/Documentation/user/macros.itexi @@ -7,7 +7,8 @@ @end ignore @macro version -@value{version} +@c @value{version} +2.11.41 @end macro @c ***** Displaying text ***** diff --git a/Documentation/user/pitches.itely b/Documentation/user/pitches.itely index f50faa6f65..0ec57da745 100644 --- a/Documentation/user/pitches.itely +++ b/Documentation/user/pitches.itely @@ -1433,7 +1433,7 @@ musicB = { @end lilypond @item piano -@funindex piano accidentals +@cindex piano accidentals @cindex piano accidentals @cindex accidentals, piano @cindex piano accidental style diff --git a/Documentation/user/policy.txt b/Documentation/user/policy.txt index 229419de9f..fd2c895cbb 100644 --- a/Documentation/user/policy.txt +++ b/Documentation/user/policy.txt @@ -45,8 +45,9 @@ material in the Learning Manual (particularly ``Fundamental Concepts''), so do not repeat that material in each section of this book. Also watch out for common constructs, like ^ - _ for directions -- those are explained in NR 3. In NR 1, you can -mention that "dynamics (or whatever) may be placed above or below -the staff, for details see @ref{Up and down}". +write: +Dynamics (or whatever) may be manually placed above or below the +staff, for details see @ref{Controlling direction and placement}". Most tweaks should be added to LSR and not placed directly in the .itely file. In some cases, tweaks may be placed in the main diff --git a/Documentation/user/rhythms.itely b/Documentation/user/rhythms.itely index da30265b53..b2f9977731 100644 --- a/Documentation/user/rhythms.itely +++ b/Documentation/user/rhythms.itely @@ -204,7 +204,7 @@ must be done with @code{\tweak}. @funindex tupletNumberFormatFunction @funindex tupletSpannerDuration -@lilypondfile [ragged-right,line-width=16\cm,staffsize=14,quote] +@lilypondfile [verbatim,lilyquote,ragged-right,texidoc] {entering-several-tuplets-using-only-one--times-command.ly} @ignore @@ -384,7 +384,7 @@ create a tuplet bracket. One application is in polymetric notation, as shown in the following example. See @ref{Polymetric notation}. -@lilypondfile [ragged-right,line-width=16\cm,staffsize=14,quote] +@lilypondfile [verbatim,lilyquote,ragged-right,texidoc] {printing-music-with-different-time-signatures.ly} @@ -515,7 +515,7 @@ be entered using @code{\laissezVibrer}: @end lilypond The vertical placement of ties may be controlled; see -@ref{Controlling direction}. +@ref{Controlling direction and placement}. @quotation DELETE THIS ? @@ -2615,3 +2615,4 @@ Internals Reference: @internalsref{Timing_translator}, + diff --git a/Documentation/user/tutorial.itely b/Documentation/user/tutorial.itely index dd777b9367..c4681c27cc 100644 --- a/Documentation/user/tutorial.itely +++ b/Documentation/user/tutorial.itely @@ -260,7 +260,7 @@ to enter most melodies. Let us see how this relative calculation works in practice. Starting from a B, which is on the middle line in a treble clef, you can reach a C, D and E within 3 staff spaces going up, and an A, G and F within 3 staff spaces going down. So -if the note following a B is a C, D or F it will be assumed to be +if the note following a B is a C, D or E it will be assumed to be above the B, and an A, G or F will be assumed to be below. @lilypond[verbatim,quote,ragged-right] @@ -1585,7 +1585,7 @@ The @code{\version} statement records the version of LilyPond that was used to write the file: @example -\version @w{"@version{}"} +\version "2.11.38" @end example @noindent @@ -1607,7 +1607,7 @@ main music expression; the @code{\header} block is usually placed underneath the @ref{Version number}. @example -\version @w{"@version{}"} +\version "2.11.38" \header @{ title = "Symphony" composer = "Me" diff --git a/Documentation/user/tweaks.itely b/Documentation/user/tweaks.itely index 9f7dd9ca45..698a7b30ea 100644 --- a/Documentation/user/tweaks.itely +++ b/Documentation/user/tweaks.itely @@ -160,8 +160,7 @@ properties. @node Tweaking methods @subsection Tweaking methods -@itemize -@item @strong{override command} +@strong{\override command} @cindex override command @funindex \override @@ -221,7 +220,7 @@ Again, just like @emph{context} in the @code{\override} command, @emph{context} is often not needed. It will be omitted in many of the following examples. -@item @strong{overrideProperty command} +@strong{\overrideProperty command} @cindex overrideProperty command @funindex \overrideProperty @@ -232,7 +231,7 @@ We mention it here for completeness, but for details see @ruser{Difficult tweaks}. @c Maybe explain in a later iteration -td -@item @strong{tweak command} +@strong{\tweak command} @cindex tweak command @funindex \tweak @@ -242,9 +241,9 @@ This should be used to change the properties of objects which occur at the same musical moment, such as the notes within a chord. Using @code{\override} would affect all the notes within a chord, whereas @code{\tweak} affects just the following -item in the input stream. +item in the input stream. -Here's an example. Suppose we wish to change the size of the +Here's an example. Suppose we wish to change the size of the middle note (the E) in a C major chord. Let's first see what @code{\once \override} would do: @@ -266,8 +265,8 @@ on the immediately following item in the input stream. However, it is effective only on objects which are created directly from the input stream, essentially note heads and articulations. (Objects such as stems and accidentals are created later and -cannot be tweaked in this way). Furthermore, when it is applied -to note heads these must be within a chord, i.e., within single +cannot be tweaked in this way). Furthermore, when it is applied +to note heads these must be within a chord, i.e., within single angle brackets, so to tweak a single note the @code{\tweak} command must be placed inside single angle brackets with the note. @@ -280,8 +279,19 @@ a chord would be changed in this way: <c \tweak #'font-size #-3 e g>4 @end lilypond -Just one in a series of articulations can be modified with -@code{\tweak}, as shown here: +Note that the syntax of @code{\tweak} is different from that +of the @code{\override} command. Neither the context nor the +layout object should be specified; in fact, it would generate +an error to do so. These are both implied by the following +item in the input stream. So the general syntax of the +@code{\tweak} command is simply: + +@example +\tweak #'@emph{layout_property} = #@emph{value} +@end example + +A @code{\tweak} command can also be used to modify just one in +a series of articulations, as shown here: @lilypond[quote,fragment,ragged-right,verbatim,relative=2] a ^Black @@ -295,8 +305,6 @@ articulation mark as if it were an articulation itself. You can find more details of the @code{\tweak} command in @ruser{Objects connected to the input}. -@end itemize - @node The Internals Reference manual @section The Internals Reference manual @@ -2207,7 +2215,7 @@ are a few attempts to do this: <b? bes> @end lilypond -None work, with the second two showing a bad collision between +None work, with the second two showing bad collisions between the two signs. One way of achieving this is to override the accidental stencil @@ -3074,16 +3082,12 @@ about LilyPond, but even more information can be gathered by looking at the internal LilyPond files. To explore these, first find the directory appropriate to your system, as follows: -@itemize - -@item -@subheading Linux +@strong{Linux} Navigate to @file{@var{installdir}/lilypond/usr/share/lilypond/current/} -@item -@subheading OSX +@strong{OSX} Navigate to @file{@var{installdir}/LilyPond.app/Contents/Resources/share/lilypond/current/} @@ -3091,22 +3095,16 @@ by either @code{cd}-ing into this directory from the Terminal, or control-clicking on the LilyPond application and selecting @q{Show Package Contents}. -@item -@subheading Windows +@strong{Windows} Using Windows Explorer, navigate to @file{@var{installdir}/LilyPond/usr/share/lilypond/current/} -@end itemize - Within this directory the two interesting subdirectories are @itemize - @item @file{../ly/ } - contains files in LilyPond format - @item @file{../scm/} - contains files in Scheme format - @end itemize Let's begin by looking at some files in @file{../ly/}. @@ -3129,7 +3127,7 @@ If you do not like the default values these built-in commands can be redefined easily, just like any other variable, at the head of your input file. -The following are the most useful files to be found in +The following are the most useful files to be found in @file{../ly/}: @multitable @columnfractions .4 .6 @@ -3190,7 +3188,7 @@ compress that line of the score just enough to fit within the margins. To be effective under all circumstances these checks must be enabled -by placing the overrides in a Score @code{\with} block, rather than +by placing the overrides in a Score @code{\with} block, rather than in-line in music, as follows: @verbatim @@ -3206,21 +3204,60 @@ in-line in music, as follows: @node Advanced tweaks with Scheme @subsection Advanced tweaks with Scheme -Although many things are possible with the @code{\override} and -@code{\tweak} commands, an even more powerful way of modifying -the action of LilyPond is available through a programmable -interface to the LilyPond internal operation. Functions are -provided which enable the user to incorporate Scheme code directly -in the internal operation of LilyPond. For example, it is -possible to parametrize an override command which is used often -but with different values. - -As the use of these functions require code to be written in the -Scheme programming language, at least a basic knowledge of -programming in Scheme is required. An introduction to this is -provided in the @ref{Scheme tutorial}, and examples showing the -use of these programmable interfaces can be found in -@ref{Tweaking with Scheme}. +Although many things are possible with the @code{\override} and +@code{\tweak} commands, an even more powerful way of modifying +the action of LilyPond is available through a programmable +interface to the LilyPond internal operation. Code written in +the Scheme programming language can be incorporated directly in +the internal operation of LilyPond. Of course, at least a basic +knowledge of programming in Scheme is required to do this, and an +introduction is provided in the @ref{Scheme tutorial}. + +As an illustration of one of the many possibilities, instead of +setting a property to a constant it can be set to a Scheme +procedure which is then called whenever that property is accessed +by LilyPond. The property can then be set dynamically to a value +determined by the procedure at the time it is called. In this +example we color the note head in accordance with its position on +the staff. + +@lilypond[quote,verbatim,ragged-right] +#(define (color-notehead grob) + "Color the notehead according to its position on the staff." + (let ((mod-position (modulo (ly:grob-property grob 'staff-position) 7))) + (case mod-position ; Set rainbow colors + ((1) (ly:grob-set-property! grob 'color (x11-color 'red))) + ((2) (ly:grob-set-property! grob 'color (x11-color 'orange))) + ((3) (ly:grob-set-property! grob 'color (x11-color 'yellow))) + ((4) (ly:grob-set-property! grob 'color (x11-color 'green))) + ((5) (ly:grob-set-property! grob 'color (x11-color 'blue))) + ((6) (ly:grob-set-property! grob 'color (x11-color 'purple))) + ((0) (ly:grob-set-property! grob 'color (x11-color 'violet))) + ) + ) +) + +rainbow = { + % Override color so it is obtained from color-notehead Scheme function + \override NoteHead #'color = #color-notehead +} + +\relative c' { + \rainbow { + c2 c' | + b4 g8 a b4 c | + c,2 a' | + g1 | + } +} +\addlyrics { + Some -- where o -- ver the Rain -- bow, way up high, +} +@end lilypond + +Further examples showing the use of these programmable interfaces +can be found in @ref{Tweaking with Scheme}. + diff --git a/Documentation/user/working.itely b/Documentation/user/working.itely index 216f577e89..4f8820da01 100644 --- a/Documentation/user/working.itely +++ b/Documentation/user/working.itely @@ -73,7 +73,7 @@ templates contain @code{\version} information. We highly recommend that you always include the @code{\version}, no matter how small your file is. Speaking from personal experience, it's quite frustrating to try to remember which version of LilyPond you were -using a few years ago. @command{convert-ly} requires you to declare +using a few years ago. @code{convert-ly} requires you to declare which version of LilyPond you used. @item @strong{Include checks}: @ruser{Bar and barnumber checks}, @@ -536,7 +536,7 @@ file with @code{\include "../global.ly"}, which contains @example %%% global.ly -\version @w{"@version{}"} +\version "2.11.38" #(ly:set-option 'point-and-click #f) \include "../init/init-defs.ly" \include "../init/init-layout.ly" diff --git a/Documentation/user/writing-texinfo.txt b/Documentation/user/writing-texinfo.txt index 7913ed0ad7..4c988f754e 100644 --- a/Documentation/user/writing-texinfo.txt +++ b/Documentation/user/writing-texinfo.txt @@ -161,19 +161,6 @@ commands. Do not use @itemize @bullet. -* To get LilyPond version, use @version{} (this does not work inside - LilyPond snippets). If you write "@version{}" (enclosed with - quotes), or generally if @version{} is not followed by a space, - enclose it with - - @w{ ... } - - e.g. - - @w{"@version{}"} - - to prevent an ugly line break in PDF output. - %%%%% SYNTAX SURVEY |