share/template.texi

   1 @c NOTE: This template.texi shows how to create a texinfo file that is
   2 @c incorporated into maxima.info. See template-standalone.texi for a
   3 @c texinfo file which is accessed apart from maxima.info.
   4
   5 @c NOTE: To bring MYTOPIC into maxima.info, you need to make references
   6 @c to MYTOPIC in 3 places. Search for "lbfgs" in include-maxima.texi for an example.
   7 @c
   8 @c 1. Under the heading "Additional packages" (line 154 at the moment)
   9 @c    Here you put "MYTOPIC:: Transmogrification a la Smith and Jones."
  10 @c
  11 @c 2. Under the heading "The Detailed Node Listing" (line 219 at the moment)
  12 @c    Here you copy the @menu which is defined in this file.
  13 @c
  14 @c 3. In the @node list (line 635 at the moment)
  15 @c    You MUST fix up the preceding and succeeding @nodes when you
  16 @c    create a new @node MYTOPIC.
  17 @c
  18 @c    @node PRECEDINGTOPIC, MYTOPIC, PRECEDINGPRECEDINGTOPIC, Top
  19 @c    @chapter PRECEDINGTOPIC
  20 @c    @include PRECEDINGTOPIC.texi
  21 @c
  22 @c    @node MYTOPIC, NEXTTOPIC, PRECEDINGTOPIC, Top
  23 @c    @chapter MYTOPIC
  24 @c    @include MYTOPIC.texi
  25 @c
  26 @c    @node NEXTTOPIC, NEXTNEXTTOPIC, MYTOPIC, Top
  27 @c    @chapter NEXTTOPIC
  28 @c    @include NEXTTOPIC.texi
  29
  30
  31 @dircategory Mathematics/Maxima
  32 @direntry
  33 * MYTOPIC: (maxima/mytopic).           Maxima share package MYTOPIC for foo bar baz quux.
  34 @end direntry
  35
  36 @menu
  37 * Introduction to MYTOPIC::
  38 * Definitions for MYTOPIC::
  39 @end menu
  40
  41 @node Introduction to MYTOPIC, Definitions for MYTOPIC, Top, Top
  42 @section Introduction to MYTOPIC
  43
  44 @code{MYTOPIC} is yadda yadda yadda, foo bar baz quux mumble blurf.
  45
  46 @node Definitions for MYTOPIC, , Introduction to MYTOPIC, Top
  47 @section Definitions for MYTOPIC
  48
  49 @deffn {Function} transmogrify (@var{foo}, @var{bar})
  50
  51 Returns the generalized transmogrificatin of @var{foo} and @var{bar}.
  52 See also @code{frotz}.
  53
  54 @end deffn
  55
  56 @defvr {Variable} frotz
  57 Default value: @code{true}
  58
  59 When @code{frotz} is @code{true},
  60 @code{transmogrify} computes the transmogrification by Smith's algorithm.
  61 Otherwise, the transmogrification is computed by Jones' algorithm.
  62
  63 @end defvr