Add note that the lapack package needs to loaded to get the functions.
[maxima.git] / doc / info / category-macros.texi.in
blob4cbb316d5f2054f4e8e43ba7e04ccf2870e66b9f
1 @ifnottex
2 @set figuresfolder ./figures
3 @end ifnottex
4 @iftex
5 @set figuresfolder @abs_srcdir@/figures
6 @end iftex
8 @ifhtml
9 @macro fname {name}
10 @*@ @ @ @ @t{\name\}
11 @end macro
12 @end ifhtml
13 @iftex
14 @macro fname {name}
15 @*@t{\name\}
16 @end macro
17 @end iftex
18 @ifinfo
19 @macro fname {name}
20 @*\name\
21 @end macro
22 @end ifinfo
23 @c Handle all the cases not handled above (xml, docbook, etc.)
24 @ifnothtml
25 @ifnottex
26 @ifnotinfo
27 @macro fname {name}
28 @*\name\
29 @end macro
30 @end ifnotinfo
31 @end ifnottex
32 @end ifnothtml
34 @ifhtml
35 @macro figure {file}
36 @image{@value{figuresfolder}/\file\}
37 @end macro
38 @end ifhtml
39 @iftex
40 @macro figure {file}
41 @center @image{@value{figuresfolder}/\file\, 10cm}
42 @end macro
43 @end iftex
44 @ifinfo
45 @macro figure {file}
46 (Figure \file\)
47 @end macro
48 @end ifinfo
49 @c Handle all the cases not handled above (xml, docbook, etc.)
50 @ifnothtml
51 @ifnottex
52 @ifnotinfo
53 @macro figure {file}
54 (Figure \file\)
55 @end macro
56 @end ifnotinfo
57 @end ifnottex
58 @end ifnothtml
60 @ifhtml
61 @macro opencatbox {label}
62 @html
63 <div class=categorybox>
64 \label\
65 @end html
66 @end macro
68 @macro category {name}
69 @html
70 @ref{Category: \name\, \name\}
71 &middot;
72 @end html
73 @end macro
75 @macro closecatbox {}
76 @html
77 </div>
78 @end html
79 @end macro
81 @c Macros for cross references
83 @macro mref {nodename}
84 @code{@ref{\nodename\}}
85 @end macro
87 @macro mxref {nodename, text}
88 @code{@ref{\nodename\, \text\}}
89 @end macro
91 @macro mrefdot {nodename}
92 @code{@ref{\nodename\}}.
93 @end macro
95 @macro mxrefdot {nodename, text}
96 @code{@ref{\nodename\, \text\}}.
97 @end macro
99 @macro mrefcomma {nodename}
100 @code{@ref{\nodename\}},
101 @end macro
103 @macro mxrefcomma {nodename, text}
104 @code{@ref{\nodename\, \text\}},
105 @end macro
107 @macro mrefparen {nodename}
108 @code{@ref{\nodename\}})
109 @end macro
111 @macro nref {nodename}
112 @ref{\nodename\}
113 @end macro
115 @macro nxref {nodename, text}
116 @ref{\nodename\, \text\}
117 @end macro
119 @macro nrefdot {nodename}
120 @ref{\nodename\}.
121 @end macro
123 @macro nrefcomma {nodename}
124 @ref{\nodename\},
125 @end macro
127 @end ifhtml
129 @c Non html versions of the macros
131 @ifnothtml
133 @macro opencatbox {label}
134 @end macro
136 @macro category {name}
137 @end macro
139 @macro closecatbox {}
140 @end macro
142 @c Macros for cross references
144 @ifnottex
145 @macro mref {nodename}
146 @code{\nodename\}
147 @end macro
149 @macro mxref {nodename, text}
150 @code{\text\}
151 @end macro
153 @macro mrefdot {nodename}
154 @code{\nodename\}.
155 @end macro
157 @macro mxrefdot {nodename, text}
158 @code{\text\}.
159 @end macro
161 @macro mrefcomma {nodename}
162 @code{\nodename\},
163 @end macro
165 @macro mxrefcomma {nodename, text}
166 @code{\text\},
167 @end macro
169 @macro mrefparen {nodename}
170 @code{\nodename\})
171 @end macro
173 @macro nref {nodename}
174 \nodename\
175 @end macro
177 @macro nxref {nodename, text}
178 \text\
179 @end macro
181 @macro nrefdot {nodename}
182 \nodename\.
183 @end macro
185 @macro nrefcomma {nodename}
186 \nodename\,
187 @end macro
188 @end ifnottex
190 @iftex
191 @tex
192 \gdef\linkcolor{0 .5 0}
193 \gdef\urlcolor{0 0 .5}
195 %% @set txiomitrefpg ==> in TeX, this creates a top-level csname SETtxiomitxrefpg
196 %% bound to some other than \relax
197 %% @clear txiomitrefpg ==> bind it to \relax
198 \gdef\mmref#1{{\def\SETtxiomitxrefpg{true}\def\xrefprintnodename##1{##1}\ref{#1}}}
199 @end tex
201 @macro mref {nodename}
202 @code{@mmref{\nodename\}}
203 @end macro
205 @macro mxref {nodename, text}
206 @code{@ref{\nodename\, \text\}}
207 @end macro
209 @macro mrefdot {nodename}
210 @mref{\nodename\}.
211 @end macro
213 @macro mxrefdot {nodename, text}
214 @mxref{\nodename\,\text\}.
215 @end macro
217 @macro mrefcomma {nodename}
218 @mref{\nodename\},
219 @end macro
221 @macro mxrefcomma {nodename, text}
222 @mxref{\nodename\, \text\},
223 @end macro
225 @macro mrefparen {nodename}
226 @mref{\nodename\})
227 @end macro
229 @macro nref {nodename}
230 @ref{\nodename\}
231 @end macro
233 @macro nxref {nodename, text}
234 @ref{\nodename\, \text\}
235 @end macro
237 @macro nrefdot {nodename}
238 @ref{\nodename\}.
239 @end macro
241 @macro nrefcomma {nodename}
242 @ref{\nodename\},
243 @end macro
245 @end iftex
246 @end ifnothtml