File: template.texi

package info (click to toggle)
maxima 5.44.0-2
  • links: PTS
  • area: main
  • in suites: bullseye, sid
  • size: 108,368 kB
  • sloc: lisp: 383,860; fortran: 14,665; perl: 14,369; tcl: 11,147; sh: 4,517; makefile: 2,580; ansic: 447; python: 262; xml: 59; awk: 37; sed: 17
file content (63 lines) | stat: -rw-r--r-- 2,031 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
@c NOTE: This template.texi shows how to create a texinfo file that is
@c incorporated into maxima.info. See template-standalone.texi for a
@c texinfo file which is accessed apart from maxima.info.

@c NOTE: To bring MYTOPIC into maxima.info, you need to make references
@c to MYTOPIC in 3 places. Search for "lbfgs" in include-maxima.texi for an example.
@c
@c 1. Under the heading "Additional packages" (line 154 at the moment)
@c    Here you put "MYTOPIC:: Transmogrification a la Smith and Jones."
@c
@c 2. Under the heading "The Detailed Node Listing" (line 219 at the moment)
@c    Here you copy the @menu which is defined in this file.
@c
@c 3. In the @node list (line 635 at the moment)
@c    You MUST fix up the preceding and succeeding @nodes when you
@c    create a new @node MYTOPIC.
@c
@c    @node PRECEDINGTOPIC, MYTOPIC, PRECEDINGPRECEDINGTOPIC, Top
@c    @chapter PRECEDINGTOPIC
@c    @include PRECEDINGTOPIC.texi
@c
@c    @node MYTOPIC, NEXTTOPIC, PRECEDINGTOPIC, Top
@c    @chapter MYTOPIC
@c    @include MYTOPIC.texi
@c
@c    @node NEXTTOPIC, NEXTNEXTTOPIC, MYTOPIC, Top
@c    @chapter NEXTTOPIC
@c    @include NEXTTOPIC.texi


@dircategory Mathematics/Maxima
@direntry
* MYTOPIC: (maxima/mytopic).           Maxima share package MYTOPIC for foo bar baz quux.
@end direntry

@menu
* Introduction to MYTOPIC::
* Definitions for MYTOPIC::
@end menu

@node Introduction to MYTOPIC, Definitions for MYTOPIC, Top, Top
@section Introduction to MYTOPIC

@code{MYTOPIC} is yadda yadda yadda, foo bar baz quux mumble blurf.

@node Definitions for MYTOPIC, , Introduction to MYTOPIC, Top
@section Definitions for MYTOPIC

@deffn {Function} transmogrify (@var{foo}, @var{bar})

Returns the generalized transmogrificatin of @var{foo} and @var{bar}.
See also @code{frotz}.

@end deffn

@defvr {Variable} frotz
Default value: @code{true}

When @code{frotz} is @code{true},
@code{transmogrify} computes the transmogrification by Smith's algorithm.
Otherwise, the transmogrification is computed by Jones' algorithm.

@end defvr