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