summaryrefslogtreecommitdiff
path: root/Documentation/Manual/macros.texi
blob: 3d54c66cddfb37b8ce75826e1337ca569644b5c6 (plain)
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
@c ===================================================================
@c Abbreviations
@c ===================================================================

@macro clim{}
CLIM
@end macro
@macro mcclim{}
McCLIM
@end macro

@c ===================================================================
@c Semantic markup and references
@c ===================================================================

@macro setf{NAME}
(setf \NAME\)
@end macro

@iftex
@macro symbol{NAME,PACKAGE}
\NAME\ @smallertt [\PACKAGE\]
@end macro
@end iftex
@ifnottex
@macro symbol{NAME,PACKAGE}
\NAME\ [\PACKAGE\]
@end macro
@end ifnottex

@macro func{NAME}
@b{\NAME\}
@end macro
@macro funref{NAME}
@ref{Function \NAME\,@b{\NAME\}}
@end macro
@ifhtml
@macro codefunref{NAME}
@funref{\NAME\}
@end macro
@end ifhtml
@ifnothtml
@macro codefunref{NAME}
\NAME\
@end macro
@end ifnothtml

@macro fmacro{NAME}
@b{\NAME\}
@end macro
@ifhtml
@macro codemacroref{NAME}
@ref{Macro \NAME\,@b{\NAME\}}
@end macro
@end ifhtml
@ifnothtml
@macro codemacroref{NAME}
\NAME\
@end macro
@end ifnothtml

@macro genfun{FUN}
@b{\FUN\}
@end macro
@macro genfunref{NAME}
@ref{Generic-Function \NAME\,@b{\NAME\}}
@end macro
@ifhtml
@macro codegenfunref{NAME}
@genfunref{\NAME\}
@end macro
@end ifhtml
@ifnothtml
@macro codegenfunref{NAME}
\NAME\
@end macro
@end ifnothtml

@alias class = code
@alias package = code
@alias gadget = code
@alias pane = code
@alias methcomp = t
@alias slot = code
@alias longref = t
@alias cl = code
@alias initarg = code

@c ===================================================================
@c Glossary entries
@c ===================================================================

@macro glossentry{ENTRY}
@anchor{\ENTRY\}
@noindent @b{\ENTRY\}
@cindex \ENTRY\
@end macro

@iftex
@alias gloss = i
@macro glossref{LABEL,CONCEPT}
@i{\LABEL\}
@end macro
@end iftex

@ifnottex
@alias gloss = i
@macro glossref{LABEL,CONCEPT}
@i{@ref{\CONCEPT\,\LABEL\,\LABEL\}}
@end macro
@end ifnottex

@c ===================================================================
@c Annotations
@c ===================================================================

@macro issue{AUTHOR,COMMENT}
@noindent
@b{Issue:} @i{\COMMENT\ --- \AUTHOR\}
@end macro