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 / rcvars.html
CommitLineData
86530b38
AT		 1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN">
2<html>
3<head>
4<title>MHonArc v2.5 -- Resource Variables</title>
5</head>
6<!--
7<BODY background="ssbg75.jpg"
8 text="#000000" link="#0000ee" vlink="#551a8b" alink="ff0000">
9-->
10<BODY>
11
12<!--X-NavButtons-Start-->
13<table width="100%">
14<tr valign="top">
15<td align="left"><nobr><a href="resources.html"><img src="prev.png"border=0 alt="[Prev]"></a>&nbsp;&nbsp;&nbsp;</nobr></td><td align="center" width="99%"><a href="mhonarc.html"><img src="up.png" border=0 alt="[TOC]"></a><a href="faq/faq.html"><img src="faq.png" border=0 alt="[FAQ]"></a><a href="app-bugs.html"><img src="bug.png" border=0 alt="[Bugs]"></a><a href="http://www.mhonarc.org/"><img src="home.png" border=0 alt="[Home]"></a></td><td align="right"><nobr>&nbsp;&nbsp;&nbsp;<a href="contacts.html"><img src="next.png" border=0 alt="[Next]"></a></nobr></td></tr></table>
16<!--X-NavButtons-End-->
17<hr>
18<h1><a name="rcvars">Resource Variables</a></h1>
19
20<!--X-TOC-Start-->
21<ul>
22<li><a href="#overview">Overview</a>
23<li><a href="#rcvar_syntax">Resource Variable Syntax</a>
24<li><a href="#rcvar_index">Resource Variable Index</a>
25<ul>
26<li><small><a href="#variables">Variables</a></small>
27</ul>
28</ul>
29<!--X-TOC-End-->
30
31<hr>
32<h2><a name="overview">Overview</a></h2>
33<p><em>Resource variables</em> are used to represent dynamic data
34in MHonArc <a href="resources.html">resources</a>. Take the following
35<a href="resources/litemplate.html">LITEMPLATE</a> resource setting
36for example:
37</p>
38
39<PRE>
40&lt;LiTemplate&gt;
41&lt;li&gt;&lt;strong&gt;<b>$SUBJECT$</b>&lt;/strong&gt;
42&lt;ul&gt;&lt;li&gt;&lt;em&gt;From&lt;/em&gt;: <b>$FROM$</b>&lt;/li&gt;&lt;/ul&gt;
43&lt;/li&gt;
44&lt;/LiTemplate&gt;
45</PRE>
46
47<p>The LITEMPLATE resource defines how each message listing is displayed
48in the main index page. The <tt>$SUBJECT$</tt> and
49<tt>$FROM$</tt> are resource
50variables. <tt>$SUBJECT$</tt> will get expanded to the current message's
51subject, hyperlinked to the message page.
52<tt>$FROM$</tt> will be replaced with
53the message's author's name and address.
54</p>
55
56<p>Some resource variables take arguments. Take the following
57<a href="resources/nextlink.html">NEXTLINK</a> resource setting for
58example:
59
60<pre>
61&lt;li&gt;Next by Date:
62&lt;strong&gt;&lt;a href="<b>$MSG(NEXT)$</b>"&gt;<b>$SUBJECT(NEXT)$</b>&lt;/a&gt;&lt;/strong&gt;
63&lt;/li&gt;
64</pre>
65
66<p>The resource setting uses two resource variables: <tt>$MSG$</tt> and
67<tt>$SUBJECT$</tt>.
68However, an argument is given to each resource variable
69delimited by <b><tt>(&nbsp;)</tt></b>.
70<tt>$SUBJECT$</tt> will get expanded to the current message's
71subject<SUP><a href="#note1">[*]</a></SUP>.
72With the "<tt>NEXT</tt>" argument,
73we are instructing MHonArc to use the <em>next</em> message's
74subject. <tt>$MSG(NEXT)$</tt> will get expanded to the next message's
75filename. Therefore, the above resource value is creating a link to
76the next message in the archive.
77</p>
78
79<table border=0 cellpadding=4>
80<tr valign=top>
81<td><strong><a name="note1">*</a>&nbsp;NOTE</strong></td>
82<td><p>In the two examples given, the replacement value of
83<tt>$SUBJECT$</tt> is different (excluding the variable argument difference).
84For compatibility of older versions of MHonArc, when <tt>$SUBJECT$</tt>
85is used <em>without</em> any arguments, it will be expanded to
86the current message's subject <em>hyperlinked</em> to the current message
87page. If an argument is given to <tt>$SUBJECT$</tt>, then the variable
88will get expanded only to the subject text of the applicable message.
89<strong>NO</strong> hyperlink is automatically created.
90</p>
91</td>
92</tr>
93</table>
94
95
96
97<!-- *************************************************************** -->
98<hr>
99<h2><a name="rcvar_syntax">Resource Variable Syntax</a></h2>
100
101<P>The syntax of resource variables in resources
102is as follows:
103</P>
104
105<pre>
106$<i>VARIABLE</i>[[:[<i>N</i>][U][J]][(<i>arglist</i>)]]$
107 ^----------^^---------^
108 ^-----------------------^
109</pre>
110
111<p>The items in <tt>[]</tt>'s are optional. The "<tt>^---^</tt>" are used to
112highlight the nested optional groupings.
113</p>
114
115<p>Definition of each part: </P>
116
117<dl>
118
119<dt><tt>$</tt></dt>
120<dd><p>The start of a resource variable. Everything (including
121line breaks) up to the
122next <tt>$</tt> is part of the resource variable.
123</p>
124</dd>
125
126<dt><tt><i>VARIABLE</i></tt></dt>
127<dd><p>The name of the variable. Variable names are case-sensitive.
128</p>
129</dd>
130
131<dt><tt>:[<i>N</i>][U][J]</tt> <em>(optional)</em></dt>
132<dd><p>The optional grouping starting with a colon are variable
133modifiers. The definition of each modifier is as follows:
134</p>
135<table border=0 cellpadding=4>
136<tr valign="top">
137 <td><i>N</i></td>
138 <td><p>Length specification. MHonArc will clip the expanded text
139 to <i>N</i> if the text length is greater than <i>N</i>.
140 </p>
141 <table border=0 cellpadding=4>
142 <tr valign=top>
143 <td><strong>NOTE</strong></td>
144 <td>Not all resource variables support clipping.
145 If a length specification is given for these variables, then
146 it will be ignored.
147 </td></tr>
148 </table>
149 <p>How MHonArc clips text is determined by the
150 <a href="resources/textclipfunc.html">TEXTCLIPFUNC</a> resource.
151 </p>
152 </td>
153</tr>
154<tr valign="top">
155 <td><tt>U</tt></td>
156 <td><p>Treat the text as part of a URL string. MHonArc will escape
157 any characters that are considered special in a URL.
158 </p>
159 </td>
160</tr>
161<tr valign="top">
162 <td><tt>J</tt></td>
163 <td><p>Treat the text as a JavaScript string. MHonArc will escape
164 any quote characters so the text can be part of a JavaScript
165 string.
166 </p>
167 </td>
168</tr>
169</table>
170</dd>
171
172<dt><tt>(<i>arglist</i>)</tt> <em>(optional)</em></dt>
173<dd>An optional argument list delimited by parentheses: <tt>(&nbsp;)</tt>.
174Some resource variables can take arguments which modify how the
175variable is expanded. If a variable can
176take more than one argument, each argument will be separated by
177a semi-colon. For example: <tt>$MSGLOCALDATE(NEXT;%H:%M)$</tt>.
178In the example, there are two arguments to the <tt>$MSGLOCALDATE$</tt>
179variable: "<tt>NEXT</tt>" and "<tt>%H:%M</tt>".
180</dd>
181
182<dt><tt>$</tt></dt>
183<dd><p>The end of a resource variable.
184</p>
185</dd>
186</dl>
187
188<p>If an unrecognized variable is encountered, it gets replaced with an
189empty string, and a warning is generated. If a literal "<tt>$</tt>"
190is needed, use "<tt>$$</tt>".
191</p>
192
193<table border=0 cellpadding=4>
194<tr valign=top>
195<td><strong>NOTE</strong></td>
196<td><p>The
197<a href="resources/mailtourl.html">MAILTOURL</a>
198resource has
199different rules for variable expansion. If a
200variable does not exactly match the set of variables available for
201the MAILTOURL, the variable text will be taken literally
202as part of the element content. Therefore, a single "<tt>$</tt>"
203can be used to represent a "<tt>$</tt>" character. </p>
204<p>Also,
205variables in the MAILTOURL should <STRONG>NOT</STRONG>
206have "<tt>:<i>N</i>UJ</tt>" modifiers. This will prevent the
207variables from being recognized. MHonArc will automatically
208treat the replacement value as a part of a URL string.
209</p>
210</td></tr>
211</table>
212
213
214
215<!-- *************************************************************** -->
216<hr>
217<h2><a name="rcvar_index">Resource Variable Index</a></h2>
218
219<p>This sections lists all the resource variables supported by MHonArc.
220Since many resource variables can take arguments, the following notations
221are used to represent argument values:
222</p>
223
224<dl>
225
226<dt><a name="mesg_spec"><b><i><tt>mesg_spec</tt></i></b></a></dt>
227<dd><p>A message specification determines which message the variable's
228expanded will be based upon. Possible values are:
229</p>
230<table border=0>
231<tr valign=top>
232<th align=right>Value&nbsp;-</th><th align=left>Meaning</th>
233</tr>
234<tr valign=top>
235<td align=right><tt>CUR</tt>&nbsp;-</td>
236 <td>Current message.</td>
237</tr>
238<tr valign=top>
239<td align=right><tt>FIRST</tt>&nbsp;-</td>
240 <td>First message listed in main index.</td>
241</tr>
242<tr valign=top>
243<td align=right><tt>LAST</tt>&nbsp;-</td>
244 <td>Last message listed in main index.</td>
245</tr>
246<tr valign=top>
247<td align=right><tt>NEXT</tt>&nbsp;-</td>
248 <td>Next message by main sort order.</td>
249</tr>
250<tr valign=top>
251<td align=right><tt>PREV</tt>&nbsp;-</td>
252 <td>Previous message by main sort order.</td>
253</tr>
254<tr valign=top>
255<td align=right><tt>TEND</tt>&nbsp;-</td>
256 <td>Last message of current discussion thread.</td>
257</tr>
258<tr valign=top>
259<td align=right><tt>TFIRST</tt>&nbsp;-</td>
260 <td>First message listed thread index.</td>
261</tr>
262<tr valign=top>
263<td align=right><tt>TLAST</tt>&nbsp;-</td>
264 <td>Last message listed thread index.</td>
265</tr>
266<tr valign=top>
267<td align=right><tt>TNEXT</tt>&nbsp;-</td>
268 <td>Next message by thread.</td>
269</tr>
270<tr valign=top>
271<td align=right><tt>TNEXTIN</tt>&nbsp;-</td>
272 <td>Next message within current thread. This differs from
273 <tt>TNEXT</tt> in that it does not cross discussion thread boundaries.</td>
274</tr>
275<tr valign=top>
276<td align=right><tt>TNEXTTOP</tt>&nbsp;-</td>
277 <td>First message of next discussion thread.</td>
278</tr>
279<tr valign=top>
280<td align=right><tt>TPARENT</tt>&nbsp;-</td>
281 <td>Parent message of current thread.</td>
282</tr>
283<tr valign=top>
284<td align=right><tt>TPREV</tt>&nbsp;-</td>
285 <td>Previous message by thread.</td>
286</tr>
287<tr valign=top>
288<td align=right><tt>TPREVIN</tt>&nbsp;-</td>
289 <td>Previous message within current thread. This differs from
290 <tt>TPREV</tt> in that it does not cross discussion thread boundaries.</td>
291</tr>
292<tr valign=top>
293<td align=right><tt>TPREVTOP</tt>&nbsp;-</td>
294 <td>First message of previous discussion thread.</td>
295</tr>
296<tr valign=top>
297<td align=right><tt>TTOP</tt>&nbsp;-</td>
298 <td>Top/root message of current discussion thread.</td>
299</tr>
300</table>
301<p>"<tt>CUR</tt>" is the default if nothing is specified for
302<i><tt>mesg_spec</tt></i>.
303</p>
304</dd>
305
306
307<dt><a name="idx_page_spec"><b><i><tt>idx_page_spec</tt></i></b></a></dt>
308<dd><p>An index page specification denoting the index page to use
309when determing the value of the variable. The possible values are:
310</p>
311<table border=0>
312<tr valign=top>
313<th align=right>Value</th><th align=left>- Meaning</th>
314</tr>
315<tr valign=top>
316<td align=right><tt>FIRST</tt></td><td>- First page of main index.</td>
317</tr>
318<tr valign=top>
319<td align=right><tt>LAST</tt></td><td>- Last page of main index.</td>
320</tr>
321<tr valign=top>
322<td align=right><tt>NEXT</tt></td><td>- Next page of main index.</td>
323</tr>
324<tr valign=top>
325<td align=right><tt>PREV</tt></td><td>- Previous page of main index.</td>
326</tr>
327<tr valign=top>
328<td align=right><tt>TFIRST</tt></td><td>- First page of thread index.</td>
329</tr>
330<tr valign=top>
331<td align=right><tt>TLAST</tt></td><td>- Last page of thread index.</td>
332</tr>
333<tr valign=top>
334<td align=right><tt>TNEXT</tt></td><td>- Next page of thread index.</td>
335</tr>
336<tr valign=top>
337<td align=right><tt>TPREV</tt></td><td>- Previous page of thread index.</td>
338</tr>
339</table>
340<p>If no value is given for <i><tt>idx_page_spec</tt></i>, the resource
341variable's value is undefined.
342</p>
343</dd>
344
345<dt><a name="time_fmt_str"><b><i><tt>time_fmt_str</tt></i></b></a></dt>
346<dd><p>A time format string specifies how a date/time will be
347printed for a date/time related variable. The syntax of the format
348string is the same as the conversion specification as defined in
349the <a href="resources/gmtdatefmt.html">GMTDATEFMT</a> and
350<a href="resources/localdatefmt.html">LOCALDATEFMT</a> resources.
351</p>
352</dd>
353
354</dl>
355
356<h3><a name="variables">Variables</a></h3>
357
358<!--X-Variable-Index-Start-->
359<dl>
360<dt><strong><a name="A_ATTR"><tt>$A_ATTR$</tt></a></strong></dt>
361<dd><table border=0>
362<tr valign=top>
363<td align=right><b>Arguments:</b></td>
364<td>N/A</td>
365</tr>
366<tr valign=top>
367<td align=right><b>Description:</b></td>
368<td>The <tt>NAME</tt> and <tt>HREF</tt> attributes to use in an anchor
369to link to the archived message.
370The <tt>NAME</tt> attribute provides a destination location when a message
371links to the index page. This resource variable is equivalent to
372"<nobr><tt><a href="#A_NAME">$A_NAME$</a>&nbsp;<a href="#A_HREF">$A_HREF$</a></tt></nobr>".
373</td>
374</tr>
375</table><br></dd>
376<dt><strong><a name="A_HREF"><tt>$A_HREF$</tt></a></strong></dt>
377<dd><table border=0>
378<tr valign=top>
379<td align=right><b>Arguments:</b></td>
380<td>N/A</td>
381</tr>
382<tr valign=top>
383<td align=right><b>Description:</b></td>
384<td>The <tt>HREF</tt> attribute to use in an anchor to link to the
385archived message.
386This variable is equivalent to
387"<tt>href="<a href="#MSG">$MSG$</a>"</tt>".
388</td>
389</tr>
390</table><br></dd>
391<dt><strong><a name="A_NAME"><tt>$A_NAME$</tt></a></strong></dt>
392<dd><table border=0>
393<tr valign=top>
394<td align=right><b>Arguments:</b></td>
395<td>N/A</td>
396</tr>
397<tr valign=top>
398<td align=right><b>Description:</b></td>
399<td>The <tt>NAME</tt> attribute to use in an anchor for messages to link
400to the index page.
401This variable is equivalent to
402"<tt>name="<a href="#MSGNUM">$MSGNUM$</a>"</tt>".
403</td>
404</tr>
405</table><br></dd>
406<dt><strong><a name="BUTTON"><tt>$BUTTON$</tt></a></strong></dt>
407<dd><table border=0>
408<tr valign=top>
409<td align=right><b>Arguments:</b></td>
410<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
411</tr>
412<tr valign=top>
413<td align=right><b>Description:</b></td>
414<td>Button markup linking to a message. The value of <tt>$BUTTON$</tt>
415is determined by the following resources based on
416<tt><i><a href="#mesg_spec">mesg_spec</a></i></tt> value:
417<a href="resources/nextbutton.html">NEXTBUTTON</a>,
418<a href="resources/nextbuttonia.html">NEXTBUTTONIA</a>,
419<a href="resources/prevbutton.html">PREVBUTTON</a>,
420<a href="resources/prevbuttonia.html">PREVBUTTONIA</a>,
421<a href="resources/tnextbutton.html">TNEXTBUTTON</a>,
422<a href="resources/tnextbuttonia.html">TNEXTBUTTONIA</a>,
423<a href="resources/tnextinbutton.html">TNEXTINBUTTON</a>,
424<a href="resources/tnextinbuttonia.html">TNEXTINBUTTONIA</a>,
425<a href="resources/tnexttopbutton.html">TNEXTTOPBUTTON</a>,
426<a href="resources/tnexttopbuttonia.html">TNEXTTOPBUTTONIA</a>,
427<a href="resources/tprevbutton.html">TPREVBUTTON</a>,
428<a href="resources/tprevbuttonia.html">TPREVBUTTONIA</a>,
429<a href="resources/tprevinbutton.html">TPREVINBUTTON</a>,
430<a href="resources/tprevinbuttonia.html">TPREVINBUTTONIA</a>,
431<a href="resources/tprevtopbutton.html">TPREVTOPBUTTON</a>,
432<a href="resources/tprevtopbuttonia.html">TPREVTOPBUTTONIA</a>.
433</td>
434</tr>
435</table><br></dd>
436<dt><strong><a name="DATE"><tt>$DATE$</tt></a></strong></dt>
437<dd><table border=0>
438<tr valign=top>
439<td align=right><b>Arguments:</b></td>
440<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
441</tr>
442<tr valign=top>
443<td align=right><b>Description:</b></td>
444<td>The date of the message.</td>
445</tr>
446</table><br></dd>
447<dt><strong><a name="DDMMYYYY"><tt>$DDMMYYYY$</tt></a></strong></dt>
448<dd><table border=0>
449<tr valign=top>
450<td align=right><b>Arguments:</b></td>
451<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
452</tr>
453<tr valign=top>
454<td align=right><b>Description:</b></td>
455<td>Message date (according to local time) in dd/mm/yyyy format.</td>
456</tr>
457</table><br></dd>
458<dt><strong><a name="DOCURL"><tt>$DOCURL$</tt></a></strong></dt>
459<dd><table border=0>
460<tr valign=top>
461<td align=right><b>Arguments:</b></td>
462<td>N/A</td>
463</tr>
464<tr valign=top>
465<td align=right><b>Description:</b></td>
466<td>URL to MHonArc documentation. Value of variable set by the
467<a href="resources/docurl.html">DOCURL</a> resource.</td>
468</tr>
469</table><br></dd>
470<dt><strong><a name="ENV"><tt>$ENV$</tt></a></strong></dt>
471<dd><table border=0>
472<tr valign=top>
473<td align=right><b>Arguments:</b></td>
474<td><tt><i>variable_name</i></tt></td>
475</tr>
476<tr valign=top>
477<td align=right><b>Description:</b></td>
478<td>The value of the environment variable specified by <i>variable_name</i>.
479For example, <tt>$ENV(HOME)$</tt> would expand to the value of the
480HOME environment variable.</td>
481</tr>
482</table><br></dd>
483<dt><strong><a name="FROM"><tt>$FROM$</tt></a></strong></dt>
484<dd><table border=0>
485<tr valign=top>
486<td align=right><b>Arguments:</b></td>
487<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
488</tr>
489<tr valign=top>
490<td align=right><b>Description:</b></td>
491<td>The complete text in the <tt>From:</tt> field of the message.</td>
492</tr>
493</table><br></dd>
494<dt><strong><a name="FROMADDR"><tt>$FROMADDR$</tt></a></strong></dt>
495<dd><table border=0>
496<tr valign=top>
497<td align=right><b>Arguments:</b></td>
498<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
499</tr>
500<tr valign=top>
501<td align=right><b>Description:</b></td>
502<td>The full mail address in the <tt>From:</tt> field of the message.</td>
503</tr>
504</table><br></dd>
505<dt><strong><a name="FROMADDRNAME"><tt>$FROMADDRNAME$</tt></a></strong></dt>
506<dd><table border=0>
507<tr valign=top>
508<td align=right><b>Arguments:</b></td>
509<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
510</tr>
511<tr valign=top>
512<td align=right><b>Description:</b></td>
513<td>The username/local-part of the mail address in the <tt>From:</tt>
514field of the message. For example, given the address "someuser@mhonarc.org",
515<tt>$FROMADDRNAME$</tt> would equal "someuser".</td>
516</tr>
517</table><br></dd>
518<dt><strong><a name="FROMADDR"><tt>$FROMADDRDOMAIN$</tt></a></strong></dt>
519<dd><table border=0>
520<tr valign=top>
521<td align=right><b>Arguments:</b></td>
522<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
523</tr>
524<tr valign=top>
525<td align=right><b>Description:</b></td>
526<td>The domain part of the mail address in the <tt>From:</tt>
527field of the message. For example, given the address "someuser@mhonarc.org",
528<tt>$FROMADDRDOMAIN$</tt> would equal "mhonarc.org".</td>
529</tr>
530</table><br></dd>
531<dt><strong><a name="FROMNAME"><tt>$FROMNAME$</tt></a></strong></dt>
532<dd><table border=0>
533<tr valign=top>
534<td align=right><b>Arguments:</b></td>
535<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
536</tr>
537<tr valign=top>
538<td align=right><b>Description:</b></td>
539<td>The human name of the person in the <tt>From:</tt> field of the message.
540If no human name is found, the local-part specified in the mail address
541is used.</td>
542</tr>
543</table><br></dd>
544<dt><strong><a name="GMTDATE"><tt>$GMTDATE$</tt></a></strong></dt>
545<dd><table border=0>
546<tr valign=top>
547<td align=right><b>Arguments:</b></td>
548<td><tt><i><a href="#time_fmt_str">time_fmt_str</a></i></tt></td>
549</tr>
550<tr valign=top>
551<td align=right><b>Description:</b></td>
552<td>Current GMT date.
553Default format of date set by the
554<a href="resources/gmtdatefmt.html">GMTDATEFMT</a>
555resource.
556</td>
557</tr>
558</table><br></dd>
559<dt><strong><a name="ICON"><tt>$ICON$</tt></a></strong></dt>
560<dd><table border=0>
561<tr valign=top>
562<td align=right><b>Arguments:</b></td>
563<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
564</tr>
565<tr valign=top>
566<td align=right><b>Description:</b></td>
567<td>The context-type sensistive icon. The type of icon displayed
568is determined by the <a href="resources/icons.html">ICONS</a> resource.</td>
569</tr>
570</table><br></dd>
571<dt><strong><a name="ICONURL"><tt>$ICONURL$</tt></a></strong></dt>
572<dd><table border=0>
573<tr valign=top>
574<td align=right><b>Arguments:</b></td>
575<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
576</tr>
577<tr valign=top>
578<td align=right><b>Description:</b></td>
579<td>The URL to the context-type sensistive icon. The URL value is
580determined by the <a href="resources/icons.html">ICONS</a> resource.</td>
581</tr>
582</table><br></dd>
583<dt><strong><a name="IDXFNAME"><tt>$IDXFNAME$</tt></a></strong></dt>
584<dd><table border=0>
585<tr valign=top>
586<td align=right><b>Arguments:</b></td>
587<td>N/A</td>
588</tr>
589<tr valign=top>
590<td align=right><b>Description:</b></td>
591<td>Filename of main index page. The value is set by the
592<a href="resources/idxfname.html">IDXFNAME</a> or
593<a href="resources/idxprefix.html">IDXPREFIX</a> and
594<a href="resources/htmlext.html">HTMLEXT</a>
595resources. If the first page, IDXFNAME is used. For other pages,
596the filename is <var>IDXPREFIXpage-number</var><tt>.</tt><var>HTMLEXT</var>.
597</td>
598</tr>
599</table><br></dd>
600<dt><strong><a name="IDXLABEL"><tt>$IDXLABEL$</tt></a></strong></dt>
601<dd><table border=0>
602<tr valign=top>
603<td align=right><b>Arguments:</b></td>
604<td>N/A</td>
605</tr>
606<tr valign=top>
607<td align=right><b>Description:</b></td>
608<td>Label for main index page. Value set by the
609<a href="resources/idxlabel.html">IDXLABEL</a> resource.</td>
610</tr>
611</table><br></dd>
612<dt><strong><a name="IDXPREFIX"><tt>$IDXPREFIX$</tt></a></strong></dt>
613<dd><table border=0>
614<tr valign=top>
615<td align=right><b>Arguments:</b></td>
616<td>N/A</td>
617</tr>
618<tr valign=top>
619<td align=right><b>Description:</b></td>
620<td>Prefix of filenames of main index pages.
621Value set by the <a href="resources/idxprefix.html">IDXPREFIX</a> resource.
622</td>
623</tr>
624</table><br></dd>
625<dt><strong><a name="IDXSIZE"><tt>$IDXSIZE$</tt></a></strong></dt>
626<dd><table border=0>
627<tr valign=top>
628<td align=right><b>Arguments:</b></td>
629<td>N/A</td>
630</tr>
631<tr valign=top>
632<td align=right><b>Description:</b></td>
633<td>Max number of messages that may be listed in index page.
634Value set by the <a href="resources/idxsize.html">IDXSIZE</a> resource.
635</td>
636</tr>
637</table><br></dd>
638<dt><strong><a name="IDXTITLE"><tt>$IDXTITLE$</tt></a></strong></dt>
639<dd><table border=0>
640<tr valign=top>
641<td align=right><b>Arguments:</b></td>
642<td>N/A</td>
643</tr>
644<tr valign=top>
645<td align=right><b>Description:</b></td>
646<td>The title of the main index page.
647Value set by the <a href="resources/title.html">TITLE</a> resource.
648</td>
649</tr>
650</table><br></dd>
651<dt><strong><a name="LINK"><tt>$LINK$</tt></a></strong></dt>
652<dd><table border=0>
653<tr valign=top>
654<td align=right><b>Arguments:</b></td>
655<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
656</tr>
657<tr valign=top>
658<td align=right><b>Description:</b></td>
659<td>Link markup linking to a message.
660The value of <tt>$LINK$</tt> is determined
661by the following resources based on
662<tt><i><a href="#mesg_spec">mesg_spec</a></i></tt> value:
663<a href="resources/nextlink.html">NEXTLINK</a>,
664<a href="resources/nextlinkia.html">NEXTLINKIA</a>,
665<a href="resources/prevlink.html">PREVLINK</a>,
666<a href="resources/prevlinkia.html">PREVLINKIA</a>,
667<a href="resources/tnextlink.html">TNEXTLINK</a>,
668<a href="resources/tnextlinkia.html">TNEXTLINKIA</a>,
669<a href="resources/tnextinlink.html">TNEXTINLINK</a>,
670<a href="resources/tnextinlinkia.html">TNEXTINLINKIA</a>,
671<a href="resources/tnexttoplink.html">TNEXTTOPLINK</a>,
672<a href="resources/tnexttoplinkia.html">TNEXTTOPLINKIA</a>,
673<a href="resources/tprevlink.html">TPREVLINK</a>,
674<a href="resources/tprevlinkia.html">TPREVLINKIA</a>,
675<a href="resources/tprevinlink.html">TPREVINLINK</a>,
676<a href="resources/tprevinlinkia.html">TPREVINLINKIA</a>,
677<a href="resources/tprevtoplink.html">TPREVTOPLINK</a>,
678<a href="resources/tprevtoplinkia.html">TPREVTOPLINKIA</a>.
679</td>
680</tr>
681</table><br></dd>
682<dt><strong><a name="LOCALDATE"><tt>$LOCALDATE$</tt></a></strong></dt>
683<dd><table border=0>
684<tr valign=top>
685<td align=right><b>Arguments:</b></td>
686<td><tt><i><a href="#time_fmt_str">time_fmt_str</a></i></tt></td>
687</tr>
688<tr valign=top>
689<td align=right><b>Description:</b></td>
690<td>Current local date.
691Default format of date set by the
692<a href="resources/localdatefmt.html">LOCALDATEFMT</a>
693resource.
694</td>
695</tr>
696</table><br></dd>
697<dt><strong><a name="MMDDYYYY"><tt>$MMDDYYYY$</tt></a></strong></dt>
698<dd><table border=0>
699<tr valign=top>
700<td align=right><b>Arguments:</b></td>
701<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
702</tr>
703<tr valign=top>
704<td align=right><b>Description:</b></td>
705<td>Message (local) date in mm/dd/yyyy format.</td>
706</tr>
707</table><br></dd>
708<dt><strong><a name="MSG"><tt>$MSG$</tt></a></strong></dt>
709<dd><table border=0>
710<tr valign=top>
711<td align=right><b>Arguments:</b></td>
712<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
713</tr>
714<tr valign=top>
715<td align=right><b>Description:</b></td>
716<td>Filename of message. Filename of the message is determined by the
717following resources:
718<a href="resources/htmlext.html">HTMLEXT</a>,
719<a href="resources/msgprefix.html">MSGPREFIX</a>.
720</td>
721</tr>
722</table><br></dd>
723<dt><strong><a name="MSGGMTDATE"><tt>$MSGGMTDATE$</tt></a></strong></dt>
724<dd><table border=0>
725<tr valign=top>
726<td align=right><b>Arguments:</b></td>
727<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt><br><tt><i><a href="#mesg_spec">mesg_spec</a></i>;<i><a href="#time_fmt_str">time_fmt_str</a></i></tt></td>
728</tr>
729<tr valign=top>
730<td align=right><b>Description:</b></td>
731<td>GMT date of current message.</td>
732</tr>
733</table><br></dd>
734<dt><strong><a name="MSGID"><tt>$MSGID$</tt></a></strong></dt>
735<dd><table border=0>
736<tr valign=top>
737<td align=right><b>Arguments:</b></td>
738<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
739</tr>
740<tr valign=top>
741<td align=right><b>Description:</b></td>
742<td>The message-id of the message.</td>
743</tr>
744</table><br></dd>
745<dt><strong><a name="MSGLOCALDATE"><tt>$MSGLOCALDATE$</tt></a></strong></dt>
746<dd><table border=0>
747<tr valign=top>
748<td align=right><b>Arguments:</b></td>
749<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt><br><tt><i><a href="#mesg_spec">mesg_spec</a></i>;<i><a href="#time_fmt_str">time_fmt_str</a></i></tt></td>
750</tr>
751<tr valign=top>
752<td align=right><b>Description:</b></td>
753<td>Local date of current message.</td>
754</tr>
755</table><br></dd>
756<dt><strong><a name="MSGNUM"><tt>$MSGNUM$</tt></a></strong></dt>
757<dd><table border=0>
758<tr valign=top>
759<td align=right><b>Arguments:</b></td>
760<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
761</tr>
762<tr valign=top>
763<td align=right><b>Description:</b></td>
764<td>The message number assigned to the message by MHonArc (includes leading zeros).</td>
765</tr>
766</table><br></dd>
767<dt><strong><a name="MSGPREFIX"><tt>$MSGPREFIX$</tt></a></strong></dt>
768<dd><table border=0>
769<tr valign=top>
770<td align=right><b>Arguments:</b></td>
771<td>N/A</td>
772</tr>
773<tr valign=top>
774<td align=right><b>Description:</b></td>
775<td>Filename prefix for message files.
776Value set by the
777<a href="resources/msgprefix.html">MSGPREFIX</a>
778resource.
779</td>
780</tr>
781</table><br></dd>
782<dt><strong><a name="MSGTORDNUM"><tt>$MSGTORDNUM$</tt></a></strong></dt>
783<dd><table border=0>
784<tr valign=top>
785<td align=right><b>Arguments:</b></td>
786<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
787</tr>
788<tr valign=top>
789<td align=right><b>Description:</b></td>
790<td>The ordinal message number of the current discussion thread. Numbering
791starts with the first top/root message of a thread and ends with the
792last message of the thread, spanning in sub-threads. The following
793illustrates how the numbering works:
794<pre>
795 <b>1</b>. <var>top/root message</var>
796 <b>2</b>. <var>first follow-up to 1</var>
797 <b>3</b>. <var>first follow-up to 2</var>
798 <b>4</b>. <var>second follow-up to 2</var>
799 <b>5</b>. <var>second follow-up to 1</var>
800 <b>6</b>. <var>first follow-up to 5</var>
801 <b>7</b>. <var>first follow-up to 6</var>
802 <b>8</b>. <var>third follow-up to 1</var>
803</pre>
804The above contains 8 total message in the discussion thread, so numbering
805goes from 1 to 8.
806</td>
807</tr>
808</table><br></dd>
809<dt><strong><a name="NOTE"><tt>$NOTE$</tt></a></strong></dt>
810<dd><table border=0>
811<tr valign=top>
812<td align=right><b>Arguments:</b></td>
813<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
814</tr>
815<tr valign=top>
816<td align=right><b>Description:</b></td>
817<td>Message annotation. If annotation text exists for the message,
818the <a href="resources/note.html">NOTE</a> resource determines the
819value of $NOTE$. When no annotation text is defined,
820<a href="resources/noteia.html">NOTEIA</a> is used.</td>
821</tr>
822</table><br></dd>
823<dt><strong><a name="NOTETEXT"><tt>$NOTETEXT$</tt></a></strong></dt>
824<dd><table border=0>
825<tr valign=top>
826<td align=right><b>Arguments:</b></td>
827<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
828</tr>
829<tr valign=top>
830<td align=right><b>Description:</b></td>
831<td>Base text of message annotation. Variable should be used only
832within the <a href="resource/note.html">NOTE</a> resource.</td>
833</tr>
834</table><br></dd>
835<dt><strong><a name="NUMFOLUP"><tt>$NUMFOLUP$</tt></a></strong></dt>
836<dd><table border=0>
837<tr valign=top>
838<td align=right><b>Arguments:</b></td>
839<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
840</tr>
841<tr valign=top>
842<td align=right><b>Description:</b></td>
843<td>Number of explicit follow-ups to the message. This number does
844<b>NOT</b> include subject-based follow-ups.</td>
845</tr>
846</table><br></dd>
847<dt><strong><a name="NUMOFIDXMSG"><tt>$NUMOFIDXMSG$</tt></a></strong></dt>
848<dd><table border=0>
849<tr valign=top>
850<td align=right><b>Arguments:</b></td>
851<td>N/A</td>
852</tr>
853<tr valign=top>
854<td align=right><b>Description:</b></td>
855<td>Number of message listed for the current page.</td>
856</tr>
857</table><br></dd>
858<dt><strong><a name="NUMOFMSG"><tt>$NUMOFMSG$</tt></a></strong></dt>
859<dd><table border=0>
860<tr valign=top>
861<td align=right><b>Arguments:</b></td>
862<td>N/A</td>
863</tr>
864<tr valign=top>
865<td align=right><b>Description:</b></td>
866<td>Total number of messages in the archive.</td>
867</tr>
868</table><br></dd>
869<dt><strong><a name="NUMOFPAGES"><tt>$NUMOFPAGES$</tt></a></strong></dt>
870<dd><table border=0>
871<tr valign=top>
872<td align=right><b>Arguments:</b></td>
873<td>N/A</td>
874</tr>
875<tr valign=top>
876<td align=right><b>Description:</b></td>
877<td>Total number of index pages for a given index type.</td>
878</tr>
879</table><br></dd>
880<dt><strong><a name="ORDNUM"><tt>$ORDNUM$</tt></a></strong></dt>
881<dd><table border=0>
882<tr valign=top>
883<td align=right><b>Arguments:</b></td>
884<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
885</tr>
886<tr valign=top>
887<td align=right><b>Description:</b></td>
888<td>The current listing number of the message.</td>
889</tr>
890</table><br></dd>
891<dt><strong><a name="OUTDIR"><tt>$OUTDIR$</tt></a></strong></dt>
892<dd><table border=0>
893<tr valign=top>
894<td align=right><b>Arguments:</b></td>
895<td>N/A</td>
896</tr>
897<tr valign=top>
898<td align=right><b>Description:</b></td>
899<td>Pathname of archive.
900Value set by the
901<a href="resources/outdir.html">OUTDIR</a>
902resource.
903</td>
904</tr>
905</table><br></dd>
906<dt><strong><a name="PAGENUM"><tt>$PAGENUM$</tt></a></strong></dt>
907<dd><table border=0>
908<tr valign=top>
909<td align=right><b>Arguments:</b></td>
910<td>N/A</td>
911</tr>
912<tr valign=top>
913<td align=right><b>Description:</b></td>
914<td>Current index page number.</td>
915</tr>
916</table><br></dd>
917<dt><strong><a name="PG"><tt>$PG$</tt></a></strong></dt>
918<dd><table border=0>
919<tr valign=top>
920<td align=right><b>Arguments:</b></td>
921<td><tt><i><a href="#idx_page_spec">idx_page_spec</a></i></tt></td>
922</tr>
923<tr valign=top>
924<td align=right><b>Description:</b></td>
925<td>Filename of an index page.
926Value determined by the
927<a href="resources/htmlext.html">HTMLEXT</a>,
928<a href="resources/idxfname.html">IDXFNAME</a>,
929<a href="resources/idxprefix.html">IDXPREFIX</a>,
930<a href="resources/tidxfname.html">TIDXFNAME</a>, and
931<a href="resources/tidxprefix.html">TIDXPREFIX</a>
932resources. Which resources are in effect depends on the current
933context.
934</td>
935</tr>
936</table><br></dd>
937<dt><strong><a name="PGLINK"><tt>$PGLINK$</tt></a></strong></dt>
938<dd><table border=0>
939<tr valign=top>
940<td align=right><b>Arguments:</b></td>
941<td><tt><i><a href="#idx_page_spec">idx_page_spec</a></i></tt></td>
942</tr>
943<tr valign=top>
944<td align=right><b>Description:</b></td>
945<td>Markup linking to a main index page.
946Value determined by the
947<a href="resources/firstpglink.html">FIRSTPGLINK</a>,
948<a href="resources/lastpglink.html">LASTPGLINK</a>,
949<a href="resources/nextpglink.html">NEXTPGLINK</a>,
950<a href="resources/nextpglinkia.html">NEXTPGLINKIA</a>,
951<a href="resources/prevpglink.html">PREVPGLINK</a>,
952<a href="resources/prevpglinkia.html">PREVPGLINKIA</a>,
953<a href="resources/tfirstpglink.html">TFIRSTPGLINK</a>,
954<a href="resources/tlastpglink.html">TLASTPGLINK</a>,
955<a href="resources/tnextpglink.html">TNEXTPGLINK</a>,
956<a href="resources/tnextpglinkia.html">TNEXTPGLINKIA</a>,
957<a href="resources/tprevpglink.html">TPREVPGLINK</a>, and
958<a href="resources/tprevpglinkia.html">TPREVPGLINKIA</a>,
959resources. The resource used depends on
960<i><a href="#idx_page_spec">idx_page_spec</a></i> and context.
961</td>
962</tr>
963</table><br></dd>
964<dt><strong><a name="PGLINKLIST"><tt>$PGLINKLIST$</tt></a></strong></dt>
965<dd><table border=0>
966<tr valign=top>
967<td align=right><b>Arguments:</b></td>
968<td><tt><i>num</i>;<i>num</i></tt></td>
969</tr>
970<tr valign=top>
971<td align=right><b>Description:</b></td>
972<td><p>Markup linking to a list of index pages. <tt>$PGLINKLIST$</tt> takes
973two arguments: the first is the number of pages before the current page
974to create links to; the second is the number of pages after the
975current page to create links to. If either number argument is prefixed
976with a '<tt><b>T</b></tt>', then the list of links apply to the thread index.
977Examples: <tt>$PGLINKLIST(3;3)$</tt>, <tt>$PGLINKLIST(T2;T3)$</tt>. The
978link text for to a give page is the page number.
979</p>
980<p>If no arguments are provided to <tt>$PGLINKLIST$</tt>, then the
981links to all index pages will be printed. To get the entire list
982for a thread index, use <tt>$PGLINKLIST(T)$</tt>.
983</p>
984</td>
985</tr>
986</table><br></dd>
987<dt><strong><a name="PROG"><tt>$PROG$</tt></a></strong></dt>
988<dd><table border=0>
989<tr valign=top>
990<td align=right><b>Arguments:</b></td>
991<td>N/A</td>
992</tr>
993<tr valign=top>
994<td align=right><b>Description:</b></td>
995<td>Program name</td>
996</tr>
997</table><br></dd>
998<dt><strong><a name="SUBJECT"><tt>$SUBJECT$</tt></a></strong></dt>
999<dd><table border=0>
1000<tr valign=top>
1001<td align=right><b>Arguments:</b></td>
1002<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
1003</tr>
1004<tr valign=top>
1005<td align=right><b>Description:</b></td>
1006<td>The subject text of the message, <em>and if no arguments</em>, wrapped in
1007an anchor element that hyperlinks to the message. This behavior exists
1008for backwards capatibility and a simple way to provide a link to
1009the current message using the subject as the link text. The
1010no argument version is equivalent to:
1011"<nobr><tt>&lt;a&nbsp;<a href="#A_ATTR">$A_ATTR$</a>&gt;<a href="#SUBJECTNA">$SUBJECTNA$</a>&lt;/a&gt;</tt></nobr>".
1012</td>
1013</tr>
1014</table><br></dd>
1015<dt><strong><a name="SUBJECTNA"><tt>$SUBJECTNA$</tt></a></strong></dt>
1016<dd><table border=0>
1017<tr valign=top>
1018<td align=right><b>Arguments:</b></td>
1019<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
1020</tr>
1021<tr valign=top>
1022<td align=right><b>Description:</b></td>
1023<td>The subject text of the message without the anchor element.</td>
1024</tr>
1025</table><br></dd>
1026<dt><strong><a name="TIDXFNAME"><tt>$TIDXFNAME$</tt></a></strong></dt>
1027<dd><table border=0>
1028<tr valign=top>
1029<td align=right><b>Arguments:</b></td>
1030<td>N/A</td>
1031</tr>
1032<tr valign=top>
1033<td align=right><b>Description:</b></td>
1034<td>Filename of thread index page. The value is set by the
1035<a href="resources/tidxfname.html">TIDXFNAME</a> or
1036<a href="resources/tidxprefix.html">TIDXPREFIX</a> and
1037<a href="resources/htmlext.html">HTMLEXT</a>
1038resources. If the first page, TIDXFNAME is used. For other pages,
1039the filename is <var>TIDXPREFIXpage-number</var><tt>.</tt><var>HTMLEXT</var>.
1040</td>
1041</tr>
1042</table><br></dd>
1043<dt><strong><a name="TIDXLABEL"><tt>$TIDXLABEL$</tt></a></strong></dt>
1044<dd><table border=0>
1045<tr valign=top>
1046<td align=right><b>Arguments:</b></td>
1047<td>N/A</td>
1048</tr>
1049<tr valign=top>
1050<td align=right><b>Description:</b></td>
1051<td>Label for thread index page. Value set by the
1052<a href="resources/tidxlabel.html">TIDXLABEL</a> resource.</td>
1053</tr>
1054</table><br></dd>
1055<dt><strong><a name="TIDXPREFIX"><tt>$TIDXPREFIX$</tt></a></strong></dt>
1056<dd><table border=0>
1057<tr valign=top>
1058<td align=right><b>Arguments:</b></td>
1059<td>N/A</td>
1060</tr>
1061<tr valign=top>
1062<td align=right><b>Description:</b></td>
1063<td>Prefix of filenames of thread index pages.
1064Value set by the
1065<a href="resources/tidxprefix.html">TIDXPREFIX</a>
1066resource.
1067</td>
1068</tr>
1069</table><br></dd>
1070<dt><strong><a name="TIDXTITLE"><tt>$TIDXTITLE$</tt></a></strong></dt>
1071<dd><table border=0>
1072<tr valign=top>
1073<td align=right><b>Arguments:</b></td>
1074<td>N/A</td>
1075</tr>
1076<tr valign=top>
1077<td align=right><b>Description:</b></td>
1078<td>The title of the thread index page.
1079Value set by the <a href="resources/ttitle.html">TTITLE</a> resource.
1080</td>
1081</tr>
1082</table><br></dd>
1083<dt><strong><a name="TLEVEL"><tt>$TLEVEL$</tt></a></strong></dt>
1084<dd><table border=0>
1085<tr valign=top>
1086<td align=right><b>Arguments:</b></td>
1087<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
1088</tr>
1089<tr valign=top>
1090<td align=right><b>Description:</b></td>
1091<td>Numeric level of message in current thread, starting with zero.
1092</td>
1093</tr>
1094</table><br></dd>
1095<dt><strong><a name="TO"><tt>$TO$</tt></a></strong></dt>
1096<dd><table border=0>
1097<tr valign=top>
1098<td align=right><b>Arguments:</b></td>
1099<td>N/A</td>
1100</tr>
1101<tr valign=top>
1102<td align=right><b>Description:</b></td>
1103<td>The mail address.
1104This variable is only applicable for use in the
1105<a href="resources/mailtourl.html">MAILTOURL</a>.</td>
1106</tr>
1107</table><br></dd>
1108<dt><strong><a name="TOADDRNAME"><tt>$TOADDRNAME$</tt></a></strong></dt>
1109<dd><table border=0>
1110<tr valign=top>
1111<td align=right><b>Arguments:</b></td>
1112<td>N/A</td>
1113</tr>
1114<tr valign=top>
1115<td align=right><b>Description:</b></td>
1116<td>The username/local-part of the e-mail address.
1117For example, given the address "someuser@mhonarc.org",
1118<tt>$TOADDRNAME$</tt> would equal "someuser".
1119This variable is only applicable for use in the
1120<a href="resources/mailtourl.html">MAILTOURL</a>.</td>
1121</tr>
1122</table><br></dd>
1123<dt><strong><a name="TOADDRDOMAIN"><tt>$TOADDRDOMAIN$</tt></a></strong></dt>
1124<dd><table border=0>
1125<tr valign=top>
1126<td align=right><b>Arguments:</b></td>
1127<td>N/A</td>
1128</tr>
1129<tr valign=top>
1130<td align=right><b>Description:</b></td>
1131<td>The domain part of the e-mail address.
1132For example, given the address "someuser@mhonarc.org",
1133<tt>$TOADDRDOMAIN$</tt> would equal "mhonarc.org".
1134This variable is only applicable for use in the
1135<a href="resources/mailtourl.html">MAILTOURL</a>.</td>
1136</tr>
1137</table><br></dd>
1138<dt><strong><a name="TSLICE"><tt>$TSLICE$</tt></a></strong></dt>
1139<dd><table border=0>
1140<tr valign=top>
1141<td align=right><b>Arguments:</b></td>
1142<td><tt><i>number</i>;<i>number</i>;<i>flag</i></tt></td>
1143</tr>
1144<tr valign=top>
1145<td align=right><b>Description:</b></td>
1146<td>A <em>slice</em> of the thread listing relative to the current message.
1147Size of slice is determined by the <a href="resources/tslice.html">TSLICE</a>
1148resource, or explicitly by the arguments provided. The first argument
1149is the number of maximum messages to list before the current message.
1150The second argument is the number of maximum message messages to list
1151after the current message. The third argument is a flag, <tt>0</tt>
1152or <tt>1</tt>, denoting if slice should cross discussion thread
1153boundaries or not. If any of the arguments are blank, the value
1154defined in the <a href="resources/tslice.html">TSLICE</a> resource
1155will be used.
1156<p>Layout appearance of <tt>$TSLICE$</tt> is determined by
1157<a href="resources/tslicebeg.html">TSLICEBEG</a>,
1158<a href="resources/tslicecontbeg.html">TSLICECONTBEG</a>,
1159<a href="resources/tslicecontend.html">TSLICECONTEND</a>,
1160<a href="resources/tsliceend.html">TSLICEEND</a>,
1161<a href="resources/tsliceindentbeg.html">TSLICEINDENTBEG</a>,
1162<a href="resources/tsliceindentend.html">TSLICEINDENTEND</a>,
1163<a href="resources/tsliceliend.html">TSLICELIEND</a>,
1164<a href="resources/tsliceliendcur.html">TSLICELIENDCUR</a>,
1165<a href="resources/tslicelinone.html">TSLICELINONE</a>,
1166<a href="resources/tslicelinoneend.html">TSLICELINONEEND</a>,
1167<a href="resources/tslicelitxt.html">TSLICELITXT</a>,
1168<a href="resources/tslicelitxtcur.html">TSLICELITXTCUR</a>,
1169<a href="resources/tslicesingletxt.html">TSLICESINGLETXT</a>,
1170<a href="resources/tslicesingletxtcur.html">TSLICESINGLETXTCUR</a>,
1171<a href="resources/tslicesubjectbeg.html">TSLICESUBJECTBEG</a>,
1172<a href="resources/tslicesubjectend.html">TSLICESUBJECTEND</a>,
1173<a href="resources/tslicesublistbeg.html">TSLICESUBLISTBEG</a>,
1174<a href="resources/tslicesublistend.html">TSLICESUBLISTEND</a>,
1175<a href="resources/tslicetopbeg.html">TSLICETOPBEG</a>,
1176<a href="resources/tslicetopbegcur.html">TSLICETOPBEGCUR</a>,
1177<a href="resources/tslicetopend.html">TSLICETOPEND</a>, and
1178<a href="resources/tslicetopendcur.html">TSLICETOPENDCUR</a>
1179resources.
1180</p>
1181</td>
1182</tr>
1183</table><br></dd>
1184<dt><strong><a name="VERSION"><tt>$VERSION$</tt></a></strong></dt>
1185<dd><table border=0>
1186<tr valign=top>
1187<td align=right><b>Arguments:</b></td>
1188<td>N/A</td>
1189</tr>
1190<tr valign=top>
1191<td align=right><b>Description:</b></td>
1192<td>Program version.</td>
1193</tr>
1194</table><br></dd>
1195<dt><strong><a name="YYYYMMDD"><tt>$YYYYMMDD$</tt></a></strong></dt>
1196<dd><table border=0>
1197<tr valign=top>
1198<td align=right><b>Arguments:</b></td>
1199<td>N/A</td>
1200</tr>
1201<tr valign=top>
1202<td align=right><b>Description:</b></td>
1203<td>Message (local) date in yyyy/mm/dd format.</td>
1204</tr>
1205</table><br></dd>
1206</dl>
1207<!--X-Variable-Index-End-->
1208
1209<!-- *************************************************************** -->
1210<hr>
1211<!--X-NavButtons-Start-->
1212<table width="100%">
1213<tr valign="top">
1214<td align="left"><nobr><a href="resources.html"><img src="prev.png"border=0 alt="[Prev]"></a>&nbsp;&nbsp;&nbsp;</nobr></td><td align="center" width="99%"><a href="mhonarc.html"><img src="up.png" border=0 alt="[TOC]"></a><a href="faq/faq.html"><img src="faq.png" border=0 alt="[FAQ]"></a><a href="app-bugs.html"><img src="bug.png" border=0 alt="[Bugs]"></a><a href="http://www.mhonarc.org/"><img src="home.png" border=0 alt="[Home]"></a></td><td align="right"><nobr>&nbsp;&nbsp;&nbsp;<a href="contacts.html"><img src="next.png" border=0 alt="[Next]"></a></nobr></td></tr></table>
1215<!--X-NavButtons-End-->
1216
1217<!-- *************************************************************** -->
1218<hr>
1219<address>
1220$Date: 2002/07/27 05:13:10 $ <br>
1221<img align="top" src="monicon.png" alt="">
1222<a href="http://www.mhonarc.org"
1223><strong>MHonArc</strong></a><br>
1224Copyright &#169; 1998-1999, <a href="http://www.mhonarc.org/~ehood/"
1225>Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org"
1226>mhonarc@mhonarc.org</a><br>
1227</address>
1228
1229</body>
1230</html>
Full OpenSPARC design & verification tarball including full HDL.