From: Trevor Daniels Date: Thu, 3 Oct 2013 22:22:54 +0000 (+0100) Subject: Doc: Remove backslash from all node names and references (3590) X-Git-Tag: release/2.17.29-1~27 X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=ff7d82711b47d3d31f26e1e6fc012c4055a20059;p=lilypond.git Doc: Remove backslash from all node names and references (3590) English docs only --- diff --git a/Documentation/learning/tweaks.itely b/Documentation/learning/tweaks.itely index 5802044e42..5ee640a9b9 100644 --- a/Documentation/learning/tweaks.itely +++ b/Documentation/learning/tweaks.itely @@ -174,15 +174,15 @@ the types of objects and properties from their names. @cindex tweaking methods @menu -* The \override command:: -* The \revert command:: -* The \once prefix:: -* The \overrideProperty command:: -* The \tweak command:: +* The override command:: +* The revert command:: +* The once prefix:: +* The overrideProperty command:: +* The tweak command:: @end menu -@node The \override command -@unnumberedsubsubsec The @code{\override} command +@node The override command +@unnumberedsubsubsec The @code{@bs{}override} command @cindex override command @cindex override syntax @@ -253,8 +253,8 @@ g4 a b c | @end lilypond -@node The \revert command -@unnumberedsubsubsec The @code{\revert} command +@node The revert command +@unnumberedsubsubsec The @code{@bs{}revert} command @cindex revert command @@ -291,8 +291,8 @@ b4 c | @end lilypond -@node The \once prefix -@unnumberedsubsubsec The @code{\once} prefix +@node The once prefix +@unnumberedsubsubsec The @code{@bs{}once} prefix @funindex \once @funindex once @@ -336,8 +336,8 @@ rather than @code{\override} so prefixing these with @code{\once} has no effect. -@node The \overrideProperty command -@unnumberedsubsubsec The @code{\overrideProperty} command +@node The overrideProperty command +@unnumberedsubsubsec The @code{@bs{}overrideProperty} command @cindex overrideProperty command @@ -351,8 +351,8 @@ We mention it here for completeness, but for details see @c Maybe explain in a later iteration -td -@node The \tweak command -@unnumberedsubsubsec The @code{\tweak} command +@node The tweak command +@unnumberedsubsubsec The @code{@bs{}tweak} command @cindex tweak command @@ -2041,7 +2041,7 @@ positioning is not optimum. @menu * The outside-staff-priority property:: -* The \textLengthOn command:: +* The textLengthOn command:: * Dynamics placement:: * Grob sizing:: @end menu @@ -2259,8 +2259,8 @@ clearly will need to space the notes out horizontally to make more room for the text. This is done using the @code{textLengthOn} command. -@node The \textLengthOn command -@unnumberedsubsubsec The @code{\textLengthOn} command +@node The textLengthOn command +@unnumberedsubsubsec The @code{@bs{}textLengthOn} command @cindex notes, spreading out with text @@ -2613,7 +2613,7 @@ to remember is that the spacing between objects in a of the @code{StaffGrouper}. Spacing from ungrouped staves (like @code{Lyrics} and @code{Staff}) is controlled by the variables of the @code{VerticalAxisGroup}. See the -@ruser{Flexible vertical spacing \paper variables} and +@ruser{Flexible vertical spacing paper variables} and @ruser{Flexible vertical spacing within systems} for more details. diff --git a/Documentation/notation/changing-defaults.itely b/Documentation/notation/changing-defaults.itely index 21b6841a7a..74782c59c2 100644 --- a/Documentation/notation/changing-defaults.itely +++ b/Documentation/notation/changing-defaults.itely @@ -1119,7 +1119,7 @@ Notation Reference: @ref{Bottom-level contexts - voices}, @ref{The set command}, @ref{The override command}, -@ref{The \layout block}. +@ref{The layout block,,The @code{@bs{}layout} block}. @node Defining new contexts diff --git a/Documentation/notation/input.itely b/Documentation/notation/input.itely index 0929c21801..1617a39395 100644 --- a/Documentation/notation/input.itely +++ b/Documentation/notation/input.itely @@ -357,7 +357,7 @@ book-wide settings. If more than one such definition of the same type is entered at the top level the definitions are combined, but in conflicting situations the later definitions take precedence. For details of how this affects the @code{\layout} block see -@ref{The \layout block}. +@ref{The layout block,,The @code{@bs{}layout} block}. @item A direct scheme expression, such as @@ -515,7 +515,7 @@ Learning Manual: Notation Reference: @ref{Titles explained}, -@ref{The \layout block}. +@ref{The layout block,,The @code{@bs{}layout} block}. @node Titles and headers diff --git a/Documentation/notation/spacing.itely b/Documentation/notation/spacing.itely index 2ddee1eb09..dfa72dc650 100644 --- a/Documentation/notation/spacing.itely +++ b/Documentation/notation/spacing.itely @@ -94,17 +94,17 @@ This section discusses page layout options for the @code{\paper} block. @menu -* The \paper block:: +* The paper block:: * Paper size and automatic scaling:: -* Fixed vertical spacing \paper variables:: -* Flexible vertical spacing \paper variables:: -* Horizontal spacing \paper variables:: -* Other \paper variables:: +* Fixed vertical spacing paper variables:: +* Flexible vertical spacing paper variables:: +* Horizontal spacing paper variables:: +* Other paper variables:: @end menu -@node The \paper block -@subsection The @code{\paper} block +@node The paper block +@subsection The @code{@bs{}paper} block @code{\paper} blocks may be placed in three different places to form a descending hierarchy of @code{\paper} blocks: @@ -161,7 +161,7 @@ footers, and titles are discussed in Most @code{\paper} variables will only work in a @code{\paper} block. The few that will also work in a @code{\layout} block are -listed in @ref{The \layout block}. +listed in @ref{The layout block,,The @code{@bs{}layout} block}. Except when specified otherwise, all @code{\paper} variables that correspond to distances on the page are measured in millimeters, @@ -203,7 +203,7 @@ The Scheme equivalent of the above example is: Notation Reference: @ref{Paper size and automatic scaling}, @ref{Custom titles headers and footers}, -@ref{The \layout block}. +@ref{The layout block,,The @code{@bs{}layout} block}. Installed Files: @file{ly/paper-defaults-init.ly}. @@ -331,11 +331,12 @@ are described in @ref{Setting the paper size}. The vertical dimensions affected by automatic scaling are @code{top-margin} and @code{bottom-margin} (see -@ref{Fixed vertical spacing \paper variables}). The horizontal +@ref{Fixed vertical spacing paper variables,,Fixed vertical spacing @code{@bs{}paper} variables}). +The horizontal dimensions affected by automatic scaling are @code{left-margin}, @code{right-margin}, @code{inner-margin}, @code{outer-margin}, @code{binding-offset}, @code{indent}, and @code{short-indent} (see -@ref{Horizontal spacing \paper variables}). +@ref{Horizontal spacing paper variables,,Horizontal spacing @code{@bs{}paper} variables}). The default values for these dimensions are set in @file{ly/paper-defaults-init.ly}, using internal variables named @@ -347,16 +348,16 @@ These are the values that result at the default paper size @seealso Notation Reference: -@ref{Fixed vertical spacing \paper variables}, -@ref{Horizontal spacing \paper variables}. +@ref{Fixed vertical spacing paper variables,,Fixed vertical spacing @code{@bs{}paper} variables}, +@ref{Horizontal spacing paper variables,,Horizontal spacing @code{@bs{}paper} variables}. Installed Files: @file{ly/paper-defaults-init.ly}, @file{scm/paper.scm}. -@node Fixed vertical spacing \paper variables -@subsection Fixed vertical spacing @code{\paper} variables +@node Fixed vertical spacing paper variables +@subsection Fixed vertical spacing @code{@bs{}paper} variables @warning{Some @code{@bs{}paper} dimensions are automatically scaled to the paper size, which may lead to unexpected behavior. @@ -423,8 +424,8 @@ Explicitly defined paper-sizes will override any user-defined top or bottom margin settings. -@node Flexible vertical spacing \paper variables -@subsection Flexible vertical spacing @code{\paper} variables +@node Flexible vertical spacing paper variables +@subsection Flexible vertical spacing @code{@bs{}paper} variables In most cases, it is preferable for the vertical distances between certain items (such as margins, titles, systems, and separate @@ -442,7 +443,7 @@ settings typically entered inside a @code{\score} or @menu * Structure of flexible vertical spacing alists:: -* List of flexible vertical spacing \paper variables:: +* List of flexible vertical spacing paper variables:: @end menu @@ -539,8 +540,8 @@ redefines the variable: @end example -@node List of flexible vertical spacing \paper variables -@unnumberedsubsubsec List of flexible vertical spacing @code{\paper} variables +@node List of flexible vertical spacing paper variables +@unnumberedsubsubsec List of flexible vertical spacing @code{@bs{}paper} variables The names of these variables follow the format @code{@var{upper}-@var{lower}-spacing}, where @code{@var{upper}} @@ -620,22 +621,22 @@ Snippets: @rlsr{Spacing}. -@node Horizontal spacing \paper variables -@subsection Horizontal spacing @code{\paper} variables +@node Horizontal spacing paper variables +@subsection Horizontal spacing @code{@bs{}paper} variables @warning{Some @code{@bs{}paper} dimensions are automatically scaled to the paper size, which may lead to unexpected behavior. See @ref{Automatic scaling to paper size}.} @menu -* \paper variables for widths and margins:: -* \paper variables for two-sided mode:: -* \paper variables for shifts and indents:: +* paper variables for widths and margins:: +* paper variables for two-sided mode:: +* paper variables for shifts and indents:: @end menu -@node \paper variables for widths and margins -@unnumberedsubsubsec @code{\paper} variables for widths and margins +@node paper variables for widths and margins +@unnumberedsubsubsec @code{@bs{}paper} variables for widths and margins Default values (before scaling) that are not listed here are defined in @file{ly/paper-defaults-init.ly}. @@ -733,8 +734,8 @@ Explicitly defined paper-sizes will override any user-defined left or right margin settings. -@node \paper variables for two-sided mode -@unnumberedsubsubsec @code{\paper} variables for two-sided mode +@node paper variables for two-sided mode +@unnumberedsubsubsec @code{@bs{}paper} variables for two-sided mode Default values (before scaling) are defined in @file{ly/paper-defaults-init.ly}. @@ -786,8 +787,8 @@ Installed Files: @file{ly/paper-defaults-init.ly}. -@node \paper variables for shifts and indents -@unnumberedsubsubsec @code{\paper} variables for shifts and indents +@node paper variables for shifts and indents +@unnumberedsubsubsec @code{@bs{}paper} variables for shifts and indents Default values (before scaling) that are not listed here are defined in @file{ly/paper-defaults-init.ly}. @@ -831,19 +832,19 @@ Snippets: @rlsr{Spacing}. -@node Other \paper variables -@subsection Other @code{\paper} variables +@node Other paper variables +@subsection Other @code{@bs{}paper} variables @menu -* \paper variables for line breaking:: -* \paper variables for page breaking:: -* \paper variables for page numbering:: -* Miscellaneous \paper variables:: +* paper variables for line breaking:: +* paper variables for page breaking:: +* paper variables for page numbering:: +* Miscellaneous paper variables:: @end menu -@node \paper variables for line breaking -@unnumberedsubsubsec @code{\paper} variables for line breaking +@node paper variables for line breaking +@unnumberedsubsubsec @code{@bs{}paper} variables for line breaking @table @code @@ -882,8 +883,8 @@ Notation Reference: @ref{Line breaking}. -@node \paper variables for page breaking -@unnumberedsubsubsec @code{\paper} variables for page breaking +@node paper variables for page breaking +@unnumberedsubsubsec @code{@bs{}paper} variables for page breaking Default values not listed here are defined in @file{ly/paper-defaults-init.ly} @@ -977,8 +978,8 @@ Installed Files: @file{ly/paper-defaults-init.ly}. -@node \paper variables for page numbering -@unnumberedsubsubsec @code{\paper} variables for page numbering +@node paper variables for page numbering +@unnumberedsubsubsec @code{@bs{}paper} variables for page numbering Default values not listed here are defined in @file{ly/paper-defaults-init.ly} @@ -1024,8 +1025,8 @@ music to start on page 1 there must be a blank page on the back of the cover page so that page 1 is on the right hand side. -@node Miscellaneous \paper variables -@unnumberedsubsubsec Miscellaneous @code{\paper} variables +@node Miscellaneous paper variables +@unnumberedsubsubsec Miscellaneous @code{@bs{}paper} variables @table @code @@ -1088,13 +1089,13 @@ This section discusses score layout options for the @code{\layout} block. @menu -* The \layout block:: +* The layout block:: * Setting the staff size:: @end menu -@node The \layout block -@subsection The @code{\layout} block +@node The layout block +@subsection The @code{@bs{}layout} block @funindex \layout @@ -1124,15 +1125,15 @@ variables that can appear in a @code{\layout} block are: @item @code{line-width}, @code{ragged-right} and @code{ragged-last} -(see @ref{\paper variables for widths and margins}) +(see @ref{paper variables for widths and margins,,@code{@bs{}paper} variables for widths and margins}) @item @code{indent} and @code{short-indent} -(see @ref{\paper variables for shifts and indents}) +(see @ref{paper variables for shifts and indents,,@code{@bs{}paper} variables for shifts and indents}) @item @code{system-count} -(see @ref{\paper variables for line breaking}) +(see @ref{paper variables for line breaking,,@code{@bs{}paper} variables for line breaking}) @end itemize @@ -1493,7 +1494,7 @@ every 4 measures, and only there: @seealso Notation Reference: -@ref{\paper variables for line breaking}. +@ref{paper variables for line breaking,,@code{@bs{}paper} variables for line breaking}. Snippets: @rlsr{Spacing}. @@ -1520,7 +1521,7 @@ There are also analogous settings to @code{ragged-right} and @code{ragged-bottom} and @code{ragged-last-bottom}. If set to @code{#t} the systems on all pages or just the last page respectively will not be justified vertically. See -@ref{Fixed vertical spacing \paper variables}. +@ref{Fixed vertical spacing paper variables,,Fixed vertical spacing @code{@bs{}paper} variables}. Page breaks are computed by the @code{page-breaking} function. LilyPond provides three algorithms for computing page breaks, @@ -1577,7 +1578,7 @@ book parts. @seealso Notation Reference: -@ref{\paper variables for page breaking}. +@ref{paper variables for page breaking,,@code{@bs{}paper} variables for page breaking}. Snippets: @rlsr{Spacing}. @@ -1674,7 +1675,7 @@ top-level markups. @seealso Notation Reference: -@ref{\paper variables for line breaking}. +@ref{paper variables for line breaking,,@code{@bs{}paper} variables for line breaking}. Snippets: @rlsr{Spacing}. @@ -1928,7 +1929,7 @@ control the vertical spacing of staves and non-staff lines within individual systems. The vertical spacing between separate systems, scores, markups, and margins is controlled by @code{\paper} variables, which are discussed in -@ref{Flexible vertical spacing \paper variables}. +@ref{Flexible vertical spacing paper variables,,Flexible vertical spacing @code{@bs{}paper} variables}. @menu * Within-system spacing properties:: @@ -2076,7 +2077,8 @@ labelContext = Each of the vertical spacing grob properties (except @code{staff-affinity}) uses the same alist structure as the @code{\paper} spacing variables discussed in -@ref{Flexible vertical spacing \paper variables}. Specific methods +@ref{Flexible vertical spacing paper variables,,Flexible vertical spacing @code{@bs{}paper} variables}. +Specific methods for modifying alists are discussed in @ref{Modifying alists}. Grob properties should be adjusted with an @code{\override} inside a @code{\score} or @code{\layout} block, and not inside a @@ -2218,7 +2220,7 @@ spacing settings for that staff. @seealso Notation Reference: -@ref{Flexible vertical spacing \paper variables}, +@ref{Flexible vertical spacing paper variables,,Flexible vertical spacing @code{@bs{}paper} variables}, @ref{Modifying alists}. Installed Files: diff --git a/Documentation/notation/staff.itely b/Documentation/notation/staff.itely index 55272a6121..00809e093b 100644 --- a/Documentation/notation/staff.itely +++ b/Documentation/notation/staff.itely @@ -930,7 +930,7 @@ multi-line instrument names, @code{\center-column} must be used: However, if the instrument names are longer, the instrument names in a staff group may not be centered unless the @code{indent} and @code{short-indent} settings are increased. For details about these -settings, see @ref{\paper variables for shifts and indents}. +settings, see @ref{paper variables for shifts and indents,,@code{@bs{}paper} variables for shifts and indents}. @lilypond[verbatim,quote,ragged-right] \relative c'' { @@ -1032,7 +1032,7 @@ expression to declare the instrument switch: @seealso Notation Reference: -@ref{\paper variables for shifts and indents}, +@ref{paper variables for shifts and indents,,@code{@bs{}paper} variables for shifts and indents}, @ref{Modifying context plug-ins}. Snippets: diff --git a/Documentation/usage/running.itely b/Documentation/usage/running.itely index a1156bbfc7..9e736bda01 100644 --- a/Documentation/usage/running.itely +++ b/Documentation/usage/running.itely @@ -923,7 +923,7 @@ are easily handled. * Error message Unbound variable %:: * Error message FT_Get_Glyph_Name:: * Warning staff affinities should only decrease:: -* Error message unexpected \new:: +* Error message unexpected new:: @end menu @node Music runs off the page @@ -1046,8 +1046,8 @@ at its start. For details, see @qq{Spacing of non-staff lines} in @ruser{Flexible vertical spacing within systems}. -@node Error message unexpected \new -@unnumberedsubsec Error message unexpected @code{\new} +@node Error message unexpected new +@unnumberedsubsec Error message unexpected @code{@bs{}new} A @code{\score} block must contain a @emph{single} music expression. If instead it contains several @code{\new Staff},