From 11d8537473047eaabe3be20943da9bd35f11a400 Mon Sep 17 00:00:00 2001 From: gpercival Date: Mon, 10 Apr 2006 03:49:49 +0000 Subject: [PATCH] Backport docs from 2.9. --- ChangeLog | 4 ++ Documentation/user/advanced-notation.itely | 33 ++++++++++----- Documentation/user/basic-notation.itely | 40 +++++++++++-------- Documentation/user/global.itely | 17 ++++++++ Documentation/user/instrument-notation.itely | 2 +- Documentation/user/invoking.itely | 7 ++-- Documentation/user/lilypond-book.itely | 4 ++ Documentation/user/lilypond.tely | 2 +- Documentation/user/music-glossary.tely | 18 ++++----- .../user/programming-interface.itely | 6 ++- Documentation/user/putting.itely | 6 +-- 11 files changed, 96 insertions(+), 43 deletions(-) diff --git a/ChangeLog b/ChangeLog index 4040821163..6f777f03b7 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2006-04-09 Graham Percival + + * Documentation/user/*: backport doc changes from 2.9. + 2006-04-06 Han-Wen Nienhuys * scripts/lilypond-book.py diff --git a/Documentation/user/advanced-notation.itely b/Documentation/user/advanced-notation.itely index 95ece143e7..87db4e6969 100644 --- a/Documentation/user/advanced-notation.itely +++ b/Documentation/user/advanced-notation.itely @@ -61,6 +61,9 @@ command @code{\fatText}, the widths will be taken into account c4^"longtext" \fatText c4_"longlongtext" c4 @end lilypond +@noindent +To prevent text from influencing spacing, use @code{\emptyText}. + More complex formatting may also be added to a note by using the markup command, @lilypond[fragment,ragged-right,verbatim,quote] @@ -130,6 +133,15 @@ c2\startTextSpan b c\stopTextSpan a @code{textSpannerNeutral}. +@commonprop + +To print a solid line, use + +@example +\override TextSpanner #'dash-fraction = #'() +@end example + + @seealso Program reference: @internalsref{TextSpanner}. @@ -450,7 +462,7 @@ to. @itemize @bullet @item @code{font-encoding} is a symbol that sets layout of the glyphs. This should only be set to -select different types of non-text fonts, eg. +select different types of non-text fonts, e.g. @code{fetaBraces} for piano staff braces, @code{fetaMusic} the standard music font, including ancient glyphs, @code{fetaDynamic} for @@ -610,7 +622,7 @@ multi-measure rest. This expansion is controlled by the property be expanded, and the appropriate number is added automatically @lilypond[quote,ragged-right,fragment,verbatim] -\time 4/4 r1 | R1 | R1*2 +\time 4/4 r1 | R1 | R1*2 \time 3/4 R2. \time 2/4 R2 \time 4/4 \set Score.skipBars = ##t R1*17 R1*4 @end lilypond @@ -1507,7 +1519,7 @@ Cue notes have smaller font sizes. @c Yes, this is good practice. Otherwise, the start of the original @c part can only be seen from the font size. This is not good enough @c for sight-reading. It is possilbe to use other -@c markers (eg. a big close-bracket over the staff) to indicate the cue notes are +@c markers (e.g. a big close-bracket over the staff) to indicate the cue notes are @c finished. @c -hwn @@ -1593,14 +1605,15 @@ see those sections of the documentation. Double time signatures are not supported explicitly, but they can be faked. In the next example, the markup for the time signature is created with a markup text. This markup text is inserted in the -@internalsref{TimeSignature} grob. +@internalsref{TimeSignature} grob. See also +@inputfileref{input/@/test,compound@/-time@/.ly}). @lilypond[verbatim,ragged-right] % create 2/4 + 5/8 tsMarkup =\markup { - \number { + \override #'(baseline-skip . 2) \number { \column { "2" "4" } - \musicglyph #"scripts.stopped" + \lower #1 "+" \bracket \column { "5" "8" } } } @@ -1977,6 +1990,9 @@ Examples: @inputfileref{input/@/regression,balloon@/.ly}. @node Blank music sheet @subsection Blank music sheet +@cindex Sheet music, empty +@cindex Staves, blank sheet + A blank music sheet can be produced also by using invisible notes, and removing @code{Bar_number_engraver}. @@ -2047,8 +2063,7 @@ scale is determined by the @code{\key} command Shape note heads are implemented through the @code{shapeNoteStyles} property. Its value is a vector of symbols. The k-th element indicates the style to use for the k-th step of the scale. Arbitrary -combinations are possible, eg., - +combinations are possible, e.g. @lilypond[verbatim,relative=1,fragment] \set shapeNoteStyles = ##(cross triangle fa #f mensural xcircle diamond) @@ -2393,7 +2408,7 @@ the change should be made. The default is @code{'Voice}. @end itemize For example, if automatic beams should always end on the first quarter -node, use +note, use @example #(override-auto-beam-setting '(end * * * *) 1 4) diff --git a/Documentation/user/basic-notation.itely b/Documentation/user/basic-notation.itely index 97deb9cb25..3fe839677b 100644 --- a/Documentation/user/basic-notation.itely +++ b/Documentation/user/basic-notation.itely @@ -134,7 +134,7 @@ espanol.ly do re mi fa sol la sib si -s -b @commonprop -In accordance with standard typsetting rules, a natural sign is printed +In accordance with standard typesetting rules, a natural sign is printed before a sharp or flat if a previous accidental needs to be cancelled. To change this behaviour, use @code{\set Staff.extraNatural = ##f} @@ -248,17 +248,19 @@ must be done with multi-measure rests. They can be used for a single bar as well as many bars, and are discussed in @ref{Multi measure rests}. - -A rest's vertical position may be explicitly specified by entering a -note with the @code{\rest} keyword appended, the rest will be placed at -the note's place. This makes manual formatting in polyphonic music -easier. Automatic rest collision formatting will leave these rests -alone +To explicitly specify a rest's vertical position, write a note +followed by @code{\rest}. A rest will be placed in the position +where the note would appear, @lilypond[fragment,quote,ragged-right,verbatim] a'4\rest d'4\rest @end lilypond +@noindent +This makes manual formatting of +polyphonic music much easier, since the automatic rest collision +formatter will leave these rests alone. + @seealso Program reference: @internalsref{Rest}. @@ -368,7 +370,7 @@ duration. The default for the first note is a quarter note. @cindex @code{.} -To obtain dotted note lenghts, simply add a dot (`@code{.}') to +To obtain dotted note lengths, simply add a dot (`@code{.}') to the number. Double-dotted notes are produced in a similar way. @lilypond[quote,ragged-right,fragment,verbatim] @@ -754,7 +756,7 @@ begins on concert D, one would write \transpose c bes @{ e4 @dots{} @} @end example -To print this music in B-flat again (ie producing a trumpet part, +To print this music in B-flat again (i.e. producing a trumpet part, instead of a concert pitch conductor's score) you would wrap the existing music with another @code{transpose} @@ -860,7 +862,7 @@ file. For longer pieces, rendering only a small part is often an order of magnitude quicker than rendering it completely Skipping parts of a score can be controlled in a more fine-grained -fashing with the property @code{Score.skipTypesetting}. When it is +fashion with the property @code{Score.skipTypesetting}. When it is set, no typesetting is performed at all. This property is also used to control output to the MIDI file. Note that @@ -987,7 +989,7 @@ pitches. The clef is set with the @code{\clef} command @cindex varbaritone clef @cindex subbass clef -Supported clefs finclude +Supported clefs include @table @code @item treble, violin, G, G2 G clef on 2nd line @@ -1536,7 +1538,7 @@ exactly the same concept @noindent Ties are used either when the note crosses a bar line, or when dots cannot be used to denote the rhythm. When using ties, larger note -values should be aligned to subdivisions of the measure, eg. +values should be aligned to subdivisions of the measure, such as @lilypond[fragment,quote,ragged-right] \relative { @@ -1551,7 +1553,6 @@ lines. When a second alternative of a repeat starts with a tied note, you have to repeat the tie. This can be achieved with @code{\repeatTie}, -eg. @lilypond[fragment,quote,ragged-right,relative=2] r \repeatTie @@ -2508,7 +2509,7 @@ arpeggios in one @internalsref{PianoStaff} at the same point in time. @node Polyphony @section Polyphony -Polyphony in music refers to having more than one voice occuring in +Polyphony in music refers to having more than one voice occurring in a piece of music. Polyphony in LilyPond refers to having more than one voice on the same staff. @@ -2557,7 +2558,7 @@ same voice. Here is the same example, with different noteheads for each voice. Note that the change to the note-head style in the main voice does not affect the inside of the @code{<< \\ >>} constructs. Also, the change to the second voice in the first @code{<< \\ >>} construct is effective in the second -@code{<< \\ >>}, and the voice is tied accross the two constructs. +@code{<< \\ >>}, and the voice is tied across the two constructs. @lilypond[quote,verbatim,fragment] \new Staff \relative c' { @@ -2664,7 +2665,7 @@ The correct definition of the voices allows the melody to be slurred. } @end lilypond -Avoiding the @code{\\} seperator also allows nesting polyphony +Avoiding the @code{\\} separator also allows nesting polyphony constructs, which in some case might be a more natural way to typeset the music. @@ -2887,6 +2888,13 @@ c1 \alternative { {d2 d} {f f,} } @end lilypond +In this example, the first ending is not a complete bar (it +only had 3 beats). The beginning of the second ending +contains the 4th beat from the first ending. This ``extra'' +beat in the second ending is due to the first time ending, +and has nothing to do with the @code{\partial} at the +beginning of the example. + @lilypond[quote,ragged-right,fragment,verbatim,relative=2] \new Staff { \partial 4 diff --git a/Documentation/user/global.itely b/Documentation/user/global.itely index f7d276ff5b..052c075a18 100644 --- a/Documentation/user/global.itely +++ b/Documentation/user/global.itely @@ -634,6 +634,23 @@ Setting the paper size will adjust a number of @code{\paper} variables LilyPond will do page layout, set margins, and add headers and footers to each page. +@cindex @code{annotate-spacing} +@cindex Spacing, display of properties + +To graphically display the dimensions of properties that may +be altered for page formatting, use + +@example +\paper @{ + annotate-spacing = ##t +@} +@end example + +@noindent +All units dimensions are measured in staff spaces. The pairs +(@var{a},@var{b}) are intervals, where @var{a} is the lower edge and +@var{b} the upper edge of the interval. + The default layout responds to the following settings in the @code{\paper} block. diff --git a/Documentation/user/instrument-notation.itely b/Documentation/user/instrument-notation.itely index c859f70812..c20497ab74 100644 --- a/Documentation/user/instrument-notation.itely +++ b/Documentation/user/instrument-notation.itely @@ -4093,7 +4093,7 @@ In this case, the extender lines always replace existing figures. The @code{FiguredBass} context doesn't pay attention to the actual bass line. As a consequence, you may have to insert extra figures to get extender lines below all notes, and you may have to add @code{\!} -to avoid getting an extender line, eg. +to avoid getting an extender line, e.g. @lilypond[relative=1] << diff --git a/Documentation/user/invoking.itely b/Documentation/user/invoking.itely index 9cfb8b18d9..2f4cf641d3 100644 --- a/Documentation/user/invoking.itely +++ b/Documentation/user/invoking.itely @@ -119,7 +119,8 @@ This mode is used by default by lilypond-book. @item -d,--define-default=@var{var}=@var{val} This sets the internal program option @var{var} to the Scheme value @var{val}. If @var{val} is not supplied, then @var{#t} is used. To -switch off an option, @code{no-} may be prefixed to @var{var}, eg. +switch off an option, @code{no-} may be prefixed to @var{var}, e.g. + @example -dno-point-and-click @end example @@ -259,7 +260,7 @@ be a single directory writable by this user, which should be passed in @item Preparing the jail LilyPond needs to read a number of files while running. All these files -are to be copied into the jail, under the same path they apper in the +are to be copied into the jail, under the same path they appear in the real root filesystem. The entire content of the LilyPond installation (e.g., @file{/usr/share/lilypond}) should be copied. @@ -412,7 +413,7 @@ test.ly:2:19: error: not a duration: 5: @end example These locations are LilyPond's best guess about where the warning or -error occured, but (by their very nature) warnings and errors occur +error occurred, but (by their very nature) warnings and errors occur when something unexpected happens. If you can't see an error in the indicated line of your input file, try checking one or two lines above the indicated position. diff --git a/Documentation/user/lilypond-book.itely b/Documentation/user/lilypond-book.itely index 09b6385be6..5549e46931 100644 --- a/Documentation/user/lilypond-book.itely +++ b/Documentation/user/lilypond-book.itely @@ -580,6 +580,10 @@ dvips -o -h yourfile.psfonts -Ppdf yourfile.dvi ps2pdf yourfile.ps @end example +The @file{.dvi} file created by this process will not contain +noteheads. This is normal; if you follow the instructions, they +will be included in the @file{.ps} and @file{.pdf} files. + To produce a Texinfo document (in any output format), follow the normal procedures for Texinfo (this is, either call @command{texi2dvi} or @command{makeinfo}, depending on the output format you want to diff --git a/Documentation/user/lilypond.tely b/Documentation/user/lilypond.tely index 7de59b3a21..205ba8f994 100644 --- a/Documentation/user/lilypond.tely +++ b/Documentation/user/lilypond.tely @@ -9,7 +9,7 @@ @direntry @ignore (I think) -Current version of the manual: 2.7.39 +Current version of the manual: 2.8.0 ****** Please update this whenever you run convert-ly on the docs. convert-ly --from=... --to=... --no-version *.itely diff --git a/Documentation/user/music-glossary.tely b/Documentation/user/music-glossary.tely index 08f03e9c14..b781d89c1e 100644 --- a/Documentation/user/music-glossary.tely +++ b/Documentation/user/music-glossary.tely @@ -5029,7 +5029,7 @@ symphony orchestra are flute, oboe, clarinet, saxophone, and bassoon. @item @tab @strong{UK} @tab @strong{I} - @tab @strong{F} + @tab @strong{F (note name / rest name)} @item @tab @strong{D} @tab @strong{NL} @@ -5059,7 +5059,7 @@ symphony orchestra are flute, oboe, clarinet, saxophone, and bassoon. @item @strong{breve} @tab breve @tab breve - @tab brève + @tab brève / double-pause @item @tab Brevis @tab brevis @@ -5074,7 +5074,7 @@ symphony orchestra are flute, oboe, clarinet, saxophone, and bassoon. @item @strong{whole} @tab semi@-breve @tab semi@-breve - @tab ronde + @tab ronde / pause @item @tab Ganze @tab hele @@ -5089,7 +5089,7 @@ symphony orchestra are flute, oboe, clarinet, saxophone, and bassoon. @item @strong{half} @tab minim @tab minima - @tab blanche + @tab blanche / demi-pause @item @tab Halbe @tab halve @@ -5104,7 +5104,7 @@ symphony orchestra are flute, oboe, clarinet, saxophone, and bassoon. @item @strong{quarter} @tab crotchet @tab semiminima - @tab noire + @tab noire / soupir @item @tab Viertel @tab kwart @@ -5119,7 +5119,7 @@ symphony orchestra are flute, oboe, clarinet, saxophone, and bassoon. @item @strong{eighth} @tab quaver @tab croma - @tab croche + @tab croche / semi-pause @item @tab Achtel @tab achtste @@ -5134,7 +5134,7 @@ symphony orchestra are flute, oboe, clarinet, saxophone, and bassoon. @item @strong{sixteenth} @tab semiquaver @tab semicroma - @tab double croche + @tab double croche / quart de soupir @item @tab Sechzehntel @tab zestiende @@ -5149,7 +5149,7 @@ symphony orchestra are flute, oboe, clarinet, saxophone, and bassoon. @item @strong{thirty-second} @tab demisemiquaver @tab biscroma - @tab triple croche + @tab triple croche / huitième de soupir @item @tab Zweiunddreissigstel @tab tweeendertigste @@ -5164,7 +5164,7 @@ symphony orchestra are flute, oboe, clarinet, saxophone, and bassoon. @item @strong{sixty-fourth} @tab hemidemisemiquaver @tab semibiscroma - @tab quadruple croche + @tab quadruple croche / seizième de soupir @item @tab Vierundsechzigstel @tab vierenzestigste diff --git a/Documentation/user/programming-interface.itely b/Documentation/user/programming-interface.itely index 8c45e57d26..14aa7dffe9 100644 --- a/Documentation/user/programming-interface.itely +++ b/Documentation/user/programming-interface.itely @@ -589,7 +589,7 @@ a list of alists, containing all active properties. @end table 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 +which selects a small caps font. Normally, we could select the small caps font as follows: @example @@ -719,6 +719,10 @@ the markups built for each token are put in a line by to the @code{interpret-markup} function, with the @code{layout} and @code{props} arguments. +Note: there is now an internal command @code{\smallCaps} which can +be used to set text in small caps. See +@ref{Overview of text markup commands} for details. + @node Contexts for programmers diff --git a/Documentation/user/putting.itely b/Documentation/user/putting.itely index d4af541acf..2cda151c08 100644 --- a/Documentation/user/putting.itely +++ b/Documentation/user/putting.itely @@ -59,12 +59,12 @@ the first time, but if you want to go back and change something two or three years later, you won't know how your file is structured if you didn't comment the file. -@item Ident your braces. A lot of problems are caused by an imbalance +@item Indent your braces. A lot of problems are caused by an imbalance in the number of @code{@{} and @code{@}}. @end itemize -If you are entering music from an existing score (ie typesetting a +If you are entering music from an existing score (i.e. typesetting a piece of existing sheet music), @itemize @bullet @@ -319,7 +319,7 @@ e4^\markup{ \italic ritenuto } g b e @end lilypond With @code{extra-offset}, the first number controls the horizontal -movement (left is negative); the second number controls the vertial +movement (left is negative); the second number controls the vertical movement (up is positive). After a bit of experimenting, we decided that these values look good -- 2.39.5