From: Graham Percival Date: Tue, 19 Feb 2008 04:02:18 +0000 (-0800) Subject: Rename macros to better indicate the output. X-Git-Tag: release/2.11.41-1~39 X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=1ef8d7381c28d5bceef78e508ca3b2cb1f068713;p=lilypond.git Rename macros to better indicate the output. --- diff --git a/Documentation/user/ancient.itely b/Documentation/user/ancient.itely index ab34102bc4..33254b0cf5 100644 --- a/Documentation/user/ancient.itely +++ b/Documentation/user/ancient.itely @@ -486,7 +486,7 @@ beams, depending on which staff line it is printed. Notation Reference: see @ref{Clef}. -@refbugs +@knownissues The mensural g clef is mapped to the Petrucci g clef. @@ -519,7 +519,7 @@ when typesetting the incipit of a transcribed piece of mensural music, the default flag style should be used. There are no flags in Gregorian Chant notation. -@refbugs +@knownissues The attachment of ancient flags to stems is slightly off due to a change in early 2.3.x. @@ -625,7 +625,7 @@ The following examples show the differences in style, This manual: @ref{Time signature}, gives a general introduction to the use of time signatures. -@refbugs +@knownissues Ratios of note durations do not change with the time signature. For example, the ratio of 1 brevis = 3 semibrevis (tempus perfectum) must @@ -683,7 +683,7 @@ designed for use with notation in Editio Vaticana style. } @end lilypond -@refbugs +@knownissues Some articulations are vertically placed too closely to the corresponding note heads. @@ -798,7 +798,7 @@ Therefore, @file{gregorian@/-init@/.ly} also defines @code{\virgula} and @lilypondfile[quote,ragged-right]{divisiones.ly} -@refcommands +@predefined @funindex \virgula @code{\virgula}, @@ -855,7 +855,7 @@ are supported with certain limitations. -@refbugs +@knownissues Ligatures need special spacing that has not yet been implemented. As a result, there is too much space between ligatures most of the time, @@ -965,7 +965,7 @@ to the following } @end lilypond -@refbugs +@knownissues Horizontal spacing is poor. @@ -1870,7 +1870,7 @@ note that you can say @code{\augmentum @{a g@}} as a shortcut for } @end lilypond -@refcommands +@predefined The following head prefixes are supported @@ -1910,7 +1910,7 @@ respectively. @funindex \augmentum Use the unary music function @code{\augmentum} to add augmentum dots. -@refbugs +@knownissues When an @code{\augmentum} dot appears at the end of the last staff within a ligature, it is sometimes vertically placed wrong. As a @@ -2200,7 +2200,7 @@ automatically. @end lilypond -@commonprop +@snippets By default, this method produces figures above the notes. To get figures below the notes, use @@ -2210,7 +2210,7 @@ figures below the notes, use @end example -@refbugs +@knownissues When using figured bass above the staff with extender lines and @code{implicitBassFigures} the lines may become swapped around. diff --git a/Documentation/user/changing-defaults.itely b/Documentation/user/changing-defaults.itely index d69c86d1c7..ef4e30d80f 100644 --- a/Documentation/user/changing-defaults.itely +++ b/Documentation/user/changing-defaults.itely @@ -627,7 +627,7 @@ Internals: @internalsref{OverrideProperty}, @internalsref{RevertProperty}, @internalsref{All layout objects}. -@refbugs +@knownissues The back-end is not very strict in type-checking object properties. Cyclic references in Scheme values for properties can cause hangs @@ -683,7 +683,7 @@ will also work. -@refbugs +@knownissues It is not possible to collect context changes in a variable and apply them to a @code{\context} definition by referring to that variable. diff --git a/Documentation/user/chords.itely b/Documentation/user/chords.itely index 84e8262e1a..24cf67787b 100644 --- a/Documentation/user/chords.itely +++ b/Documentation/user/chords.itely @@ -245,7 +245,7 @@ commands may be used to change various settings. -@refbugs +@knownissues Each step can only be present in a chord once. The following simply produces the augmented chord, since @code{5+} is interpreted @@ -411,7 +411,7 @@ chart}. Turning on these styles is demonstrated in @cindex chords, jazz -@refcommands +@predefined @funindex \germanChords @code{\germanChords}, @@ -434,7 +434,7 @@ Init files: @file{scm/@/chords@/-ignatzek@/.scm}, and @file{scm/@/chord@/-entry@/.scm}. -@refbugs +@knownissues Chord names are determined solely from the list of pitches. Chord inversions are not identified, and neither are added bass notes. This diff --git a/Documentation/user/converters.itely b/Documentation/user/converters.itely index 7814a511bc..9b293bcaa9 100644 --- a/Documentation/user/converters.itely +++ b/Documentation/user/converters.itely @@ -20,7 +20,7 @@ These are separate programs from lilypond itself, and are run on the command-line; see @ref{Command-line usage} for more information. -@refbugs +@knownissues We unfortunately do not have the resources to maintain these programs; please consider them @qq{as-is}. Patches are appreciated, but bug reports will almost certainly not be resolved. @@ -115,7 +115,7 @@ Treat every text as a lyric. @end table -@refbugs +@knownissues Overlapping notes in an arpeggio will not be correctly rendered. The first note will be read and the others will be ignored. Set them all @@ -195,7 +195,7 @@ will cause the text following the @q{slyrics} keyword to be inserted into the current line of lyrics. -@refbugs +@knownissues The ABC standard is not very @q{standard}. For extended features (e.g., polyphonic music) different conventions exist. @@ -242,7 +242,7 @@ version information @end table -@refbugs +@knownissues The list of articulation scripts is incomplete. Empty measures confuse @command{etf2ly}. Sequences of grace notes are ended improperly. diff --git a/Documentation/user/editorial.itely b/Documentation/user/editorial.itely index 304f51f0a8..5a361fda2d 100644 --- a/Documentation/user/editorial.itely +++ b/Documentation/user/editorial.itely @@ -85,7 +85,7 @@ The @code{font-size} property can only be set on layout objects that use fonts. These are the ones supporting the @code{font-interface} layout interface. -@refcommands +@predefined The following commands set @code{fontSize} for the current voice: @@ -142,7 +142,7 @@ chord by adding them after the pitches. @end lilypond -@commonprop +@snippets @code{fingeringOrientations} are used to control where the fingering numbers are placed. @@ -193,7 +193,7 @@ b c @end lilypond -@refcommands +@predefined @code{\hideNotes}, @code{\unHideNotes} @@ -286,7 +286,7 @@ the input}. Snippets: @lsrdir{Editorial,Editorial-annotations}. -@refbugs +@knownissues Not all x11 colors are distinguishable in a web browser i.e. a web browser might not display a difference between 'LimeGreen and 'ForestGreen. For web use normal colors are recommended. (#blue, @@ -352,7 +352,7 @@ Whenever a note is found, a @code{Stem} object is created automatically. For whole notes and rests, they are also created but made invisible. -@refcommands +@predefined @funindex \stemUp @code{\stemUp}, @@ -362,7 +362,7 @@ made invisible. @code{\stemNeutral}. -@commonprop +@snippets @cindex stem, direction @cindex stem, up diff --git a/Documentation/user/expressive.itely b/Documentation/user/expressive.itely index 3aa252c270..211e84d67a 100644 --- a/Documentation/user/expressive.itely +++ b/Documentation/user/expressive.itely @@ -123,7 +123,7 @@ c\fermata c^\fermata c_\fermata @cindex varcoda -@commonprop +@snippets The shorthands are defined in @file{ly/@/script@/-init@/.ly}, where the variables @code{dashHat}, @code{dashPlus}, @@ -168,7 +168,7 @@ Internals Reference: @internalsref{Script}, @internalsref{TextScript}. -@refbugs +@knownissues These signs appear in the printed output but have no effect on the MIDI rendering of the music. @@ -316,7 +316,7 @@ Vertical positioning of dynamics is handled by @internalsref{DynamicLineSpanner}. -@refcommands +@predefined @funindex \dynamicUp @code{\dynamicUp}, @@ -326,7 +326,7 @@ Vertical positioning of dynamics is handled by @code{\dynamicNeutral}. -@commonprop +@snippets Dynamics that occur at, begin on, or end on the same note will be vertically aligned. If you want to ensure that dynamics are @@ -411,7 +411,7 @@ Only one slur can be printed at once. If you need to print a long slur over a few small slurs, please see @ref{Phrasing slurs}. -@refcommands +@predefined @funindex \slurUp @code{\slurUp}, @@ -427,7 +427,7 @@ slur over a few small slurs, please see @ref{Phrasing slurs}. @code{\slurSolid}. -@commonprop +@snippets Some composers write two slurs when they want legato chords. This can be achieved in LilyPond by setting @code{doubleSlurs}, @@ -469,7 +469,7 @@ and@tie{}@code{^}. You cannot have simultaneous phrasing slurs. -@refcommands +@predefined @funindex \phrasingSlurUp @code{\phrasingSlurUp}, @@ -496,7 +496,7 @@ c'4 \breathe d4 @end lilypond -@commonprop +@snippets The glyph of the breath mark can be tuned by overriding the @code{text} property of the @code{BreathingSign} layout object @@ -555,7 +555,7 @@ c2\glissando c' c2\glissando c, @end lilypond -@commonprop +@snippets @lilypond[verbatim,quote,ragged-right] @@ -582,7 +582,7 @@ Snippets: @lsrdir{Expressive,Expressive-marks}. Internals Reference: @internalsref{Glissando}. -@refbugs +@knownissues Printing text over the line (such as @emph{gliss.}) is not supported. @@ -627,7 +627,7 @@ reverts to the arrow-less version: @end lilypond -@refcommands +@predefined @code{\arpeggio}, @funindex \arpeggioUp @@ -640,7 +640,7 @@ reverts to the arrow-less version: @code{\arpeggioBracket}. -@commonprop +@snippets In a @code{PianoStaff}, it is possible to let an arpeggio cross between the staves by setting the property @@ -710,7 +710,7 @@ Internals Reference: @internalsref{Arpeggio}, @internalsref{PianoStaff}. -@refbugs +@knownissues It is not possible to mix connected arpeggios and unconnected arpeggios in one @code{PianoStaff} at the same point in @@ -752,7 +752,7 @@ The first argument is the main note. The pitch of the second is printed as a stemless note head in parentheses. -@refcommands +@predefined @code{\startTrillSpan}, @funindex \startTrillSpan diff --git a/Documentation/user/guitar.itely b/Documentation/user/guitar.itely index 8bcb002abe..b056670d88 100644 --- a/Documentation/user/guitar.itely +++ b/Documentation/user/guitar.itely @@ -98,7 +98,7 @@ frag = { @end lilypond -@commonprop +@snippets To print tablatures with stems down and horizontal beams, initialize the @code{TabStaff} with this code: @@ -112,7 +112,7 @@ initialize the @code{TabStaff} with this code: Internals Reference: @internalsref{TabNoteHead}, @internalsref{TabStaff}, @internalsref{TabVoice}. -@refbugs +@knownissues Chords are not handled in a special way, and hence the automatic string selector may easily select the same string to two notes in a @@ -177,7 +177,7 @@ The file @file{scm/@/output@/-lib@/.scm} contains the predefined string tunings. Internals Reference: @internalsref{Tab_note_heads_engraver}. -@refbugs +@knownissues No guitar special effects have been implemented. @@ -291,7 +291,7 @@ short, for example @code{RH}, @cindex fingerings, right hand, for guitar @cindex right hand fingerings for guitar -@commonprop +@snippets You may exercise greater control over right handing fingerings by setting @code{strokeFingerOrientations}, diff --git a/Documentation/user/input.itely b/Documentation/user/input.itely index 036367738b..a9ad9a80dd 100644 --- a/Documentation/user/input.itely +++ b/Documentation/user/input.itely @@ -501,7 +501,7 @@ a piece of music with multiple @code{\tag} entries, Examples: @c @lsr{parts,tag@/-filter@/.ly} -@refbugs +@knownissues Multiple rests are not merged if you create the score with both tagged sections. diff --git a/Documentation/user/install.itely b/Documentation/user/install.itely index ca8c94902d..16c9a6950c 100644 --- a/Documentation/user/install.itely +++ b/Documentation/user/install.itely @@ -294,7 +294,7 @@ unstable Lily will fail to build the docs. You may build the manual ( Documentation/user/ ) without building all the input/* stuff. -@refbugs +@knownissues You may also need to create a script for @command{pngtopnm} and @code{pnmtopng}. On Linux, I use this: diff --git a/Documentation/user/lilypond-book.itely b/Documentation/user/lilypond-book.itely index a31ab03874..86b274f9cf 100644 --- a/Documentation/user/lilypond-book.itely +++ b/Documentation/user/lilypond-book.itely @@ -290,7 +290,7 @@ kpsewhich feta20.tex @end ignore -@commonprop +@snippets Sometimes it is useful to display music elements (such as ties and slurs) as if they continued after the end of the fragment. This can be done by @@ -865,7 +865,7 @@ Be verbose. Print version information. @end table -@refbugs +@knownissues The Texinfo command @code{@@pagesizes} is not interpreted. Similarly, @LaTeX{} commands that change margins and line widths after the preamble diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi index ab06cecbb6..f3e89d7983 100644 --- a/Documentation/user/macros.itexi +++ b/Documentation/user/macros.itexi @@ -70,16 +70,14 @@ @c **** Headings in a doc subsection **** -@c obsolete; being removed. -@macro refcommands +@macro predefined @noindent @subsubheading Predefined commands @end macro -@macro commonprop +@macro snippets @noindent -@c @subsubheading Commonly tweaked properties @subsubheading Selected Snippets @end macro @@ -91,13 +89,12 @@ @indent @end macro -@macro refbugs +@macro knownissues @noindent @subsubheading Known issues and warnings @end macro - @macro funindex {TEXT} @findex \TEXT\ @kindex \TEXT\ @@ -107,21 +104,6 @@ @c **** Links and references **** -@c usage: @lsr{ancient,Ancient-notation,custodes.ly} -@ignore - -DEPRECATED - -@macro lsr{SECTION,DIR,TEXT} -@ifhtml -@uref{source/input/lsr/snippets/\DIR\.html#\TEXT\,@file{\SECTION\/\TEXT\}} -@end ifhtml -@ifnothtml -@file{\SECTION\/\TEXT\} -@end ifnothtml -@end macro -@end ignore - @c usage: @lsrdir{ancient,Ancient-notation} @macro lsrdir{SECTION,DIR} @ifhtml diff --git a/Documentation/user/non-music.itely b/Documentation/user/non-music.itely index 0e6380173a..a2c64724c1 100644 --- a/Documentation/user/non-music.itely +++ b/Documentation/user/non-music.itely @@ -329,7 +329,7 @@ the markup have to be known before, so a gauge is used to decide these dimensions. If the book has between 10 and 99 pages, it may be "00", ie. a two digit number. -@refcommands +@predefined @funindex \label @code{\label} @@ -442,7 +442,7 @@ tocAct = Init files: @file{ly/@/toc@/-init@/.ly}. -@refcommands +@predefined @funindex \table-of-contents @code{\table-of-contents} @@ -466,7 +466,7 @@ what was entered. This is convenient for checking the music; octaves that are off or accidentals that were mistyped stand out very much when listening to the MIDI output. -@refbugs +@knownissues Many musically interesting effects, such as swing, articulation, slurring, etc., are not translated to midi. @@ -564,7 +564,7 @@ in the @code{\midi@{@}} section. @end example -@refbugs +@knownissues Unterminated (de)crescendos will not render properly in the midi file, resulting in silent passages of music. The workaround is to explicitly diff --git a/Documentation/user/percussion.itely b/Documentation/user/percussion.itely index f52970f8f0..5e71616971 100644 --- a/Documentation/user/percussion.itely +++ b/Documentation/user/percussion.itely @@ -283,7 +283,7 @@ Init files: @file{ly/@/drumpitch@/-init@/.ly}. Internals Reference: @internalsref{DrumStaff}, @internalsref{DrumVoice}. -@refbugs +@knownissues Because general MIDI does not contain rim shots, the sidestick is used for this purpose instead. diff --git a/Documentation/user/piano.itely b/Documentation/user/piano.itely index 138a21da15..54ed891e00 100644 --- a/Documentation/user/piano.itely +++ b/Documentation/user/piano.itely @@ -31,7 +31,7 @@ handle this cross-staffing behavior. In this section we discuss the * Cross staff stems:: @end menu -@refbugs +@knownissues Dynamics are not centered, but workarounds do exist. See the @q{piano centered dynamics} template in @rlearning{Piano templates}. @@ -91,7 +91,7 @@ Internals Reference: @internalsref{AutoChangeMusic}. -@refbugs +@knownissues The staff switches may not end up in optimal places. For high quality output, staff switches should be specified manually. @@ -236,7 +236,7 @@ can be printed automatically. This is switched on by setting Internals Reference: @internalsref{VoiceFollower}. -@refcommands +@predefined @funindex \showStaffSwitch @code{\showStaffSwitch}, diff --git a/Documentation/user/pitches.itely b/Documentation/user/pitches.itely index 81033eb3d4..f50faa6f65 100644 --- a/Documentation/user/pitches.itely +++ b/Documentation/user/pitches.itely @@ -207,7 +207,7 @@ Snippets: @lsrdir{Pitches,Pitches}. @funindex \chordmode @funindex \relative -@refbugs +@knownissues The relative conversion will not affect @code{\transpose}, @code{\chordmode} or @code{\relative} sections in its argument. @@ -309,7 +309,7 @@ cis @end lilypond -@commonprop +@snippets @lilypondfile[verbatim,lilyquote,ragged-right,texidoc] {preventing-extra-naturals-from-being-automatically-added.ly} @@ -328,7 +328,7 @@ Notation Reference: @ref{Automatic accidentals}, Snippets: @lsrdir{Pitches,Pitches}. -@refbugs +@knownissues There are no generally accepted standards for denoting quarter-tone accidentals, so LilyPond's symbol does not conform to @@ -615,7 +615,7 @@ For more information about transposing instruments, see @ref{Instrument transpositions}. -@commonprop +@snippets @lilypondfile[verbatim,lilyquote,ragged-right,texidoc] {transposing-pitches-with-minimum-accidentals-smart-transpose.ly} @@ -633,7 +633,7 @@ Internals Reference: @internalsref{TransposedMusic}. @funindex \chordmode @funindex \relative -@refbugs +@knownissues The relative conversion will not affect @code{\transpose}, @@ -752,7 +752,7 @@ c2 c @end lilypond -@commonprop +@snippets @lilypondfile[verbatim,lilyquote,ragged-right,texidoc] {clefs-commonly-tweaked-properties.ly} @@ -816,7 +816,7 @@ fis @end lilypond -@commonprop +@snippets @lilypondfile[verbatim,lilyquote,ragged-right,texidoc] {preventing-natural-signs-from-being-printed-when-the-key-signature-changes.ly} @@ -861,7 +861,7 @@ The @code{set-octavation} function also takes -1 (for 8va bassa), 2@tie{}(for 15ma), and -2 (for 15ma bassa) as arguments. -@commonprop +@snippets @lilypondfile[verbatim,lilyquote,ragged-right,texidoc] {ottava-text.ly} @@ -1661,7 +1661,7 @@ musicB = { @end lilypond @end table -@commonprop +@snippets @lilypondfile[verbatim,lilyquote,ragged-right,texidoc] {dodecaphonic-style-accidentals-for-each-note-including-naturals.ly} @@ -1682,7 +1682,7 @@ Internals Reference: @internalsref{Accidental_engraver}, @cindex accidentals in chords @cindex chords, accidentals in -@refbugs +@knownissues Simultaneous notes are considered to be entered in sequential mode. This means that in a chord the accidentals are typeset as @@ -1701,7 +1701,6 @@ problematic notes. @cindex range of pitches @cindex pitch range -@c FIXME: square brackets for plural ? The term @notation{ambitus} (pl. ambitus) denotes a range of pitches for a given voice in a part of music. It may also denote the pitch range that a musical instrument is capable of playing. @@ -1727,7 +1726,7 @@ printed if they are not part of the key signature. @end lilypond -@commonprop +@snippets @lilypondfile[verbatim,lilyquote,ragged-right,texidoc] {adding-ambiti-per-voice.ly} @@ -1748,7 +1747,7 @@ Internals Reference: @internalsref{Ambitus}, @internalsref{Staff}, @internalsref{Voice}. -@refbugs +@knownissues There is no collision handling in the case of multiple per-voice ambitus. @@ -1841,7 +1840,7 @@ The command @code{\easyHeadsOn} overrides settings for the in a large font size. To print with a larger font, see @ref{Setting the staff size}. -@refcommands +@predefined @funindex \easyHeadsOn @funindex \easyHeadsOff @@ -1887,7 +1886,7 @@ c,8 d4 e8 a2 g1 Shapes are typeset according to the step in the scale, where the base of the scale is determined by the @code{\key} command. -@commonprop +@snippets @lilypondfile[verbatim,lilyquote,ragged-right,texidoc] {applying-noteheads-styles-depending-on-the-step-of-the-scale.ly} @@ -1929,7 +1928,7 @@ rhythm. Such note heads can be created: @end lilypond -@refcommands +@predefined @funindex \improvisationOn @funindex \improvisationOff diff --git a/Documentation/user/policy.txt b/Documentation/user/policy.txt index 4813942499..229419de9f 100644 --- a/Documentation/user/policy.txt +++ b/Documentation/user/policy.txt @@ -79,10 +79,10 @@ Users are not expected to read this manual from start to finish. The order of headings inside documentation sections should be: main docs -@refcommands -@commonprop +@predefined +@snippets @seealso -@refbugs +@knownissues * You _must_ include a @seealso. The order of items inside the @seealso section is diff --git a/Documentation/user/programming-interface.itely b/Documentation/user/programming-interface.itely index ac5e5ea0a4..3219124d4e 100644 --- a/Documentation/user/programming-interface.itely +++ b/Documentation/user/programming-interface.itely @@ -389,7 +389,7 @@ define some Scheme code in a macro (to be called later), use @end example -@refbugs +@knownissues Mixing Scheme and LilyPond variables is not possible with the @code{--safe} option. @@ -895,7 +895,7 @@ useful when defining new markup commands (see @ref{New markup command definition}). -@refbugs +@knownissues The markup-list argument of commands such as @code{#:line}, @code{#:center}, and @code{#:column} cannot be a variable or diff --git a/Documentation/user/repeats.itely b/Documentation/user/repeats.itely index a812380fbd..3aec6edc08 100644 --- a/Documentation/user/repeats.itely +++ b/Documentation/user/repeats.itely @@ -214,7 +214,7 @@ Internals Reference: @internalsref{VoltaBracket}, @c Examples: -@refbugs +@knownissues @cindex repeat, ambiguous @@ -350,7 +350,7 @@ c'2:8 c':32 | c': c': | @end lilypond -@refbugs +@knownissues Tremolos entered with @q{@code{:}[@var{number}]} do not carry over diff --git a/Documentation/user/rhythms.itely b/Documentation/user/rhythms.itely index 49263ce4c6..864ed0a045 100644 --- a/Documentation/user/rhythms.itely +++ b/Documentation/user/rhythms.itely @@ -108,7 +108,7 @@ Optionally, notes can be spaced strictly proportionately to their duration. For details of this and other settings which control proportional notation, see @ref{Proportional notation}. -@refcommands +@predefined Dots are normally moved up to avoid staff lines, except in polyphonic situations. The following commands may be used to @@ -138,7 +138,7 @@ Internals Reference: @internalsref{Dots}, @internalsref{DotColumn}. -@refbugs +@knownissues @c Deliberately duplicated in Durations and Rests. -gp There is no fundamental limit to rest durations (both in terms of @@ -182,7 +182,7 @@ Tuplets may be nested: } @end lilypond -@refcommands +@predefined @funindex \tupletUp @code{\tupletUp}, @@ -192,7 +192,7 @@ Tuplets may be nested: @code{\tupletNeutral}. -@commonprop +@snippets @cindex tuplet formatting @cindex triplet formatting @@ -387,7 +387,7 @@ Snippets: @lsrdir{Rhythms,Rhythms}. Internals Reference: @internalsref{TupletBracket}, @internalsref{TupletNumber}, @internalsref{TimeScaledMusic}. -@refbugs +@knownissues Lines may be broken within a tuplet with @code{\bar "" \break}, but the tuplet bracket does not correctly carry over. @@ -517,7 +517,7 @@ c4_~ c c^~ c) @end lilypond @end quotation -@refcommands +@predefined @funindex \tieUp @code{\tieUp}, @@ -533,7 +533,7 @@ c4_~ c c^~ c) @code{\tieSolid}. -@commonprop +@snippets Ties are sometimes used to write out arpeggios. In this case, two tied notes need not be consecutive. This can be achieved by @@ -589,7 +589,7 @@ Snippets: @lsrdir{Rhythms,Rhythms} Internals Reference: @internalsref{Tie}. -@refbugs +@knownissues Switching staves when a tie is active will not produce a slanted tie. @@ -661,7 +661,7 @@ Snippets: @lsrdir{Rhythms,Rhythms}. Internals Reference: @internalsref{Rest}. -@refbugs +@knownissues @c Deliberately duplicated in Durations and Rests. -gp There is no fundamental limit to rest durations (both in terms of @@ -879,7 +879,7 @@ default number, and @internalsref{MultiMeasureRestText} for user specified texts. -@refbugs +@knownissues If an attempt is made to use fingerings (e.g., @code{R1*10-4}) to put numbers over multi-measure rests, the @@ -925,7 +925,7 @@ The time signature is set with the @code{\time} command: \time 2/4 c2 \time 3/4 c2. @end lilypond -@commonprop +@snippets The symbol that is printed can be customized with the @code{style} property. Setting it to @code{#'()} uses fraction style for 4/4 @@ -1015,7 +1015,7 @@ Internals Reference: @internalsref{TimeSignature}, and Examples: @c @lsr{contemporary,compound-time-signature.ly}. -@refbugs +@knownissues Automatic beaming does not use the measure grouping specified with @code{set-time-signature}. @@ -1058,7 +1058,7 @@ that this is a negative number; @code{\partial 4} is internally translated to mean @qq{there is a quarter note left in the bar.} -@refbugs +@knownissues This command does not take into account grace notes at the start of the music. When a piece starts with grace notes in the @@ -1113,7 +1113,7 @@ c4 c d8 d d f4 g4. d4 e d c @end lilypond -@refbugs +@knownissues LilyPond will only insert line breaks and page breaks at a bar line. Unless the unmetered music ends before the end of the @@ -1257,7 +1257,7 @@ staff, shown durations are multiplied by 3/5, so that 3/5 * 10/8 = @end lilypond -@refbugs +@knownissues When using different time signatures in parallel, the spacing is aligned vertically, but bar lines distort the regular spacing. @@ -1297,7 +1297,7 @@ If you want to allow line breaking on the bar lines where also remove @internalsref{Forbid_line_break_engraver}. -@refbugs +@knownissues Not all durations (especially those containing tuplets) can be represented exactly with normal notes and dots, but the engraver @@ -1364,7 +1364,7 @@ c16 c8 @end lilypond -@commonprop +@snippets Beaming patterns may be altered with the @code{beatGrouping} property, @@ -1447,7 +1447,7 @@ Snippets: @lsrdir{Rhythms,Rhythms} Internals Reference: @internalsref{Beam}. -@refbugs +@knownissues Automatically kneed cross-staff beams cannot be used together with hidden staves. See @ref{Hiding staves}. @@ -1621,7 +1621,7 @@ If beams are used to indicate melismata in songs, then automatic beaming should be switched off with @code{\autoBeamOff}. -@refcommands +@predefined @funindex \autoBeamOff @code{\autoBeamOff}, @@ -1629,7 +1629,7 @@ beaming should be switched off with @code{\autoBeamOff}. @code{\autoBeamOn}. -@refbugs +@knownissues If a score ends while an automatic beam has not been ended and is still accepting notes, this last beam will not be typeset at all. @@ -1693,7 +1693,7 @@ the group as a whole. @end lilypond -@commonprop +@snippets @node Feathered beams @subsubsection Feathered beams @@ -1743,7 +1743,7 @@ the last four 32nd notes are at a constant tempo. The spacing in the printed output represents the note durations only approximately, but the midi output is exact. -@refbugs +@knownissues The @code{\featherDurations} command only works with very short music snippets, and when numbers in the fraction are small. @@ -1886,7 +1886,7 @@ connected between different staves of a @code{StaffGroup}, @end lilypond -@commonprop +@snippets @funindex whichBar @funindex defaultBarType @@ -1933,7 +1933,7 @@ c1 c c c @end lilypond -@commonprop +@snippets @funindex barNumberVisibility @cindex bar numbers, regular spacing @@ -2052,7 +2052,7 @@ Snippets: @lsrdir{Rhythms,Rhythms} Internals Reference: @internalsref{BarNumber}. -@refbugs +@knownissues Bar numbers may collide with the top of the @internalsref{StaffGroup} bracket, if there is one. To solve @@ -2406,7 +2406,7 @@ other situations by @code{\override Stem #'stroke-style = #"grace"}. -@commonprop +@snippets Grace notes may be forced to use align with regular notes in other staves by setting @code{strict-grace-spacing} to @@ -2443,7 +2443,7 @@ Snippets: @lsrdir{Rhythms,Rhythms} Internals Reference: @internalsref{GraceMusic}. -@refbugs +@knownissues A multi-note beamed @emph{acciaccatura} is printed without a slash, and looks exactly the same as a multi-note beamed diff --git a/Documentation/user/simultaneous.itely b/Documentation/user/simultaneous.itely index bca28d52df..4713ae4cd0 100644 --- a/Documentation/user/simultaneous.itely +++ b/Documentation/user/simultaneous.itely @@ -54,7 +54,7 @@ Notation Reference: @ref{Introducing chord names}. Snippets: @lsrdir{Simultaneous,Simultaneous-notes}. -@refbugs +@knownissues Music expressions like @code{<< @{ g8 e8 @} a4 >>} are not printed accurately. Use @code{8 8} instead. @@ -191,7 +191,7 @@ voiceFive = #(context-spec-music (make-voice-props-set 4) 'Voice) -@refcommands +@predefined @funindex \oneVoice @code{\oneVoice}, @@ -257,7 +257,7 @@ collisions are @internalsref{NoteCollision} and @internalsref{RestCollision}. -@refbugs +@knownissues When using @code{merge-differently-headed} with an upstem eighth or a shorter note, and a downstem half note, the eighth note gets @@ -357,7 +357,7 @@ Snippets: @lsrdir{Simultaneous,Simultaneous-notes}. Internals Reference: @internalsref{PartCombineMusic}, @internalsref{Voice}. -@refbugs +@knownissues When @code{printPartCombineTexts} is set, if the two voices play the same notes on and off, the part combiner may typeset @code{a2} diff --git a/Documentation/user/spacing.itely b/Documentation/user/spacing.itely index 2d6136abf2..c4e1302554 100644 --- a/Documentation/user/spacing.itely +++ b/Documentation/user/spacing.itely @@ -295,7 +295,7 @@ result in the first page number remaining as is or being increased by one. @end quotation -@commonprop +@snippets The header and footer are created by the functions make-footer and make-header, defined in \paper. The default implementations are in @@ -369,7 +369,7 @@ how much space can be spent on a page, the latter creates the actual page given the system to put on it. -@refbugs +@knownissues The option right-margin is defined but doesn't set the right margin yet. The value for the right margin has to be defined adjusting the @@ -491,7 +491,7 @@ staves. The sizes of individual staves are relative to the global size. This manual: @ref{Selecting notation font size}. -@refbugs +@knownissues @code{layout-set-staff-size} does not change the distance between the staff lines. @@ -605,7 +605,7 @@ skips and repeated with @code{\repeat}: This makes the following 28 measures (assuming 4/4 time) be broken every 4 measures, and only there. -@refcommands +@predefined @code{\break}, and @code{\noBreak}. @funindex \break @@ -621,7 +621,7 @@ fit pages in a second formatting run. This is fairly new and complicated. More details are available in @c @lsrdir{spacing} -@refbugs +@knownissues Line breaks can only occur if there is a @q{proper} bar line. A note which is hanging over a bar line is not proper, such as @@ -680,7 +680,7 @@ The old page breaking algorithm is called @code{optimal-page-breaks}. If you are having trouble with the new page breakers, you can enable the old one as a workaround. -@refcommands +@predefined @funindex \pageBreak @code{\pageBreak} @@ -764,7 +764,7 @@ The page turning commands, @code{\pageTurn}, @code{\noPageTurn} and @code{\allowPageTurn}, may also be used at top-level, between scores and top-level markups. -@refcommands +@predefined @funindex \pageTurn @code{\pageTurn} @@ -773,7 +773,7 @@ top-level markups. @funindex \allowPageTurn @code{\allowPageTurn} -@refbugs +@knownissues There should only be one @code{Page_turn_engraver} in a score. If there is more than one, they will interfere with each other. @@ -1547,7 +1547,7 @@ Internals: @internalsref{SpacingSpanner}, @internalsref{NoteSpacing}, @internalsref{SeparatingGroupSpanner}. -@refbugs +@knownissues There is no convenient mechanism to manually override spacing. The following work-around may be used to insert extra space into a score. @@ -1625,7 +1625,7 @@ than @code{1 16}. @end lilypond -@commonprop +@snippets By default, spacing in tuplets depends on various non-duration factors (such as accidentals, clef changes, etc). To disregard diff --git a/Documentation/user/staff.itely b/Documentation/user/staff.itely index ee40671d52..618bc6bf27 100644 --- a/Documentation/user/staff.itely +++ b/Documentation/user/staff.itely @@ -119,7 +119,7 @@ Staff groups can be nested, using the context @c @lsr{staff,staff-brackets.ly} @c snippet 137 -@commonprop +@snippets More complex nesting can be accomplished using the property @code{systemStartDelimiterHierarchy}: @@ -354,7 +354,7 @@ the layout output, a metronome marking is printed @end lilypond -@commonprop +@snippets To change the tempo in the MIDI output without printing anything, make the metronome marking invisible @example \once \override @@ -387,7 +387,7 @@ Internals Reference: @internalsref{MetronomeMark}, @ref{MIDI output}. -@refbugs +@knownissues Collisions are not checked. If you have notes above the top line of the staff (or notes with articulations, slurs, text, etc), then @@ -603,7 +603,7 @@ notes and rests of the quoted voice end up in the will quote notes (but no rests), together with scripts and dynamics. -@refbugs +@knownissues Only the contents of the first @code{Voice} occurring in an @code{\addQuote} command will be considered for quotation, so diff --git a/Documentation/user/text.itely b/Documentation/user/text.itely index 27e0a85816..5e0db95539 100644 --- a/Documentation/user/text.itely +++ b/Documentation/user/text.itely @@ -105,7 +105,7 @@ More complex formatting may also be added to a note by using the c'4^\markup { bla \bold bla } @end lilypond -@refcommands +@predefined @funindex \textLengthOn @code{\textLengthOn}, @@ -113,7 +113,7 @@ c'4^\markup { bla \bold bla } @code{\textLengthOff}. -@commonprop +@snippets @c TODO: put this in the LSR. -vv By default, these indications do not influence the note spacing. However, by using the command @code{\textLengthOn}, the widths @@ -185,7 +185,7 @@ c2\startTextSpan b c\stopTextSpan a c2\startTextSpan b c\stopTextSpan a @end lilypond -@refcommands +@predefined @funindex textSpannerUp @code{\textSpannerUp}, @@ -195,7 +195,7 @@ c2\startTextSpan b c\stopTextSpan a @code{\textSpannerNeutral}. -@commonprop +@snippets To print a solid line, use @@ -254,7 +254,7 @@ If there is no next line, then the mark will not be printed at all. -@commonprop +@snippets @c TODO: to be LSR-ized stuff -vv @@ -536,7 +536,7 @@ Internals Reference: @internalsref{TextScript}. Init files: @file{scm/@/new@/-markup@/.scm}. -@refbugs +@knownissues Kerning or generation of ligatures is only done when the @TeX{} backend is used. In this case, LilyPond does not account for them @@ -601,7 +601,7 @@ markup list command definition}. Snippets: @lsrdir{Text,Text} -@refcommands +@predefined @funindex \markuplines @code{\markuplines} diff --git a/Documentation/user/vocal.itely b/Documentation/user/vocal.itely index 712ca7890c..fcdf647715 100644 --- a/Documentation/user/vocal.itely +++ b/Documentation/user/vocal.itely @@ -34,7 +34,7 @@ by examining the simplest method, and gradually increase complexity. * More about stanzas:: @end menu -@commonprop +@snippets Checking to make sure that text scripts and lyrics are within the margins is a relatively large computational task. To speed up processing, lilypond does @@ -473,7 +473,7 @@ A complete example of a SATB score setup is in section @rlearning{Vocal ensembles}. -@refcommands +@predefined @code{\melisma}, @code{\melismaEnd} @funindex \melismaEnd @@ -485,7 +485,7 @@ Internals Reference: @internalsref{Melisma_translator}. @c @lsr{vocal,lyric@/-combine.ly}. -@refbugs +@knownissues Melismata are not detected automatically, and extender lines must be inserted by hand. diff --git a/Documentation/user/writing-sections.txt b/Documentation/user/writing-sections.txt index 3a0c767431..54cd534634 100644 --- a/Documentation/user/writing-sections.txt +++ b/Documentation/user/writing-sections.txt @@ -23,7 +23,7 @@ WORKING I recommend working on one subsection at a time. For each subsection, -- check the mundane formatting. Are the headings (@refcommands, +- check the mundane formatting. Are the headings (@predefined, @seealso, etc) in the right order? - add any appropriate index entries. - check the links in the @seealso section -- links to music @@ -36,7 +36,7 @@ subsection, - check the examples and descriptions. Do they still work? *Do not* assume that the existing text is accurate/complete; some of the manual is highly out of date. -- is the material in the @refbugs still accurate? +- is the material in the @knownissues still accurate? - process anything on the TODO list on the GDP web site. - can the examples be improved (made more explanatory), or is there any missing info? (feel free to ask specific questions @@ -55,7 +55,7 @@ TWEAKS In general, any \set or \override commands should go in the "select snippets" section, which means that they should go in LSR and not the .itely file. For some cases, the command obviously -belongs in the "main text" (ie not inside @refcommands or @seealso +belongs in the "main text" (ie not inside @predefined or @seealso or whatever) -- instrument names are a good example of this. \set Staff.instrumentName = #"foo" On the other side of this,