<br>(writing music in LilyPond)
<li>
- <a class="title" href="user/lilypond-internals/index.html">Program reference</a>
+ <a class="title"
+href="user/lilypond-internals/index.html">Internals reference</a>
(in <a class="title" href="user/lilypond-internals-big-page.html">one big page</a> ~ 1 Mb)
<br>(definitions for tweaking)
<ul>
<li>
- <a class="title" href="user/lilypond-program/index.html">Program usage</a>
+ <a class="title"
+href="user/lilypond-program/index.html">Application usage</a>
(in <a class="title" href="user/lilypond-program-big-page.html">one big page</a>,
in <a class="title" href="user/lilypond-program.pdf">PDF</a>)
<br>(how to install and run the program)
accidentals. @ref{Key signature}, gives a general introduction of
the use of key signatures.
-Program reference: @internalsref{KeySignature}.
+Internals Reference: @internalsref{KeySignature}.
Examples: @lsrdir{ancient}
@seealso
-Program reference: @internalsref{Custos}.
+Internals Reference: @internalsref{Custos}.
Examples:
@lsr{ancient,custodes@/.ly}.
In this manual: @ref{Breath marks}.
-Program reference: @internalsref{BreathingSign}.
+Internals Reference: @internalsref{BreathingSign}.
Examples: @lsr{expressive,breathing-sign.ly}.
@seealso
-Program reference: @internalsref{Accidental_engraver} engraver and
+Internals Reference: @internalsref{Accidental_engraver} engraver and
the @internalsref{AccidentalSuggestion} object.
@node Figured bass
@seealso
-Program reference: @internalsref{NewBassFigure},
+Internals Reference: @internalsref{NewBassFigure},
@internalsref{BassFigureAlignment}, @internalsref{BassFigureLine},
@internalsref{BassFigureBracket}, and
@internalsref{BassFigureContinuation} objects and
particular effect.
-@cindex Program reference
+@cindex Internals Reference
The controls available for tuning are described in a separate
document, the
@iftex
-Program reference manual.
+Internals Reference manual.
@end iftex
@ifnottex
-@ref{Top,Program reference,,lilypond-internals}.
+@ref{Top,Internals Reference,,lilypond-internals}.
@end ifnottex
That manual
lists all different variables, functions and options available in
@internalsref{Engravers}.
@end ifhtml
@ifnothtml
-Program reference @expansion{} Translation @expansion{} Engravers.
+Internals Reference @expansion{} Translation @expansion{} Engravers.
@end ifnothtml
Every context described in
@ifhtml
@internalsref{Contexts}
@end ifhtml
@ifnothtml
-Program reference @expansion{} Translation @expansion{} Context.
+Internals Reference @expansion{} Translation @expansion{} Context.
@end ifnothtml
lists the engravers used for that context.
@quotation
@seealso
-Program reference: @internalsref{Fingering}.
+Internals Reference: @internalsref{Fingering}.
@end quotation
@noindent
As you can see, the @code{Fingering} object is nothing more than a
-bunch of variable settings, and the webpage in the Program Reference
+bunch of variable settings, and the webpage in the Internals Reference
is directly generated from this definition.
@seealso
-Program reference: @internalsref{NoteHead}.
+Internals Reference: @internalsref{NoteHead}.
@seealso
-Program reference: @internalsref{Fingering}.
+Internals Reference: @internalsref{Fingering}.
Examples: @lsr{expressive,fingering-chords.ly}
@seealso
-Program reference: @internalsref{Ambitus},
+Internals Reference: @internalsref{Ambitus},
@internalsref{AmbitusLine}, @internalsref{AmbitusNoteHead},
@internalsref{AmbitusAccidental}.
@seealso
-Program reference: @internalsref{text-balloon-interface}.
+Internals Reference: @internalsref{text-balloon-interface}.
@node Grid lines
@seealso
-Program reference: @internalsref{Script}.
+Internals Reference: @internalsref{Script}.
@refbugs
@seealso
-Program reference: @internalsref{DynamicText},
+Internals Reference: @internalsref{DynamicText},
@internalsref{Hairpin}. Vertical positioning of these symbols is
handled by @internalsref{DynamicLineSpanner}.
Glossary: @rglos{Hairpin}, @rglos{crescendo}, @rglos{decrescendo}
@seealso
-Program reference: @internalsref{Slur}.
+Internals Reference: @internalsref{Slur}.
@node Phrasing slurs
@seealso
-Program reference: @internalsref{PhrasingSlur}.
+Internals Reference: @internalsref{PhrasingSlur}.
@node Breath marks
@seealso
-Program reference: @internalsref{BreathingSign}.
+Internals Reference: @internalsref{BreathingSign}.
Examples: @lsr{expressive,breathing-sign.ly}
@seealso
-Program reference: @internalsref{Glissando}.
+Internals Reference: @internalsref{Glissando}.
Glossary: @rglos{falls}, @rglos{doits}
Example files:
Notation manual: @ref{Ties}, for writing out arpeggios.
-Program reference: @internalsref{Arpeggio}.
+Internals Reference: @internalsref{Arpeggio}.
@refbugs
@seealso
-Program reference: @internalsref{TrillSpanner}.
+Internals Reference: @internalsref{TrillSpanner}.
@node Analysis brackets
@seealso
-Program reference: @internalsref{HorizontalBracket}.
+Internals Reference: @internalsref{HorizontalBracket}.
@seealso
-Program reference: @internalsref{StringNumber},
+Internals Reference: @internalsref{StringNumber},
@lsr{guitar/,string-number.ly}.
@seealso
-Program reference: @internalsref{TabStaff}, @internalsref{TabVoice}.
+Internals Reference: @internalsref{TabStaff}, @internalsref{TabVoice}.
@refbugs
The file @file{scm/@/output@/-lib@/.scm} contains the predefined string
tunings.
-Program reference: @internalsref{Tab_note_heads_engraver}.
+Internals Reference: @internalsref{Tab_note_heads_engraver}.
@refbugs
@seealso
-Program reference: @internalsref{StrokeFinger}
+Internals Reference: @internalsref{StrokeFinger}
@seealso
-Program reference: @internalsref{Contexts}.
+Internals Reference: @internalsref{Contexts}.
@lilypond[quote,ragged-right]
\include "engraver-example.ily"
FIXME: needs almost-complete rewrite. -gp
There are four manuals about LilyPond: the @emph{Learning Manual},
-the @emph{Notation Reference}, the @emph{Program Usage}, and the
-@emph{Program Reference}.
+the @emph{Notation Reference}, the @emph{Application Usage}, and the
+@emph{Internals Reference}.
@subheading Learning Manual (LM)
@item
The
@iftex
-Program reference
+Internals Reference
@end iftex
@ifnottex
-@ref{Top,Program reference,,lilypond-internals}
+@ref{Top,Internals Reference,,lilypond-internals}
@end ifnottex
is a set of heavily cross linked HTML pages, which document the
nitty-gritty details of each and every LilyPond class, object, and
@seealso
-Program reference: @ruser{Manual beams}
+Internals Reference: @ruser{Manual beams}
@node fermata
@seealso
-Program reference: @internalsref{RhythmicStaff}.
+Internals Reference: @internalsref{RhythmicStaff}.
@node Entering percussion
@seealso
-Program reference: @internalsref{note-event}.
+Internals Reference: @internalsref{note-event}.
@node Percussion staves
@unnumberedsubsubsec Percussion staves
Init files: @file{ly/@/drumpitch@/-init@/.ly}.
-Program reference: @internalsref{DrumStaff}, @internalsref{DrumVoice}.
+Internals Reference: @internalsref{DrumStaff}, @internalsref{DrumVoice}.
@refbugs
In this manual: @ref{Manual staff switches}.
-Program reference: @internalsref{AutoChangeMusic}.
+Internals Reference: @internalsref{AutoChangeMusic}.
For fine-tuning the appearance of a pedal bracket, the properties
@code{edge-width}, @code{edge-height}, and @code{shorten-pair} of
@code{PianoPedalBracket} objects (see
-@internalsref{PianoPedalBracket} in the Program reference) can be
+@internalsref{PianoPedalBracket} in the Internals Reference) can be
modified. For example, the bracket may be extended to the right edge
of the note head
@seealso
-Program reference: @internalsref{VoiceFollower}.
+Internals Reference: @internalsref{VoiceFollower}.
@refcommands
Snippets: @lsrdir{pitch}
-Program reference: @internalsref{LedgerLineSpanner},
+Internals Reference: @internalsref{LedgerLineSpanner},
@internalsref{NoteHead}.
Snippets: @lsrdir{pitch}, @lsr{scheme,
transpose-pitches-with-minimum-accidentals.ly}.
-Program reference: @internalsref{TransposedMusic}.
+Internals Reference: @internalsref{TransposedMusic}.
@refbugs
Snippets: @lsrdir{pitch}
-Program reference: @internalsref{Clef}.
+Internals Reference: @internalsref{Clef}.
@node Key signature
FIXME link to snippet 248,
FIXME link to a snippet about scordatura.
-Program reference: @internalsref{KeyCancellation},
+Internals Reference: @internalsref{KeyCancellation},
@internalsref{KeySignature}, @internalsref{Key_engraver}
Snippets: @lsrdir{pitch}
-Program reference: @internalsref{OttavaBracket}.
+Internals Reference: @internalsref{OttavaBracket}.
@refbugs
@seealso
-Program reference: @internalsref{Accidental_engraver},
+Internals Reference: @internalsref{Accidental_engraver},
@internalsref{Accidental}, @internalsref{AccidentalSuggestion} and @internalsref{AccidentalPlacement}.
in the Music Glossary.
-* Program Usage: information about using the program lilypond with
- other programs (lilypond-book, operating systems, GUIs,
+* Application Usage: information about using the program lilypond
+ with other programs (lilypond-book, operating systems, GUIs,
convert-ly, etc). This section is written in formal technical
writing style.
Users are not expected to read this manual from start to finish.
+* Internals Reference: not really a documentation book, since it
+ is automagically generated from the source, but this is its
+ name.
+
%%%%% SECTION ORGANIZATION
Notation Reference: @ruser{faazle}, @ruser{boo}.
- Snippets: @lsrdir{section}, @lsr{specific/example-name.ly}
-
- Program reference: @internalsref{fazzle}, @internalsref{booar}.
+ Application Usage: @rprogram{blah}.
Installed files: @file{blahz}.
+ Snippets: @lsrdir{section}, @lsr{specific/example-name.ly}
+
+ Internals Reference: @internalsref{fazzle}, @internalsref{booar}.
+
("Snippets" is REQUIRED; the others are optional)
* To create links, use @ref{} if the link is within the same
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
-available is in the Program reference manual, under
+available is in the Internals Reference manual, under
@internalsref{Music expressions}.
@item
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
-Program reference, under
+Internals Reference, under
@internalsref{Music classes}.
@item
@seealso
-Program reference: @internalsref{VoltaBracket},
+Internals Reference: @internalsref{VoltaBracket},
@internalsref{RepeatedMusic},
@internalsref{VoltaRepeatedMusic}, and
@internalsref{UnfoldedRepeatedMusic}.
@seealso
-Program reference: @internalsref{VoltaBracket},
+Internals Reference: @internalsref{VoltaBracket},
@internalsref{RepeatedMusic}, @internalsref{VoltaRepeatedMusic},
and @internalsref{UnfoldedRepeatedMusic}.
In this manual: @ref{Tremolo subdivisions}, @ref{Repeats}.
-Program reference: @internalsref{Beam},
+Internals Reference: @internalsref{Beam},
@internalsref{StemTremolo}.
@seealso
-Program reference: @internalsref{RepeatSlash},
+Internals Reference: @internalsref{RepeatSlash},
@internalsref{PercentRepeat}, @internalsref{DoublePercentRepeat},
@internalsref{DoublePercentRepeatCounter},
@internalsref{PercentRepeatCounter},
For details of this and other settings which control
proportional notation see @ref{Proportional notation}.
-Program reference: @internalsref{Dots}, and
+Internals Reference: @internalsref{Dots}, and
@internalsref{DotColumn}.
@seealso
-Program reference: @internalsref{TupletBracket},
+Internals Reference: @internalsref{TupletBracket},
@internalsref{TupletNumber}, and @internalsref{TimeScaledMusic}.
@seealso
-Program reference:
+Internals Reference:
@internalsref{LaissezVibrerTie}
@internalsref{LaissezVibrerTieColumn}
In this manual: @ref{Automatic note splitting}.
-Program reference: @internalsref{Tie}.
+Internals Reference: @internalsref{Tie}.
@refbugs
@seealso
-Program reference: @internalsref{Rest}.
+Internals Reference: @internalsref{Rest}.
@node Skips
@seealso
-Program reference: @internalsref{SkipMusic}.
+Internals Reference: @internalsref{SkipMusic}.
@node Multi measure rests
This manual: @ref{Text}
-Program reference:
+Internals Reference:
@internalsref{MultiMeasureRest}.
@seealso
-Program reference: @internalsref{TimeSignature}, and
+Internals Reference: @internalsref{TimeSignature}, and
@internalsref{Timing_translator}.
Examples: @lsr{contemporary,compound-time-signature.ly}.
@seealso
-Program reference: @internalsref{Completion_heads_engraver}.
+Internals Reference: @internalsref{Completion_heads_engraver}.
@node Setting automatic beam behavior
@seealso
-Program reference: @internalsref{Beam}.
+Internals Reference: @internalsref{Beam}.
@refbugs
In this manual: @ref{Repeats}, @ref{System start delimiters}.
-Program reference: @internalsref{BarLine} (created at
+Internals Reference: @internalsref{BarLine} (created at
@internalsref{Staff} level), @internalsref{SpanBar} (across
staves), @internalsref{Timing_translator} (for Timing
properties).
@seealso
-Program reference: @internalsref{BarNumber}.
+Internals Reference: @internalsref{BarNumber}.
Examples: @lsrdir{bar number}
This manual: @ref{Text marks}.
-Program reference: @internalsref{RehearsalMark}.
+Internals Reference: @internalsref{RehearsalMark}.
Init files: @file{scm/@/translation@/-functions@/.scm} contains
the definition of @code{format-mark-numbers} and
@seealso
-Program reference: @internalsref{GraceMusic}.
+Internals Reference: @internalsref{GraceMusic}.
@refbugs
This manual: @ref{Bar numbers}, @ref{Unmetered music}
-Program Reference: @internalsref{Timing_translator},
+Internals Reference: @internalsref{Timing_translator},
@internalsref{Score}
@seealso
-Program reference: @internalsref{ClusterSpanner},
+Internals Reference: @internalsref{ClusterSpanner},
@internalsref{ClusterSpannerBeacon},
@internalsref{Cluster_spanner_engraver}.
@seealso
-Program reference: the objects responsible for resolving
+Internals Reference: the objects responsible for resolving
collisions are @internalsref{NoteCollision} and
@internalsref{RestCollision}.
@seealso
-Program reference: @internalsref{PartCombineMusic}.
+Internals Reference: @internalsref{PartCombineMusic}.
@refbugs
@seealso
-Program reference: @internalsref{StaffSymbol},
+Internals Reference: @internalsref{StaffSymbol},
@internalsref{DrumStaff}.
Examples: @lsrdir{staff}
@seealso
-Program reference: @internalsref{MetronomeMark}, @ref{MIDI
+Internals Reference: @internalsref{MetronomeMark}, @ref{MIDI
output}.
@seealso
-Program reference: @internalsref{InstrumentName}.
+Internals Reference: @internalsref{InstrumentName}.
@node Quoting other voices
Examples: @lsr{parts,quote.ly},
@lsr{parts,quote-transportation.ly}
-Program reference: @internalsref{QuoteMusic}.
+Internals Reference: @internalsref{QuoteMusic}.
@node Formatting cue notes
In this manual: @ref{Text markup}.
-Program reference: @internalsref{TextScript}.
+Internals Reference: @internalsref{TextScript}.
@node Text spanners
@seealso
-Program reference: @internalsref{TextSpanner}.
+Internals Reference: @internalsref{TextSpanner}.
@node Text marks
@seealso
-Program reference: @internalsref{RehearsalMark}.
+Internals Reference: @internalsref{RehearsalMark}.
This manual: @ref{Overview of text markup commands}.
-Program reference: @internalsref{TextScript}.
+Internals Reference: @internalsref{TextScript}.
Init files: @file{scm/@/new@/-markup@/.scm}.
@seealso
-Program reference: @internalsref{TextSpanner},
+Internals Reference: @internalsref{TextSpanner},
@internalsref{Glissando}, @internalsref{VoiceFollower},
@internalsref{TrillSpanner},
@internalsref{line-spanner-interface}.
@quotation
@seealso
-Program reference: @internalsref{DynamicText}, @internalsref{Hairpin}.
+Internals Reference: @internalsref{DynamicText}, @internalsref{Hairpin}.
Vertical positioning of these symbols is handled by
@internalsref{DynamicLineSpanner}.
@end quotation
@node Default files
@subsection Default files
-The Program Reference documentation contains a lot of information
+The Internals Reference documentation contains a lot of information
about LilyPond, but even more information can be gathered from
looking at the internal LilyPond files.
@seealso
-Program reference: @internalsref{LyricText}, @internalsref{LyricSpace}.
+Internals Reference: @internalsref{LyricText}, @internalsref{LyricSpace}.
@seealso
-Program reference: @internalsref{Lyrics}.
+Internals Reference: @internalsref{Lyrics}.
@node Assigning more than one syllable to a single note
@seealso
-Program reference: @internalsref{LyricCombineMusic}.
+Internals Reference: @internalsref{LyricCombineMusic}.
@c Here come the section which used to be "Melismata"
@c the new title might be more self-explanatory
@seealso
-Program reference: @internalsref{Melisma_translator}.
+Internals Reference: @internalsref{Melisma_translator}.
@lsr{vocal,lyric@/-combine.ly}.
@seealso
-Program reference: @internalsref{LyricExtender},
+Internals Reference: @internalsref{LyricExtender},
@internalsref{LyricHyphen}
@seealso
@c TODO: document \new Staff << Voice \lyricsto >> bug
-Program reference: @internalsref{LyricCombineMusic},
+Internals Reference: @internalsref{LyricCombineMusic},
@internalsref{Lyrics}.
@seealso
-Program reference: @internalsref{LyricText}, @internalsref{StanzaNumber},
+Internals Reference: @internalsref{LyricText}, @internalsref{StanzaNumber},
@internalsref{VocalName}.