contrib/cvs-1.12/doc/HACKING.DOCS

   1 Here's some of the texinfo conventions the CVS documentation uses:
   2
   3 @code{ ... }                    command usage & command snippets, including
   4                                 command names.
   5 @var{ ... }                     variables - text which the user is expected to
   6                                 replace with some meaningful text of their own
   7                                 in actual usage.
   8 @file{ ... }                    file names
   9 @samp{ ... }                    for most anything else you need quotes around
  10                                 (often still misused for command snippets)
  11 @example ... @end example       example command usage and output, etc.
  12 @emph{ ... }                    emphasis - warnings, stress, etc.  This will be
  13                                 bracketed by underline characters in info files
  14                                 (_ ... _) and in italics in PDF & probably in
  15                                 postscript & HTML.
  16 @strong{ ... }                  Similar to @emph{}, but the effect is to
  17                                 bracket with asterisks in info files (* ... *)
  18                                 and in bold in PDF & probably in postscript &
  19                                 HTML.
  20 @noindent                       Suppresses indentation of the following
  21                                 paragraph.  This can ocassionally be useful
  22                                 after examples and the like.
  23 @cindex ...                     Add a tag to the index.
  24 @pxref{ ... }                   Cross reference in parentheses.
  25 @xref{ ... }                    Cross reference.
  26
  27 Preformatted text should be marked as such (use @example... there may be other
  28 ways) since many of the final output formats can use relational fonts otherwise
  29 and marking it as formatted should restrict it to a fixed width font.  Keep
  30 this sort of text to 80 characters or less per line since larger may not be
  31 properly viewable for some info users.
  32
  33 There are dictionary lists and function definition markers.  Scan cvs.texinfo
  34 for their usage.  There may be table definitions as well but I haven't used
  35 them.
  36
  37 Use lots of index markers.  Scan the index for the current style.  Try to reuse
  38 an existing entry if the meaning is similar.
  39
  40 `makeinfo' 3.11 or greater is required for output generation since earlier
  41 versions do not support the @ifnottex & @ifnothtml commands.  There may be
  42 other commands used in `cvs.texinfo' that are unsupported by earlier versions
  43 of `makeinfo' by the time you read this.
  44
  45 For more on using texinfo docs, see the `info texinfo' documentation or
  46 http://www.gnu.org/manual/texinfo/texinfo.html .