1 DOCUMENTATION FORMATTING
2 ------------------------
4 The language is called texinfo; you can see its manual here:
5 http://www.gnu.org/software/texinfo/manual/texinfo/
7 However, you don't need to read those docs. The most important
8 thing to notice is that text is text. If you see a mistake in the
9 text, you can fix it. If you want to change the order of
10 something, you can cut-and-paste that stuff into a new location.
13 %%%%% SECTIONING COMMANDS
15 Most of the manual operates at the
18 level. Sections are created with
23 * sectioning commands (@node and @section) must not appear inside
24 an @ignore. Separate those commands with a space, ie @n ode.
28 %%%%% LILYPOND FORMATTING
30 * Use two spaces for indentation in lilypond examples. (no tabs)
32 * All text strings should be prefaced with #. LilyPond does not
33 strictly require this, but it is helpful to get users accustomed
34 to this scheme construct. ie
35 \set Staff.instrumentName = #"cello"
37 * All engravers should have double-quotes around them:
38 \consists "Spans_arpeggio_engraver"
39 Again, LilyPond does not strictly require this, but it is a
40 useful standard to follow.
42 * Examples should end with a complete bar if possible.
44 * If possible, only write one bar per line. The notes on each
45 line should be an independent line -- tweaks should occur on
46 their own line if possible.
48 \override textscript #'padding = #3 c1^"hi"
50 \override textscript #'padding = #3
53 * LilyPond input should be produced via
54 @lilypond[verbatim,quote,ragged-right]
55 with `fragment' and `relative=2' optional.
57 Examples about page layout may alter the quote/ragged-right
58 options. Omitting `verbatim' is not allowed except for special
61 * Inspirational headwords are produced with
62 @lilypondfile[quote,ragged-right,line-width=16\cm,staffsize=16]
65 * LSR snippets are linked with
66 @lilypondfile[verbatim,lilyquote,ragged-right,texidoc]
69 * Avoid long stretches of input code. Noone is going to read them
70 in print. Please create a smaller example. (the smaller
71 example does not need to be minimal, however)
73 * If you want to work on an example outside of the manual (for
74 easier/faster processing), use this header:
77 #(define dump-extents #t)
79 line-width = 160\mm - 2.0 * 0.4\in
81 force-assignment = #""
82 line-width = #(- line-width (* mm 3.000000))
88 You may not change any of these values. If you are making an
89 example demonstrating special \paper{} values, contact the
95 * Lines should be less than 72 characters long. (I personally
96 recommend writing with 66-char lines, but don't bother modifying
101 * Do not use spaces at the beginning of a line (except in @example
102 or @verbatim environments), and do not use more than a single
103 space between words. `makeinfo' copies the input lines verbatim
104 without removing those spaces.
106 * Use two spaces after a period.
108 * Variables or numbers which consist of a single character
109 (probably followed by a punctuation mark) should be tied
110 properly, either to the previous or the next word. Example:
112 The variable@tie{}@var{a} ...
114 * To get consistent indentation in the DVI output it is better to
115 avoid the @verbatim environment. Use the @example environment
116 instead if possible, but without extraneous indentation. For
125 should be replaced with
133 where `@example' starts the line (without leading spaces).
135 * Do not compress the input vertically; this is, do not use
137 Beginning of logical unit
141 continuation of logical unit
145 Beginning of logical unit
152 continuation of logical unit
154 This makes it easier to avoid forgetting the `@noindent'. Only
155 use @noindent if the material is discussing the same material;
156 new material should simply begin without anything special on the
159 * in @itemize use @item on a separate line like this:
167 Do not use @itemize @bullet.
169 * To get LilyPond version, use @version{} (this does not work inside
170 LilyPond snippets). If you write "@version{}" (enclosed with
171 quotes), or generally if @version{} is not followed by a space,
180 to prevent an ugly line break in PDF output.
185 @c - single line comments
186 "@c NOTE:" is a comment which should remain in the final
187 version. (gp only command ;)
188 @ignore ... @end ignore - multi-line comment
190 @cindex - General index. Please add as many as you can. Don't
191 capitalize the first word.
192 @funindex - is for a \lilycommand.
194 @example ... @end ignore - example text that should be set as a
195 blockquote. Any {} must be escaped with @{ }@
196 @itemize @item A @item B ... @end itemize - for bulleted lists.
197 Do not compress vertically like this.
199 @code{} - typeset in a tt-font. Use for actual lilypond code or
200 property/context names.
201 @notation{} - refers to pieces of notation, e.g.
202 "@notation{cres.}". Also use to specific lyrics ("the
203 @notation{A - men} is centered")
204 @q{} - Single quotes. Used for `vague' terms.
205 @qq{} - Double quotes. Used for actual quotes ("he said").
207 @warning{}: produces a "Note: " box. Use for important
210 @tie{} - Variables or numbers which consist of a single character
211 (probably followed by a punctuation mark) should be tied
212 properly, either to the previous or the next word. Example:
213 "The letter@tie{}@q{I} is skipped"
215 @var - Use for variables.
216 @warning{} - produces a "Note: " box.
217 Any `\' used inside this must be written as `\\'.
221 %%%%% OTHER TEXT CONCERNS
223 * References must occur at the end of a sentence, for more
224 information see @ref{the texinfo manual}. Ideally this should
225 also be the final sentence of a paragraph, but this is not
226 required. Any link in a doc section must be duplicated in the
227 @seealso section at the bottom.
229 * Introducing examples must be done with
230 . (ie finish the previous sentence/paragaph)
231 : (ie `in this example:')
232 , (ie `may add foo with the blah construct,')
233 The old "sentence runs directly into the example" method is not
236 * Abbrevs in caps, e.g., HTML, DVI, MIDI, etc.
240 1. To introduce lists
241 2. When beginning a quote: "So, he said,..."
242 This usage is rarer. Americans often just use a comma.
243 3. When adding a defining example at the end of a sentence.
245 * Non-ASCII characters which are in utf-8 should be directly used;
246 this is, don't say `Ba@ss{}tuba' but `Baßtuba'. This ensures that
247 all such characters appear in all output formats.