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