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
|
<!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 ref macros</title>
</head>
<body>
<p style="text-align:right">
29 Nov 2007
<a class="local" href="pud-ref.ps"><b>pud-ref</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="#macro">MACROS</a>
</div></td></tr>
</table>
</div>
<a name="name"></a>
<h2>NAME</h2>
<p class="default L50" style="margin-bottom:0">
pud-ref - A description of the Portable Unix Documentation macros for referencing</p>
<a name="description"></a>
<h2>DESCRIPTION</h2>
<p class="default L50" style="margin-bottom:0">
The following macros are used by the PUD manual macros
(see <a class="local" href="pud-man.html">pud-man</a>) and the PUD FAQ macros
(<a class="local" href="pud-faq.html">pud-faq</a>).</p>
<a name="macro"></a>
<h2>MACROS</h2>
<div style="margin-top:1em">
<table
cellspacing="0" border=0
cellpadding="0" summary="itemize">
<tr><td colspan=3 class=left><tt>\refload#2</tt></td></tr><tr><td colspan=3 class=left><tt>\refloadx#2</tt></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">
Both macros take as first argument
a label that uniquely defines the reference.
The second argument is a vararg containing key-value pairs.</p>
<p class="default L50" style="margin-bottom:0">
These macros are usually not needed in PUD documents; they are
lower level facilities used by high level PUD macros.</p>
</div></td></tr><tr><td width=32> </td><td width=8> </td><td></td></tr><tr><td colspan=3><tt>\ref#2</tt></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">
The first argument is a label. The second argument should be a key
associated with that label. The result is the value associated
with the label/key pair.</p>
<p class="default L50" style="margin-bottom:0">
These macros are usually not needed in PUD documents; they are
lower level facilities used by high level PUD macros (e.g. <tt>\iref#2</tt>,
and <tt>\secref#1</tt>).</p>
</div></td></tr><tr><td width=32> </td><td width=8> </td><td></td></tr><tr><td colspan=3 class=left><tt>\refcaption#1</tt></td></tr><tr><td colspan=3 class=left><tt>\refnumber#1</tt></td></tr><tr><td colspan=3 class=left><tt>\reflevel#1</tt></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">
The argument is a label. The result is respectively the caption, number,
or level associated with that label.</p>
</div></td></tr><tr><td width=32> </td><td width=8> </td><td></td></tr><tr><td colspan=3 class=left><a name="optreference">\<tt>reference#1</tt></a></td></tr><tr><td colspan=3 class=left><a name="optrefer">\<tt>refer#1</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">
The first associates a number with the label that is in the first argument,
and prints it inbeween square brackets. The label is anchored to this
location. The second outputs the associated number inbetween brackets, and
makes it carry a link to the anchor. For example, I am about
to create a link <a class="intern" href="#pub1">[1]</a> and another link <a class="intern" href="#pub2">[2]</a>
to the items appearing below.</p>
<p class="default L50" style="margin-bottom:0">
<a name="pub1">[1]</a> The first reference.</p>
<p class="default L50" style="margin-bottom:0">
<a name="pub2">[2]</a> The second reference.</p>
<p class="default L50" style="margin-bottom:0">
If you prefer another bibliography style, find the macros
and adapt them according to your needs - they are very simple.</p>
<p class="default L50" style="margin-bottom:0">
<tt>\reference#2</tt> currently writes data to the file <tt>\__fnbase__.zmr</tt>,
to be read back in using a <tt>\load{\__fnbase__.zmr}</tt> statement.
This is automatically done when using the PUD man or FAQ packages.</p>
</div></td></tr>
</table>
</div>
</body>
</html>
|
