From d6315a746c47259f56dc2835347985658d71d0c9 Mon Sep 17 00:00:00 2001 From: Werner Lemberg Date: Wed, 17 Aug 2011 19:22:21 +0200 Subject: [PATCH] [doc] Handle leading dash in @code. Due to the default value of texinfo.tex's `@allowcodebreaks true', line breaks after a dash within @code is allowed; this makes sense due to the very long Scheme identifiers containing many dashes. However, we have a lot of `@code{-1}', and it looks very ugly to have a line break within this expression. This patch fixes it (also converting many `@code' to the correct `@option'), using `@w{...}' where appropriate. However, I've done it only for the English documentation, expecting the translators to follow up. --- Documentation/changes.tely | 2 +- .../contributor/administration.itexi | 6 +-- Documentation/contributor/build-notes.itexi | 2 +- Documentation/contributor/lsr-work.itexi | 2 +- .../contributor/programming-work.itexi | 8 ++-- Documentation/contributor/source-code.itexi | 14 +++---- Documentation/extending/scheme-tutorial.itely | 4 +- Documentation/included/compile.itexi | 8 ++-- Documentation/learning/common-notation.itely | 2 +- Documentation/learning/tweaks.itely | 16 ++++---- .../notation/changing-defaults.itely | 32 +++++++-------- Documentation/notation/input.itely | 4 +- Documentation/notation/rhythms.itely | 2 +- Documentation/notation/spacing.itely | 2 +- Documentation/notation/vocal.itely | 2 +- Documentation/snippets/clip-systems.ly | 4 +- .../dynamics-custom-text-spanner-postfix.ly | 2 +- ...ues-for-articulation-shorthand-notation.ly | 8 ++-- Documentation/snippets/new/clip-systems.ly | 2 +- Documentation/usage/external.itely | 2 +- Documentation/usage/lilypond-book.itely | 18 ++++----- Documentation/usage/running.itely | 40 +++++++++---------- Documentation/usage/updating.itely | 4 +- Documentation/web/introduction.itexi | 4 +- Documentation/web/news.itexi | 2 +- input/regression/clip-systems.ly | 2 +- input/regression/midi/key-option.ly | 2 +- input/regression/midi/quantize-duration-2.ly | 2 +- input/regression/midi/quantize-duration.ly | 2 +- input/regression/midi/quantize-start.ly | 2 +- input/regression/skyline-debug.ly | 2 +- lily/general-scheme.cc | 6 +-- lily/item-scheme.cc | 2 +- lily/item.cc | 2 +- lily/spanner-scheme.cc | 2 +- lily/stencil-scheme.cc | 2 +- scm/define-grob-properties.scm | 17 ++++---- scm/define-markup-commands.scm | 2 +- scm/define-music-types.scm | 6 +-- scm/fret-diagrams.scm | 4 +- scm/music-functions.scm | 2 +- 41 files changed, 125 insertions(+), 124 deletions(-) diff --git a/Documentation/changes.tely b/Documentation/changes.tely index 1c210579fa..f5e4f151d2 100644 --- a/Documentation/changes.tely +++ b/Documentation/changes.tely @@ -62,7 +62,7 @@ which scares away people. @end ignore @item -New command-line option @code{--loglevel=LEVEL} to control how much output +New command-line option @option{--loglevel=@var{level}} to control how much output LilyPond creates. Possible values are ERROR, WARN, BASIC_PROGRESS, PROGRESS, DEBUG. @item diff --git a/Documentation/contributor/administration.itexi b/Documentation/contributor/administration.itexi index 5c1abe6c80..36ead431e1 100644 --- a/Documentation/contributor/administration.itexi +++ b/Documentation/contributor/administration.itexi @@ -20,7 +20,7 @@ don't fit anywhere else. The Contributor's Guide as a whole is still a work in progress, but some chapters are much more complete than others. Chapters which are @qq{almost finished} should not have major changes -without a discussion on @code{-devel}; in other chapters, a +without a discussion on @w{@code{-devel}}; in other chapters, a disorganized @qq{wiki-style dump} of information is encouraged. Do not change (other than spelling mistakes) without discussion: @@ -110,9 +110,9 @@ Currently: Francisco @item Frog Meister: is responsible for code patches from (relatively) inexperienced contributors. Keeps track of patches, does initial -reviewing of those patches, sends them to @code{-devel} when +reviewing of those patches, sends them to @w{@code{-devel}} when they've had some initial review on the Frog list, pesters the -@code{-devel} community into actually reviewing said patches, and +@w{@code{-devel}} community into actually reviewing said patches, and finally pushes the patches once they're accepted. This person is @emph{not} responsible for training new programmers, because that would be far too much work -- he job is @qq{only} to guide diff --git a/Documentation/contributor/build-notes.itexi b/Documentation/contributor/build-notes.itexi index 16726b1bc2..b84bdbef60 100644 --- a/Documentation/contributor/build-notes.itexi +++ b/Documentation/contributor/build-notes.itexi @@ -347,7 +347,7 @@ install-WWW: @end smallexample I don't currently understand the @code{ifeq}, since @code{$(out)} -is empty at this point, but the line starting @code{-$(INSTALL)} +is empty at this point, but the line starting @w{@code{-$(INSTALL)}} translates to: @example diff --git a/Documentation/contributor/lsr-work.itexi b/Documentation/contributor/lsr-work.itexi index 647c8afc0a..1ba8730640 100644 --- a/Documentation/contributor/lsr-work.itexi +++ b/Documentation/contributor/lsr-work.itexi @@ -260,7 +260,7 @@ To update LSR, perform the following steps: @item Download the latest snippet tarball, extract it, and run @code{convert-ly} on all files using the command-line option -@code{--to=VERSION} to ensure snippets are updated to the +@option{--to=@var{version}} to ensure snippets are updated to the correct stable version. @item diff --git a/Documentation/contributor/programming-work.itexi b/Documentation/contributor/programming-work.itexi index b90042d7a3..f11406f5fd 100644 --- a/Documentation/contributor/programming-work.itexi +++ b/Documentation/contributor/programming-work.itexi @@ -219,7 +219,7 @@ grep -i functionName subdirectory/* This command will search all the contents of the directory subdirectory/ and display every line in any of the files that contains -functionName. The @code{-i} option makes @command{grep} ignore +functionName. The @option{-i} option makes @command{grep} ignore case -- this can be very useful if you are not yet familiar with our capitalization conventions. @@ -731,7 +731,7 @@ the console should be: @end itemize The loglevel can either be set with the environment variable -@code{LILYPOND_LOGLEVEL} or on the command line with the @code{--loglevel=...} +@code{LILYPOND_LOGLEVEL} or on the command line with the @option{--loglevel=...} option. @unnumberedsubsec Functions for debug and log output @@ -1181,7 +1181,7 @@ number of different platforms: In order for the Graphviz tool to work, config.make must be modified. It is probably a good idea to first save a copy of config.make under a different name. Then, edit config.make by removing every occurrence -of @code{-DNDEBUG}. +of @option{-DNDEBUG}. @item Rebuilding LilyPond @@ -1229,7 +1229,7 @@ dot -Tpdf graphviz.log > graphviz.pdf The pdf file can then be viewed with any pdf viewer. -When compiled without @code{-DNDEBUG}, lilypond may run slower +When compiled without @option{-DNDEBUG}, lilypond may run slower than normal. The original configuration can be restored by either renaming the saved copy of @code{config.make} or rerunning @code{configure}. Then rebuild lilypond with diff --git a/Documentation/contributor/source-code.itexi b/Documentation/contributor/source-code.itexi index fee5e36717..60c8ca2c12 100644 --- a/Documentation/contributor/source-code.itexi +++ b/Documentation/contributor/source-code.itexi @@ -196,7 +196,7 @@ should configure some basic settings with the global and repository-specific options. To configure settings that affect all repositories, use the -@command{--global} command line option. For example, the first +@option{--global} command line option. For example, the first two options that you should always set are your @var{name} and @var{email}, since Git needs these to keep track of commit authors: @@ -247,7 +247,7 @@ by the above commands would look like this: @end example Using the @command{git@tie{}config} command @emph{without} the -@command{--global} option configures repository-specific settings, +@option{--global} option configures repository-specific settings, which are stored in the file @file{.git/config}. This file is created when a repository is initialized (using @command{git@tie{}init}), and by default contains these lines: @@ -522,7 +522,7 @@ git pull # recommended for translators @end example If you're tracking the remote @code{master} branch, you should add -the @code{-r} option (short for @code{--rebase}) to keep commits +the @option{-r} option (short for @option{--rebase}) to keep commits on your local branch current: @example @@ -530,7 +530,7 @@ git pull -r # use with caution when translating @end example If you don't edit translated documentation and don't want to type -@code{-r} every time, configure the master branch to rebase by +@option{-r} every time, configure the master branch to rebase by default with this command: @example @@ -629,7 +629,7 @@ git branch -d @var{name} @end example Git will ask you for confirmation if it sees that data would be -lost by deleting the branch. Use @code{-D} instead of @code{-d} +lost by deleting the branch. Use @option{-D} instead of @option{-d} to bypass this. Note that you cannot delete a branch if it is currently checked out. @@ -801,7 +801,7 @@ git commit -a @end example @noindent -The @code{-a} is short for @code{--all} which includes modified +The @option{-a} is short for @option{--all} which includes modified and deleted files, but only those newly created files that have previously been added. @@ -873,7 +873,7 @@ We prefer it if you follow the instructions in alternate method here. You should always run @command{git@tie{}pull@tie{}-r} (translators -should leave off the @code{-r}) before doing this to ensure that +should leave off the @option{-r}) before doing this to ensure that your patches are as current as possible. Once you have made one or more commits in your local repository, diff --git a/Documentation/extending/scheme-tutorial.itely b/Documentation/extending/scheme-tutorial.itely index 7b38a76ef9..d94b718918 100644 --- a/Documentation/extending/scheme-tutorial.itely +++ b/Documentation/extending/scheme-tutorial.itely @@ -148,7 +148,7 @@ and False is @code{#f}. @item Numbers Numbers are entered in the standard fashion, -@code{1} is the (integer) number one, while @code{-1.5} is a +@code{1} is the (integer) number one, while @w{@code{-1.5}} is a floating point number (a non-integer number). @item Strings @@ -780,7 +780,7 @@ define some Scheme code in a macro (to be called later), use @knownissues Mixing Scheme and LilyPond variables is not possible with the -@code{--safe} option. +@option{--safe} option. @node Object properties diff --git a/Documentation/included/compile.itexi b/Documentation/included/compile.itexi index 8f9a237608..17db5163c9 100644 --- a/Documentation/included/compile.itexi +++ b/Documentation/included/compile.itexi @@ -396,7 +396,7 @@ directory. Here are the relevant lines taken from the output of By default, `@command{make@tie{}install}' will install all the files in @file{/usr/local/bin}, @file{/usr/local/lib} etc. You can specify an installation prefix other than @file{/usr/local} -using `@code{--prefix}', for instance `@code{--prefix=$HOME}'. +using `@option{--prefix}', for instance `@option{--prefix=$HOME}'. @end quotation A typical installation prefix is @file{$HOME/usr}: @@ -483,9 +483,9 @@ that case, running @samp{make} without the @option{-j} is advised. If you want to build multiple versions of LilyPond with different configuration settings, you can use the -@code{--enable-config=@var{CONF}} option of @command{configure}. -You should use @code{make@tie{}conf=@var{CONF}} to generate the -output in @file{out-@var{CONF}}. For example, suppose you want to +@option{--enable-config=@var{conf}} option of @command{configure}. +You should use @code{make@tie{}conf=@var{conf}} to generate the +output in @file{out-@var{conf}}. For example, suppose you want to build with and without profiling, then use the following for the normal build diff --git a/Documentation/learning/common-notation.itely b/Documentation/learning/common-notation.itely index 55b6d984bc..7404445215 100644 --- a/Documentation/learning/common-notation.itely +++ b/Documentation/learning/common-notation.itely @@ -197,7 +197,7 @@ aes4 c b c If the above seems confusing, consider this: if you were playing a piano, which key would you hit? If you would press a black key, -then you @emph{must} add @code{-is} or @code{-es} to the note +then you @emph{must} add @w{@code{-is}} or @w{@code{-es}} to the note name! Adding all alterations explicitly might require a little more diff --git a/Documentation/learning/tweaks.itely b/Documentation/learning/tweaks.itely index 40f46cf675..504c86084c 100644 --- a/Documentation/learning/tweaks.itely +++ b/Documentation/learning/tweaks.itely @@ -923,7 +923,7 @@ to the front of these values when they are entered in the @tab A valid direction constant or its numerical equivalent (decimal values between -1 and 1 are allowed) @tab @code{LEFT}, @code{CENTER}, @code{UP}, - @code{1}, @code{-1} + @code{1}, @w{@code{-1}} @item Integer @tab A positive whole number @tab @code{3}, @code{1} @@ -942,7 +942,7 @@ make-moment function @code{(ly:make-moment 3 8)} @item Number @tab Any positive or negative decimal value - @tab @code{3.5}, @code{-2.45} + @tab @code{3.5}, @w{@code{-2.45}} @item Pair (of numbers) @tab Two numbers separated by a @q{space . space} and enclosed in brackets preceded by an apostrophe @@ -1718,7 +1718,7 @@ a4 g c a | @end lilypond Here we use the constants @code{DOWN} and @code{UP}. -These have the values @code{-1} and @code{+1} respectively, and +These have the values @w{@code{-1}} and @code{+1} respectively, and these numerical values may be used instead. The value @code{0} may also be used in some cases. It is simply treated as meaning @code{UP} for stems, but for some objects it means @q{center}. @@ -1901,8 +1901,8 @@ Here are a few examples: @noindent If the fingering seems a little crowded the @code{font-size} could be reduced. The default value can be seen from the -@code{Fingering} object in the IR to be @code{-5}, so let's -try @code{-7}: +@code{Fingering} object in the IR to be @w{@code{-5}}, so let's +try @w{@code{-7}}: @lilypond[quote,fragment,ragged-right,verbatim,relative=1] \override Fingering #'font-size = #-7 @@ -2422,11 +2422,11 @@ reference point. It may be used with all objects which support the @code{self-alignment-interface}. In general these are objects that contain text. The values are @code{LEFT}, @code{RIGHT} or @code{CENTER}. Alternatively, a numerical value between -@code{-1} and @code{+1} may be specified, where @code{-1} is +@w{@code{-1}} and @code{+1} may be specified, where @w{@code{-1}} is left-aligned, @code{+1} is right-aligned, and numbers in between move the text progressively from left-aligned to right-aligned. Numerical values greater than @code{1} may be specified to move -the text even further to the left, or less than @code{-1} to +the text even further to the left, or less than @w{@code{-1}} to move the text even further to the right. A change of @code{1} in the value corresponds to a movement of half the text's length. @@ -2709,7 +2709,7 @@ The best solution here is to move the multimeasure rest down, since the rest is in voice two. The default in @code{\voiceTwo} (i.e. in the second voice of a @code{<<@{...@} \\ @{...@}>>} construct) is that @code{staff-position} is set to -4 for MultiMeasureRest, so we need to -move it, say, four half-staff spaces down to @code{-8}. +move it, say, four half-staff spaces down to @w{@code{-8}}. @cindex MultiMeasureRest, example of overriding @cindex staff-position property, example diff --git a/Documentation/notation/changing-defaults.itely b/Documentation/notation/changing-defaults.itely index 756e32680b..01bd35dc89 100644 --- a/Documentation/notation/changing-defaults.itely +++ b/Documentation/notation/changing-defaults.itely @@ -1043,7 +1043,7 @@ This fragment points to two parts of the program reference: a page on @code{FingeringEvent} and one on @code{Fingering}. The page on @code{FingeringEvent} describes the properties of the music -expression for the input @code{-2}. The page contains many links +expression for the input @w{@code{-2}}. The page contains many links forward. For example, it says @quotation @@ -2242,8 +2242,8 @@ but a direction indicator is @strong{always} required before @item @code{\markup} commands @item @code{\tag} commands @item string markups, e.g. -"string" -@item fingering instructions, e.g. @code{-1} -@item articulation shortcuts, e.g. @code{-.}, @code{->}, @code{--} +@item fingering instructions, e.g. @w{@code{-1}} +@item articulation shortcuts, e.g. @w{@code{-.}}, @w{@code{->}}, @w{@code{--}} @end itemize Direction indicators affect only the next note: @@ -2261,9 +2261,9 @@ The position or direction of many layout objects is controlled by the @code{direction} property. The value of the @code{direction} property may be -set to @code{1}, meaning @qq{up} or @qq{above}, or to @code{-1}, +set to @code{1}, meaning @qq{up} or @qq{above}, or to @w{@code{-1}}, meaning @qq{down} or @qq{below}. The symbols @code{UP} and -@code{DOWN} may be used instead of @code{1} and @code{-1} +@code{DOWN} may be used instead of @code{1} and @w{@code{-1}} respectively. The default direction may be specified by setting @code{direction} to @code{0} or @code{CENTER}. Alternatively, in many cases predefined commands @@ -2279,7 +2279,7 @@ See @rlearning{Within-staff objects}. In a few cases, arpeggio being the only common example, the value of the @code{direction} property specifies whether the object is to be placed to the right or left of the parent object. In -this case @code{-1} or @code{LEFT} means @qq{to the left} and +this case @w{@code{-1}} or @code{LEFT} means @qq{to the left} and @code{1} or @code{RIGHT} means @qq{to the right}. @code{0} or @code{CENTER} means @qq{use the default} direction, as before. @@ -2636,7 +2636,7 @@ it is hardcoded to 0. @item attach-dir This determines where the line starts and ends in the X-direction, -relative to the bound object. So, a value of @code{-1} (or +relative to the bound object. So, a value of @w{@code{-1}} (or @code{LEFT}) makes the line start/end at the left side of the note head it is attached to. @@ -2681,7 +2681,7 @@ c4^\startTextSpan c c c \stopTextSpan @end lilypond Note that negative values move the text @emph{up}, contrary to the -effect that might be expected, as a value of @code{-1} or +effect that might be expected, as a value of @w{@code{-1}} or @code{DOWN} means align the @emph{bottom} edge of the text with the spanner line. A value of @code{1} or @code{UP} aligns the top edge of the text with the spanner line. @@ -2824,7 +2824,7 @@ In the example above the white clef, with a default @code{layer} value of @code{1}, is drawn after the staff lines (default @code{layer} value @code{0}), so overwriting them. To change this, the @code{Clef} object must be given in a lower value of -@code{layer}, say @code{-1}, so that it is drawn earlier: +@code{layer}, say @w{@code{-1}}, so that it is drawn earlier: @lilypond[quote,verbatim,relative=2] \override Staff.Clef #'color = #white @@ -3103,7 +3103,7 @@ e2 \glissando f e2 \glissando f @end lilypond -The value for @code{Y} is set to @code{-2} for the right end +The value for @code{Y} is set to @w{@code{-2}} for the right end point. The left side may be similarly adjusted by specifying @code{left} instead of @code{right}. @@ -3338,12 +3338,12 @@ the @code{self-alignment-X} property, provided the object's real value, in units of half the total X extent of the object. Negative values move the object to the right, positive to the left. A value of @code{0} centers the object on the -reference point of its parent, a value of @code{-1} aligns the +reference point of its parent, a value of @w{@code{-1}} aligns the left edge of the object on the reference point of its parent, and a value of @code{1} aligns the right edge of the object on the reference point of its parent. The symbols @code{LEFT}, -@code{CENTER} and @code{RIGHT} may be used instead of the values -@code{-1, 0, 1} respectively. +@code{CENTER}, and @code{RIGHT} may be used instead of the values +@w{@code{-1}}, @code{0}, and @code{1}, respectively. Normally the @code{\override} command would be used to modify the value of @code{self-alignment-X}, but the @code{\tweak} command @@ -3372,13 +3372,13 @@ value of @code{Y-offset} is just one variable taken into account. This may make adjusting the value of some objects tricky. The units are just half the vertical extent of the object, which is usually quite small, so quite large numbers may be required. -A value of @code{-1} aligns the lower edge of the object with +A value of @w{@code{-1}} aligns the lower edge of the object with the reference point of the parent object, a value of @code{0} aligns the center of the object with the reference point of the parent, and a value of @code{1} aligns the top edge of the object with the reference point of the parent. The symbols @code{DOWN}, -@code{CENTER}, @code{UP} may be substituted for @code{-1, 0, 1} -respectively. +@code{CENTER}, and @code{UP} may be substituted for @w{@code{-1}}, +@code{0}, and @code{1}, respectively. @emph{Self-aligning objects in both directions} diff --git a/Documentation/notation/input.itely b/Documentation/notation/input.itely index 169ac357c7..40b81aa148 100644 --- a/Documentation/notation/input.itely +++ b/Documentation/notation/input.itely @@ -1258,7 +1258,7 @@ been brought into the main file, so the file names they specify must all be relative to the directory containing the main file, not the directory containing the included file. However, this behavior can be changed by passing the option -@code{-drelative-includes} option at the command line +@option{-drelative-includes} option at the command line (or by adding @code{#(ly:set-option 'relative-includes #t)} at the top of the main input file). With @code{relative-includes} set, the path for each @code{\include} command will be taken @@ -1742,7 +1742,7 @@ More clip regions can be defined by adding more pairs of rhythmic-locations to the list. In order to use this feature, LilyPond must be invoked with -@code{-dclip-systems}. The clips are output as EPS files, and are +@option{-dclip-systems}. The clips are output as EPS files, and are converted to PDF and PNG if these formats are switched on as well. For more information on output formats, see @rprogram{Invoking lilypond}. diff --git a/Documentation/notation/rhythms.itely b/Documentation/notation/rhythms.itely index 697c08a626..625d7db4a8 100644 --- a/Documentation/notation/rhythms.itely +++ b/Documentation/notation/rhythms.itely @@ -1377,7 +1377,7 @@ For example, @code{\partial 8*3} becomes: The property @code{measurePosition} contains a rational number indicating how much of the measure has passed at this point. Note that this is set to a negative number by the @code{\partial} command: -i.e., @code{\partial 4} is internally translated to @code{-4}, meaning +i.e., @code{\partial 4} is internally translated to @w{@code{-4}}, meaning @qq{there is a quarter note left in the measure.} @seealso diff --git a/Documentation/notation/spacing.itely b/Documentation/notation/spacing.itely index b07668b4f6..3c5842b842 100644 --- a/Documentation/notation/spacing.itely +++ b/Documentation/notation/spacing.itely @@ -2633,7 +2633,7 @@ measure, the shortest duration is determined. The most common shortest duration is taken as the basis for the spacing, with the stipulation that this shortest duration should always be equal to or shorter than an 8th note. The shortest duration is printed when you run -@code{lilypond} with the @code{--verbose} option. +@code{lilypond} with the @option{--verbose} option. These durations may also be customized. If you set the @code{common-shortest-duration} in @rinternals{SpacingSpanner}, then diff --git a/Documentation/notation/vocal.itely b/Documentation/notation/vocal.itely index f6ab639d91..2f8f623448 100644 --- a/Documentation/notation/vocal.itely +++ b/Documentation/notation/vocal.itely @@ -644,7 +644,7 @@ left-aligned with the first note of the melisma. When a melisma occurs on a syllable other that the last one in a word, that syllable is usually joined to the following one with a hyphenated line. This is indicated by placing a double hyphen, -@code{--}, immediately after the syllable. +@w{@code{--}}, immediately after the syllable. Alternatively, when a melisma occurs on the last or only syllable in a word an extender line is usually drawn from the end of the syllable diff --git a/Documentation/snippets/clip-systems.ly b/Documentation/snippets/clip-systems.ly index 35134c6dc5..28e5180bd6 100644 --- a/Documentation/snippets/clip-systems.ly +++ b/Documentation/snippets/clip-systems.ly @@ -14,7 +14,7 @@ Este código muestra cómo recortar (extraer) fragmentos a partir de una partitura completa. Este archivo tiene que procesarse de forma separada con la opción -@code{-dclip-systems}; la página de fragmentos de código podría no +@option{-dclip-systems}; la página de fragmentos de código podría no mostrar el resultado adecuadamente. La salida consiste en archivos con los nombres @@ -40,7 +40,7 @@ varios archivos EPS. texidoc = " This code shows how to clip (extract) snippets from a full score. -This file needs to be run separately with @code{-dclip-systems}; the +This file needs to be run separately with @option{-dclip-systems}; the snippets page may not adequately show the results. The result will be files named diff --git a/Documentation/snippets/dynamics-custom-text-spanner-postfix.ly b/Documentation/snippets/dynamics-custom-text-spanner-postfix.ly index fc4b01f2fb..6ce32b861e 100644 --- a/Documentation/snippets/dynamics-custom-text-spanner-postfix.ly +++ b/Documentation/snippets/dynamics-custom-text-spanner-postfix.ly @@ -37,7 +37,7 @@ zugewiesen. texidocfr = " Il s'agit de fonctions postfix pour personnaliser l'extension des crescendos textuels. L'extension devrait débuter sur la première notte -de la mesure. Il faut utiliser @code{-\mycresc} -- comme une +de la mesure. Il faut utiliser @w{@code{-\mycresc}} -- comme une articulation -- sous peine que le départ de l'extension n'apparaisse qu'à la note suivante. " diff --git a/Documentation/snippets/modifying-default-values-for-articulation-shorthand-notation.ly b/Documentation/snippets/modifying-default-values-for-articulation-shorthand-notation.ly index c7bffb1d2f..8c5e12f72f 100644 --- a/Documentation/snippets/modifying-default-values-for-articulation-shorthand-notation.ly +++ b/Documentation/snippets/modifying-default-values-for-articulation-shorthand-notation.ly @@ -17,7 +17,7 @@ Las abreviaturas se encuentran definidas dentro del archivo @code{dashLarger}, @code{dashDot} y @code{dashUnderscore} reciben valores predeterminados. Se pueden modificar estos valores predeterminados para las abreviaturas. Por ejemplo, para asociar -la abreviatura @code{-+} (@code{dashPlus}) con el símbolo del +la abreviatura @w{@code{-+}} (@code{dashPlus}) con el símbolo del semitrino en lugar del símbolo predeterminado +, asigne el valor @code{trill} a la variable @code{dashPlus}: @@ -32,7 +32,7 @@ den Variablen @code{dashHat}, @code{dashPlus}, @code{dashDash}, @code{dashBar}, @code{dashLarger}, @code{dashDot} und @code{dashUnderscore} Standardwerte zugewiesen werden. Diese Standardwerte können verändert werden. Um zum Beispiel die Abkürzung -@code{-+} (@code{dashPlus}) mit dem Triller anstatt mit dem +-Symbol zu +@w{@code{-+}} (@code{dashPlus}) mit dem Triller anstatt mit dem +-Symbol zu assoziieren, muss der Wert @code{trill} der Variable @code{dashPlus} zugewiesen werden: @@ -46,7 +46,7 @@ Les raccourcis sont répertoriés dans le fichier @code{dashHat}, @code{dashPlus}, @code{dashDash}, @code{dashBar}, @code{dashLarger}, @code{dashDot}, et @code{dashUnderscore} ainsi que leur valeur par défaut. Ces valeurs peuvent être modifiées selon vos -besoins. Il suffit par exemple, pour affecter au raccourci @code{-+} +besoins. Il suffit par exemple, pour affecter au raccourci @w{@code{-+}} (@code{dashPlus}) le symbole du trille en lieu et place du @code{+} (caractère plus), d'assigner la valeur @code{trill} à la variable @code{dashPlus} : @@ -61,7 +61,7 @@ variables @code{dashHat}, @code{dashPlus}, @code{dashDash}, @code{dashBar}, @code{dashLarger}, @code{dashDot}, and @code{dashUnderscore} are assigned default values. The default values for the shorthands can be modified. For example, to associate the -@code{-+} (@code{dashPlus}) shorthand with the trill symbol instead of +@w{@code{-+}} (@code{dashPlus}) shorthand with the trill symbol instead of the default + symbol, assign the value @code{trill} to the variable @code{dashPlus}: diff --git a/Documentation/snippets/new/clip-systems.ly b/Documentation/snippets/new/clip-systems.ly index ebf8cdea9b..3f412325dd 100644 --- a/Documentation/snippets/new/clip-systems.ly +++ b/Documentation/snippets/new/clip-systems.ly @@ -6,7 +6,7 @@ texidoc = " This code shows how to clip (extract) snippets from a full score. -This file needs to be run separately with @code{-dclip-systems}; the +This file needs to be run separately with @option{-dclip-systems}; the snippets page may not adequately show the results. The result will be files named diff --git a/Documentation/usage/external.itely b/Documentation/usage/external.itely index 375031c98f..f3a3b09481 100644 --- a/Documentation/usage/external.itely +++ b/Documentation/usage/external.itely @@ -239,7 +239,7 @@ for pitches, durations are only written when necessary. It is possible to record a MIDI file using a digital keyboard, and then convert it to @file{.ly}. However, human players are not rhythmically exact enough to make a MIDI to LY conversion trivial. -When invoked with quantizing (@code{-s} and @code{-d} options) +When invoked with quantizing (@option{-s} and @option{-d} options) @command{midi2ly} tries to compensate for these timing errors, but is not very good at this. It is therefore not recommended to use @command{midi2ly} for human-generated midi files. diff --git a/Documentation/usage/lilypond-book.itely b/Documentation/usage/lilypond-book.itely index d1018be507..86cc588778 100644 --- a/Documentation/usage/lilypond-book.itely +++ b/Documentation/usage/lilypond-book.itely @@ -128,7 +128,7 @@ xpdf lilybook Running @command{lilypond-book} and @command{latex} creates a lot of temporary files, which would clutter up the working directory. To -remedy this, use the @code{--output=@var{dir}} option. It will create +remedy this, use the @option{--output=@var{dir}} option. It will create the files in a separate subdirectory @file{dir}. Finally the result of the @LaTeX{} example shown above.@footnote{This @@ -845,7 +845,7 @@ will be included in the @file{.ps} and @file{.pdf} files. Running @command{dvips} may produce some warnings about fonts; these are harmless and may be ignored. If you are running @command{latex} in -twocolumn mode, remember to add @code{-t landscape} to the +twocolumn mode, remember to add @option{-t landscape} to the @command{dvips} options. @subsubheading Texinfo @@ -902,7 +902,7 @@ Add @var{dir} to the include path. @command{lilypond-book} also looks for already compiled snippets in the include path, and does not write them back to the output directory, so in some cases it is necessary to invoke further processing commands such as @command{makeinfo} or -@command{latex} with the same @code{-I @var{dir}} options. +@command{latex} with the same @option{-I @var{dir}} options. @item -o @var{dir} @itemx --output=@var{dir} @@ -927,7 +927,7 @@ Do not fail if no PNG images are found for EPS files. It is used for LilyPond Info documentation without images. @itemx --lily-output-dir=@var{dir} -Write lily-XXX files to directory @var{dir}, link into @code{--output} +Write lily-XXX files to directory @var{dir}, link into @option{--output} directory. Use this option to save building time for documents in different directories which share a lot of identical snippets. @@ -953,8 +953,8 @@ line to the right by the same amount. @item -P @var{command} @itemx --process=@var{command} Process LilyPond snippets using @var{command}. The default command is -@code{lilypond}. @code{lilypond-book} will not @code{--filter} and -@code{--process} at the same time. +@code{lilypond}. @code{lilypond-book} will not @option{--filter} and +@option{--process} at the same time. @item --pdf Create PDF files for use with PDF@LaTeX{}. @@ -966,8 +966,8 @@ all output to log files in the same directory as the source files. @itemx --use-source-file-names Write snippet output files with the same base name as their source file. This option works only for snippets included with @code{lilypondfile} -and only if directories implied by @code{--output-dir} and -@code{--lily-output-dir} options are different. +and only if directories implied by @option{--output-dir} and +@option{--lily-output-dir} options are different. @item -V @itemx --verbose @@ -1017,7 +1017,7 @@ selects the output format based on the input filename's extension. If you use the same filename extension for the input file than the extension @command{lilypond-book} uses for the output file, and if the input file is in the same directory as @command{lilypond-book} working -directory, you must use @code{--output} option to make +directory, you must use @option{--output} option to make @command{lilypond-book} running, otherwise it will exit with an error message like @qq{Output would overwrite input file}. diff --git a/Documentation/usage/running.itely b/Documentation/usage/running.itely index 5f226c3ed8..35be41f9db 100644 --- a/Documentation/usage/running.itely +++ b/Documentation/usage/running.itely @@ -135,7 +135,7 @@ The following options are supported: @item -e,--evaluate=@var{expr} Evaluate the Scheme @var{expr} before parsing any @file{.ly} files. -Multiple @code{-e} options may be given, they will be evaluated +Multiple @option{-e} options may be given, they will be evaluated sequentially. The expression will be evaluated in the @code{guile-user} module, so @@ -186,7 +186,7 @@ Here are a few interesting options. @table @samp @item help -Running @code{lilypond -dhelp} will print all of the @code{-d} options +Running @code{lilypond -dhelp} will print all of the @option{-d} options available. @cindex paper-size, command line @@ -207,8 +207,8 @@ Note that the string must be enclosed in escaped quotes ( @code{\"} ). Do not trust the @code{.ly} input. When LilyPond formatting is available through a web server, either the -@code{--safe} or the @code{--jail} option @b{MUST} be passed. The -@code{--safe} option will prevent inline Scheme code from wreaking +@option{--safe} or the @option{--jail} option @b{MUST} be passed. The +@option{--safe} option will prevent inline Scheme code from wreaking havoc, for example @quotation @@ -220,7 +220,7 @@ havoc, for example @end verbatim @end quotation -The @code{-dsafe} option works by evaluating in-line Scheme +The @option{-dsafe} option works by evaluating in-line Scheme expressions in a special safe module. This safe module is derived from GUILE @file{safe-r5rs} module, but adds a number of functions of the LilyPond API. These functions are listed in @file{scm/safe-lily.scm}. @@ -231,14 +231,14 @@ disables the use of backslashes in @TeX{} strings. In safe mode, it is not possible to import LilyPond variables into Scheme. -@code{-dsafe} does @emph{not} detect resource overuse. It is still possible to +@option{-dsafe} does @emph{not} detect resource overuse. It is still possible to make the program hang indefinitely, for example by feeding cyclic data structures into the backend. Therefore, if using LilyPond on a publicly accessible webserver, the process should be limited in both CPU and memory usage. The safe mode will prevent many useful LilyPond snippets from being -compiled. The @code{--jail} is a more secure alternative, but +compiled. The @option{--jail} is a more secure alternative, but requires more work to set up. @cindex output format, setting @@ -286,7 +286,7 @@ This mode is used by default by @command{lilypond-book}. for a dump of the raw, internal Scheme-based drawing commands. @item null - do not output a printed score; has the same effect as @code{-dno-print-pages}. + do not output a printed score; has the same effect as @option{-dno-print-pages}. @end table Example: @code{lilypond -dbackend=svg @var{filename}.ly} @@ -305,13 +305,13 @@ Runs silently and redirect all output to a log file. Note to Windows users: By default @code{lilypond.exe} outputs all progress information to the command window, @code{lilypond-windows.exe} does not and returns a prompt, with no progress information, immediately -at the command line. The @code{-dgui} option can be used in this case +at the command line. The @option{-dgui} option can be used in this case to redirect output to a log file. @item print-pages -Generate the full pages, the default. @code{-dno-print-pages} is -useful in combination with @code{-dpreview}. +Generate the full pages, the default. @option{-dno-print-pages} is +useful in combination with @option{-dpreview}. @end table @@ -380,7 +380,7 @@ Generate PostScript. @item --png Generate pictures of each page, in PNG format. This implies -@code{--ps}. The resolution in DPI of the image may be set with +@option{--ps}. The resolution in DPI of the image may be set with @example -dresolution=110 @end example @@ -388,24 +388,24 @@ Generate pictures of each page, in PNG format. This implies @cindex Portable Document Format (PDF) output @item --pdf -Generate PDF. This implies @code{--ps}. +Generate PDF. This implies @option{--ps}. @item -j,--jail=@var{user},@var{group},@var{jail},@var{dir} Run @command{lilypond} in a chroot jail. -The @code{--jail} option provides a more flexible alternative to -@code{--safe} when LilyPond formatting is available through a web +The @option{--jail} option provides a more flexible alternative to +@option{--safe} when LilyPond formatting is available through a web server or whenever LilyPond executes externally provided sources. -The @code{--jail} option works by changing the root of @command{lilypond} to +The @option{--jail} option works by changing the root of @command{lilypond} to @var{jail} just before starting the actual compilation process. The user and group are then changed to match those provided, and the current directory is changed to @var{dir}. This setup guarantees that it is not possible (at least in theory) to escape from the jail. Note that for -@code{--jail} to work @command{lilypond} must be run as root, which is usually +@option{--jail} to work @command{lilypond} must be run as root, which is usually accomplished in a safe way using @command{sudo}. Setting up a jail is a slightly delicate matter, as we must be sure that @@ -483,7 +483,7 @@ This selects the language for the warning messages. @item LILYPOND_LOGLEVEL The default loglevel. If LilyPond is called without an explicit loglevel (i.e. -no @code{--loglevel} command line option), this value is used. +no @option{--loglevel} command line option), this value is used. @item LILYPOND_GC_YIELD A variable, as a percentage, that tunes memory management @@ -642,8 +642,8 @@ happens rarely. The most usual cause is misinstalled fonts. @cindex call trace @cindex Scheme error Errors that occur while executing Scheme code are caught by the Scheme -interpreter. If running with the verbose option (@code{-V} or -@code{--verbose}) then a call trace of the offending +interpreter. If running with the verbose option (@option{-V} or +@option{--verbose}) then a call trace of the offending function call is printed. @item Programming error diff --git a/Documentation/usage/updating.itely b/Documentation/usage/updating.itely index 755c530632..8bb8cef926 100644 --- a/Documentation/usage/updating.itely +++ b/Documentation/usage/updating.itely @@ -132,7 +132,7 @@ in-place. @item -f,--from=@var{from-patchlevel} Set the version to convert from. If this is not set, @command{convert-ly} will guess this, on the basis of @code{\version} strings in the file. -E.g. @code{--from=2.10.25} +E.g. @option{--from=2.10.25} @item -n,--no-version Normally, @command{convert-ly} adds a @code{\version} indicator @@ -143,7 +143,7 @@ Show all known conversions and exit. @item --to=@var{to-patchlevel} Set the goal version of the conversion. It defaults to the latest -available version. E.g. @code{--to=2.12.2} +available version. E.g. @option{--to=2.12.2} @item -h, --help Print usage help. diff --git a/Documentation/web/introduction.itexi b/Documentation/web/introduction.itexi index 63c3c61aa1..2f14efa1e1 100644 --- a/Documentation/web/introduction.itexi +++ b/Documentation/web/introduction.itexi @@ -920,8 +920,8 @@ entered with backslashes. @imageFloat{text-input-1-annotate,png,center} @imageFloat{text-input-1-output,png,center} -Alterations are made with different names: add @code{-is} for -sharp, and @code{-es} for flat (these are Dutch note names, other +Alterations are made with different names: add @w{@code{-is}} for +sharp, and @w{@code{-es}} for flat (these are Dutch note names, other languages are available). LilyPond figures out where to put accidentals. diff --git a/Documentation/web/news.itexi b/Documentation/web/news.itexi index 0dfa491ff5..0f0f5568e1 100644 --- a/Documentation/web/news.itexi +++ b/Documentation/web/news.itexi @@ -4075,7 +4075,7 @@ in the @subsubheading February 2, 2004 LilyPond 2.1.17 is out. It adds texts (solo, a due) for the part combiner. It also reinstates the -@code{--safe} option which prevents havoc by Scheme exploits. More +@option{--safe} option which prevents havoc by Scheme exploits. More information in the @ref{Changes}. @newsEnd diff --git a/input/regression/clip-systems.ly b/input/regression/clip-systems.ly index 3533514972..f38f163886 100644 --- a/input/regression/clip-systems.ly +++ b/input/regression/clip-systems.ly @@ -9,7 +9,7 @@ Notes: @item Regions can span multiple systems. In this case, multiple EPS files are generated. @end itemize -This file needs to be run separately with @code{-dclip-systems}; the +This file needs to be run separately with @option{-dclip-systems}; the collated-files.html of the regression test does not adequately show the results. diff --git a/input/regression/midi/key-option.ly b/input/regression/midi/key-option.ly index 47b96b4cc7..27fa7f193b 100644 --- a/input/regression/midi/key-option.ly +++ b/input/regression/midi/key-option.ly @@ -19,7 +19,7 @@ % included from ./out-www/option-key.header \header { -texidoc="midi2ly @code{--key} works, this is F major" +texidoc="@code{midi2ly}'s option @option{--key} works, this is F major." options="--key=-1" } % end diff --git a/input/regression/midi/quantize-duration-2.ly b/input/regression/midi/quantize-duration-2.ly index 26f7d65a7c..868ca44c18 100644 --- a/input/regression/midi/quantize-duration-2.ly +++ b/input/regression/midi/quantize-duration-2.ly @@ -18,7 +18,7 @@ } \header { -texidoc="midi2ly @code{--duration-quant} preserves first note length (16)" +texidoc="@code{midi2ly}'s option @option{--duration-quant} preserves first note length (16)." options="--duration-quant=16" } diff --git a/input/regression/midi/quantize-duration.ly b/input/regression/midi/quantize-duration.ly index f0d6bed9ae..6c9570f4a8 100644 --- a/input/regression/midi/quantize-duration.ly +++ b/input/regression/midi/quantize-duration.ly @@ -19,7 +19,7 @@ % included from ./out-www/voice-2.header \header { -texidoc="midi2ly @code{--duration-quant} quantizes durations of notes" +texidoc="@code{midi2ly}'s option @option{--duration-quant} quantizes durations of notes." options="--duration-quant=4" } % end diff --git a/input/regression/midi/quantize-start.ly b/input/regression/midi/quantize-start.ly index 2e5497f11e..ffa1176946 100644 --- a/input/regression/midi/quantize-start.ly +++ b/input/regression/midi/quantize-start.ly @@ -19,7 +19,7 @@ % included from ./out-www/voice-2.header \header { -texidoc="midi2ly @code{--start-quant} quantizes start of notes" +texidoc="@code{midi2ly}'s option @option{--start-quant} quantizes start of notes." options="--start-quant=4" } % end diff --git a/input/regression/skyline-debug.ly b/input/regression/skyline-debug.ly index 6746e2ae05..59e8b7a2c9 100644 --- a/input/regression/skyline-debug.ly +++ b/input/regression/skyline-debug.ly @@ -1,5 +1,5 @@ \header { - texidoc = "@code{-ddebug-skyline} draws the outline of the skyline used." + texidoc = "@option{-ddebug-skyline} draws the outline of the skyline used." } \version "2.14.0" diff --git a/lily/general-scheme.cc b/lily/general-scheme.cc index 254b5ab677..af2bcd73b4 100644 --- a/lily/general-scheme.cc +++ b/lily/general-scheme.cc @@ -102,8 +102,8 @@ LY_DEFINE (ly_gulp_file, "ly:gulp-file", LY_DEFINE (ly_dir_p, "ly:dir?", 1, 0, 0, (SCM s), - "Is @var{s} a direction? Valid directions are @code{-1}," - " @code{0}, or@tie{}@code{1}, where @code{-1} represents" + "Is @var{s} a direction? Valid directions are @w{@code{-1}}," + " @code{0}, or@tie{}@code{1}, where @w{@code{-1}} represents" " left or down, @code{1}@tie{}represents right or up, and @code{0}" " represents a neutral direction.") { @@ -187,7 +187,7 @@ LY_DEFINE (ly_string_percent_encode, "ly:string-percent-encode", 1, 0, 0, (SCM str), "Encode all characters in string @var{str} with hexadecimal" " percent escape sequences, with the following exceptions:" - " characters @code{-}, @code{.}, @code{/}, and @code{_}; and" + " characters @w{@code{-},} @code{.}, @code{/}, and @code{_}; and" " characters in ranges @code{0-9}, @code{A-Z}, and @code{a-z}.") { LY_ASSERT_TYPE (scm_is_string, str, 1); diff --git a/lily/item-scheme.cc b/lily/item-scheme.cc index bd612efdee..11604bb33a 100644 --- a/lily/item-scheme.cc +++ b/lily/item-scheme.cc @@ -31,7 +31,7 @@ LY_DEFINE (ly_item_p, "ly:item?", LY_DEFINE (ly_item_break_dir, "ly:item-break-dir", 1, 0, 0, (SCM it), - "The break status direction of item @var{it}. @code{-1} means" + "The break status direction of item @var{it}. @w{@code{-1}} means" " end of line, @code{0}@tie{}unbroken, and" " @code{1}@tie{}beginning of line.") { diff --git a/lily/item.cc b/lily/item.cc index 4e9818192a..bf67f3c6dd 100644 --- a/lily/item.cc +++ b/lily/item.cc @@ -270,7 +270,7 @@ ADD_INTERFACE (Item, "Whether these versions are visible and take up space is" " determined by the outcome of the @code{break-visibility}" " grob property, which is a function taking a direction" - " (@code{-1}, @code{0} or@tie{}@code{1}) as an argument. It" + " (@w{@code{-1}}, @code{0} or@tie{}@code{1}) as an argument. It" " returns a cons of booleans, signifying whether this grob" " should be transparent and have no extent.\n" "\n" diff --git a/lily/spanner-scheme.cc b/lily/spanner-scheme.cc index 65c1c261cd..f1a206b69a 100644 --- a/lily/spanner-scheme.cc +++ b/lily/spanner-scheme.cc @@ -23,7 +23,7 @@ LY_DEFINE (ly_spanner_bound, "ly:spanner-bound", 2, 0, 0, (SCM spanner, SCM dir), - "Get one of the bounds of @var{spanner}. @var{dir} is @code{-1}" + "Get one of the bounds of @var{spanner}. @var{dir} is @w{@code{-1}}" " for left, and @code{1} for right.") { LY_ASSERT_TYPE (unsmob_spanner, spanner, 1); diff --git a/lily/stencil-scheme.cc b/lily/stencil-scheme.cc index 1f33cd7aec..9526e5cc2e 100644 --- a/lily/stencil-scheme.cc +++ b/lily/stencil-scheme.cc @@ -201,7 +201,7 @@ LY_DEFINE (ly_make_stencil, "ly:make-stencil", LY_DEFINE (ly_stencil_aligned_to, "ly:stencil-aligned-to", 3, 0, 0, (SCM stil, SCM axis, SCM dir), "Align @var{stil} using its own extents. @var{dir} is a number." - " @code{-1} and @code{1} are left and right, respectively." + " @w{@code{-1}} and @code{1} are left and right, respectively." " Other values are interpolated (so @code{0} means the center).") { LY_ASSERT_SMOB (Stencil, stil, 1); diff --git a/scm/define-grob-properties.scm b/scm/define-grob-properties.scm index 283db6faec..3e846af1e5 100644 --- a/scm/define-grob-properties.scm +++ b/scm/define-grob-properties.scm @@ -38,7 +38,7 @@ included in this script's support.") (after-line-breaking ,boolean? "Dummy property, used to trigger callback for @code{after-line-breaking}.") - (align-dir ,ly:dir? "Which side to align? @code{-1}: left side, + (align-dir ,ly:dir? "Which side to align? @w{@code{-1}}: left side, @code{0}: around center of width, @code{1}: right side.") (allow-loose-spacing ,boolean? "If set, column can be detached from main spacing.") @@ -217,8 +217,8 @@ having a @code{details} property.") @code{#LEFT}, @code{#CENTER} or @code{#RIGHT} with respect to the other object. Otherwise, it determines whether the object is placed @code{#UP}, @code{#CENTER} or @code{#DOWN}. Numerical values may also -be used: @code{#UP}=@code{1}, @code{#DOWN}=@code{-1}, -@code{#LEFT}=@code{-1}, @code{#RIGHT}=@code{1}, +be used: @code{#UP}=@code{1}, @code{#DOWN}=@w{@code{-1}}, +@code{#LEFT}=@w{@code{-1}}, @code{#RIGHT}=@code{1}, @code{#CENTER}=@code{0}.") (dot-count ,integer? "The number of dots.") (dot-negative-kern ,number? "The space to remove between a dot @@ -300,7 +300,7 @@ include @code{medium}, @code{bold}, @code{bold-narrow}, etc.") include @code{upright}, @code{italic}, @code{caps}.") (font-size ,number? "The font size, compared to the @q{normal}@tie{}size. @code{0}@tie{}is style-sheet's normal size, -@code{-1} is smaller, @code{+1} is bigger. Each step of@tie{}1 is +@w{@code{-1}} is smaller, @code{+1} is bigger. Each step of@tie{}1 is approximately 12% larger; 6@tie{}steps are exactly a factor@tie{}2 larger. Fractional values are allowed.") (footnote-text ,markup? "A footnote for the grob.") @@ -356,7 +356,7 @@ the center of the fret in direction parallel to strings. Default@tie{}0. @item @code{label-dir} -- Side to which the fret label is attached. -@code{-1}, @code{#LEFT}, or @code{#DOWN} for left or down; @code{1}, +@w{@code{-1}}, @code{#LEFT}, or @code{#DOWN} for left or down; @code{1}, @code{#RIGHT}, or @code{#UP} for right or up. Default @code{#RIGHT}. @item @code{mute-string} -- Character string to be used to indicate muted @@ -716,7 +716,7 @@ stem distance.") (script-priority ,number? "A sorting key that determines in what order a script is within a stack of scripts.") (self-alignment-X ,number? "Specify alignment of an object. The -value @code{-1} means left aligned, @code{0}@tie{}centered, and +value @w{@code{-1}} means left aligned, @code{0}@tie{}centered, and @code{1}@tie{}right-aligned in X@tie{}direction. Other numerical values may also be specified.") (self-alignment-Y ,number? "Like @code{self-alignment-X} but for @@ -779,7 +779,8 @@ bounds (i.e., clefs, key signatures and time signatures) using the following override: @example -\\override MultiMeasureRest #'spacing-pair = #'(staff-bar . staff-bar) +\\override MultiMeasureRest + #'spacing-pair = #'(staff-bar . staff-bar) @end example") (spanner-id ,string? "An identifier to distinguish concurrent spanners.") (springs-and-rods ,boolean? "Dummy variable for triggering @@ -889,7 +890,7 @@ should use @code{LEFT}.") @var{dir})} pairs, indicating the desired tie configuration, where @var{position} is the offset from the center of the staff in staff space and @var{dir} indicates the direction of the tie -(@code{1}=>up, @code{-1}=>down, @code{0}=>center). A non-pair entry +(@code{1}=>up, @w{@code{-1}}=>down, @code{0}=>center). A non-pair entry in the list causes the corresponding tie to be formatted automatically.") (to-barline ,boolean? "If true, the spanner will stop at the bar diff --git a/scm/define-markup-commands.scm b/scm/define-markup-commands.scm index d39cfab0ca..cdfaf1f9f8 100644 --- a/scm/define-markup-commands.scm +++ b/scm/define-markup-commands.scm @@ -1683,7 +1683,7 @@ Align @var{arg} in @var{axis} direction to the @var{dir} side. " @cindex setting horizontal text alignment -Set horizontal alignment. If @var{dir} is @code{-1}, then it is +Set horizontal alignment. If @var{dir} is @w{@code{-1}}, then it is left-aligned, while @code{+1} is right. Values in between interpolate alignment accordingly. diff --git a/scm/define-music-types.scm b/scm/define-music-types.scm index 8a3676b2a1..0fa6b95a4d 100644 --- a/scm/define-music-types.scm +++ b/scm/define-music-types.scm @@ -55,7 +55,7 @@ context, and 3.@tie{}the context where @var{func} is called.") (ArpeggioEvent . ((description . "Make an arpeggio on this note. -Syntax: @var{note}@code{-\\arpeggio}") +Syntax: @w{@var{note}@code{-\\arpeggio}}") (types . (general-music arpeggio-event event)) )) @@ -67,7 +67,7 @@ Syntax: @var{note}@code{-\\arpeggio}") Syntax: @var{note}@code{x}@code{y}, where @code{x} is a direction (@code{^} for up or @code{_} for down), or LilyPond's choice (no direction specified), and where @code{y} is an articulation -(such as @code{-.}, @code{->}, @code{\\tenuto}, @code{\\downbow}). +(such as @w{@code{-.}}, @w{@code{->}}, @code{\\tenuto}, @code{\\downbow}). See the Notation Reference for details.") (types . (general-music event articulation-event script-event)) )) @@ -609,7 +609,7 @@ octavation.") (TieEvent . ((description . "A tie. -Syntax: @var{note}@code{-~}") +Syntax: @w{@var{note}@code{-~}}") (types . (general-music tie-event event)) )) diff --git a/scm/fret-diagrams.scm b/scm/fret-diagrams.scm index acc095a567..9247a115f7 100644 --- a/scm/fret-diagrams.scm +++ b/scm/fret-diagrams.scm @@ -1116,13 +1116,13 @@ If there are multiple fret indicators desired on a string, they should be separated by spaces. @item -Fingerings are given by following the fret number with a @code{-}, +Fingerings are given by following the fret number with a @w{@code{-},} followed by the finger indicator, e.g. @samp{3-2} for playing the third fret with the second finger. @item Where a barre indicator is desired, follow the fret (or fingering) symbol -with @code{-(} to start a barre and @code{-)} to end the barre. +with @w{@code{-(}} to start a barre and @w{@code{-)}} to end the barre. @end itemize" ;; TODO -- change syntax to fret\string-finger diff --git a/scm/music-functions.scm b/scm/music-functions.scm index defe293619..8cdd53955f 100644 --- a/scm/music-functions.scm +++ b/scm/music-functions.scm @@ -1104,7 +1104,7 @@ active pitch in any octave. @var{laziness} states over how many bars an accidental should be remembered. @code{0}@tie{}is the default -- accidental lasts over 0@tie{}bar lines, that is, to the end of current measure. A positive integer means that the -accidental lasts over that many bar lines. @code{-1} is `forget +accidental lasts over that many bar lines. @w{@code{-1}} is `forget immediately', that is, only look at key signature. @code{#t} is `forever'." (check-pitch-against-signature context pitch barnum laziness octaveness)) -- 2.39.2