From: Werner Lemberg Date: Thu, 18 Aug 2011 22:01:41 +0000 (+0200) Subject: [doc] Insert possible breakpoints after slashes. X-Git-Tag: release/2.15.9-1~9^2~37 X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=b777d963f90da011f1cbdf71e4a1d1281c108df2;p=lilypond.git [doc] Insert possible breakpoints after slashes. This is far from complete, but... --- diff --git a/input/regression/beam-knee-symmetry.ly b/input/regression/beam-knee-symmetry.ly index 737f64ac84..646c5a6e85 100644 --- a/input/regression/beam-knee-symmetry.ly +++ b/input/regression/beam-knee-symmetry.ly @@ -3,7 +3,7 @@ \header { texidoc = "Point-symmetric beams should receive the same - quanting. There is no up/down bias in the quanting code." +quanting. There is no up/@/down bias in the quanting code." } \layout{ diff --git a/input/regression/break-alignment-anchor-alignment.ly b/input/regression/break-alignment-anchor-alignment.ly index 27ef71291d..d5dad0f0d0 100644 --- a/input/regression/break-alignment-anchor-alignment.ly +++ b/input/regression/break-alignment-anchor-alignment.ly @@ -1,8 +1,8 @@ \version "2.14.0" \header { - texidoc = "The default callback for break-align-anchor in clefs and time/key -signatures reads the break-align-anchor-aligment property to align + texidoc = "The default callback for break-align-anchor in clefs and time/@/key +signatures reads the @code{break-align-anchor-aligment} property to align the anchor to the extent of the break-aligned grob." } diff --git a/input/regression/breathing-sign-ancient.ly b/input/regression/breathing-sign-ancient.ly index af5f207b4f..3ec2c79cc0 100644 --- a/input/regression/breathing-sign-ancient.ly +++ b/input/regression/breathing-sign-ancient.ly @@ -3,10 +3,9 @@ \header{ texidoc=" Gregorian chant notation sometimes also uses commas and ticks, but in -smaller font size (we call it 'virgula' and 'caesura'). However, the -most common breathing signs are divisio minima/maior/maxima and +smaller font size (we call it `virgula' and `caesura'). However, the +most common breathing signs are divisio minima/@/maior/@/maxima and finalis, the latter three looking similar to bar glyphs. - " } \include "gregorian.ly" diff --git a/input/regression/cue-clef-begin-of-score.ly b/input/regression/cue-clef-begin-of-score.ly index 012130c2b0..b0e18781bd 100644 --- a/input/regression/cue-clef-begin-of-score.ly +++ b/input/regression/cue-clef-begin-of-score.ly @@ -2,7 +2,7 @@ \header { texidoc = "Clefs for cue notes at the start of a score should print the -standard clef plus a small cue clef after the time/key signature." +standard clef plus a small cue clef after the time/@/key signature." } vI = \relative c'' { \clef "treble" \repeat unfold 40 g4 } diff --git a/input/regression/cue-clef-new-line.ly b/input/regression/cue-clef-new-line.ly index bfe5e504d2..2f64b74159 100644 --- a/input/regression/cue-clef-new-line.ly +++ b/input/regression/cue-clef-new-line.ly @@ -7,7 +7,7 @@ Similarly, an end clef for cue notes ending at a line break should only be printed at the end of the line. Cue notes going over a line break should print the standard clef on the new -line plus an additional cue clef after the time/key signature." +line plus an additional cue clef after the time/@/key signature." } vI = \relative c'' { \clef "treble" \repeat unfold 40 g4 } diff --git a/input/regression/finger-chords-order.ly b/input/regression/finger-chords-order.ly index 8d54a8a9cf..16b6120b24 100644 --- a/input/regression/finger-chords-order.ly +++ b/input/regression/finger-chords-order.ly @@ -3,7 +3,7 @@ \header { texidoc = "Ordering of the fingerings depends on vertical ordering of the notes, and -is independent of up/down direction." +is independent of up/@/down direction." } diff --git a/input/regression/font-bogus-ligature.ly b/input/regression/font-bogus-ligature.ly index 37e83eb2d8..7d3053875a 100644 --- a/input/regression/font-bogus-ligature.ly +++ b/input/regression/font-bogus-ligature.ly @@ -1,6 +1,6 @@ \header { - texidoc = "TM and No should not be changed into trademark/number symbols. + texidoc = "TM and No should not be changed into trademark/@/number symbols. This may happen with incorrect font versions. " } diff --git a/input/regression/fret-diagrams-size.ly b/input/regression/fret-diagrams-size.ly index e492b5d85a..cb33f552e3 100644 --- a/input/regression/fret-diagrams-size.ly +++ b/input/regression/fret-diagrams-size.ly @@ -3,7 +3,7 @@ \header { texidoc=" Fret diagrams can be scaled using the @code{size} property. -The position and size of first fret label, mute/open signs, fingers, +The position and size of first fret label, mute/@/open signs, fingers, relative to the diagram grid, shall be the same in all cases. " diff --git a/input/regression/grace-sync.ly b/input/regression/grace-sync.ly index 99cfc7e5ea..a88d9ee017 100644 --- a/input/regression/grace-sync.ly +++ b/input/regression/grace-sync.ly @@ -1,6 +1,6 @@ \version "2.14.0" \header { - texidoc = "Grace notes in different voices/staves are synchronized." + texidoc = "Grace notes in different voices/@/staves are synchronized." } \layout { ragged-right = ##t} diff --git a/input/regression/lyric-combine.ly b/input/regression/lyric-combine.ly index 0b5bf4db9c..1c213476f1 100644 --- a/input/regression/lyric-combine.ly +++ b/input/regression/lyric-combine.ly @@ -8,7 +8,7 @@ lyrics will be discarded. Lyrics will not be set over rests. You can have melismata either by setting a property melismaBusy, or by setting automaticMelismas (which will set melismas during slurs and ties). If you want a different order than first Music, then Lyrics, you must -precook a chord of staves/lyrics and label those. Of course, the +precook a chord of staves/@/lyrics and label those. Of course, the lyrics ignore any other rhythms in the piece." } diff --git a/input/regression/metronome-text.ly b/input/regression/metronome-text.ly index f5f826a673..37c321213b 100644 --- a/input/regression/metronome-text.ly +++ b/input/regression/metronome-text.ly @@ -2,8 +2,8 @@ \header{ texidoc=" -The tempo command supports text markup and/or duration=count. Using -@code{Score.tempoHideNote}, one can hide the duration=count in the tempo mark. +The tempo command supports text markup and/@/or `duration=count'. Using +@code{Score.tempoHideNote}, one can hide the `duration=count' in the tempo mark. " } diff --git a/input/regression/optimal-page-breaking-hstretch.ly b/input/regression/optimal-page-breaking-hstretch.ly index b96107c098..2623a6d3ec 100644 --- a/input/regression/optimal-page-breaking-hstretch.ly +++ b/input/regression/optimal-page-breaking-hstretch.ly @@ -7,9 +7,9 @@ \header{ texidoc="The optimal page breaker will make trade-offs between horizontal and vertical stretching so that the overall spacing -will be more acceptable. The page-spacing-weight parameter -controls the relative importance of vertical/horizontal spacing. -Because ragged-last-bottom is on, there is no penalty for odd +will be more acceptable. The @code{page-spacing-weight} parameter +controls the relative importance of vertical/@/horizontal spacing. +Because @code{ragged-last-bottom} is on, there is no penalty for odd vertical spacing on the final page. As a result, only the first page should be horizontally stretched. " diff --git a/input/regression/part-combine.ly b/input/regression/part-combine.ly index bdb2697001..5647b774f4 100644 --- a/input/regression/part-combine.ly +++ b/input/regression/part-combine.ly @@ -3,7 +3,7 @@ texidoc ="The new part combiner stays apart from: @itemize @bullet @item different durations, -@item different articulations (taking into account only slur/beam/tie), and +@item different articulations (taking into account only slur/@/beam/@/tie), and @item wide pitch ranges. @end itemize " diff --git a/input/regression/rest-collision-beam-note.ly b/input/regression/rest-collision-beam-note.ly index 433510d78c..646bd6fd17 100644 --- a/input/regression/rest-collision-beam-note.ly +++ b/input/regression/rest-collision-beam-note.ly @@ -1,7 +1,7 @@ \header { - texidoc = "Beam/rest collision resolution and normal rest/note + texidoc = "Beam/rest collision resolution and normal rest/@/note collisions can be combined." } diff --git a/input/regression/rest-pitch.ly b/input/regression/rest-pitch.ly index 93a9531558..e1abe1c24a 100644 --- a/input/regression/rest-pitch.ly +++ b/input/regression/rest-pitch.ly @@ -1,9 +1,9 @@ \version "2.14.0" \header { - texidoc = "Rests can have pitches--these will be affected by -transposition and relativization. If a rest has a pitch, rest/rest and -beam/rest collision resolving will leave it alone." + texidoc = "Rests can have pitches -- these will be affected by +transposition and relativization. If a rest has a pitch, rest/@/rest and +beam/@/rest collision resolving will leave it alone." } diff --git a/input/regression/slur-scoring.ly b/input/regression/slur-scoring.ly index e2810eea9b..2f78cf06c6 100644 --- a/input/regression/slur-scoring.ly +++ b/input/regression/slur-scoring.ly @@ -7,7 +7,7 @@ one big file, since changing one score parameter for one situation may affect several other situations. - Tunable parameters are in @file{scm/slur.scm}. + Tunable parameters are in @file{scm/@/slur.scm}. " } diff --git a/input/regression/span-bar-partial.ly b/input/regression/span-bar-partial.ly index 4d206bfa76..20f85ac9f8 100644 --- a/input/regression/span-bar-partial.ly +++ b/input/regression/span-bar-partial.ly @@ -1,6 +1,6 @@ \version "2.14.0" \header { - texidoc = "Span bars can be turned on/off on a staff-by-staff basis." + texidoc = "Span bars can be turned on/@/off on a staff-by-staff basis." } \layout { diff --git a/input/regression/tie-chord.ly b/input/regression/tie-chord.ly index f4e973dc69..1bea075b30 100644 --- a/input/regression/tie-chord.ly +++ b/input/regression/tie-chord.ly @@ -1,15 +1,13 @@ \header { - texidoc = "In chords, ties keep closer to the note head vertically, -but never collide with heads or stems. Seconds are formatted up/down; +but never collide with heads or stems. Seconds are formatted up/@/down; the rest of the ties are positioned according to their vertical position. -The code does not handle all cases. Sometimes ties will printed on top -of or very close to each other. This happens in the last chords of -each system. " - +The code does not handle all cases. Sometimes ties will printed on top +of or very close to each other. This happens in the last chords of +each system." } diff --git a/input/regression/tie-single-manual.ly b/input/regression/tie-single-manual.ly index 5859b488a6..1d9357655d 100644 --- a/input/regression/tie-single-manual.ly +++ b/input/regression/tie-single-manual.ly @@ -1,7 +1,7 @@ \header { texidoc = "Individual ties may be formatted manually by -specifying their @code{direction} and/or @code{staff-position}." +specifying their @code{direction} and/@/or @code{staff-position}." } diff --git a/scm/chord-generic-names.scm b/scm/chord-generic-names.scm index a30036d1af..83adcb0e48 100644 --- a/scm/chord-generic-names.scm +++ b/scm/chord-generic-names.scm @@ -53,7 +53,7 @@ FIXME: func, options/context have changed See @file{double-plus-new-chord-name.scm} for the signature of @var{style}. @var{pitches}, @var{bass}, and @var{inversion} are lily pitches. -@var{options} is an alist-alist (see @file{input/test/dpncnt.ly})." +@var{options} is an alist-alist (see @file{input/@/test/@/dpncnt.ly})." (define (step-nr pitch) (let* ((pitch-nr (+ (* 7 (ly:pitch-octave pitch)) diff --git a/scm/chord-name.scm b/scm/chord-name.scm index 79b018992a..e3447eba27 100644 --- a/scm/chord-name.scm +++ b/scm/chord-name.scm @@ -107,7 +107,7 @@ (list-ref '("eses" "es" "" "is" "isis") (+ 2 (cdr n-a))))))))) (define-public ((chord-name->italian-markup re-with-eacute) pitch lowercase?) - "Return pitch markup for @var{pitch}, using italian/french note names. + "Return pitch markup for @var{pitch}, using Italian/@/French note names. If @var{re-with-eacute} is set to @code{#t}, french `ré' is returned for pitch@tie{}D instead of `re'." diff --git a/scm/define-context-properties.scm b/scm/define-context-properties.scm index 08440d1a09..e9acd96907 100644 --- a/scm/define-context-properties.scm +++ b/scm/define-context-properties.scm @@ -98,7 +98,7 @@ printed. @code{(#t . #f)} does not make sense. @end table") (autoBeamCheck ,procedure? "A procedure taking three -arguments, @var{context}, @var{dir} [start/stop (-1 or 1)], and +arguments, @var{context}, @var{dir} [start/@/stop (-1 or 1)], and @var{test} [shortest note in the beam]. A non-@code{#f} return value starts or stops the auto beam.") (autoBeaming ,boolean? "If set to true then beams are generated @@ -239,7 +239,7 @@ for a bass figure.") (figuredBassPlusDirection ,ly:dir? "Where to put plus signs relative to the main figure.") (fingeringOrientations ,list? "A list of symbols, containing -@samp{left}, @samp{right}, @samp{up} and/or @samp{down}. This list +@samp{left}, @samp{right}, @samp{up} and/@/or @samp{down}. This list determines where fingerings are put relative to the chord being fingered.") (firstClef ,boolean? "If true, create a new clef when starting a @@ -477,7 +477,7 @@ subdivided at @code{baseMoment} positions by only drawing one beam over the beat (suggestAccidentals ,boolean? "If set, accidentals are typeset as cautionary suggestions over the note.") (systemStartDelimiter ,symbol? "Which grob to make for the start -of the system/staff? Set to @code{SystemStartBrace}, +of the system/@/staff? Set to @code{SystemStartBrace}, @code{SystemStartBracket} or @code{SystemStartBar}.") (systemStartDelimiterHierarchy ,pair? "A nested list, indicating the nesting of a start delimiters.") @@ -624,7 +624,7 @@ is not set") (scriptDefinitions ,list? "The description of scripts. This is used by the @code{Script_engraver} for typesetting note-superscripts -and subscripts. See @file{scm/script.scm} for more information.") +and subscripts. See @file{scm/@/script.scm} for more information.") (slurMelismaBusy ,boolean? "Signal if a slur is present.") (stavesFound ,grob-list? "A list of all staff-symbols found.") diff --git a/scm/define-grob-properties.scm b/scm/define-grob-properties.scm index a381da8368..a45f1053d1 100644 --- a/scm/define-grob-properties.scm +++ b/scm/define-grob-properties.scm @@ -164,12 +164,12 @@ stick out of its bounds?") ;; (c0-position ,integer? "An integer indicating the position of middle@tie{}C.") - (circled-tip ,boolean? "Put a circle at start/end of -hairpins (al/del niente).") + (circled-tip ,boolean? "Put a circle at start/@/end of +hairpins (al/@/del niente).") (clip-edges ,boolean? "Allow outward pointing beamlets at the edges of beams?") (collapse-height ,ly:dimension? "Minimum height of system start -delimiter. If equal or smaller, the bracket/brace/line is removed.") +delimiter. If equal or smaller, the bracket/@/brace/@/line is removed.") (collision-interfaces ,list? "A list of interfaces for which automatic beam-collision resolution is run.") (collision-voice-only ,boolean? "Does automatic beam collsion apply @@ -434,8 +434,8 @@ be included in harp-pedal-details include the following: @itemize @bullet @item -@code{box-offset} -- Vertical shift of the center of flat/sharp pedal -boxes above/below the horizontal line. Default value@tie{}0.8. +@code{box-offset} -- Vertical shift of the center of flat/@/sharp pedal +boxes above/@/below the horizontal line. Default value@tie{}0.8. @item @code{box-width} -- Width of each pedal box. Default value@tie{}0.4. @item @@ -998,7 +998,7 @@ function is to protect objects from being garbage collected.") (bound-alignment-interfaces ,list "Interfaces to be used for positioning elements that align with a column.") (bounded-by-me ,ly:grob-array? "An array of spanners that have this -column as start/begin point. Only columns that have grobs or act as +column as start/@/begin point. Only columns that have grobs or act as bounds are spaced.") (bracket ,ly:grob? "The bracket for a number.") @@ -1169,7 +1169,7 @@ an additional stem on the right side?") (cavum ,boolean? "Is this neume outlined?") (context-info ,integer? "Within a ligature, the final glyph or shape of -a head may be affected by the left and/or right neighbour head. +a head may be affected by the left and/@/or right neighbour head. @code{context-info} holds for each head such information about the left and right neighbour, encoded as a bit mask.") diff --git a/scm/define-music-types.scm b/scm/define-music-types.scm index 0fa6b95a4d..4085957e03 100644 --- a/scm/define-music-types.scm +++ b/scm/define-music-types.scm @@ -111,7 +111,7 @@ Syntax for manual control: @code{c8-[ c c-] c8}") )) (BendAfterEvent - . ((description . "A drop/fall/doit jazz articulation.") + . ((description . "A drop/@/fall/@/doit jazz articulation.") (types . (general-music bend-after-event event)))) (BreathingEvent diff --git a/scm/define-stencil-commands.scm b/scm/define-stencil-commands.scm index 7b27d5201b..d377342843 100644 --- a/scm/define-stencil-commands.scm +++ b/scm/define-stencil-commands.scm @@ -64,7 +64,7 @@ defined in the output modules (@file{output-*.scm})." (define-public (ly:all-output-backend-commands) "Return the list of extra output backend commands that -are used internally in @file{lily/stencil-interpret.cc}." +are used internally in @file{lily/@/stencil-interpret.cc}." '(color combine-stencil delay-stencil-evaluation diff --git a/scm/font.scm b/scm/font.scm index db07a6d998..73287b6635 100644 --- a/scm/font.scm +++ b/scm/font.scm @@ -167,7 +167,7 @@ Arguments: @var{design-size-alist} is a list of @code{(rounded . designsize)}. @code{rounded} is a suffix for font filenames, while @code{designsize} should be the actual design size. The latter is used for text fonts -loaded through pango/fontconfig. +loaded through pango/@/fontconfig. @item @var{factor} is a size factor relative to the default size that is being