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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
Perl script `update_examples' is intended to update
examples in the Maxima texinfo documentation.
`update_examples' is a filter - it reads standard input
and direst result to standard output:
./update_examples < original.texi > updated.texi
The script scans input texinfo file for
constructions of the form:
@c ===beg===
@c expand((x+y)^2);
@c factor(%);
@c ===end===
@example
(%i1) expand((x+y)^2);
2 2
(%o1) y + 2 x y + x
(%i2) factor(%);
2
(%o2) (y + x)
@end example
Lines between `@c ===beg===' and `@c ===end==='
are Maxima commands (without leftmost `@c ').
The script extracts this commands, passes them to
Maxima and inserts resulting output between
`@example' and `@end example'.
Maxima commands between `@c ===beg===' and `@c ===end==='
must obey some simple rules:
1. Each command must begin at 4th column right
after `@c ' without extra spaces between `@c '
and the command:
@c expand((x+y)^2); - is right
@c expand((x+y)^2); - is wrong
2. If command spans several lines then second and
all subsequent lines must have alt least one
extra space between `@c ' and the command.
Wrong:
@c (x +
@c y +
@c z)^3;
Right:
@c (x +
@c y +
@c z)^3;
Examples without preceding `@c ===beg==='/`@c ===end==='
remain unchanged.
By default `update_examples' calls local Maxima
script `../../maxima-local' but this can be changed
by setting MAXIMA_EXAMPLE_COMMAND environment
variable.
The environment variable STRIP_TOPDIR controls
which path is stripped out of the output (load,
batch commands). If the variable isn't set then
anything above /maxima/doc/info is stripped.
IMPORTANT: `update_examples' script works only
in combination with special Maxima initialization
file `maxima-init.lisp'. This init file ensures
that output is no more than 65 characters wide
by setting `linel:65;' and helps to identify
Maxima prompts.
Vadim V. Zhytnikov <vvzhy@mail.ru>
Jan 12, 2005
|
