From e3fbf0543b38e5c20155cef9dc48d70e91da45c2 Mon Sep 17 00:00:00 2001 From: Werner Lemberg Date: Tue, 10 Apr 2007 16:21:23 +0200 Subject: [PATCH] @ref{...} must *always* be followed by punctuation. --- Documentation/user/advanced-notation.itely | 16 +++---- Documentation/user/basic-notation.itely | 8 ++-- Documentation/user/changing-defaults.itely | 8 ++-- Documentation/user/converters.itely | 6 +-- Documentation/user/instrument-notation.itely | 18 ++++---- Documentation/user/introduction.itely | 43 ++++++++++--------- Documentation/user/music-glossary.tely | 2 +- Documentation/user/non-music.itely | 4 +- .../user/programming-interface.itely | 4 +- Documentation/user/running.itely | 2 +- Documentation/user/spacing.itely | 4 +- Documentation/user/tutorial.itely | 22 +++++----- Documentation/user/tweaks.itely | 6 +-- Documentation/user/working.itely | 6 +-- 14 files changed, 75 insertions(+), 74 deletions(-) diff --git a/Documentation/user/advanced-notation.itely b/Documentation/user/advanced-notation.itely index c4c2d4895d..d8be87f2e4 100644 --- a/Documentation/user/advanced-notation.itely +++ b/Documentation/user/advanced-notation.itely @@ -59,7 +59,7 @@ saved as UTF-8. For more information, see @ref{Text encoding}. @cindex text items, non-empty @cindex non-empty texts -It is possible to place arbitrary strings of text or @ref{Text markup} +It is possible to place arbitrary strings of text or @ref{Text markup}, above or below notes by using a string @code{c^"text"}. By default, these indications do not influence the note spacing, but by using the command @code{\fatText}, the widths will be taken into account @@ -304,7 +304,7 @@ The @code{\mark} command is primarily used for but it can also be used to put signs like coda, segno, and fermata on a bar line. Use @code{\markup} to access the appropriate symbol (symbols are listed in -@ref{The Feta font}) +@ref{The Feta font}). @lilypond[fragment,quote,ragged-right,verbatim,relative=2] c1 \mark \markup { \musicglyph #"scripts.ufermata" } @@ -417,7 +417,7 @@ c1_\markup { "\special {weird} #characters" } @end lilypond @noindent -See @ref{Overview of text markup commands} for a list of all +See @ref{Overview of text markup commands}, for a list of all commands. @code{\markup} is primarily used for @internalsref{TextScript}s, @@ -535,7 +535,7 @@ c'4^\markup{ \hspace #0 \raise #1.5 raised } Some situations (such as dynamic marks) have preset font-related properties. If you are creating text in such situations, it is advisable to cancel those properties with -@code{normal-text}. See @ref{Overview of text markup commands} +@code{normal-text}. See @ref{Overview of text markup commands}, for more details. @@ -706,7 +706,7 @@ marks. Note that the dynamic font only contains the characters Some situations (such as dynamic marks) have preset font-related properties. If you are creating text in such situations, it is advisable to cancel those properties with -@code{normal-text}. See @ref{Overview of text markup commands} +@code{normal-text}. See @ref{Overview of text markup commands}, for more details. @cindex make-dynamic-script @@ -906,7 +906,7 @@ c4^\markup { @end lilypond @noindent -See @ref{Text markup} for more details. +See @ref{Text markup}, for more details. @seealso @@ -1011,7 +1011,7 @@ c1 @end lilypond @noindent -See @ref{The Feta font} for a list of symbols which may be +See @ref{The Feta font}, for a list of symbols which may be printed with @code{\musicglyph}. The horizontal location of rehearsal marks can be adjusted by @@ -2549,7 +2549,7 @@ An x11 color is not necessarily exactly the same shade as a similarly named normal color. Notes in a chord cannot be colored with @code{\override}; use -@code{\tweak} instead. See @ref{Objects connected to the input} +@code{\tweak} instead. See @ref{Objects connected to the input}, for details. diff --git a/Documentation/user/basic-notation.itely b/Documentation/user/basic-notation.itely index 107f6f42ec..a105e4a242 100644 --- a/Documentation/user/basic-notation.itely +++ b/Documentation/user/basic-notation.itely @@ -854,7 +854,7 @@ b16*4 c4 @seealso -This manual: @ref{Tuplets} +This manual: @ref{Tuplets}. @node Bar check @@ -1505,7 +1505,7 @@ can be specified by setting this property directly. Accidentals and key signatures often confuse new users, because unaltered notes get natural signs depending on the key signature. For -more information, see @ref{Accidentals} or @ref{Accidentals and key signatures}. +more information, see @ref{Accidentals}, or @ref{Accidentals and key signatures}. @lilypond[quote,ragged-right,verbatim,relative=2,fragment] \key g \major @@ -1571,7 +1571,7 @@ property. Setting it to @code{#'()} uses fraction style for 4/4 and @end lilypond There are many more options for its layout. See @ref{Ancient time -signatures} for more examples. +signatures}, for more examples. @code{\time} sets the property @code{timeSignatureFraction}, @code{beatLength} and @code{measureLength} in the @code{Timing} @@ -2267,7 +2267,7 @@ LilyPond inserts beams automatically When these automatic decisions are not good enough, beaming can be entered explicitly. It is also possible to define beaming patterns -that differ from the defaults. See @ref{Setting automatic beam behavior} +that differ from the defaults. See @ref{Setting automatic beam behavior}, for details. Individual notes may be marked with @code{\noBeam} to prevent them diff --git a/Documentation/user/changing-defaults.itely b/Documentation/user/changing-defaults.itely index 717384d19d..2a48f07f0a 100644 --- a/Documentation/user/changing-defaults.itely +++ b/Documentation/user/changing-defaults.itely @@ -56,14 +56,14 @@ notation. For example, giving each staff a separate time signature. @item Page layout: changing the appearance of the spacing, line breaks, and page dimensions. These modifications are discussed -in @ref{Non-musical notation} and @ref{Spacing issues}. +in @ref{Non-musical notation}, and @ref{Spacing issues}. @end itemize Internally, LilyPond uses Scheme (a LISP dialect) to provide infrastructure. Overriding layout decisions in effect accesses the program internals, which requires Scheme input. Scheme elements are introduced in a @code{.ly} file with the hash mark -@code{#}.@footnote{@ref{Scheme tutorial} contains a short tutorial +@code{#}.@footnote{@ref{Scheme tutorial}, contains a short tutorial on entering numbers, lists, strings, and symbols in Scheme.} @@ -889,7 +889,7 @@ Here @var{name} is the name of a graphical object, like @code{Stem} or @code{NoteHead}, and @var{property} is an internal variable of the formatting system (@q{grob property} or @q{layout property}). The latter is a symbol, so it must be quoted. The subsection @ref{Constructing a -tweak} explains what to fill in for @var{name}, @var{property}, and +tweak}, explains what to fill in for @var{name}, @var{property}, and @var{value}. Here we only discuss the functionality of this command. The command @@ -1637,7 +1637,7 @@ to output, so @end example @noindent -does not change color. See @ref{Displaying music expressions} for +does not change color. See @ref{Displaying music expressions}, for details. diff --git a/Documentation/user/converters.itely b/Documentation/user/converters.itely index bc92313afa..d8a3d8c2d6 100644 --- a/Documentation/user/converters.itely +++ b/Documentation/user/converters.itely @@ -75,7 +75,7 @@ midi2ly [@var{option}]@dots{} @var{midi-file} @end example Note that by @q{command-line}, we mean the command line of the -operating system. See @ref{Converting from other formats} for +operating system. See @ref{Converting from other formats}, for more information about this. The following options are supported by @command{midi2ly}. @@ -147,7 +147,7 @@ etf2ly [@var{option}]@dots{} @var{etf-file} @end example Note that by @q{command-line}, we mean the command line of the -operating system. See @ref{Converting from other formats} for +operating system. See @ref{Converting from other formats}, for more information about this. The following options are supported by @command{etf2ly}: @@ -177,7 +177,7 @@ for representing music notation. files, and writes it to a .ly file. It is invoked from the command-line. Note that by @q{command-line}, we mean the command line of the -operating system. See @ref{Converting from other formats} for +operating system. See @ref{Converting from other formats}, for more information about this. The following options are supported by @command{musicxml2ly}: diff --git a/Documentation/user/instrument-notation.itely b/Documentation/user/instrument-notation.itely index 61473e29e4..d9583caff3 100644 --- a/Documentation/user/instrument-notation.itely +++ b/Documentation/user/instrument-notation.itely @@ -221,7 +221,7 @@ c\sostenutoDown d e c, f g a\sostenutoUp @seealso -In this manual: @ref{Laissez vibrer ties} +In this manual: @ref{Laissez vibrer ties}. @node Staff switch lines @subsection Staff switch lines @@ -818,7 +818,7 @@ glyph. To enter lyrics with characters from non-English languages, or with accented and special characters (such as the heart symbol or slanted quotes), simply insert the characters directly into the input file and save -it with utf-8 encoding. See @ref{Text encoding} for more info. +it with utf-8 encoding. See @ref{Text encoding}, for more info. @lilypond[quote,ragged-right,fragment,verbatim] \relative { e4 f e d e f e2 } @@ -2550,12 +2550,12 @@ the proper note heads, so there is no need to explicitly set the note head style. Still, the note head style can be set, e.g., to @code{vaticana_punctum} to produce punctum neumes. Similarly, a @internalsref{Mensural_ligature_engraver} is used to automatically -assemble mensural ligatures. See @ref{Ligatures} for how ligature +assemble mensural ligatures. See @ref{Ligatures}, for how ligature engravers work. @seealso -@ref{Note head styles} gives an overview over all available note head styles. +@ref{Note head styles}, gives an overview over all available note head styles. @node Ancient accidentals @@ -2618,9 +2618,9 @@ controlled by the @code{glyph-name-alist} property of the @seealso -In this manual: @ref{Pitches}, @ref{Cautionary accidentals} and -@ref{Automatic accidentals} give a general introduction of the use of -accidentals. @ref{Key signature} gives a general introduction of +In this manual: @ref{Pitches}, @ref{Cautionary accidentals}, and +@ref{Automatic accidentals}, give a general introduction of the use of +accidentals. @ref{Key signature}, gives a general introduction of the use of key signatures. Program reference: @internalsref{KeySignature}. @@ -2660,7 +2660,7 @@ There are no rests in Gregorian Chant notation; instead, it uses @seealso -In this manual: @ref{Rests} gives a general introduction into the use of +In this manual: @ref{Rests}, gives a general introduction into the use of rests. @@ -3033,7 +3033,7 @@ The following examples show the differences in style, @seealso -This manual: @ref{Time signature} gives a general introduction to +This manual: @ref{Time signature}, gives a general introduction to the use of time signatures. @refbugs diff --git a/Documentation/user/introduction.itely b/Documentation/user/introduction.itely index f1bf39a055..554c039e17 100644 --- a/Documentation/user/introduction.itely +++ b/Documentation/user/introduction.itely @@ -697,72 +697,73 @@ The manual is divided into the following chapters: @ifhtml The @end ifhtml -@emph{@ref{Tutorial}} +@emph{@ref{Tutorial}}, gives a gentle introduction to typesetting music. First time users should start here. @item -@emph{@ref{Putting it all together}} +@emph{@ref{Putting it all together}}, explains some general concepts about the lilypond file format. If you are not certain where to place a command, read this chapter! @item -@emph{@ref{Working on LilyPond projects}} +@emph{@ref{Working on LilyPond projects}}, discusses practical uses of LilyPond and how to avoid some common problems. @item -@emph{@ref{Tweaking output}} +@emph{@ref{Tweaking output}}, shows how to change the default engraving that LilyPond produces. @item -@emph{@ref{Basic notation}} +@emph{@ref{Basic notation}}, discusses topics grouped by notation construct. This section gives details about basic notation that will be useful in almost any notation project. @item -@emph{@ref{Instrument-specific notation}} +@emph{@ref{Instrument-specific notation}}, discusses topics grouped by notation construct. This section gives details about special notation that will only be useful for particular instrument (or vocal) groups. @item -@emph{@ref{Advanced notation}} +@emph{@ref{Advanced notation}}, discusses topics grouped by notation construct. This section gives details about complicated or unusual notation. @item -@emph{@ref{Changing defaults}} +@emph{@ref{Changing defaults}}, explains how to fine tune layout. @item -@emph{@ref{Non-musical notation}} +@emph{@ref{Non-musical notation}}, discusses non-musical output such as titles, multiple movements, and how to select which MIDI instruments to use. @item -@emph{@ref{Spacing issues}} +@emph{@ref{Spacing issues}}, discusses issues which affect the global output, such as selecting paper size or specifying page breaks. @item -@emph{@ref{Interfaces for programmers}} +@emph{@ref{Interfaces for programmers}}, explains how to create music functions. @item -@emph{@ref{Running LilyPond}} +@emph{@ref{Running LilyPond}}, shows how to run LilyPond and its helper programs. In addition, this section explains how to upgrade input files from previous versions of LilyPond. @item -@emph{@ref{LilyPond-book}} explains the details behind creating +@emph{@ref{LilyPond-book}}, +explains the details behind creating documents with in-line music examples, like this manual. @item -@emph{@ref{Converting from other formats}} +@emph{@ref{Converting from other formats}}, explains how to run the conversion programs. These programs are supplied with the LilyPond package, and convert a variety of music formats to the @code{.ly} format. @@ -771,39 +772,39 @@ formats to the @code{.ly} format. @ifhtml The @end ifhtml -@emph{@ref{Literature list}} +@emph{@ref{Literature list}}, contains a set of useful reference books for those who wish to know more on notation and engraving. @item The -@emph{@ref{Scheme tutorial}} +@emph{@ref{Scheme tutorial}}, presents a short introduction to Scheme, the programming language that music functions use. @item -@emph{@ref{Notation manual tables}} +@emph{@ref{Notation manual tables}}, are a set of tables showing the chord names, MIDI instruments, a list of color names, and the Feta font. @item -@emph{@ref{Templates}} +@emph{@ref{Templates}}, of LilyPond pieces. Just cut and paste a template into a file, add notes, and you're done! @item The -@emph{@ref{Cheat sheet}} +@emph{@ref{Cheat sheet}}, is a handy reference of the most common LilyPond commands. @item The -@emph{@ref{LilyPond command index}} +@emph{@ref{LilyPond command index}}, is an index of all LilyPond @code{\commands}. @item The -@emph{@ref{LilyPond index}} +@emph{@ref{LilyPond index}}, is a complete index. @end itemize diff --git a/Documentation/user/music-glossary.tely b/Documentation/user/music-glossary.tely index a2c7b04e10..984aae2a14 100644 --- a/Documentation/user/music-glossary.tely +++ b/Documentation/user/music-glossary.tely @@ -3615,7 +3615,7 @@ melodic line of the contrapunctal web. @node pause @section pause -@ref{fermata} +@ref{fermata}. @node pennant @section pennant diff --git a/Documentation/user/non-music.itely b/Documentation/user/non-music.itely index c8754c5bb1..65e49e8351 100644 --- a/Documentation/user/non-music.itely +++ b/Documentation/user/non-music.itely @@ -74,7 +74,7 @@ c'4 @noindent will result in a parsing error. Instead, music should be inside other expressions, which may be put in a file by themselves. Such -expressions are called toplevel expressions; see @ref{File structure} for +expressions are called toplevel expressions; see @ref{File structure}, for a list of all such expressions. @@ -557,7 +557,7 @@ Centered at the bottom of the last page. @end table Here is a demonstration of the fields available. Note that you -may use any @ref{Text markup} commands in the header. +may use any @ref{Text markup}, commands in the header. @lilypond[quote,verbatim,line-width=11.0\cm] \paper { diff --git a/Documentation/user/programming-interface.itely b/Documentation/user/programming-interface.itely index 7b59a3e8c5..e55d26471b 100644 --- a/Documentation/user/programming-interface.itely +++ b/Documentation/user/programming-interface.itely @@ -377,7 +377,7 @@ been written as Scheme code is evaluated as soon as the parser encounters it. To define some Scheme code in a macro (to be called later), use -@ref{Void functions} or +@ref{Void functions}, or @example #(define (nopc) @@ -1111,7 +1111,7 @@ to the @code{interpret-markup} function, with the @code{layout} and 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. +@ref{Overview of text markup commands}, for details. diff --git a/Documentation/user/running.itely b/Documentation/user/running.itely index 981e71867a..0644f34220 100644 --- a/Documentation/user/running.itely +++ b/Documentation/user/running.itely @@ -595,7 +595,7 @@ bug by following the directions on @uref{http://lilypond.org/web/devel/participating/bugs} -Please construct submit @ref{Minimal examples} of bug reports. We do not +Please construct submit @ref{Minimal examples}, of bug reports. We do not have the resources to investigate reports which are not as small as possible. diff --git a/Documentation/user/spacing.itely b/Documentation/user/spacing.itely index 708e8d0981..fbeb4c9dfd 100644 --- a/Documentation/user/spacing.itely +++ b/Documentation/user/spacing.itely @@ -508,7 +508,7 @@ layout. @seealso -This manual: @ref{Changing context default settings} +This manual: @ref{Changing context default settings}. @node Displaying spacing @@ -1788,7 +1788,7 @@ means that, by default, @code{uniform-stretching} is either turned on for the entire score or turned off for the entire score. We can, however, override this behavior and turn on different spacing features at different places in the score. We do this with the command -@code{\newSpacingSection}. See @ref{New spacing area} for more info. +@code{\newSpacingSection}. See @ref{New spacing area}, for more info. Next we examine the effects of the @code{Separating_line_group_engraver} and see why proportional scores frequently remove this engraver. The following diff --git a/Documentation/user/tutorial.itely b/Documentation/user/tutorial.itely index 9b17df98d2..3c47c95bc7 100644 --- a/Documentation/user/tutorial.itely +++ b/Documentation/user/tutorial.itely @@ -114,8 +114,8 @@ line to avoid ambiguities. These may be omitted in some examples in this manual, but don't forget them in your own music! @cindex Case sensitive -In addition, LilyPond input is @strong{case sensitive}. @code{ @{ c d e @} } -is valid input; @code{ @{ C D E @} } will produce an error message. +In addition, LilyPond input is @strong{case sensitive}. @code{ @{c d e @}} +is valid input; @code{@{ C D E @}} will produce an error message. @sp 1 @@ -126,7 +126,7 @@ and how to view or print the output. @subsubheading MacOS X -If you double click LilyPond.app, it will open with an example +If you double click @code{LilyPond.app}, it will open with an example file. Save it, for example, to @file{test.ly} on your Desktop, and then process it with the menu command @samp{Compile > Typeset File}. The resulting PDF file will be displayed on your screen. @@ -135,7 +135,7 @@ Be warned that the first time you ever run LilyPond, it will take a minute or two because all of the system fonts have to be analyzed first. For future use of LilyPond, you should begin by selecting @q{New} -or "@q{Open}. You must save your file before typesetting it. If any errors +or @q{Open}. You must save your file before typesetting it. If any errors occur in processing, please see the log window. @subsubheading Windows @@ -158,7 +158,7 @@ produces a @file{.log} file that contains some information on what LilyPond has done to the file. If any errors occur, please examine this file. Note that there are several other text editors available, with better -support for LilyPond, see @ref{Editor support} for more information. +support for LilyPond, see @ref{Editor support}, for more information. @subsubheading Unix @@ -168,7 +168,7 @@ example, you could open an xterm and execute is a @code{LilyPond-mode} for Emacs addicts. If they have not been installed already, refer to the file @file{INSTALL.txt}. The easiest editing environment is @file{LilyPondTool}. See -@ref{Editor support} for more information.}. In your +@ref{Editor support}, for more information.}. In your text editor, enter the following input and save the file as @file{test.ly} @@ -369,7 +369,7 @@ Here is a small example showing all these elements together: @quotation @table @asis @item Entering pitches and durations -see @ref{Pitches} and @ref{Durations}. +see @ref{Pitches}, and @ref{Durations}. @item Rests see @ref{Rests}. @item Time signatures and other timing commands @@ -610,14 +610,14 @@ e Adding all alterations explicitly might require a little more effort when typing, but the advantage is that transposing is easier, and accidentals can be printed according to different conventions. See -@ref{Automatic accidentals} for some examples how accidentals can be printed +@ref{Automatic accidentals}, for some examples how accidentals can be printed according to different rules. @moreinfo @quotation @table @asis @item Accidentals -see @ref{Accidentals} and @ref{Automatic accidentals}. +see @ref{Accidentals}, and @ref{Automatic accidentals}. @item Key signature see @ref{Key signature}. @end table @@ -1001,7 +1001,7 @@ sign in mathematics. The formula @math{(4+5)} is an expression, so Time signatures entered in one staff affects all other staves, but the key signature of one staff does @emph{not} affect other staves@footnote{This behavior may be changed if desired; see -@ref{Changing defaults} for details.}. +@ref{Changing defaults}, for details.}. @lilypond[quote,ragged-right,verbatim] \relative c'' { @@ -1459,7 +1459,7 @@ places. The following example uses the above variables: @subsection After the tutorial After finishing the tutorial, you should probably try writing a -piece or two. Start with one of the @ref{Templates} and +piece or two. Start with one of the @ref{Templates}, and add notes. If you need any notation that was not covered in the tutorial, look at the Notation Reference, starting with @ref{Basic notation}. If you want to write for an instrument diff --git a/Documentation/user/tweaks.itely b/Documentation/user/tweaks.itely index 6d24d3a422..8c681e5a61 100644 --- a/Documentation/user/tweaks.itely +++ b/Documentation/user/tweaks.itely @@ -377,7 +377,7 @@ of room left on those. When investigating layout issues, @code{annotate-spacing} is an invaluable tool. This command prints the values of various -layout spacing commands; see @ref{Displaying spacing} for more +layout spacing commands; see @ref{Displaying spacing}, for more details. From the output of @code{annotate-spacing}, we can see which margins we may wish to alter. @@ -431,7 +431,7 @@ a system. @item Alter the horizontal spacing via @code{SpacingSpanner}. See -@ref{Changing horizontal spacing} for more details. +@ref{Changing horizontal spacing}, for more details. @lilypond[verbatim,quote] \score { @@ -461,7 +461,7 @@ We have seen how LilyPond output can be heavily modified using commands like @code{\override TextScript #'extra-offset = ( 1 . -1)}. But we have even more power if we use Scheme. For a full explantion -of this, see the @ref{Scheme tutorial} and +of this, see the @ref{Scheme tutorial}, and @ref{Interfaces for programmers}. We can use Scheme to simply @code{\override} commands, diff --git a/Documentation/user/working.itely b/Documentation/user/working.itely index 65bf9a656b..8a416f7ad7 100644 --- a/Documentation/user/working.itely +++ b/Documentation/user/working.itely @@ -77,7 +77,7 @@ quite frustrating to try to remember which version of LilyPond you were using a few years ago. @code{convert-ly} requires you to declare which version of LilyPond you used. -@item @strong{Include checks}: @ref{Bar check}, @ref{Octave check} and +@item @strong{Include checks}: @ref{Bar check}, @ref{Octave check}, and @ref{Barnumber check}. If you include checks every so often, then if you make a mistake, you can pinpoint it quicker. How often is @q{every so often}? It depends on the complexity @@ -110,7 +110,7 @@ phrase (instead of just @code{c d e}) you can save yourself some problems if you rearrange your music later. @item @strong{Separate tweaks} from music definitions. See -@ref{Saving typing with identifiers and functions} and +@ref{Saving typing with identifiers and functions}, and @ref{Style sheets}. @end itemize @@ -295,7 +295,7 @@ instead of making changes throughout every @code{.ly} file. @section Style sheets The output that LilyPond produces can be heavily modified; see -@ref{Tweaking output} for details. But what if you have many +@ref{Tweaking output}, for details. But what if you have many files that you want to apply your tweaks to? Or what if you simply want to separate your tweaks from the actual music? This is quite easy to do. -- 2.39.2