Documentation/user/writing-texinfo.txt

   1 DOCUMENTATION FORMATTING
   2 ------------------------
   3
   4 The language is called texinfo; you can see its manual here:
   5 http://www.gnu.org/software/texinfo/manual/texinfo/
   6
   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.
  11
  12
  13 %%%%% SECTIONING COMMANDS
  14
  15 Most of the manual operates at the
  16         @node Foo
  17         @subsubsection Foo
  18 level.  Sections are created with
  19         @node Foo
  20         @subsection Foo
  21 commands.
  22
  23 * Please leave two blank lines above a @node; this makes it easier
  24   to find sections in texinfo.
  25
  26 * sectioning commands (@node and @section) must not appear inside
  27   an @ignore.  Separate those commands with a space, ie @n ode.
  28
  29
  30
  31 %%%%% LILYPOND FORMATTING
  32
  33 * Use two spaces for indentation in lilypond examples.  (no tabs)
  34
  35 * All text strings should be prefaced with #.  LilyPond does not
  36   strictly require this, but it is helpful to get users accustomed
  37   to this scheme construct.  ie
  38     \set Staff.instrumentName = #"cello"
  39
  40 * All engravers should have double-quotes around them:
  41     \consists "Spans_arpeggio_engraver"
  42   Again, LilyPond does not strictly require this, but it is a
  43   useful standard to follow.
  44
  45 * Examples should end with a complete bar if possible.
  46
  47 * If possible, only write one bar per line.  The notes on each
  48   line should be an independent line -- tweaks should occur on
  49   their own line if possible.
  50   Bad:
  51     \override textscript #'padding = #3 c1^"hi"
  52   Good:
  53     \override textscript #'padding = #3
  54     c1^"hi"
  55
  56 * LilyPond input should be produced via
  57     @lilypond[verbatim,quote,ragged-right]
  58   with `fragment' and `relative=2' optional.
  59
  60   Examples about page layout may alter the quote/ragged-right
  61   options.  Omitting `verbatim' is not allowed except for special
  62   circumstances.
  63
  64 * Inspirational headwords are produced with
  65   @lilypondfile[quote,ragged-right,line-width=16\cm,staffsize=16]
  66   {pitches-headword.ly}
  67
  68 * LSR snippets are linked with
  69   @lilypondfile[verbatim,lilyquote,ragged-right,texidoc]
  70   {filename.ly}
  71
  72 * Avoid long stretches of input code.  Noone is going to read them
  73   in print.  Please create a smaller example.  (the smaller
  74   example does not need to be minimal, however)
  75
  76 * Specify durations for at least the first note of every bar.
  77
  78 * If possible, end with a complete bar.
  79
  80 * Comments should go on their own line, and be placed before the
  81   line(s) to which they refer.
  82
  83 * Add extra spaces around { } marks; ie
  84   not:          \chordmode {c e g}
  85   but instead:  \chordmode { c e g }
  86
  87 * If you only have one bar per line, omit bar checks.  If you
  88   put more than one bar per line (not recommended), then include
  89   bar checks.
  90
  91 * If you want to work on an example outside of the manual (for
  92   easier/faster processing), use this header:
  93
  94 \paper {
  95   #(define dump-extents #t)
  96   indent = 0\mm
  97   line-width = 160\mm - 2.0 * 0.4\in
  98   ragged-right = ##t
  99   force-assignment = #""
 100   line-width = #(- line-width (* mm  3.000000))
 101 }
 102
 103 \layout {
 104 }
 105
 106   You may not change any of these values.  If you are making an
 107   example demonstrating special \paper{} values, contact the
 108   Documentation Editor.
 109
 110
 111 %%%%% TEXT FORMATTING
 112
 113 * Lines should be less than 72 characters long.  (I personally
 114   recommend writing with 66-char lines, but don't bother modifying
 115   existing material.)
 116
 117 * Do not use tabs.
 118
 119 * Do not use spaces at the beginning of a line (except in @example
 120   or @verbatim environments), and do not use more than a single
 121   space between words.  `makeinfo' copies the input lines verbatim
 122   without removing those spaces.
 123
 124 * Use two spaces after a period.
 125
 126 * In examples of syntax, use @var{musicexpr} for a music
 127   expression.
 128
 129 * Don't use @rinternals{} in the main text.  If you're tempted to
 130   do so, you're probably getting too close to "talking through the
 131   code".  If you really want to refer to a context, use @code{} in
 132   the main text and @rinternals{} in the @seealso.
 133
 134 * Variables or numbers which consist of a single character
 135   (probably followed by a punctuation mark) should be tied
 136   properly, either to the previous or the next word.  Example:
 137
 138       The variable@tie{}@var{a} ...
 139
 140 * To get consistent indentation in the DVI output it is better to
 141   avoid the @verbatim environment.  Use the @example environment
 142   instead if possible, but without extraneous indentation.  For
 143   example, this
 144
 145     @example
 146       foo {
 147         bar
 148       }
 149     @end example
 150
 151   should be replaced with
 152
 153     @example
 154     foo {
 155       bar
 156     }
 157     @end example
 158
 159   where `@example' starts the line (without leading spaces).
 160
 161 * Do not compress the input vertically; this is, do not use
 162
 163     Beginning of logical unit
 164     @example
 165     ...
 166     @end example
 167     continuation of logical unit
 168
 169   but
 170
 171     Beginning of logical unit
 172
 173     @example
 174     ...
 175     @end example
 176
 177     @noindent
 178     continuation of logical unit
 179
 180   This makes it easier to avoid forgetting the `@noindent'.  Only
 181   use @noindent if the material is discussing the same material;
 182   new material should simply begin without anything special on the
 183   line above it.
 184
 185 * in @itemize use @item on a separate line like this:
 186   @itemize
 187   @item
 188   Foo
 189
 190   @item
 191   Bar
 192
 193   Do not use @itemize @bullet.
 194
 195 * To get LilyPond version, use @version{} (this does not work inside
 196   LilyPond snippets).  If you write "@version{}" (enclosed with
 197   quotes), or generally if @version{} is not followed by a space,
 198   enclose it with
 199
 200   @w{ ... }
 201
 202   e.g.
 203
 204   @w{"@version{}"}
 205
 206   to prevent an ugly line break in PDF output.
 207
 208
 209 %%%%% SYNTAX SURVEY
 210
 211 @c - single line comments
 212   "@c NOTE:" is a comment which should remain in the final
 213   version.  (gp only command ;)
 214 @ignore ... @end ignore - multi-line comment
 215
 216 @cindex - General index. Please add as many as you can.  Don't
 217   capitalize the first word.
 218 @funindex - is for a \lilycommand.
 219
 220 @example ... @end ignore - example text that should be set as a
 221   blockquote.  Any {} must be escaped with @{ }@
 222 @itemize @item A @item B ... @end itemize - for bulleted lists.
 223   Do not compress vertically like this.
 224
 225 @code{} - typeset in a tt-font. Use for actual lilypond code or
 226   property/context names.  If the name contains a space, wrap
 227   the entire thing inside @w{@code{  }}.
 228 @notation{} - refers to pieces of notation, e.g.
 229   "@notation{cres.}".  Also use to specific lyrics ("the
 230   @notation{A - men} is centered")
 231 @q{} - Single quotes. Used for `vague' terms.
 232 @qq{} - Double quotes.  Used for actual quotes ("he said").
 233
 234 @tie{} - Variables or numbers which consist of a single character
 235   (probably followed by a punctuation mark) should be tied
 236   properly, either to the previous or the next word.  Example:
 237     "The letter@tie{}@q{I} is skipped"
 238
 239 @var - Use for variables.
 240 @warning{} - produces a "Note: " box. Use for important messages.
 241
 242 @bs - Generates a backslash inside @warning.
 243     Any `\' used inside @warning (and @q or @qq) must be written as `@bs{}'
 244     (texinfo would also allow \\, but this breaks with PDF output).
 245
 246
 247
 248 %%%%% OTHER TEXT CONCERNS
 249
 250 * References must occur at the end of a sentence, for more
 251   information see @ref{the texinfo manual}.  Ideally this should
 252   also be the final sentence of a paragraph, but this is not
 253   required.  Any link in a doc section must be duplicated in the
 254   @seealso section at the bottom.
 255
 256 * Introducing examples must be done with
 257      . (ie finish the previous sentence/paragaph)
 258      : (ie `in this example:')
 259      , (ie `may add foo with the blah construct,')
 260   The old "sentence runs directly into the example" method is not
 261   allowed any more.
 262
 263 * Abbrevs in caps, e.g., HTML, DVI, MIDI, etc.
 264
 265 * Colon usage
 266
 267   1. To introduce lists
 268   2. When beginning a quote: "So, he said,..."
 269      This usage is rarer.  Americans often just use a comma.
 270   3. When adding a defining example at the end of a sentence.
 271
 272 * Non-ASCII characters which are in utf-8 should be directly used;
 273   this is, don't say `Ba@ss{}tuba' but `Baßtuba'.  This ensures that
 274   all such characters appear in all output formats.
 275