projects / OpenSPARC-T2-DV / blame
? search:
summary | tags | clone url | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / perl-5.8.0 / doc / MHonArc / resources / botlinks.html
CommitLineData
86530b38
AT		 1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN">
2<html>
3<head>
4<title>MHonArc Resources: BOTLINKS</title>
5</head>
6<body>
7<!--x-rc-nav-->
8<table border=0><tr valign="top">
9<td align="left" width="50%">[Prev:&nbsp;<a href="authsort.html">AUTHSORT</a>]</td><td><nobr>[<a href="../resources.html#botlinks">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="charsetconverters.html">CHARSETCONVERTERS</a>]</td></tr></table>
10<!--/x-rc-nav-->
11<hr>
12<h1>BOTLINKS</h1>
13
14<!-- *************************************************************** -->
15<hr>
16<h2>Syntax</h2>
17
18<dl>
19
20<dt><strong>Envariable</strong></dt>
21<dd><p>N/A
22</p>
23</dd>
24
25<dt><strong>Element</strong></dt>
26<dd><p>
27<code>&lt;BOTLINKS&gt;<br></code>
28<var>markup ...</var><br>
29<code>&lt;/BOTLINKS&gt;<br></code>
30</p>
31</dd>
32
33<dt><strong>Command-line Option</strong></dt>
34<dd><p>N/A
35</p>
36</dd>
37
38</dl>
39
40<!-- *************************************************************** -->
41<hr>
42<h2>Description</h2>
43
44<p>BOTLINKS defines the markup for the links at the bottom
45of a message page. Its usage is analagous to the
46<a href="toplinks.html">TOPLINKS</a> resource, but tends
47to be more verbose. However, you can define the resource
48anyway you desire.
49</p>
50
51<!-- *************************************************************** -->
52<hr>
53<h2>Default Setting</h2>
54
55<p>The following represents the default setting when there are
56main and thread indexes. References to either index will not
57show up if either index does not exist.
58</p>
59
60<pre>
61<b>&lt;BotLinks&gt;</b>
62&lt;hr&gt;
63&lt;ul&gt;
64<a href="#LINK">$LINK(PREV)$</a><a href="#LINK">$LINK(NEXT)$</a>
65<a href="#LINK">$LINK(TPREV)$</a><a href="#LINK">$LINK(TNEXT)$</a>
66&lt;li&gt;Index(es):
67&lt;ul&gt;
68&lt;li&gt;&lt;a href="<a href="#IDXFNAME">$IDXFNAME$</a>#<a href="#MSGNUM">$MSGNUM$</a>"&gt;
69&lt;strong&gt;Main&lt;/strong&gt;&lt;/a&gt;&lt;/li&gt;
70&lt;li&gt;&lt;a href="<a href="#TIDXFNAME">$TIDXFNAME$</a>#<a href="#MSGNUM">$MSGNUM$</a>"&gt;
71&lt;strong&gt;Thread&lt;/strong&gt;&lt;/a&gt;&lt;/li&gt;
72&lt;/ul&gt;
73&lt;/li&gt;
74&lt;/ul&gt;
75<b>&lt;/BotLinks&gt;</b>
76</pre>
77
78<!-- *************************************************************** -->
79<hr>
80<h2>Resource Variables</h2>
81
82<table border=1>
83<tr bgcolor="#C0C0C0">
84<th>Variable</th><th>Value</th>
85</tr>
86<tr valign=top>
87<td align=center><a name="BUTTON" href="../rcvars.html#BUTTON"><strong><code>$BUTTON$</code></strong></a></td>
88<td>Button markup linking to a message.</td>
89</tr>
90<tr valign=top>
91<td align=center><a name="DATE" href="../rcvars.html#DATE"><strong><code>$DATE$</code></strong></a></td>
92<td>The date of the message.</td>
93</tr>
94<tr valign=top>
95<td align=center><a name="DDMMYYYY" href="../rcvars.html#DDMMYYYY"><strong><code>$DDMMYYYY$</code></strong></a></td>
96<td>Message date in dd/mm/yyyy format.</td>
97</tr>
98<tr valign=top>
99<td align=center><a name="DOCURL" href="../rcvars.html#DOCURL"><strong><code>$DOCURL$</code></strong></a></td>
100<td>URL to documentation.</td>
101</tr>
102<tr valign=top>
103<td align=center><a name="ENV" href="../rcvars.html#ENV"><strong><code>$ENV$</code></strong></a></td>
104<td>Value of an environment variable.</td>
105</tr>
106<tr valign=top>
107<td align=center><a name="FROM" href="../rcvars.html#FROM"><strong><code>$FROM$</code></strong></a></td>
108<td>The complete text in the <tt>From:</tt> field of the message.</td>
109</tr>
110<tr valign=top>
111<td align=center><a name="FROMADDR" href="../rcvars.html#FROMADDR"><strong><code>$FROMADDR$</code></strong></a></td>
112<td>The e-mail address in the <tt>From:</tt> field of the message.</td>
113</tr>
114<tr valign=top>
115<td align=center><a name="FROMADDRDOMAIN" href="../rcvars.html#FROMADDRDOMAIN"><strong><code>$FROMADDRDOMAIN$</code></strong></a></td>
116<td>The e-mail address domain of the <tt>From:</tt> field of the message.</td>
117</tr>
118<tr valign=top>
119<td align=center><a name="FROMADDRNAME" href="../rcvars.html#FROMADDRNAME"><strong><code>$FROMADDRNAME$</code></strong></a></td>
120<td>The e-mail address "username" (or local-part) of the <tt>From:</tt> field of the message.</td>
121</tr>
122<tr valign=top>
123<td align=center><a name="FROMNAME" href="../rcvars.html#FROMNAME"><strong><code>$FROMNAME$</code></strong></a></td>
124<td>The human name of the person in the <tt>From:</tt> field of the message. If no human name is found, the username specified in the e-mail address is used.</td>
125</tr>
126<tr valign=top>
127<td align=center><a name="GMTDATE" href="../rcvars.html#GMTDATE"><strong><code>$GMTDATE$</code></strong></a></td>
128<td>Current GMT date.</td>
129</tr>
130<tr valign=top>
131<td align=center><a name="ICON" href="../rcvars.html#ICON"><strong><code>$ICON$</code></strong></a></td>
132<td>The context-type sensitive icon.</td>
133</tr>
134<tr valign=top>
135<td align=center><a name="ICONURL" href="../rcvars.html#ICONURL"><strong><code>$ICONURL$</code></strong></a></td>
136<td>The URL to the context-type sensitive icon.</td>
137</tr>
138<tr valign=top>
139<td align=center><a name="IDXFNAME" href="../rcvars.html#IDXFNAME"><strong><code>$IDXFNAME$</code></strong></a></td>
140<td>Filename of main index page.</td>
141</tr>
142<tr valign=top>
143<td align=center><a name="IDXLABEL" href="../rcvars.html#IDXLABEL"><strong><code>$IDXLABEL$</code></strong></a></td>
144<td>Label for main index page.</td>
145</tr>
146<tr valign=top>
147<td align=center><a name="IDXPREFIX" href="../rcvars.html#IDXPREFIX"><strong><code>$IDXPREFIX$</code></strong></a></td>
148<td>Prefix of filenames of main index pages.</td>
149</tr>
150<tr valign=top>
151<td align=center><a name="IDXSIZE" href="../rcvars.html#IDXSIZE"><strong><code>$IDXSIZE$</code></strong></a></td>
152<td>Max number of messages that may be listed in index page.</td>
153</tr>
154<tr valign=top>
155<td align=center><a name="IDXTITLE" href="../rcvars.html#IDXTITLE"><strong><code>$IDXTITLE$</code></strong></a></td>
156<td>The title of the main index page.</td>
157</tr>
158<tr valign=top>
159<td align=center><a name="LINK" href="../rcvars.html#LINK"><strong><code>$LINK$</code></strong></a></td>
160<td>Link markup linking to a message.</td>
161</tr>
162<tr valign=top>
163<td align=center><a name="LOCALDATE" href="../rcvars.html#LOCALDATE"><strong><code>$LOCALDATE$</code></strong></a></td>
164<td>Current local date.</td>
165</tr>
166<tr valign=top>
167<td align=center><a name="MMDDYYYY" href="../rcvars.html#MMDDYYYY"><strong><code>$MMDDYYYY$</code></strong></a></td>
168<td>Message date in mm/dd/yyyy format.</td>
169</tr>
170<tr valign=top>
171<td align=center><a name="MSG" href="../rcvars.html#MSG"><strong><code>$MSG$</code></strong></a></td>
172<td>Filename of message.</td>
173</tr>
174<tr valign=top>
175<td align=center><a name="MSGGMTDATE" href="../rcvars.html#MSGGMTDATE"><strong><code>$MSGGMTDATE$</code></strong></a></td>
176<td>GMT date of current message.</td>
177</tr>
178<tr valign=top>
179<td align=center><a name="MSGID" href="../rcvars.html#MSGID"><strong><code>$MSGID$</code></strong></a></td>
180<td>The message-id of the message.</td>
181</tr>
182<tr valign=top>
183<td align=center><a name="MSGLOCALDATE" href="../rcvars.html#MSGLOCALDATE"><strong><code>$MSGLOCALDATE$</code></strong></a></td>
184<td>Local date of current message.</td>
185</tr>
186<tr valign=top>
187<td align=center><a name="MSGNUM" href="../rcvars.html#MSGNUM"><strong><code>$MSGNUM$</code></strong></a></td>
188<td>The message number assigned to the message by MHonArc (includes leading zeros).</td>
189</tr>
190<tr valign=top>
191<td align=center><a name="MSGPREFIX" href="../rcvars.html#MSGPREFIX"><strong><code>$MSGPREFIX$</code></strong></a></td>
192<td>Filename prefix for message files.</td>
193</tr>
194<tr valign=top>
195<td align=center><a name="MSGTORDNUM" href="../rcvars.html#MSGTORDNUM"><strong><code>$MSGTORDNUM$</code></strong></a></td>
196<td>The ordinal message number of the current discussion thread.</td>
197</tr>
198<tr valign=top>
199<td align=center><a name="NOTE" href="../rcvars.html#NOTE"><strong><code>$NOTE$</code></strong></a></td>
200<td>Message annotation.</td>
201</tr>
202<tr valign=top>
203<td align=center><a name="NUMFOLUP" href="../rcvars.html#NUMFOLUP"><strong><code>$NUMFOLUP$</code></strong></a></td>
204<td>Number of explicit follow-ups to the message.</td>
205</tr>
206<tr valign=top>
207<td align=center><a name="NUMOFMSG" href="../rcvars.html#NUMOFMSG"><strong><code>$NUMOFMSG$</code></strong></a></td>
208<td>Number of messages in the archive.</td>
209</tr>
210<tr valign=top>
211<td align=center><a name="NUMOFPAGES" href="../rcvars.html#NUMOFPAGES"><strong><code>$NUMOFPAGES$</code></strong></a></td>
212<td>Number of index pages.</td>
213</tr>
214<tr valign=top>
215<td align=center><a name="ORDNUM" href="../rcvars.html#ORDNUM"><strong><code>$ORDNUM$</code></strong></a></td>
216<td>The current listing number of the message.</td>
217</tr>
218<tr valign=top>
219<td align=center><a name="OUTDIR" href="../rcvars.html#OUTDIR"><strong><code>$OUTDIR$</code></strong></a></td>
220<td>Pathname of archive.</td>
221</tr>
222<tr valign=top>
223<td align=center><a name="PROG" href="../rcvars.html#PROG"><strong><code>$PROG$</code></strong></a></td>
224<td>Program name</td>
225</tr>
226<tr valign=top>
227<td align=center><a name="SUBJECT" href="../rcvars.html#SUBJECT"><strong><code>$SUBJECT$</code></strong></a></td>
228<td>The subject text of the message, and if no arguments, wrapped in an anchor element that hyperlinks to the message.</td>
229</tr>
230<tr valign=top>
231<td align=center><a name="SUBJECTNA" href="../rcvars.html#SUBJECTNA"><strong><code>$SUBJECTNA$</code></strong></a></td>
232<td>The subject text of the message without the anchor element.</td>
233</tr>
234<tr valign=top>
235<td align=center><a name="TIDXFNAME" href="../rcvars.html#TIDXFNAME"><strong><code>$TIDXFNAME$</code></strong></a></td>
236<td>Filename of thread index page.</td>
237</tr>
238<tr valign=top>
239<td align=center><a name="TIDXLABEL" href="../rcvars.html#TIDXLABEL"><strong><code>$TIDXLABEL$</code></strong></a></td>
240<td>Label for thread index page.</td>
241</tr>
242<tr valign=top>
243<td align=center><a name="TIDXPREFIX" href="../rcvars.html#TIDXPREFIX"><strong><code>$TIDXPREFIX$</code></strong></a></td>
244<td>Prefix of filenames of thread index pages.</td>
245</tr>
246<tr valign=top>
247<td align=center><a name="TIDXTITLE" href="../rcvars.html#TIDXTITLE"><strong><code>$TIDXTITLE$</code></strong></a></td>
248<td>Title of thread index.</td>
249</tr>
250<tr valign=top>
251<td align=center><a name="TLEVEL" href="../rcvars.html#TLEVEL"><strong><code>$TLEVEL$</code></strong></a></td>
252<td>Numeric level of message in thread, starting with 0.</td>
253</tr>
254<tr valign=top>
255<td align=center><a name="TSLICE" href="../rcvars.html#TSLICE"><strong><code>$TSLICE$</code></strong></a></td>
256<td>A <em>slice</em> of the thread listing relative to the current message. Size of slice determined by the TSLICE resource.</td>
257</tr>
258<tr valign=top>
259<td align=center><a name="VERSION" href="../rcvars.html#VERSION"><strong><code>$VERSION$</code></strong></a></td>
260<td>Program version.</td>
261</tr>
262<tr valign=top>
263<td align=center><a name="YYYYMMDD" href="../rcvars.html#YYYYMMDD"><strong><code>$YYYYMMDD$</code></strong></a></td>
264<td>Message date in yyyy/mm/dd format.</td>
265</tr>
266</table>
267
268<!-- *************************************************************** -->
269<hr>
270<h2>Examples</h2>
271
272<p>None.
273</p>
274
275<!-- *************************************************************** -->
276<hr>
277<h2>Version</h2>
278
279<p>1.2
280</p>
281
282<!-- *************************************************************** -->
283<hr>
284<h2>See Also</h2>
285
286<p>
287<a href="idxfname.html">IDXFNAME</a>,
288<a href="nextlink.html">NEXTLINK</a>,
289<a href="prevlink.html">PREVLINK</a>,
290<a href="tidxfname.html">TIDXFNAME</a>,
291<a href="tnextlink.html">TNEXTLINK</a>,
292<a href="toplinks.html">TOPLINKS</a>,
293<a href="tprevlink.html">TPREVLINK</a>
294</p>
295<p>
296<a href="../layout.html"><strong>Page Layout</strong></a>
297</p>
298
299<!-- *************************************************************** -->
300<hr>
301<!--x-rc-nav-->
302<table border=0><tr valign="top">
303<td align="left" width="50%">[Prev:&nbsp;<a href="authsort.html">AUTHSORT</a>]</td><td><nobr>[<a href="../resources.html#botlinks">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="charsetconverters.html">CHARSETCONVERTERS</a>]</td></tr></table>
304<!--/x-rc-nav-->
305<hr>
306<address>
307$Date: 2002/07/27 05:13:10 $ <br>
308<img align="top" src="../monicon.png" alt="">
309<a href="http://www.mhonarc.org/"><strong>MHonArc</strong></a><br>
310Copyright &#169; 1997-1998, <a href="http://www.earlhood.com/">Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org">mhonarc@mhonarc.org</a><br>
311</address>
312
313</body>
314</html>
Full OpenSPARC design & verification tarball including full HDL.