From: Graham Percival Date: Tue, 29 Apr 2008 05:33:46 +0000 (-0700) Subject: @lsrdir and @internalsref renaming. X-Git-Tag: release/2.11.46-1~33^2~1 X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=ea08249371adee926a82a1eb364fcceec65af939;p=lilypond.git @lsrdir and @internalsref renaming. --- diff --git a/Documentation/user/ancient.itely b/Documentation/user/ancient.itely index bda9e15e12..752a5ac860 100644 --- a/Documentation/user/ancient.itely +++ b/Documentation/user/ancient.itely @@ -126,7 +126,7 @@ up during the baroque period. For ancient notation, a note head style other than the @code{default} style may be chosen. This is accomplished by setting the @code{style} -property of the @internalsref{NoteHead} object to @code{baroque}, +property of the @rinternals{NoteHead} object to @code{baroque}, @code{neomensural}, @code{mensural} or @code{petrucci}. The @code{baroque} style differs from the @code{default} style only in using a square shape for @code{\breve} note heads. The @@ -148,11 +148,11 @@ a'\longa a'\breve a'1 a'2 a'4 a'8 a'16 @end lilypond When typesetting a piece in Gregorian Chant notation, the -@internalsref{Gregorian_ligature_engraver} will automatically select +@rinternals{Gregorian_ligature_engraver} will automatically select the proper note heads, so there is no need to explicitly set the note head style. Still, the note head style can be set, e.g., to @code{vaticana_punctum} to produce punctum neumes. Similarly, a -@internalsref{Mensural_ligature_engraver} is used to automatically +@rinternals{Mensural_ligature_engraver} is used to automatically assemble mensural ligatures. See @ref{Ligatures}, for how ligature engravers work. @@ -168,7 +168,7 @@ engravers work. Use the @code{glyph-name-alist} property of grob -@internalsref{Accidental} and @internalsref{KeySignature} to select +@rinternals{Accidental} and @rinternals{KeySignature} to select ancient accidentals. @lilypond[quote,ragged-right,staffsize=26] @@ -217,7 +217,7 @@ different style, as demonstrated in Similarly to local accidentals, the style of the key signature can be controlled by the @code{glyph-name-alist} property of the -@internalsref{KeySignature} grob. +@rinternals{KeySignature} grob. @seealso @@ -226,7 +226,7 @@ Notation Reference: @ref{Pitches}, @ref{Accidentals}, and accidentals. @ref{Key signature}, gives a general introduction of the use of key signatures. -Internals Reference: @internalsref{KeySignature}. +Internals Reference: @rinternals{KeySignature}. Examples: @c @lsrdir{ancient} @@ -236,7 +236,7 @@ Examples: @c @lsrdir{ancient} @cindex rests, ancient -Use the @code{style} property of grob @internalsref{Rest} to select +Use the @code{style} property of grob @rinternals{Rest} to select ancient rests. Supported styles are @code{classical}, @code{neomensural}, and @code{mensural}. @code{classical} differs from the @code{default} style only in that the quarter rest looks like @@ -511,7 +511,7 @@ The mensural g clef is mapped to the Petrucci g clef. @cindex flags -Use the @code{flag-style} property of grob @internalsref{Stem} to +Use the @code{flag-style} property of grob @rinternals{Stem} to select ancient flags. Besides the @code{default} flag style, only the @code{mensural} style is supported @@ -600,7 +600,7 @@ following table } @end lilypond -Use the @code{style} property of grob @internalsref{TimeSignature} to +Use the @code{style} property of grob @rinternals{TimeSignature} to select ancient time signatures. Supported styles are @code{neomensural} and @code{mensural}. The above table uses the @code{neomensural} style. This style is appropriate for the @@ -721,8 +721,8 @@ of musical notation such as contemporary editions of Gregorian chant like the @emph{editio vaticana}. There are different custos glyphs used in different flavors of notational style. -For typesetting custodes, just put a @internalsref{Custos_engraver} into the -@internalsref{Staff} context when declaring the @code{\layout} block, +For typesetting custodes, just put a @rinternals{Custos_engraver} into the +@rinternals{Staff} context when declaring the @code{\layout} block, as shown in the following example @example @@ -778,7 +778,7 @@ supported are @code{vaticana}, @code{medicaea}, @code{hufnagel}, and @seealso -Internals Reference: @internalsref{Custos}. +Internals Reference: @rinternals{Custos}. Examples: @c @lsr{ancient,custodes@/.ly}. @@ -830,7 +830,7 @@ Therefore, @file{gregorian@/-init@/.ly} also defines @code{\virgula} and Notation Reference: @ref{Breath marks}. -Internals Reference: @internalsref{BreathingSign}. +Internals Reference: @rinternals{BreathingSign}. Examples: @c @lsr{expressive,breathing-sign.ly}. @@ -850,7 +850,7 @@ chant notation to denote ascending or descending sequences of notes. Ligatures are entered by enclosing them in @code{\[} and @code{\]}. Some ligature styles may need additional input syntax specific for this particular type of ligature. By default, the -@internalsref{LigatureBracket} engraver just puts a square bracket +@rinternals{LigatureBracket} engraver just puts a square bracket above the ligature @lilypond[quote,ragged-right,verbatim] @@ -862,7 +862,7 @@ above the ligature @end lilypond To select a specific style of ligatures, a proper ligature engraver -has to be added to the @internalsref{Voice} context, as explained in +has to be added to the @rinternals{Voice} context, as explained in the following subsections. Only white mensural ligatures are supported with certain limitations. @@ -902,9 +902,9 @@ with the same effect and is believed to be stable. There is limited support for white mensural ligatures. To engrave white mensural ligatures, in the layout block put the -@internalsref{Mensural_ligature_engraver} into the -@internalsref{Voice} context, and remove the -@internalsref{Ligature_bracket_engraver}, like this +@rinternals{Mensural_ligature_engraver} into the +@rinternals{Voice} context, and remove the +@rinternals{Ligature_bracket_engraver}, like this @example \layout @{ @@ -960,8 +960,8 @@ For example, } @end lilypond -Without replacing @internalsref{Ligature_bracket_engraver} with -@internalsref{Mensural_ligature_engraver}, the same music transcribes +Without replacing @rinternals{Ligature_bracket_engraver} with +@rinternals{Mensural_ligature_engraver}, the same music transcribes to the following @lilypond[quote,ragged-right] @@ -2100,8 +2100,8 @@ ais ais bis @seealso -Internals Reference: @internalsref{Accidental_engraver} engraver and -the @internalsref{AccidentalSuggestion} object. +Internals Reference: @rinternals{Accidental_engraver} engraver and +the @rinternals{AccidentalSuggestion} object. @node Baroque rhythmic notation @@ -2121,4 +2121,4 @@ the @internalsref{AccidentalSuggestion} object. @c staff as an hint to performers. (Karl Hammer) -TBC \ No newline at end of file +TBC diff --git a/Documentation/user/changing-defaults.itely b/Documentation/user/changing-defaults.itely index 5a4b996aa3..32f14c606a 100644 --- a/Documentation/user/changing-defaults.itely +++ b/Documentation/user/changing-defaults.itely @@ -148,7 +148,7 @@ to define new contexts. A complete description of all available contexts is in the program reference, see @ifhtml -@internalsref{Contexts}. +@rinternals{Contexts}. @end ifhtml @ifnothtml Translation @expansion{} Context. @@ -334,7 +334,7 @@ c8 c c c @noindent the @var{context} argument to @code{\set} is left out, so automatic -beaming is switched off in the current @internalsref{Voice}. Note that +beaming is switched off in the current @rinternals{Voice}. Note that the bottom-most context does not always contain the property that you wish to change -- for example, attempting to set the @code{skipBars} property (of the bottom-most context, in this case @code{Voice}) will @@ -413,7 +413,7 @@ note. A full description of all available context properties is in the program reference, see @ifhtml -@internalsref{Tunable context properties}. +@rinternals{Tunable context properties}. @end ifhtml @ifnothtml Translation @expansion{} Tunable context properties. @@ -432,14 +432,14 @@ elements. For example, the @code{Voice} context contains a For a full a description of each plug-in, see @ifhtml -@internalsref{Engravers and Performers}. +@rinternals{Engravers and Performers}. @end ifhtml @ifnothtml Internals Reference @expansion{} Translation @expansion{} Engravers. @end ifnothtml Every context described in @ifhtml -@internalsref{Contexts} +@rinternals{Contexts} @end ifhtml @ifnothtml Internals Reference @expansion{} Translation @expansion{} Context. @@ -625,9 +625,9 @@ such as @seealso -Internals: @internalsref{OverrideProperty}, @internalsref{RevertProperty}, -@internalsref{PropertySet}, @internalsref{Backend}, and -@internalsref{All layout objects}. +Internals: @rinternals{OverrideProperty}, @rinternals{RevertProperty}, +@rinternals{PropertySet}, @rinternals{Backend}, and +@rinternals{All layout objects}. @knownissues @@ -786,8 +786,8 @@ but we only need this on the center line, squashedPosition = #0 @end example -The @internalsref{Pitch_squash_engraver} modifies note heads (created -by @internalsref{Note_heads_engraver}) and sets their vertical +The @rinternals{Pitch_squash_engraver} modifies note heads (created +by @rinternals{Note_heads_engraver}) and sets their vertical position to the value of @code{squashedPosition}, in this case@tie{}@code{0}, the center line. @@ -800,7 +800,7 @@ The notes look like a slash, and have no stem, All these plug-ins have to cooperate, and this is achieved with a special plug-in, which must be marked with the keyword @code{\type}. -This should always be @internalsref{Engraver_group}, +This should always be @rinternals{Engraver_group}, @example \type "Engraver_group" @@ -997,7 +997,7 @@ If you visit the documentation on fingering instructions (in @quotation @strong{See also} -Internals Reference: @internalsref{Fingering}. +Internals Reference: @rinternals{Fingering}. @end quotation @@ -1012,7 +1012,7 @@ expression for the input @code{-2}. The page contains many links forward. For example, it says @quotation -Accepted by: @internalsref{Fingering_engraver}, +Accepted by: @rinternals{Fingering_engraver}, @end quotation @noindent @@ -1020,7 +1020,7 @@ That link brings us to the documentation for the Engraver, the plug-in, which says @quotation -This engraver creates the following layout objects: @internalsref{Fingering}. +This engraver creates the following layout objects: @rinternals{Fingering}. @end quotation In other words, once the @code{FingerEvent}s are interpreted, the @@ -1031,7 +1031,7 @@ In other words, once the @code{FingerEvent}s are interpreted, the @c I can't figure out what this is supposed to mean. -gp The @code{Fingering_engraver} is also listed to create -@internalsref{Fingering} objects, +@rinternals{Fingering} objects, @c old info? it doesn't make any sense to me with our current docs. This is also the @@ -1047,12 +1047,12 @@ difficult to understand if you are using the PDF manual. @end ifnothtml -Follow the link to @internalsref{Fingering}. At the top of the +Follow the link to @rinternals{Fingering}. At the top of the page, you will see @quotation -Fingering objects are created by: @internalsref{Fingering_engraver} and -@internalsref{New_fingering_engraver}. +Fingering objects are created by: @rinternals{Fingering_engraver} and +@rinternals{New_fingering_engraver}. @end quotation By following related links inside the program reference, we can follow the @@ -1060,16 +1060,16 @@ flow of information within the program: @itemize -@item @internalsref{Fingering}: -@internalsref{Fingering} objects are created by: -@internalsref{Fingering_engraver} +@item @rinternals{Fingering}: +@rinternals{Fingering} objects are created by: +@rinternals{Fingering_engraver} -@item @internalsref{Fingering_engraver}: -Music types accepted: @internalsref{fingering-event} +@item @rinternals{Fingering_engraver}: +Music types accepted: @rinternals{fingering-event} -@item @internalsref{fingering-event}: +@item @rinternals{fingering-event}: Music event type @code{fingering-event} is in Music expressions named -@internalsref{FingerEvent} +@rinternals{FingerEvent} @end itemize This path goes against the flow of information in the program: it @@ -1080,12 +1080,12 @@ information, eventually ending up at the output object(s). The program reference can also be browsed like a normal document. It contains chapters on @ifhtml -@internalsref{Music definitions}, +@rinternals{Music definitions}, @end ifhtml @ifnothtml @code{Music definitions} @end ifnothtml -on @internalsref{Translation}, and the @internalsref{Backend}. Every +on @rinternals{Translation}, and the @rinternals{Backend}. Every chapter lists all the definitions used and all properties that may be tuned. @@ -1098,11 +1098,11 @@ tuned. @cindex grob The HTML page that we found in the previous section describes the -layout object called @internalsref{Fingering}. Such an object is a +layout object called @rinternals{Fingering}. Such an object is a symbol within the score. It has properties that store numbers (like thicknesses and directions), but also pointers to related objects. A layout object is also called a @emph{Grob}, which is short for Graphical -Object. For more details about Grobs, see @internalsref{grob-interface}. +Object. For more details about Grobs, see @rinternals{grob-interface}. The page for @code{Fingering} lists the definitions for the @code{Fingering} object. For example, the page says @@ -1145,15 +1145,15 @@ and subscript symbols. @end itemize Each of these aspects is captured in so-called @emph{interface}s, -which are listed on the @internalsref{Fingering} page at the bottom +which are listed on the @rinternals{Fingering} page at the bottom @quotation This object supports the following interfaces: -@internalsref{item-interface}, -@internalsref{self-alignment-interface}, -@internalsref{side-position-interface}, @internalsref{text-interface}, -@internalsref{text-script-interface}, @internalsref{font-interface}, -@internalsref{finger-interface}, and @internalsref{grob-interface}. +@rinternals{item-interface}, +@rinternals{self-alignment-interface}, +@rinternals{side-position-interface}, @rinternals{text-interface}, +@rinternals{text-script-interface}, @rinternals{font-interface}, +@rinternals{finger-interface}, and @rinternals{grob-interface}. @end quotation Clicking any of the links will take you to the page of the respective @@ -1253,10 +1253,10 @@ f In this case, the context for this tweak is @code{Voice}. This fact can also be deduced from the program reference, for the page for -the @internalsref{Fingering_engraver} plug-in says +the @rinternals{Fingering_engraver} plug-in says @quotation -Fingering_engraver is part of contexts: @dots{} @internalsref{Voice} +Fingering_engraver is part of contexts: @dots{} @rinternals{Voice} @end quotation @@ -1283,7 +1283,7 @@ without mentioning the grob name or context where this should be applied. This technique only works for objects that are directly connected to -an @internalsref{Event} from the input, for example +an @rinternals{Event} from the input, for example @itemize @item note heads, caused by chord-pitch (i.e., notes inside a chord) @@ -1443,7 +1443,7 @@ checks if we are the last of the split objects if yes, it sets @code{extra-offset}. @end itemize -This procedure is installed into @internalsref{Tie}, so the last part +This procedure is installed into @rinternals{Tie}, so the last part of the broken tie is translated up. @lilypond[quote,verbatim,ragged-right] @@ -1658,10 +1658,10 @@ hairpins with \!. @seealso -Internals Reference: @internalsref{TextSpanner}, -@internalsref{Glissando}, @internalsref{VoiceFollower}, -@internalsref{TrillSpanner}, -@internalsref{line-spanner-interface}. +Internals Reference: @rinternals{TextSpanner}, +@rinternals{Glissando}, @rinternals{VoiceFollower}, +@rinternals{TrillSpanner}, +@rinternals{line-spanner-interface}. diff --git a/Documentation/user/chords.itely b/Documentation/user/chords.itely index c1f956dae6..6dcff43c23 100644 --- a/Documentation/user/chords.itely +++ b/Documentation/user/chords.itely @@ -295,7 +295,7 @@ sheet, @cindex chord names @cindex chords -For displaying printed chord names, use the @internalsref{ChordNames} context. +For displaying printed chord names, use the @rinternals{ChordNames} context. The chords may be entered either using the notation described above, or directly using @code{<} and @code{>} @@ -310,7 +310,7 @@ harmonies = { @end lilypond You can make the chord changes stand out by setting -@internalsref{ChordNames}.@code{chordChanges} to true. This will only +@rinternals{ChordNames}.@code{chordChanges} to true. This will only display chord names when there is a change in the chords scheme and at the start of a new line @@ -328,7 +328,7 @@ harmonies = \chordmode { The previous examples all show chords over a staff. This is not necessary. Chords may also be printed separately. It may be necessary -to add @internalsref{Volta_engraver} and @internalsref{Bar_engraver} +to add @rinternals{Volta_engraver} and @rinternals{Bar_engraver} for showing repeats. @lilypond[ragged-right,verbatim] @@ -505,7 +505,7 @@ LilyPond has support for figured bass Although the support for figured bass may superficially resemble chord support, it is much simpler. The @code{\figuremode} mode simply -stores the numbers and @internalsref{FiguredBass} context prints them +stores the numbers and @rinternals{FiguredBass} context prints them as entered. There is no conversion to pitches and no realizations of the bass are played in the MIDI file. @@ -519,8 +519,8 @@ vertical spacing of the figures may be set with @code{baseline-skip}. The support for figured bass consists of two parts: there is an input mode, introduced by @code{\figuremode}, where you can enter bass figures -as numbers, and there is a context called @internalsref{FiguredBass} that -takes care of making @internalsref{BassFigure} objects. +as numbers, and there is a context called @rinternals{FiguredBass} that +takes care of making @rinternals{BassFigure} objects. In figures input mode, a group of bass figures is delimited by @code{<} and @code{>}. The duration is entered after the @code{>} @@ -674,9 +674,9 @@ use @code{stacking-dir} on @code{BassFigureAlignment}. @seealso -Internals Reference: @internalsref{NewBassFigure}, -@internalsref{BassFigureAlignment}, @internalsref{BassFigureLine}, -@internalsref{BassFigureBracket}, and -@internalsref{BassFigureContinuation} objects and -@internalsref{FiguredBass} context. +Internals Reference: @rinternals{NewBassFigure}, +@rinternals{BassFigureAlignment}, @rinternals{BassFigureLine}, +@rinternals{BassFigureBracket}, and +@rinternals{BassFigureContinuation} objects and +@rinternals{FiguredBass} context. diff --git a/Documentation/user/converters.itely b/Documentation/user/converters.itely index 17bc45a9a7..adf3d3107d 100644 --- a/Documentation/user/converters.itely +++ b/Documentation/user/converters.itely @@ -52,8 +52,8 @@ exporting music from other programs, so this capability may come in useful when importing files from a program that has a converter for a direct format. -@command{midi2ly} converts tracks into @internalsref{Staff} and -channels into @internalsref{Voice} contexts. Relative mode is used +@command{midi2ly} converts tracks into @rinternals{Staff} and +channels into @rinternals{Voice} contexts. Relative mode is used for pitches, durations are only written when necessary. It is possible to record a MIDI file using a digital keyboard, and diff --git a/Documentation/user/fretted-strings.itely b/Documentation/user/fretted-strings.itely index 0543cad7bc..9f4945eb66 100644 --- a/Documentation/user/fretted-strings.itely +++ b/Documentation/user/fretted-strings.itely @@ -53,7 +53,7 @@ with @code{\}@var{number}, @seealso -Internals Reference: @internalsref{StringNumber}, +Internals Reference: @rinternals{StringNumber}, @c @lsr{guitar/,string-number.ly}. @@ -71,8 +71,8 @@ The string number associated to a note is given as a backslash followed by a number, e.g., @code{c4\3} for a C quarter on the third string. By default, string 1 is the highest one, and the tuning defaults to the standard guitar tuning (with 6 strings). The notes -are printed as tablature, by using @internalsref{TabStaff} and -@internalsref{TabVoice} contexts +are printed as tablature, by using @rinternals{TabStaff} and +@rinternals{TabVoice} contexts @lilypond[quote,ragged-right,fragment,verbatim] \new TabStaff { @@ -120,7 +120,7 @@ initialize the @code{TabStaff} with this code: @seealso -Internals Reference: @internalsref{TabNoteHead}, @internalsref{TabStaff}, @internalsref{TabVoice}. +Internals Reference: @rinternals{TabNoteHead}, @rinternals{TabStaff}, @rinternals{TabVoice}. @knownissues @@ -185,7 +185,7 @@ Some other predefined tunings are @code{guitar-open-g-tuning}, The file @file{scm/@/output@/-lib@/.scm} contains the predefined string tunings. -Internals Reference: @internalsref{Tab_note_heads_engraver}. +Internals Reference: @rinternals{Tab_note_heads_engraver}. @knownissues @@ -234,7 +234,7 @@ markup interfaces are found at @ref{Text markup commands}. You can set a number of graphical properties according to your preference. Details about the property interface to fret diagrams are found at -@internalsref{fret-diagram-interface}. +@rinternals{fret-diagram-interface}. @seealso @@ -294,7 +294,7 @@ The letters used for the fingerings are contained in the property @seealso -Internals Reference: @internalsref{StrokeFinger} +Internals Reference: @rinternals{StrokeFinger} @node Guitar diff --git a/Documentation/user/introduction.itely b/Documentation/user/introduction.itely index 5c4d3e8897..b6a3320400 100644 --- a/Documentation/user/introduction.itely +++ b/Documentation/user/introduction.itely @@ -541,7 +541,7 @@ context. The Score context is the top level notation context. @seealso -Internals Reference: @internalsref{Contexts}. +Internals Reference: @rinternals{Contexts}. @lilypond[quote,ragged-right] \include "engraver-example.ily" diff --git a/Documentation/user/non-music.itely b/Documentation/user/non-music.itely index 635c070af5..68885e2d93 100644 --- a/Documentation/user/non-music.itely +++ b/Documentation/user/non-music.itely @@ -541,7 +541,7 @@ crescendi and decrescendi translate into MIDI volume levels. Dynamic marks translate to a fixed fraction of the available MIDI volume range, crescendi and decrescendi make the volume vary linearly between their two extremes. The fractions can be adjusted by -@code{dynamicAbsoluteVolumeFunction} in @internalsref{Voice} context. +@code{dynamicAbsoluteVolumeFunction} in @rinternals{Voice} context. For each type of MIDI instrument, a volume range can be defined. This gives a basic equalizer control, which can enhance the quality of the MIDI output remarkably. The equalizer can be controlled by diff --git a/Documentation/user/percussion.itely b/Documentation/user/percussion.itely index f358e4f613..dc5b946a23 100644 --- a/Documentation/user/percussion.itely +++ b/Documentation/user/percussion.itely @@ -37,7 +37,7 @@ TBC @seealso -Internals Reference: @internalsref{RhythmicStaff}. +Internals Reference: @rinternals{RhythmicStaff}. @node Basic percussion notation @@ -101,7 +101,7 @@ overridden to achieve a pleasing baseline. @seealso -Internals Reference: @internalsref{note-event}. +Internals Reference: @rinternals{note-event}. @node Percussion staves @subsubsection Percussion staves @@ -114,7 +114,7 @@ of percussion. To typeset the music, the notes must be interpreted in a -@internalsref{DrumStaff} and @internalsref{DrumVoice} contexts +@rinternals{DrumStaff} and @rinternals{DrumVoice} contexts @lilypond[quote,ragged-right,verbatim] up = \drummode { crashcymbal4 hihat8 halfopenhihat hh hh hh openhihat } @@ -127,7 +127,7 @@ down = \drummode { bassdrum4 snare8 bd r bd sn4 } The above example shows verbose polyphonic notation. The short polyphonic notation, described in @rlearning{I'm hearing Voices}, -can also be used if the @internalsref{DrumVoice}s are instantiated +can also be used if the @rinternals{DrumVoice}s are instantiated by hand first. For example, @lilypond[quote,ragged-right,fragment,verbatim] @@ -147,7 +147,7 @@ by hand first. For example, There are also other layout possibilities. To use these, set the -property @code{drumStyleTable} in context @internalsref{DrumVoice}. +property @code{drumStyleTable} in context @rinternals{DrumVoice}. The following variables have been predefined @table @code @@ -312,7 +312,7 @@ down = \drummode { bd4 sn bd toml8 toml } Init files: @file{ly/@/drumpitch@/-init@/.ly}. -Internals Reference: @internalsref{DrumStaff}, @internalsref{DrumVoice}. +Internals Reference: @rinternals{DrumStaff}, @rinternals{DrumVoice}. @knownissues diff --git a/Documentation/user/programming-interface.itely b/Documentation/user/programming-interface.itely index 142181f692..549190172a 100644 --- a/Documentation/user/programming-interface.itely +++ b/Documentation/user/programming-interface.itely @@ -409,10 +409,10 @@ A music object has three kinds of types: @itemize @item music name: Each music expression has a name. For example, a note -leads to a @internalsref{NoteEvent}, and @code{\simultaneous} leads to -a @internalsref{SimultaneousMusic}. A list of all expressions +leads to a @rinternals{NoteEvent}, and @code{\simultaneous} leads to +a @rinternals{SimultaneousMusic}. A list of all expressions available is in the Internals Reference manual, under -@internalsref{Music expressions}. +@rinternals{Music expressions}. @item @q{type} or interface: Each music name has several @q{types} or @@ -420,7 +420,7 @@ interfaces, for example, a note is an @code{event}, but it is also a @code{note-event}, a @code{rhythmic-event}, and a @code{melodic-event}. All classes of music are listed in the Internals Reference, under -@internalsref{Music classes}. +@rinternals{Music classes}. @item C++ object: Each music object is represented by an object of the C++ @@ -428,19 +428,19 @@ class @code{Music}. @end itemize The actual information of a music expression is stored in properties. -For example, a @internalsref{NoteEvent} has @code{pitch} and +For example, a @rinternals{NoteEvent} has @code{pitch} and @code{duration} properties that store the pitch and duration of that note. A list of all properties available is in the internals manual, -under @internalsref{Music properties}. +under @rinternals{Music properties}. A compound music expression is a music object that contains other music objects in its properties. A list of objects can be stored in the @code{elements} property of a music object, or a single @q{child} music object in the @code{element} object. For example, -@internalsref{SequentialMusic} has its children in @code{elements}, -and @internalsref{GraceMusic} has its single argument in +@rinternals{SequentialMusic} has its children in @code{elements}, +and @rinternals{GraceMusic} has its single argument in @code{element}. The body of a repeat is stored in the @code{element} -property of @internalsref{RepeatedMusic}, and the alternatives in +property of @rinternals{RepeatedMusic}, and the alternatives in @code{elements}. @@ -1277,8 +1277,8 @@ arguments: In addition, the cause of the layout object, i.e., the music expression or object that was responsible for creating it, is in the object property @code{cause}. For example, for a note head, this is a -@internalsref{NoteHead} event, and for a @internalsref{Stem} object, -this is a @internalsref{NoteHead} object. +@rinternals{NoteHead} event, and for a @rinternals{Stem} object, +this is a @rinternals{NoteHead} object. Here is a function to use for @code{\applyOutput}; it blanks note-heads on the center-line: diff --git a/Documentation/user/spacing.itely b/Documentation/user/spacing.itely index 3f86bec85c..439ce43d4f 100644 --- a/Documentation/user/spacing.itely +++ b/Documentation/user/spacing.itely @@ -481,7 +481,7 @@ The recommended font sizes are listed in the following table: These fonts are available in any sizes. The context property @code{fontSize} and the layout property @code{staff-space} (in -@internalsref{StaffSymbol}) can be used to tune the size for individual +@rinternals{StaffSymbol}) can be used to tune the size for individual staves. The sizes of individual staves are relative to the global size. @example @@ -615,13 +615,13 @@ This makes the following 28 measures (assuming 4/4 time) be broken every @seealso -Internals: @internalsref{LineBreakEvent}. +Internals: @rinternals{LineBreakEvent}. A linebreaking configuration can be saved as a @code{.ly} file automatically. This allows vertical alignments to be stretched to fit pages in a second formatting run. This is fairly new and complicated. More details are available in -@c @lsrdir{spacing} +@rlsr{Spacing}. @knownissues @@ -955,7 +955,7 @@ in having more systems per page. Normally staves are stacked vertically. To make staves maintain a distance, their vertical size is padded. This is done with the property @code{minimum-Y-extent}. When applied to a -@internalsref{VerticalAxisGroup}, it controls the size of a horizontal +@rinternals{VerticalAxisGroup}, it controls the size of a horizontal line, such as a staff or a line of lyrics. @code{minimum-Y-extent} takes a pair of numbers, so if you want to make it smaller than its default @code{#'(-4 . 4)} @@ -977,7 +977,7 @@ After page breaks are determined, the vertical spacing within each system is reevaluated in order to fill the page more evenly; if a page has space left over, systems are stretched in order to fill that space. The amount of stretching can be configured though the @code{max-stretch} -property of the @internalsref{VerticalAlignment} grob. By default, +property of the @rinternals{VerticalAlignment} grob. By default, @code{max-stretch} is set to zero, disabling stretching. To enable stretching, a sane value for @code{max-stretch} is @code{ly:align-interface::calc-max-stretch}. @@ -987,7 +987,7 @@ leaving some parts fixed. For example, if a piano part occurs in the middle of an orchestral score, you may want to leave the piano staves close to each other while stretching the rest of the score. The @code{keep-fixed-while-stretching} property of -@internalsref{VerticalAxisGroup} can be used to achieve this. When set +@rinternals{VerticalAxisGroup} can be used to achieve this. When set to @code{##t}, this property keeps its staff (or line of lyrics) from moving relative to the one directly above it. In the example above, you would override @code{keep-fixed-while-stretching} to @code{##t} in @@ -1038,9 +1038,9 @@ the second piano staff: @seealso Internals: Vertical alignment of staves is handled by the -@internalsref{VerticalAlignment} object. The context parameters +@rinternals{VerticalAlignment} object. The context parameters specifying the vertical extent are described in connection with -the @internalsref{Axis_group_engraver}. +the @rinternals{Axis_group_engraver}. Example files: @c @lsr{spacing,page-spacing.ly}, @c @lsr{spacing,alignment-vertical-spacing.ly}. @@ -1461,7 +1461,7 @@ The spacing engine translates differences in durations into stretchable distances (@q{springs}) of differing lengths. Longer durations get more space, shorter durations get less. The shortest durations get a fixed amount of space (which is controlled by -@code{shortest-duration-space} in the @internalsref{SpacingSpanner} +@code{shortest-duration-space} in the @rinternals{SpacingSpanner} object). The longer the duration, the more space it gets: doubling a duration adds a fixed amount (this amount is controlled by @code{spacing-increment}) of space to the note. @@ -1499,7 +1499,7 @@ an 8th note. The shortest duration is printed when you run @code{lilypond} with the @code{--verbose} option. These durations may also be customized. If you set the -@code{common-shortest-duration} in @internalsref{SpacingSpanner}, then +@code{common-shortest-duration} in @rinternals{SpacingSpanner}, then this sets the base duration for spacing. The maximum duration for this base (normally an 8th), is set through @code{base-shortest-duration}. @@ -1521,9 +1521,9 @@ c2 c4. c8 c4. c16[ c] c4. c8 c8 c8 c4 c4 c4 In the introduction (see @rlearning{Engraving}), it was explained that stem directions influence spacing. This is controlled with the @code{stem-spacing-correction} property in the -@internalsref{NoteSpacing}, object. These are generated for every -@internalsref{Voice} context. The @code{StaffSpacing} object -(generated in @internalsref{Staff} context) contains the same property +@rinternals{NoteSpacing}, object. These are generated for every +@rinternals{Voice} context. The @code{StaffSpacing} object +(generated in @rinternals{Staff} context) contains the same property for controlling the stem/bar line spacing. The following example shows these corrections, once with default settings, and once with exaggerated corrections: @@ -1544,9 +1544,9 @@ Proportional notation is supported; see @ref{Proportional notation}. @seealso -Internals: @internalsref{SpacingSpanner}, @internalsref{NoteSpacing}, -@internalsref{StaffSpacing}, @internalsref{SeparationItem}, and -@internalsref{SeparatingGroupSpanner}. +Internals: @rinternals{SpacingSpanner}, @rinternals{NoteSpacing}, +@rinternals{StaffSpacing}, @rinternals{SeparationItem}, and +@rinternals{SeparatingGroupSpanner}. @knownissues @@ -1581,7 +1581,7 @@ c16[ c c8] The @code{\newSpacingSection} command creates a new -@internalsref{SpacingSpanner} object, and hence new @code{\override}s +@rinternals{SpacingSpanner} object, and hence new @code{\override}s may be used in that location. diff --git a/Documentation/user/text.itely b/Documentation/user/text.itely index 540a26c1d6..3c2c2a4d20 100644 --- a/Documentation/user/text.itely +++ b/Documentation/user/text.itely @@ -98,9 +98,9 @@ Notation Reference: @ref{Formatting text}, @ref{Controlling direction and placement}. Snippets: -@lsrdir{Text,Text}. +@rlsr{Text}. -Internals Reference: @internalsref{TextScript}. +Internals Reference: @rinternals{TextScript}. @knownissues @@ -161,9 +161,9 @@ object property. This syntax is described in @ref{Line styles}. Notation Reference: @ref{Line styles}. Snippets: -@lsrdir{Text,Text}. +@rlsr{Text}. -Internals Reference: @internalsref{TextSpanner}. +Internals Reference: @rinternals{TextSpanner}. @node Text marks @@ -224,9 +224,9 @@ Notation Reference: @ref{Rehearsal marks}, @ref{Formatting text}, @ref{The Feta font}. Snippets: -@lsrdir{Text,Text}. +@rlsr{Text}. -Internals Reference: @internalsref{RehearsalMark}. +Internals Reference: @rinternals{RehearsalMark}. @knownissues @c IMO this is a bug; hopefully it'll be fixed soon, so I can @@ -302,9 +302,9 @@ Notation Reference: @ref{Formatting text}, @ref{Multi-page markup}. Snippets: -@lsrdir{Text,Text}. +@rlsr{Text}. -Internals Reference: @internalsref{TextScript}. +Internals Reference: @rinternals{TextScript}. @node Formatting text @@ -436,7 +436,7 @@ allegro = \markup @{ \bold \large @{ Allegro @} @} Some objects have alignment procedures of their own, which cancel out any effects of alignments applied to their markup arguments as -a whole. For example, the @internalsref{RehearsalMark} is +a whole. For example, the @rinternals{RehearsalMark} is horizontally centered, so using @code{\mark \markup @{ \left-align .. @}} has no effect. @@ -500,9 +500,9 @@ I'm putting them in bulk, prior to working on this section. -vv This manual: @ref{Text markup commands}. Snippets: -@lsrdir{Text,Text}. +@rlsr{Text}. -Internals Reference: @internalsref{TextScript}. +Internals Reference: @rinternals{TextScript}. Init files: @file{scm/@/new@/-markup@/.scm}. @@ -711,7 +711,7 @@ block. In such a case, the @code{\score} must contain a @code{\layout} block. @seealso Snippets: -@lsrdir{Text,Text}. +@rlsr{Text}. @node Multi-page markup @subsubsection Multi-page markup @@ -745,7 +745,7 @@ This manual: @ref{Text markup list commands}, @ref{New markup list command definition}. Snippets: -@lsrdir{Text,Text}. +@rlsr{Text}. @predefined @@ -880,6 +880,6 @@ property. The resulting size is taken relative to the @seealso Snippets: -@lsrdir{Text,Text}. +@rlsr{Text}. diff --git a/Documentation/user/vocal.itely b/Documentation/user/vocal.itely index a48e09ffaf..dfaf92d750 100644 --- a/Documentation/user/vocal.itely +++ b/Documentation/user/vocal.itely @@ -278,7 +278,7 @@ verseOne = \lyricmode @{ Joy to the world the Lord is come @} @seealso -Internals Reference: @internalsref{LyricText}, @internalsref{LyricSpace}. +Internals Reference: @rinternals{LyricText}, @rinternals{LyricSpace}. @node Working with lyrics and variables @subsubsection Working with lyrics and variables @@ -337,8 +337,8 @@ The final input would resemble @seealso @c TODO: document \new Staff << Voice \lyricsto >> bug -Internals Reference: @internalsref{LyricCombineMusic}, -@internalsref{Lyrics}. +Internals Reference: @rinternals{LyricCombineMusic}, +@rinternals{Lyrics}. @node Aligning lyrics to a melody @@ -350,7 +350,7 @@ Internals Reference: @internalsref{LyricCombineMusic}, Lyrics are printed by interpreting them in the context called -@internalsref{Lyrics}. +@rinternals{Lyrics}. @example \new Lyrics \lyricmode @dots{} @@ -395,7 +395,7 @@ melody and the lyrics with the @code{\lyricsto} expression @end example This aligns the lyrics to the -notes of the @internalsref{Voice} context called @var{name}, which must +notes of the @rinternals{Voice} context called @var{name}, which must already exist. Therefore normally the @code{Voice} is specified first, and then the lyrics are specified with @code{\lyricsto}. The command @code{\lyricsto} switches to @code{\lyricmode} mode automatically, so the @@ -458,7 +458,7 @@ The alignment to a melody can be specified with the @noindent The value of the property (here: @code{"lala"}) should be the name of -a @internalsref{Voice} context. Without this setting, extender lines +a @rinternals{Voice} context. Without this setting, extender lines will not be formatted properly. Here is an example demonstrating manual lyric durations, @@ -476,7 +476,7 @@ Here is an example demonstrating manual lyric durations, @seealso -Internals Reference: @internalsref{Lyrics}. +Internals Reference: @rinternals{Lyrics}. @node Multiple syllables to one note @@ -504,7 +504,7 @@ glyph.}. @seealso -Internals Reference: @internalsref{LyricCombineMusic}. +Internals Reference: @rinternals{LyricCombineMusic}. @c Here come the section which used to be "Melismata" @c the new title might be more self-explanatory @@ -582,7 +582,7 @@ A complete example of a SATB score setup is in section @seealso -Internals Reference: @internalsref{Melisma_translator}. +Internals Reference: @rinternals{Melisma_translator}. @c @lsr{vocal,lyric@/-combine.ly}. @@ -636,8 +636,8 @@ distance between two syllables) and the @code{minimum-length} @seealso -Internals Reference: @internalsref{LyricExtender}, -@internalsref{LyricHyphen} +Internals Reference: @rinternals{LyricExtender}, +@rinternals{LyricHyphen} @node Lyrics and repeats @subsubsection Lyrics and repeats @@ -1156,8 +1156,8 @@ text = \lyricmode { @seealso -Internals Reference: @internalsref{LyricText}, @internalsref{StanzaNumber}, -@internalsref{VocalName}. +Internals Reference: @rinternals{LyricText}, @rinternals{StanzaNumber}, +@rinternals{VocalName}.