contrib/cvs/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 @noindent                       Suppresses indentation of the following
  17                                 paragraph.  This can ocassionally be useful
  18                                 after examples and the like.
  19 @cindex ...                     Add a tag to the index.
  20 @pxref{ ... }                   Cross reference in parentheses.
  21 @xref{ ... }                    Cross reference.
  22
  23 Preformatted text should be marked as such (use @example... there may be other
  24 ways) since many of the final output formats can use relational fonts otherwise
  25 and marking it as formatted should restrict it to a fixed wiidth font.  Keep
  26 this sort of text to 80 characters or less per line since larger may not be
  27 properly viewable for some info users.
  28
  29 There are dictionary lists and function definition markers.  Scan cvs.texinfo
  30 for their usage.  There may be table definitions as well but I haven't used
  31 them.
  32
  33 Use lots of index markers.  Scan the index for the current style.  Try to reuse
  34 an existing entry if the meaning is similar.
  35
  36 For more on using texinfo docs, see the `info texinfo' documentation or
  37 http://www.gnu.org/manual/texinfo/texinfo.html .