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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE api SYSTEM "api.dtd">
<api name="Prefs">
<constant name="PREFS" val="prefs"/>
<constant name="SERVER" val="server"/>
<constant name="GENERAL" val="general"/>
<constant name="PROJECT" val="project"/>
<constant name="INFO" val="info"/>
<constant name="FORMAT" val="format"/>
<constant name="OUTPUT" val="output"/>
<constant name="PARSING" val="parsing"/>
<constant name="PARSER" val="parser"/>
<constant name="PREPROC" val="preproc"/>
<constant name="ARG" val="arg"/>
<constant name="EXTENSION" val="extension"/>
<constant name="STYLE" val="style"/>
<constant name="SPECIFICS" val="specifics"/>
<constant name="HYPERSPEC" val="hyperspec"/>
<class name="Toplevel" elmname="Prefs">
<var type="ptr" name="server"/>
<var type="ptr" name="general"/>
<var type="ptrlist" name="projects"/>
<var type="ptrlist" name="parsing"/>
<var type="ptrlist" name="output"/>
<var type="ptrlist" name="style"/>
<subelem type="ptr" name="server" var="server"/>
<subelem type="ptr" name="general" var="general"/>
<subelem type="ptrlist" name="project" var="projects"/>
<subelem type="ptrlist" name="parsing" var="parsing"/>
<subelem type="ptrlist" name="output" var="output"/>
<subelem type="ptrlist" name="style" var="style"/>
</class>
<class name="Info" elmname="info">
<doc>See the individual documentation for a class which
info-fields are understood and how the TYPE, VALUE and INFO fields
should be filled.</doc>
<var type="string" name="type"/>
<var type="string" name="value"/>
<var type="string" name="info"/>
<attr type="string" name="type" var="type"/>
<attr type="string" name="value" var="value"/>
<attr type="string" name="info" var="info"/>
</class>
<class name="Server" elmname="server">
<doc>Preferences for the server and for how to connect to the server</doc>
<var type="string" name="name"/>
<var type="string" name="host"/>
<var type="string" name="port"/>
<var type="string" name="ondemand"/>
<var type="string" name="user"/>
<var type="string" name="password"/>
<attr type="string" name="name" var="name"/>
<attr type="string" name="host" var="host"/>
<attr type="string" name="port" var="port"/>
<attr type="string" name="ondemand" var="ondemand"/>
<attr type="string" name="user" var="user"/>
<attr type="string" name="password" var="password"/>
</class>
<class name="General" elmname="general">
<doc>General preferences/information</doc>
<var type="string" name="hyperspec" doc="URL to the Common Lisp hyperspec."/>
<var type="string" name="serveruse" doc="Should server be used? yes|no."/>
<attr type="string" name="serveruse" var="serveruse"/>
<subelem type="string" name="hyperspec" var="hyperspec"/>
</class>
<class name="Project" elmname="project">
<doc>Preferences for a specific project.</doc>
<var type="string" name="id" doc="used to refer to the project from other places."/>
<var type="string" name="name"/>
<var type="string" name="prefsfile"/>
<var type="ptrlist" name="info"/>
<attr type="string" name="id" var="id"/>
<attr type="string" name="name" var="name"/>
<attr type="string" name="prefs-file" var="prefsfile"/>
<subelem type="ptrlist" name="info" var="info"/>
<infodoc type="fullname" value="full name of the project">
<expl>This is used by documenters for pretty docs</expl>
</infodoc>
<infodoc type="author" value="name of one author"
info="email address">
<expl>This is used by documenters for pretty docs</expl>
</infodoc>
<infodoc type="version" value="version name or number">
<expl>This is used by documenters for pretty docs</expl>
</infodoc>
<infodoc type="date" value="the wanted date">
<expl>This lets you configure the date you want e.g on
documents.</expl>
</infodoc>
</class>
<class name="Parsing" elmname="parsing">
<var type="ptrlist" name="extensions"/>
<subelem type="ptrlist" name="extension" var="extensions"/>
</class>
<class name="Extension" elmname="extension">
<var type="string" name="name"/>
<var type="ptrlist" name="parsers"/>
<attr type="string" name="name" var="name"/>
<subelem type="ptrlist" name="parser" var="parsers"/>
</class>
<class name="Parser" elmname="parser">
<var type="string" name="name"/>
<var type="stringlist" name="args"/>
<var type="ptrlist" name="preprocs"/>
<attr type="string" name="name" var="name"/>
<subelem type="stringlist" name="arg" var="args"/>
<subelem type="ptrlist" name="preproc" var="preprocs"/>
</class>
<class name="Preproc" elmname="preproc">
<var type="string" name="name"/>
<var type="stringlist" name="args"/>
<attr type="string" name="name" var="name"/>
<subelem type="stringlist" name="arg" var="args"/>
</class>
<class name="Output" elmname="output">
<var type="ptrlist" name="info"/>
<var type="ptrlist" name="formats"/>
<subelem type="ptrlist" name="info" var="info"/>
<subelem type="ptrlist" name="format" var="formats"/>
<infodoc type="outdir" value="name of a directory">
<expl>This specifies the general directory for output. It
can be overrided by individual formats.</expl>
</infodoc>
</class>
<class name="OutFormat" elmname="format">
<var type="string" name="name" doc="Names the format in question."/>
<var type="ptrlist" name="info"/>
<attr type="string" name="name" var="name"/>
<subelem type="ptrlist" name="info" var="info"/>
<infodoc type="outdir" value="name of a directory">
<expl>This specifies the directory for output for this
format.</expl>
</infodoc>
<infodoc type="baseurl" value="a legal (base) URL">
<expl>This specifies the base URL to use when
making links between documents. Used by e.g HTML.</expl>
</infodoc>
<infodoc type="bgcolour" value="spec for a background-colour">
<expl>This is translated to e.g a bgcolor attribute in HTML.</expl>
</infodoc>
<infodoc type="textcolour" value="spec for a text-colour">
<expl>This is translated to e.g a textcolor attribute in HTML.</expl>
</infodoc>
<infodoc type="papersize" value="spec for a papersize">
<expl>This is translated to a useful value for e.g LaTeX-documents.</expl>
</infodoc>
<infodoc type="fontsize" value="spec for a fontsize">
<expl>This is translated to a useful value for e.g LaTeX-documents.</expl>
</infodoc>
<infodoc type="bookfile" value="a filename">
<expl>This filename is used for e.g DocBook book-files or LaTeX reportfiles.</expl>
</infodoc>
<infodoc type="generate" value="all">
<expl>This means that everything possible for the format should be
generated. The generate type info is dependent on the format being
output and the info-field may be used as an argument.</expl>
</infodoc>
<infodoc type="generate" value="book">
<expl>This means that a book-like document should be generated. Works with
DocBook now.</expl>
</infodoc>
<infodoc type="generate" value="report">
<expl>This means that a report-like document should be generated. Not
used yet.</expl>
</infodoc>
<infodoc type="generate" value="emacs-lookup">
<expl>Generate a lookup-file for use with the SDS-interface in
Emacs.</expl>
</infodoc>
<infodoc type="generate" value="classhier">
<expl>Generate a page or seven describing the class hierarchy.</expl>
</infodoc>
<infodoc type="generate" value="object-pages">
<expl>Make pages for individual objects sorted in directories based on type.</expl>
</infodoc>
<infodoc type="generate" value="full-index">
<expl>Make a linked index for the whole documentation.</expl>
</infodoc>
<infodoc type="generate" value="obj-indexes">
<expl>Make index-pages for objects of various types.</expl>
</infodoc>
</class>
<class name="Style" elmname="style">
<var type="string" name="name"/>
<var type="ptrlist" name="info"/>
<var type="ptrlist" name="specifics"/>
<attr type="string" name="name" var="name"/>
<subelem type="ptrlist" name="info" var="info"/>
<subelem type="ptrlist" name="specifics" var="specifics"/>
</class>
</api>
|
