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 / toplinks.html
CommitLineData
86530b38
AT		 1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN">
2<html>
3<head>
4<title>MHonArc Resources: TOPLINKS</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="tnexttoplinkia.html">TNEXTTOPLINKIA</a>]</td><td><nobr>[<a href="../resources.html#toplinks">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="tprevbutton.html">TPREVBUTTON</a>]</td></tr></table>
10<!--/x-rc-nav-->
11<hr>
12<h1>TOPLINKS</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;TOPLINKS&gt;<br></code>
28<var>markup ...</var><br>
29<code>&lt;/TOPLINKS&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>TOPLINKS defines the markup for the navigational links at the top
45of a message page. Its usage is analagous to the
46<a href="botlinks.html">BOTLINKS</a> resource, but tends
47to be terser. 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;TopLinks&gt;</b>
62&lt;hr&gt;
63<a href="#BUTTON">$BUTTON(PREV)$</a><a href="#BUTTON">$BUTTON(NEXT)$</a><a href="#BUTTON">$BUTTON(TPREV)$</a><a href="#BUTTON">$BUTTON(TNEXT)$</a>[&lt;a
64href="<a href="#IDXFNAME">$IDXFNAME$</a>#<a href="#MSGNUM">$MSGNUM$</a>"&gt;Date Index&lt;/a&gt;][&lt;a
65href="<a href="#TIDXFNAME">$TIDXFNAME$</a>#<a href="#MSGNUM">$MSGNUM$</a>"&gt;Thread Index&lt;/a&gt;]
66<b>&lt;/TopLinks&gt;</b>
67</pre>
68
69<!-- *************************************************************** -->
70<hr>
71<h2>Resource Variables</h2>
72
73<table border=1>
74<tr bgcolor="#C0C0C0">
75<th>Variable</th><th>Value</th>
76</tr>
77<tr valign=top>
78<td align=center><a name="BUTTON" href="../rcvars.html#BUTTON"><strong><code>$BUTTON$</code></strong></a></td>
79<td>Button markup linking to a message.</td>
80</tr>
81<tr valign=top>
82<td align=center><a name="DATE" href="../rcvars.html#DATE"><strong><code>$DATE$</code></strong></a></td>
83<td>The date of the message.</td>
84</tr>
85<tr valign=top>
86<td align=center><a name="DDMMYYYY" href="../rcvars.html#DDMMYYYY"><strong><code>$DDMMYYYY$</code></strong></a></td>
87<td>Message date in dd/mm/yyyy format.</td>
88</tr>
89<tr valign=top>
90<td align=center><a name="DOCURL" href="../rcvars.html#DOCURL"><strong><code>$DOCURL$</code></strong></a></td>
91<td>URL to documentation.</td>
92</tr>
93<tr valign=top>
94<td align=center><a name="ENV" href="../rcvars.html#ENV"><strong><code>$ENV$</code></strong></a></td>
95<td>Value of an environment variable.</td>
96</tr>
97<tr valign=top>
98<td align=center><a name="FROM" href="../rcvars.html#FROM"><strong><code>$FROM$</code></strong></a></td>
99<td>The complete text in the <tt>From:</tt> field of the message.</td>
100</tr>
101<tr valign=top>
102<td align=center><a name="FROMADDR" href="../rcvars.html#FROMADDR"><strong><code>$FROMADDR$</code></strong></a></td>
103<td>The e-mail address in the <tt>From:</tt> field of the message.</td>
104</tr>
105<tr valign=top>
106<td align=center><a name="FROMADDRDOMAIN" href="../rcvars.html#FROMADDRDOMAIN"><strong><code>$FROMADDRDOMAIN$</code></strong></a></td>
107<td>The e-mail address domain of the <tt>From:</tt> field of the message.</td>
108</tr>
109<tr valign=top>
110<td align=center><a name="FROMADDRNAME" href="../rcvars.html#FROMADDRNAME"><strong><code>$FROMADDRNAME$</code></strong></a></td>
111<td>The e-mail address "username" (or local-part) of the <tt>From:</tt> field of the message.</td>
112</tr>
113<tr valign=top>
114<td align=center><a name="FROMNAME" href="../rcvars.html#FROMNAME"><strong><code>$FROMNAME$</code></strong></a></td>
115<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>
116</tr>
117<tr valign=top>
118<td align=center><a name="GMTDATE" href="../rcvars.html#GMTDATE"><strong><code>$GMTDATE$</code></strong></a></td>
119<td>Current GMT date.</td>
120</tr>
121<tr valign=top>
122<td align=center><a name="ICON" href="../rcvars.html#ICON"><strong><code>$ICON$</code></strong></a></td>
123<td>The context-type sensitive icon.</td>
124</tr>
125<tr valign=top>
126<td align=center><a name="ICONURL" href="../rcvars.html#ICONURL"><strong><code>$ICONURL$</code></strong></a></td>
127<td>The URL to the context-type sensitive icon.</td>
128</tr>
129<tr valign=top>
130<td align=center><a name="IDXFNAME" href="../rcvars.html#IDXFNAME"><strong><code>$IDXFNAME$</code></strong></a></td>
131<td>Filename of main index page.</td>
132</tr>
133<tr valign=top>
134<td align=center><a name="IDXLABEL" href="../rcvars.html#IDXLABEL"><strong><code>$IDXLABEL$</code></strong></a></td>
135<td>Label for main index page.</td>
136</tr>
137<tr valign=top>
138<td align=center><a name="IDXPREFIX" href="../rcvars.html#IDXPREFIX"><strong><code>$IDXPREFIX$</code></strong></a></td>
139<td>Prefix of filenames of main index pages.</td>
140</tr>
141<tr valign=top>
142<td align=center><a name="IDXSIZE" href="../rcvars.html#IDXSIZE"><strong><code>$IDXSIZE$</code></strong></a></td>
143<td>Max number of messages that may be listed in index page.</td>
144</tr>
145<tr valign=top>
146<td align=center><a name="IDXTITLE" href="../rcvars.html#IDXTITLE"><strong><code>$IDXTITLE$</code></strong></a></td>
147<td>The title of the main index page.</td>
148</tr>
149<tr valign=top>
150<td align=center><a name="LINK" href="../rcvars.html#LINK"><strong><code>$LINK$</code></strong></a></td>
151<td>Link markup linking to a message.</td>
152</tr>
153<tr valign=top>
154<td align=center><a name="LOCALDATE" href="../rcvars.html#LOCALDATE"><strong><code>$LOCALDATE$</code></strong></a></td>
155<td>Current local date.</td>
156</tr>
157<tr valign=top>
158<td align=center><a name="MMDDYYYY" href="../rcvars.html#MMDDYYYY"><strong><code>$MMDDYYYY$</code></strong></a></td>
159<td>Message date in mm/dd/yyyy format.</td>
160</tr>
161<tr valign=top>
162<td align=center><a name="MSG" href="../rcvars.html#MSG"><strong><code>$MSG$</code></strong></a></td>
163<td>Filename of message.</td>
164</tr>
165<tr valign=top>
166<td align=center><a name="MSGGMTDATE" href="../rcvars.html#MSGGMTDATE"><strong><code>$MSGGMTDATE$</code></strong></a></td>
167<td>GMT date of current message.</td>
168</tr>
169<tr valign=top>
170<td align=center><a name="MSGID" href="../rcvars.html#MSGID"><strong><code>$MSGID$</code></strong></a></td>
171<td>The message-id of the message.</td>
172</tr>
173<tr valign=top>
174<td align=center><a name="MSGLOCALDATE" href="../rcvars.html#MSGLOCALDATE"><strong><code>$MSGLOCALDATE$</code></strong></a></td>
175<td>Local date of current message.</td>
176</tr>
177<tr valign=top>
178<td align=center><a name="MSGNUM" href="../rcvars.html#MSGNUM"><strong><code>$MSGNUM$</code></strong></a></td>
179<td>The message number assigned to the message by MHonArc (includes leading zeros).</td>
180</tr>
181<tr valign=top>
182<td align=center><a name="MSGPREFIX" href="../rcvars.html#MSGPREFIX"><strong><code>$MSGPREFIX$</code></strong></a></td>
183<td>Filename prefix for message files.</td>
184</tr>
185<tr valign=top>
186<td align=center><a name="MSGTORDNUM" href="../rcvars.html#MSGTORDNUM"><strong><code>$MSGTORDNUM$</code></strong></a></td>
187<td>The ordinal message number of the current discussion thread.</td>
188</tr>
189<tr valign=top>
190<td align=center><a name="NOTE" href="../rcvars.html#NOTE"><strong><code>$NOTE$</code></strong></a></td>
191<td>Message annotation.</td>
192</tr>
193<tr valign=top>
194<td align=center><a name="NUMFOLUP" href="../rcvars.html#NUMFOLUP"><strong><code>$NUMFOLUP$</code></strong></a></td>
195<td>Number of explicit follow-ups to the message.</td>
196</tr>
197<tr valign=top>
198<td align=center><a name="NUMOFMSG" href="../rcvars.html#NUMOFMSG"><strong><code>$NUMOFMSG$</code></strong></a></td>
199<td>Number of messages in the archive.</td>
200</tr>
201<tr valign=top>
202<td align=center><a name="NUMOFPAGES" href="../rcvars.html#NUMOFPAGES"><strong><code>$NUMOFPAGES$</code></strong></a></td>
203<td>Number of index pages.</td>
204</tr>
205<tr valign=top>
206<td align=center><a name="ORDNUM" href="../rcvars.html#ORDNUM"><strong><code>$ORDNUM$</code></strong></a></td>
207<td>The current listing number of the message.</td>
208</tr>
209<tr valign=top>
210<td align=center><a name="OUTDIR" href="../rcvars.html#OUTDIR"><strong><code>$OUTDIR$</code></strong></a></td>
211<td>Pathname of archive.</td>
212</tr>
213<tr valign=top>
214<td align=center><a name="PROG" href="../rcvars.html#PROG"><strong><code>$PROG$</code></strong></a></td>
215<td>Program name</td>
216</tr>
217<tr valign=top>
218<td align=center><a name="SUBJECT" href="../rcvars.html#SUBJECT"><strong><code>$SUBJECT$</code></strong></a></td>
219<td>The subject text of the message, and if no arguments, wrapped in an anchor element that hyperlinks to the message.</td>
220</tr>
221<tr valign=top>
222<td align=center><a name="SUBJECTNA" href="../rcvars.html#SUBJECTNA"><strong><code>$SUBJECTNA$</code></strong></a></td>
223<td>The subject text of the message without the anchor element.</td>
224</tr>
225<tr valign=top>
226<td align=center><a name="TIDXFNAME" href="../rcvars.html#TIDXFNAME"><strong><code>$TIDXFNAME$</code></strong></a></td>
227<td>Filename of thread index page.</td>
228</tr>
229<tr valign=top>
230<td align=center><a name="TIDXLABEL" href="../rcvars.html#TIDXLABEL"><strong><code>$TIDXLABEL$</code></strong></a></td>
231<td>Label for thread index page.</td>
232</tr>
233<tr valign=top>
234<td align=center><a name="TIDXPREFIX" href="../rcvars.html#TIDXPREFIX"><strong><code>$TIDXPREFIX$</code></strong></a></td>
235<td>Prefix of filenames of thread index pages.</td>
236</tr>
237<tr valign=top>
238<td align=center><a name="TIDXTITLE" href="../rcvars.html#TIDXTITLE"><strong><code>$TIDXTITLE$</code></strong></a></td>
239<td>Title of thread index.</td>
240</tr>
241<tr valign=top>
242<td align=center><a name="TLEVEL" href="../rcvars.html#TLEVEL"><strong><code>$TLEVEL$</code></strong></a></td>
243<td>Numeric level of message in thread, starting with 0.</td>
244</tr>
245<tr valign=top>
246<td align=center><a name="TSLICE" href="../rcvars.html#TSLICE"><strong><code>$TSLICE$</code></strong></a></td>
247<td>A <em>slice</em> of the thread listing relative to the current message. Size of slice determined by the TSLICE resource.</td>
248</tr>
249<tr valign=top>
250<td align=center><a name="VERSION" href="../rcvars.html#VERSION"><strong><code>$VERSION$</code></strong></a></td>
251<td>Program version.</td>
252</tr>
253<tr valign=top>
254<td align=center><a name="YYYYMMDD" href="../rcvars.html#YYYYMMDD"><strong><code>$YYYYMMDD$</code></strong></a></td>
255<td>Message date in yyyy/mm/dd format.</td>
256</tr>
257</table>
258
259<!-- *************************************************************** -->
260<hr>
261<h2>Examples</h2>
262
263<p>The following shows an example of using button icons for
264links to the index pages:
265</p>
266
267<pre>
268<b>&lt;TopLinks&gt;</b>
269&lt;hr&gt;
270<a href="#BUTTON">$BUTTON(PREV)$</a><a href="#BUTTON">$BUTTON(NEXT)$</a><a href="#BUTTON">$BUTTON(TPREV)$</a><a href="#BUTTON">$BUTTON(TNEXT)$</a>&lt;a
271href="<a href="#IDXFNAME">$IDXFNAME$</a>#<a href="#MSGNUM">$MSGNUM$</a>"&gt;&lt;img
272src="dateidx.png" alt="[Date Index]"&gt;&lt;/a&gt;&lt;a
273href="<a href="#TIDXFNAME">$TIDXFNAME$</a>#<a href="#MSGNUM">$MSGNUM$</a>"&gt;&lt;img
274src="thrdidx.png" alt="[Thread Index]"&gt;&lt;/a&gt;]
275<b>&lt;/TopLinks&gt;</b>
276</pre>
277
278<!-- *************************************************************** -->
279<hr>
280<h2>Version</h2>
281
282<p>1.2
283</p>
284
285<!-- *************************************************************** -->
286<hr>
287<h2>See Also</h2>
288
289<p>
290
291<a href="botlinks.html">BOTLINKS</a>,
292<a href="idxfname.html">IDXFNAME</a>,
293<a href="nextbutton.html">NEXTBUTTON</a>,
294<a href="prevbutton.html">PREVBUTTON</a>,
295<a href="tidxfname.html">TIDXFNAME</a>,
296<a href="tnextbutton.html">TNEXTBUTTON</a>,
297<a href="tprevbutton.html">TPREVBUTTON</a>
298</p>
299
300<!-- *************************************************************** -->
301<hr>
302<!--x-rc-nav-->
303<table border=0><tr valign="top">
304<td align="left" width="50%">[Prev:&nbsp;<a href="tnexttoplinkia.html">TNEXTTOPLINKIA</a>]</td><td><nobr>[<a href="../resources.html#toplinks">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="tprevbutton.html">TPREVBUTTON</a>]</td></tr></table>
305<!--/x-rc-nav-->
306<hr>
307<address>
308$Date: 2002/07/27 05:13:11 $ <br>
309<img align="top" src="../monicon.png" alt="">
310<a href="http://www.mhonarc.org/"><strong>MHonArc</strong></a><br>
311Copyright &#169; 1997-1998, <a href="http://www.earlhood.com/">Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org">mhonarc@mhonarc.org</a><br>
312</address>
313
314</body>
315</html>
Full OpenSPARC design & verification tarball including full HDL.