share/template-standalone.texi

   1 \input texinfo
   2
   3 @c NOTE: This template-standalone.texi shows how to create a texinfo file
   4 @c that yields a stand-alone MYPACKAGE.info file.
   5 @c See template.texi for a texinfo file which is to be part of maxima.info.
   6
   7 @c NOTE: The content of this file was determined by tedious trial and error.
   8 @c My advice is to keep all elements of this template, from \input to @bye,
   9 @c otherwise you'll experience cryptic error messages, hair loss, etc.
  10
  11 @c makeinfo MYPACKAGE.texi         to make .info
  12 @c texi2html MYPACKAGE.texi        to make .html
  13 @c texi2pdf MYPACKAGE.texi         to make .pdf
  14
  15 @setfilename MYPACKAGE.info
  16 @settitle Package MYPACKAGE
  17
  18 @ifinfo
  19 @macro var {expr}
  20 <\expr\>
  21 @end macro
  22 @end ifinfo
  23
  24 @dircategory Mathematics/Maxima
  25 @direntry
  26 * Package MYPACKAGE: (maxima)Maxima share package MYPACKAGE for foo bar baz quux.
  27 @end direntry
  28
  29 @node Top, Introduction to package MYPACKAGE, (dir), (dir)
  30 @top
  31 @menu
  32 * Introduction to package MYPACKAGE::
  33 * Definitions for package MYPACKAGE::
  34 * Function and variable index::
  35 @end menu
  36 @chapter Package MYPACKAGE
  37
  38 @node Introduction to package MYPACKAGE, Definitions for package MYPACKAGE, Top, Top
  39 @section Introduction to package MYPACKAGE
  40
  41 Package @code{MYPACKAGE} is yadda yadda yadda, foo bar baz quux mumble blurf.
  42
  43 @node Definitions for package MYPACKAGE, Function and variable index, Introduction to package MYPACKAGE, Top
  44 @section Definitions for package MYPACKAGE
  45
  46 @deffn {Function} transmogrify (@var{foo}, @var{bar})
  47
  48 Returns the generalized transmogrificatin of @var{foo} and @var{bar}.
  49 See also @code{frotz}.
  50
  51 @end deffn
  52
  53 @defvr {Variable} frotz
  54 Default value: @code{true}
  55
  56 When @code{frotz} is @code{true},
  57 @code{transmogrify} computes the transmogrification by Smith's algorithm.
  58 Otherwise, the transmogrification is computed by Jones' algorithm.
  59
  60 @end defvr
  61
  62 @node Function and variable index,  , Definitions for package MYPACKAGE, Top
  63 @appendix Function and variable index
  64 @printindex fn
  65 @printindex vr
  66
  67 @bye