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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<!-- Copyright (c) 2007 Stijn van Dongen -->
<head>
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<style type="text/css">
body {
text-align: justify;
color: #001111;
background: white;
margin-left: 8%;
margin-right: 8%;
font-family: Helvetica, Univers, Verdana, sans-serif;
}
p.default {
font-family: Helvetica, Univers, Verdana, sans-serif;
text-align: justify;
}
p.L53 { font-size: 30pt; }
p.L52 { font-size: 20pt; }
p.L51 { font-size: 15pt; }
p.L50 { font-size: 12pt; }
p.L49 { font-size: 10pt; }
p.L48 { font-size: 9pt; }
p.L47 { font-size: 8pt; }
td {
font-family: Helvetica, Univers, Verdana, sans-serif;
text-align: justify;
}
h3 { margin-top:1em; }
h2 { margin-top:2em; }
.left { text-align: left; align: left; }
.right { text-align: right; align: right; }
.center { text-align: center; align: center; }
.nowrap { white-space: nowrap; }
a:link { text-decoration: none; }
a:active { text-decoration: none; }
a:visited { text-decoration: none; }
a:link { color: #1111aa; }
a:active { color: #1111aa; }
a:visited { color: #111166; }
a.local:link { color: #11aa11; }
a.local:active { color: #11aa11; }
a.local:visited { color: #116611; }
a.intern:link { color: #1111aa; }
a.intern:active { color: #1111aa; }
a.intern:visited { color: #111166; }
a.extern:link { color: #aa1111; }
a.extern:active { color: #aa1111; }
a.extern:visited { color: #661111; }
a.quiet:link { color: black; }
a.quiet:active { color: black; }
a.quiet:visited { color: black; }
div.copy
{ font-size: 12pt;
font-family: monospace;
text-align: left;
white-space: pre;
margin-left: 2em;
margin-top: 1em;
margin-bottom: 1em;
}
div.indent
{ margin-left: 8%;
margin-right: 0%;
}
</style>
<title>The PUD base language</title>
</head>
<body>
<p style="text-align:right">
29 Nov 2007
<a class="local" href="pud-base.ps"><b>pud-base</b></a>
1.002, 07-333
</p>
<div style="margin-top:1em">
<table
cellspacing="0" border=0
cellpadding="0" summary="itemize">
<tr><td width=48 valign="top" class="left nowrap">1.</td><td width=8> </td><td><div style="text-align:justify">
<a class="intern" href="#name">NAME</a>
</div></td></tr><tr><td width=48 valign="top" class="left nowrap">2.</td><td width=8> </td><td><div style="text-align:justify">
<a class="intern" href="#description">DESCRIPTION</a>
</div></td></tr><tr><td width=48 valign="top" class="left nowrap">3.</td><td width=8> </td><td><div style="text-align:justify">
<a class="intern" href="#itemintro">INTRODUCTION TO THE ITEMIZE ENVIRONMENT</a>
</div></td></tr><tr><td width=48 valign="top" class="left nowrap">4.</td><td width=8> </td><td><div style="text-align:justify">
<a class="intern" href="#itemuse">USING THE ITEMIZE ENVIRONMENT</a>
</div></td></tr><tr><td width=48 valign="top" class="left nowrap">5.</td><td width=8> </td><td><div style="text-align:justify">
<a class="intern" href="#spacing">THE SPACING ENVIRONMENT</a>
</div></td></tr><tr><td width=48 valign="top" class="left nowrap">6.</td><td width=8> </td><td><div style="text-align:justify">
<a class="intern" href="#macros">MACROS</a>
</div></td></tr><tr><td width=48 valign="top" class="left nowrap">7.</td><td width=8> </td><td><div style="text-align:justify">
<a class="intern" href="#issues">ISSUES</a>
</div></td></tr>
</table>
</div>
<a name="name"></a>
<h2>NAME</h2>
<p class="default L50" style="margin-bottom:0">
pud-base - a description of the Portable Unix Documentation base language</p>
<p class="default L50" style="margin-bottom:0">
The macros in this package have been ported to both HTML and
troff.</p>
<a name="description"></a>
<h2>DESCRIPTION</h2>
<p class="default L50" style="margin-bottom:0">
<i>pud-base</i> - A description of the Portable Unix Documentation (PUD)
base language. The macros in this package have been ported to both
HTML and troff.
This package is used by the PUD mini-language for
authoring manual pages (<a class="local" href="pud-man.html">pud-man</a>) and the PUD language
for FAQ authoring (<a class="local" href="pud-faq.html">pud-faq</a>).</p>
<p class="default L50" style="margin-bottom:0">
There is a small list of known issues in the <a class="intern" href="#issues">ISSUES</a> section,
mostly concerning the troff device. These should generally be of no
concern at all, but if you run into trouble look there first. A quick
glance through the list <i>before</i> you run into trouble may be the
wisest thing to do.</p>
<a name="itemintro"></a>
<h2>INTRODUCTION TO THE ITEMIZE ENVIRONMENT</h2>
<p class="default L50">
The <i>itemize</i> environemnt is the PUD workhorse for lists,
enumerations, itemizations, and other tailed creatures. A simple and
valid use is for example
<pre> \begin{itemize}
\item{\bf{foo}}
For I am foo.
\items{
{\bf{barra}}
{\bf{zuttelezut}}
}
For we are bar and zut.
\end{itemize}</pre>
<p class="default L50" style="margin-top:0em; margin-bottom:0em">
This source result in the following output:
<div style="margin-top:1em">
<table
cellspacing="0" border=0
cellpadding="0" summary="itemize">
<tr><td colspan=3><b>foo</b></td></tr><tr><td width=32> </td><td width=8> </td><td><div style="text-align:justify">
For I am foo.
</div></td></tr><tr><td width=32> </td><td width=8> </td><td></td></tr><tr><td colspan=3 class=left><b>barra</b></td></tr><tr><td colspan=3 class=left><b>zuttelezut</b></td></tr><tr><td width=32> </td><td width=8> </td><td><div style="text-align:justify">
For we are bar and zut.
</div></td></tr>
</table>
</div>
<p class="default L50">
This is not impressive at all, but it gives an idea of how itemize works.
The following example is a single itemize environment providing a
rollercoasterride through most of the features of the itemize environment.
As shown below, it is possible to change all the itemize settings and styles
at will even within a single itemize instance. Of course this is not useful
at all except for demonstrating the <i>itemize</i> capabilities, but it goes
to show that the itemize macros are quite robust (by virtue of modularity).
<p class="default L50"><b>NOTE</b><br>
The entire listing below was put in PUD's <i>spacing</i> environment,
described further below. The environment was used to create
extra margins on the two sides.
The listing was furthermore output in <i>debug</i> mode, which
shows the underlying table structure in the rendered HTML output.
<div style="
margin-left:5mm;
margin-right:10mm;
">
<div style="margin-top:1em">
<table
cellspacing="0" border=1
cellpadding="0" summary="itemize">
<tr><td width=80 valign="top" class=right>1</td><td width=24> </td><td><div style="text-align:justify">
Several spacing modes (contiguous, compact, indent). The mode in the
current list is both compact and contiguous. Compact means that the itemize
token and the ensuing text are on the same line. Contiguous means that there
is no paragraph skip between different item-description pairs. Below,
compact mode is switched off (approximately) halfway.
</div></td></tr><tr><td width=80 valign="top" class=right>2</td><td width=24> </td><td><div style="text-align:justify">
Several item modes (custom, mark, enumeration).
</div></td></tr><tr><td width=80 valign="top" class=right>3</td><td width=24> </td><td><div style="text-align:justify">
Several enumeration modes (roman, arabic, alphabetic).
</div></td></tr><tr><td width=80 valign="top" class=right>iv)</td><td width=24> </td><td><div style="text-align:justify">
The style of a list can be changed while in the middle of it.
</div></td></tr><tr><td width=80 valign="top" class=right>v)</td><td width=24> </td><td><div style="text-align:justify">
Nuther item.
</div></td></tr><tr><td width=80 valign="top" class=right>vi)</td><td width=24> </td><td><div style="text-align:justify">
The list can be 'interupted' and resumed (by means of
the <tt>\intermezzo#1</tt> macro).
</div></td></tr><tr><td colspan=3>Perhaps you wonder what good is THAT for, and justly so.
The <tt>\intermezzo#1</tt> macro should only be used inbetween different
items, i.e. it should <i>not</i> split content belonging to a single item.
</td></tr>
<tr><td width=80 valign="top" class=right>[7]</td><td width=24> </td><td><div style="text-align:justify">
Items can be optionally and automatically
right and/or left delimited. The current
item is delimited with square brackets.
</div></td></tr><tr><td width=80 valign="top" class=left>[8]</td><td width=24> </td><td><div style="text-align:justify">
Items can be left or right aligned.
</div></td></tr><tr><td width=80 valign="top" class=left>[9]</td><td width=24> </td><td><div style="text-align:justify">
Items can be stacked, which is supported only when compact is off.
</div></td></tr><tr><td width=80 valign="top" class=left>[10]</td><td width=24> </td><tr><td width=80> </td><td width=24> </td><td><div style="text-align:justify">
Beginning with this item, compact is off.
</div></td></tr><tr><td colspan=3 class=left>Implying</td></tr><tr><td colspan=3 class=left>That</td></tr><tr><td colspan=3 class=left>Stacking</td></tr><tr><td width=80> </td><td width=24> </td><td><div style="text-align:justify">
is now possible.
</div></td></tr><tr><td width=80 valign="top" class=right>[12]</td><td width=24> </td><tr><td width=80> </td><td width=24> </td><td><div style="text-align:justify">
(back to right-align) The itemcounter just keeps running by the way.
</div></td></tr><tr><td width=80 valign="top" class=right>[18]</td><td width=24> </td><td><div style="text-align:justify">
(back to compact) But the counter can be manipulated at will.
</div></td></tr><tr><td width=80 valign="top" class=right>•</td><td width=24> </td><td><div style="text-align:justify">
A bullet item, with an ugly bullet in HTML. Unfortunately the <tt>&bull;</tt>
entity is not widely supported yet. I decided to stick with a plain asterisk
until that time arrives.
</div></td></tr><tr><td width=80> </td><td width=24> </td><td></td></tr><tr><td width=80 valign="top" class=right>•</td><td width=24> </td><td><div style="text-align:justify">
We now switch to contiguous=0 mode (affecting the current list),
and start a new list that is contiguous to the present text
(by setting margintop to 0).
<div style="margin-top:0em">
<table
cellspacing="0" border=1
cellpadding="0" summary="itemize">
<tr><td width=64 valign="top" class=right>a.</td><td width=16> </td><td><div style="text-align:justify">
Hubris
</div></td></tr><tr><td width=64 valign="top" class=right>b.</td><td width=16> </td><td><div style="text-align:justify">
Laziness
</div></td></tr><tr><td width=64 valign="top" class=right>c.</td><td width=16> </td><td><div style="text-align:justify">
Impatience
</div></td></tr>
</table>
</div>
<p class="default L50" style="margin-top:0em; margin-bottom:0em">
Are the three virtues of programming.
</div></td></tr><tr><td width=80> </td><td width=24> </td><td></td></tr><tr><td width=80 valign="top" class=right>•</td><td width=24> </td><td><div style="text-align:justify">
This concludes a listing showing most of the itemize capabilities.
</div></td></tr>
</table>
</div>
</div>
<a name="itemuse"></a>
<h2>USING THE ITEMIZE ENVIRONMENT</h2>
<p class="default L50">
You steer the itemize environment by providing it with tag-value pairs like
so:
<pre> \begin{itemize}{
{compact}{1}
{contiguous}{1}
{align}{right}
{type}{abc}
{rp}{.}
}</pre>
<p class="default L50" style="margin-top:0em; margin-bottom:0em">
This is the list of tags that you may use.
<div style="margin-top:1em">
<table
cellspacing="0" border=0
cellpadding="0" summary="itemize">
<tr><td colspan=3><i>margintop</i></td></tr><tr><td width=32> </td><td width=8> </td><td><div style="text-align:justify">
Top of table, anomalous unit (ems), default 0.</div></td></tr><tr><td width=32> </td><td width=8> </td><td></td></tr><tr><td colspan=3><i>contiguous</i></td></tr><tr><td width=32> </td><td width=8> </td><td><div style="text-align:justify">
Don't put paragraph skips inbetween items, default 0 (do it).</div></td></tr><tr><td width=32> </td><td width=8> </td><td></td></tr><tr><td colspan=3><i>compact</i></td></tr><tr><td width=32> </td><td width=8> </td><td><div style="text-align:justify">
Put item and description on same line, default 0 (don't do it).</div></td></tr><tr><td width=32> </td><td width=8> </td><td></td></tr><tr><td colspan=3><i>w1</i></td></tr><tr><td width=32> </td><td width=8> </td><td><div style="text-align:justify">
Width of item column in ems.</div></td></tr><tr><td width=32> </td><td width=8> </td><td></td></tr><tr><td colspan=3><i>w2</i></td></tr><tr><td width=32> </td><td width=8> </td><td><div style="text-align:justify">
Width of separating column in ems.</div></td></tr><tr><td width=32> </td><td width=8> </td><td></td></tr><tr><td colspan=3><i>mark</i></td></tr><tr><td width=32> </td><td width=8> </td><td><div style="text-align:justify">
E.g. • (if type=mark), affects <tt>\item</tt>.</div></td></tr><tr><td width=32> </td><td width=8> </td><td></td></tr><tr><td colspan=3><i>align</i></td></tr><tr><td width=32> </td><td width=8> </td><td><div style="text-align:justify">
One of left or right (item alignment), default left.</div></td></tr><tr><td width=32> </td><td width=8> </td><td></td></tr><tr><td colspan=3><i>debug</i></td></tr><tr><td width=32> </td><td width=8> </td><td><div style="text-align:justify">
Shows underlying table structure in html.</div></td></tr><tr><td width=32> </td><td width=8> </td><td></td></tr><tr><td colspan=3><i>lp</i></td></tr><tr><td width=32> </td><td width=8> </td><td><div style="text-align:justify">
What's printed immediately to the left of an item.</div></td></tr><tr><td width=32> </td><td width=8> </td><td></td></tr><tr><td colspan=3><i>rp</i></td></tr><tr><td width=32> </td><td width=8> </td><td><div style="text-align:justify">
What's printed immediately to the right of an item.</div></td></tr><tr><td width=32> </td><td width=8> </td><td></td></tr><tr><td colspan=3><i>type</i></td></tr><tr><td width=32> </td><td width=8> </td><td><div style="text-align:justify">
One of mark, roman, abc, arabic, affects <tt>\item</tt>.</div></td></tr><tr><td width=32> </td><td width=8> </td><td></td></tr><tr><td colspan=3><i>itemcount</i></td></tr><tr><td width=32> </td><td width=8> </td><td><div style="text-align:justify">
The count of items seen so far, e.g. 11 right now.
</div></td></tr>
</table>
</div>
<p class="default L50">
You need to know that the itemize environment internally maps these tags
to dollar keys simply by prepending a dollar.
Thus, if you want to reset one of the values associated with such a tag,
you need to do e.g.
<pre>\set{$align}{right}
\set{$itemcount}{30}</pre>
<a name="spacing"></a>
<h2>THE SPACING ENVIRONMENT</h2>
<p class="default L50">
Its syntax is identical to that of the <i>itemize</i> environment.
It accepts tags <i>left</i>, <i>right</i>, <i>top</i>, and <i>bottom</i>.
These should receive numeric values. The associated
unit is millimeter.
<p class="default L50">
The troff device does not yet support the <i>top</i> and <i>bottom</i>
tags.
<a name="macros"></a>
<h2>MACROS</h2>
<div style="margin-top:1em">
<table
cellspacing="0" border=0
cellpadding="0" summary="itemize">
<tr><td colspan=3 class=left><a name="optenref2">\<tt>enref#2</tt></a></td></tr><tr><td colspan=3 class=left><a name="optiref2">\<tt>iref#2</tt></a></td></tr><tr><td colspan=3 class=left><a name="optlref2">\<tt>lref#2</tt></a></td></tr><tr><td colspan=3 class=left><a name="optaref2">\<tt>aref#2</tt></a></td></tr><tr><td colspan=3 class=left><a name="opthttpref1">\<tt>httpref#1</tt></a></td></tr><tr><td colspan=3 class=left><a name="optsibref1">\<tt>sibref#1</tt></a></td></tr><tr><td colspan=3 class=left><a name="optsibref2">\<tt>sibref#2</tt></a></td></tr><tr><td colspan=3 class=left><a name="optsibref3">\<tt>sibref#3</tt></a></td></tr><tr><td width=32> </td><td width=8> </td><td><div style="text-align:justify">
<p class="default L50" style="margin-top:0em; margin-bottom:0em">
<tt>\enref#2</tt> <i>creates</i> a link for which the first argument is the anchor
and for which the second argument is the content (which can be left empty).
<tt>\iref#2</tt> takes such an anchor as the first argument and it takes content
that carries the link as the second argument. <tt>\lref#2</tt> takes a file name
(possibly including a relative or absolute path) as the first argument and
content as the second argument. <tt>\aref#2</tt> takes a URL (later possibly a
URI) as the first argument and content as the second argument. <tt>\sibref#2</tt>
takes a label as argument which presumably is the name of some application.
It may append an extension depending on the current device, and it assumes
that <tt>label + extension</tt> is the name of a file in the current directory.
The second argument is displayed in the text. For <tt>\sibref#1</tt> the
displayed text is the same as the label. For <tt>\sibref#3</tt> the second
argument is an additional anchor within the file being linked to, and
the third argument is the displayed text.
<tt>\httpref#1</tt> simply prints a URL which will be active when html is output.</p>
</div></td></tr><tr><td width=32> </td><td width=8> </td><td></td></tr><tr><td colspan=3 class=left><a name="optpar1">\<tt>par#1</tt></a></td></tr><tr><td colspan=3 class=left><a name="optcpar2">\<tt>cpar#2</tt></a></td></tr><tr><td colspan=3 class=left><a name="optcar1">\<tt>car#1</tt></a></td></tr><tr><td colspan=3 class=left><a name="optccar2">\<tt>ccar#2</tt></a></td></tr><tr><td width=32> </td><td width=8> </td><td><div style="text-align:justify">
These are all paragraph macros that carry the paragraph content as
the last argument. The first argument of <tt>\cpar#2</tt> and <tt>\ccar#2</tt>
is the caption. These macros will ensure wellformedness for devices
that support it, such as HTML. For more information on the differences
between these macros consult the entries below.
</div></td></tr><tr><td width=32> </td><td width=8> </td><td></td></tr><tr><td colspan=3 class=left><a name="optpar">\<tt>par</tt></a></td></tr><tr><td colspan=3 class=left><a name="optcpar1">\<tt>cpar#1</tt></a></td></tr><tr><td colspan=3 class=left><a name="optcar">\<tt>car</tt></a></td></tr><tr><td colspan=3 class=left><a name="optccar1">\<tt>ccar#1</tt></a></td></tr><tr><td width=32> </td><td width=8> </td><td><div style="text-align:justify">
use <tt>\car</tt> where you don't need a paragraph skip, but just need to
indicate that you are in text mode again. You can simply always use
<tt>\par</tt> and never use <tt>\car</tt>. If you care about the details of spacing
though, or if you have particular trouble for example in creating an itemize
environment where you do not want top and bottom margins, then it could be
worthwile to turn to <tt>\car</tt> under very specific circumstances. Examples
for using <tt>\car</tt> are:
<div style="margin-top:0em">
<table
cellspacing="0" border=0
cellpadding="0" summary="itemize">
<tr><td width=32 valign="top" class=right>-</td><td width=8> </td><td><div style="text-align:justify">
After an environment that always carries a bottom margin.
</div></td></tr><tr><td width=32 valign="top" class=right>-</td><td width=8> </td><td><div style="text-align:justify">
After a caption that always carries a bottom margin, such
as most sectioning commands (e.g. <tt>\sec</tt> in the manual macros).
</div></td></tr><tr><td width=32 valign="top" class=right>-</td><td width=8> </td><td><div style="text-align:justify">
After an environment that does <i>not</i> carry a bottom margin,
and where you specifically want the environment to be contiguous to the
enclosing text. The listing you are currently reading is an
example of this.
</div></td></tr>
</table>
</div>
<p class="default L50" style="margin-top:0em; margin-bottom:0em">
As promised. The <tt>\car</tt> macro may feel a little unusual. If you don't mind
standing the chance of a little spurious vertical white-space just use
<tt>\par</tt> all the time. If you really need it, such as in an 'inline' listing
as above, the <tt>\car</tt> macro is ready to do the job.
</div></td></tr><tr><td width=32> </td><td width=8> </td><td></td></tr><tr><td colspan=3 class=left><a name="optbf1">\<tt>bf#1</tt></a></td></tr><tr><td colspan=3 class=left><a name="optit1">\<tt>it#1</tt></a></td></tr><tr><td colspan=3 class=left><a name="opttt1">\<tt>tt#1</tt></a></td></tr><tr><td colspan=3 class=left><a name="optv1">\<tt>v#1</tt></a></td></tr><tr><td colspan=3 class=left><a name="optftinc2">\<tt>ftinc#2</tt></a></td></tr><tr><td colspan=3 class=left><a name="optftdec2">\<tt>ftdec#2</tt></a></td></tr><tr><td width=32> </td><td width=8> </td><td><div style="text-align:justify">
The first four items set their argument in the <b>font</b> <i>specified</i>.
<tt>\tt#1</tt> and <tt>\v#1</tt> both denote a typewriter font. <i>These macros should
not be nested if troff is to be among the output devices</i>. Support for the
last two items is not yet very robust. They temporarily increment
respectively decrement the font by the amount of the first argument and
apply the resulting setting to the second argument.
</div></td></tr><tr><td width=32> </td><td width=8> </td><td></td></tr><tr><td colspan=3 class=left><a name="optverbatim1">\<tt>verbatim#1</tt></a></td></tr><tr><td colspan=3 class=left><a name="optverbatix1">\<tt>verbatix#1</tt></a></td></tr><tr><td width=32> </td><td width=8> </td><td><div style="text-align:justify">
Make the device output the contents verbatim in a mono-spaced font,
obeying spaces and newlines. This does not prohibit expansion of zoem
macros, use <tt>\protect#1</tt> for that. The macro <tt>\verbatim#1</tt> will
create a non-breaking environment.
</div></td></tr><tr><td width=32> </td><td width=8> </td><td></td></tr><tr><td colspan=3><tt>\"html::charset"</tt></td></tr><tr><td width=32> </td><td width=8> </td><td><div style="text-align:justify">
Set this e.g. to ISO-8859-5 or some other acceptable charset label.
Do this <i>before</i> you use the <tt>preamble</tt> key from the base package
that you are using (e.g. the <tt>man.zmm</tt> or <tt>faq.zmm</tt> macros).
</div></td></tr>
</table>
</div>
<a name="issues"></a>
<h2>ISSUES</h2>
<div style="margin-top:1em">
<table
cellspacing="0" border=0
cellpadding="0" summary="itemize">
<tr><td colspan=3><b>Nesting</b></td></tr><tr><td width=32> </td><td width=8> </td><td><div style="text-align:justify">
Do not nest <tt>\bf#1</tt>, <tt>\it#1</tt>, <tt>\tt#1</tt>, or <tt>\v#1</tt> macros if troff is
among the output devices. It will yield unexpected results.
</div></td></tr><tr><td width=32> </td><td width=8> </td><td></td></tr><tr><td colspan=3>The rest of this list pertains to the <i>itemize</i> environment.</td></tr>
<tr><td width=32> </td><td width=8> </td><td></td></tr><tr><td colspan=3><b>Boldness</b></td></tr><tr><td width=32> </td><td width=8> </td><td><div style="text-align:justify">
There is currently not a way to get bold (Roman) numerals using
the automatic enumeration mode within <i>itemize</i>, or to change
the appearance of any of the other enumeration types.
</div></td></tr><tr><td width=32> </td><td width=8> </td><td></td></tr><tr><td colspan=3><b>Margins</b></td></tr><tr><td width=32> </td><td width=8> </td><td><div style="text-align:justify">
If you use fractional values for <tt>w1</tt> and <tt>w2</tt> in the itemize
environment, you may well run into a problem with troff (c.q. nroff)
Suppose you use <tt>w1=1.6</tt> and <tt>w2=0.8</tt>. Nroff will round both these
values as well as the sum of the two, thus incrementing by <tt>2</tt> and <tt>1</tt>,
followed by a decrement of <tt>2</tt>.
</div></td></tr><tr><td width=32> </td><td width=8> </td><td></td></tr><tr><td colspan=3><b>Misc</b></td></tr><tr><td width=32> </td><td width=8> </td><td><div style="text-align:justify">
Refrain from doing
<pre> \begin{itemize}
\begin{spacing}
\item{foo}
FOO
\item{bar}
BAR
\end{spacing}
\end{itemize}</pre>
<p class="default L50" style="margin-top:0em; margin-bottom:0em">
Because the <tt>\item#1</tt> invocations will update keys in the dictionary
pushed by the <i>spacing</i> environment rather than the dictionary beneath
it that was pushed by the <i>itemize</i> environment.
On the other hand, you <i>can</i> do this:
<pre> \begin{spacing}
\begin{itemize}
\item{foo}
FOO
\item{bar}
BAR
\end{itemize}
\end{spacing}</pre>
<p class="default L50" style="margin-top:0em; margin-bottom:0em">
The reason being that the <i>spacing</i> environment does not facilitate
associated keys within the dictionary scope it creates.
Compare with this with the <i>itemize</i> environment, that facilitates
the use of <tt>\item#1</tt>, <tt>\item</tt>, and <tt>\items#1</tt>.
</div></td></tr>
</table>
</div>
</body>
</html>
|
