Sophie: MHonArc-2.4.9-1mdk noarch

MHonArc-2.4.9-1mdk.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN">
<html>
<head>
<title>MHonArc v2.4 -- Resource Variables</title>
</head>
<BODY background="ssbg75.jpg"
      text="#000000" link="#0000ee" vlink="#551a8b" alink="ff0000">

<!--X-NavButtons-Start-->
<p align=center>
<a href="resources.html"><img src="prev.gif" border=0 alt="[Prev]"></a><a href="contacts.html"><img src="next.gif" border=0 alt="[Next]"></a><a href="mhonarc.html"><img src="up.gif" border=0 alt="[TOC]"></a><a href="faq/faq.html"><img src="faq.gif" border=0 alt="[FAQ]"></a><a href="app-bugs.html"><img src="bug.gif" border=0 alt="[Bugs]"></a><a href="http://www.mhonarc.org/"><img src="home.gif" border=0 alt="[Home]"></a>
</p>
<!--X-NavButtons-End-->
<hr>
<h1><a name="rcvars">Resource Variables</a></h1>

<!--X-TOC-Start-->
<ul>
<li><a href="#overview">Overview</a>
<li><a href="#rcvar_syntax">Resource Variable Syntax</a>
<li><a href="#rcvar_index">Resource Variable Index</a>
<ul>
<li><small><a href="#variables">Variables</a></small>
</ul>
</ul>
<!--X-TOC-End-->

<hr>
<h2><a name="overview">Overview</a></h2>
<p><em>Resource variables</em> are used to represent dynamic data
in MHonArc <a href="resources.html">resources</a>.  Take the following
<a href="resources/litemplate.html">LITEMPLATE</a> resource setting
for example:
</p>

<PRE>
&lt;LiTemplate&gt;
&lt;li&gt;&lt;strong&gt;<b>$SUBJECT$</b>&lt;/strong&gt;
&lt;ul&gt;&lt;li&gt;&lt;em&gt;From&lt;/em&gt;: <b>$FROM$</b>&lt;/li&gt;&lt;/ul&gt;
&lt;/li&gt;
&lt;/LiTemplate&gt;
</PRE>

<p>The LITEMPLATE resource defines how each message listing is displayed
in the main index page.  The <tt>$SUBJECT$</tt> and
<tt>$FROM$</tt> are resource
variables.  <tt>$SUBJECT$</tt> will get expanded to the current message's
subject, hyperlinked to the message page.
<tt>$FROM$</tt> will be replaced with
the message's author's name and address.
</p>

<p>Some resource variables take arguments.  Take the following
<a href="resources/nextlink.html">NEXTLINK</a> resource setting for
example:

<pre>
&lt;li&gt;Next by Date:
&lt;strong&gt;&lt;a href="<b>$MSG(NEXT)$</b>"&gt;<b>$SUBJECT(NEXT)$</b>&lt;/a&gt;&lt;/strong&gt;
&lt;/li&gt;
</pre>

<p>The resource setting uses two resource variables: <tt>$MSG$</tt> and
<tt>$SUBJECT$</tt>.
However, an argument is given to each resource variable
delimited by <b><tt>(&nbsp;)</tt></b>.
<tt>$SUBJECT$</tt> will get expanded to the current message's
subject<SUP><a href="#note1">[*]</a></SUP>.
With the "<tt>NEXT</tt>" argument,
we are instructing MHonArc to use the <em>next</em> message's
subject.  <tt>$MSG(NEXT)$</tt> will get expanded to the next message's
filename.  Therefore, the above resource value is creating a link to
the next message in the archive.
</p>

<table border=0 cellpadding=4>
<tr valign=top>
<td><strong><a name="note1">*</a> NOTE</strong></td>
<td><p>In the two examples given, the replacement value of
<tt>$SUBJECT$</tt> is different (excluding the variable argument difference).
For compatibility of older versions of MHonArc, when <tt>$SUBJECT$</tt>
is used <em>without</em> any arguments, it will be expanded to
the current message's subject <em>hyperlinked</em> to the current message
page.  If an argument is given to <tt>$SUBJECT$</tt>, then the variable
will get expanded only to the subject text of the applicable message.
<strong>NO</strong> hyperlink is automatically created.
</p>
</td>
</tr>
</table>



<!-- *************************************************************** -->
<hr>
<h2><a name="rcvar_syntax">Resource Variable Syntax</a></h2>

<P>The syntax of resource variables in resources
is as follows:
</P>

<pre>
$<i>VARIABLE</i>[[:[<i>N</i>][U][J]][(<i>arglist</i>)]]$
	  ^----------^^---------^ 
         ^-----------------------^
</pre>

<p>The items in <tt>[]</tt>'s are optional.  The "<tt>^---^</tt>" are used to
highlight the nested optional groupings.
</p>

<p>Definition of each part: </P>

<dl>

<dt><tt>$</tt></dt>
<dd><p>The start of a resource variable.  Everything (including
line breaks) up to the
next <tt>$</tt> is part of the resource variable.
</p>
</dd>

<dt><tt><i>VARIABLE</i></tt></dt>
<dd><p>The name of the variable.  Variable names are case-sensitive.
</p>
</dd>

<dt><tt>:[<i>N</i>][U][J]</tt> <em>(optional)</em></dt>
<dd><p>The optional grouping starting with a colon are variable
modifiers.  The definition of each modifier is as follows:
</p>
    <dl compact>
    <dt><i>N</i></dt>
    <dd>Length specification.  MHonArc will clip the expanded text
    to <i>N</i> if the text length is greater than <i>N</i>.
    </dd>
    <dt><tt>U</tt></dt>
    <dd>Treat the text as part of a URL string.  MHonArc will escape
    any characters that are considered special in a URL.
    </dd>
    <dt><tt>J</tt></dt>
    <dd>Treat the text as a JavaScript string.  MHonArc will escape
    any quote characters so the text can be part of a JavaScript
    string.
    </dd>
    </dl>
<p></p>

<dt><tt>(<i>arglist</i>)</tt> <em>(optional)</em></dt>
<dd>An optional argument list delimited by parentheses: <tt>(&nbsp;)</tt>.
Some resource variables can take arguments which modify how the
variable is expanded.  If a variable can
take more than one argument, each argument will be separated by
a semi-colon.  For example: <tt>$MSGLOCALDATE(NEXT;%H:%M)$</tt>.
In the example, there are two arguments to the <tt>$MSGLOCALDATE$</tt>
variable: "<tt>NEXT</tt>" and "<tt>%H:%M</tt>".
</dd>

<dt><tt>$</tt></dt>
<dd><p>The end of a resource variable.
</p>
</dd>
</dl>

<p>If an unrecognized variable is encountered, it gets replaced with an
empty string, and a warning is generated. If a literal "<tt>$</tt>"
is needed, use "<tt>$$</tt>".
</p>

<table border=0 cellpadding=4>
<tr valign=top>
<td><strong>NOTE</strong></td>
<td><p>The
<a href="resources/mailtourl.html">MAILTOURL</a>
resource has
different rules for variable expansion. If a
variable does not exactly match the set of variables available for
the MAILTOURL, the variable text will be taken literally
as part of the element content. Therefore, a single "<tt>$</tt>"
can be used to represent a "<tt>$</tt>" character.  </p>
<p>Also,
variables in the MAILTOURL should <STRONG>NOT</STRONG>
have "<tt>:<i>N</i>UJ</tt>" modifiers. This will prevent the
variables from being recognized. MHonArc will automatically
treat the replacement value as a part of a URL string.
</p>
</td></tr>
</table>



<!-- *************************************************************** -->
<hr>
<h2><a name="rcvar_index">Resource Variable Index</a></h2>

<p>This sections lists all the resource variables supported by MHonArc.
Since many resource variables can take arguments, the following notations
are used to represent argument values:
</p>

<dl>

<dt><a name="mesg_spec"><b><i><tt>mesg_spec</tt></i></b></a></dt>
<dd><p>A message specification determines which message the variable's
expanded will be based upon. Possible values are:
</p>
<table border=0>
<tr valign=top>
<th align=right>Value</th><th align=left>- Meaning</th>
</tr>
<tr valign=top>
<td align=right><tt>CUR</tt></td>
  <td>- Current message.</td>
</tr>
<tr valign=top>
<td align=right><tt>FIRST</tt></td>
  <td>- First message listed in main index.</td>
</tr>
<tr valign=top>
<td align=right><tt>LAST</tt></td>
  <td>- Last message listed in main index.</td>
</tr>
<tr valign=top>
<td align=right><tt>NEXT</tt></td>
  <td>- Next message by main sort order.</td>
</tr>
<tr valign=top>
<td align=right><tt>PREV</tt></td>
  <td>- Previous message by main sort order.</td>
</tr>
<tr valign=top>
<td align=right><tt>TEND</tt></td>
  <td>- Last message of current discussion thread.</td>
</tr>
<tr valign=top>
<td align=right><tt>TFIRST</tt></td>
  <td>- First message listed thread index.</td>
</tr>
<tr valign=top>
<td align=right><tt>TLAST</tt></td>
  <td>- Last message listed thread index.</td>
</tr>
<tr valign=top>
<td align=right><tt>TNEXT</tt></td>
  <td>- Next message by thread.</td>
</tr>
<tr valign=top>
<td align=right><tt>TPARENT</tt></td>
  <td>- Parent message of current
thread.</td>
</tr>
<tr valign=top>
<td align=right><tt>TPREV</tt></td>
  <td>- Previous message by thread.</td>
</tr>
<tr valign=top>
<td align=right><tt>TTOP</tt></td>
  <td>- Top/root message of current discussion thread.</td>
</tr>
</table>
<p>"<tt>CUR</tt>" is the default if nothing is specified for
<i><tt>mesg_spec</tt></i>.
</p>
</dd>


<dt><a name="idx_page_spec"><b><i><tt>idx_page_spec</tt></i></b></a></dt>
<dd><p>An index page specification denoting the index page to use
when determing the value of the variable.  The possible values are:
</p>
<table border=0>
<tr valign=top>
<th align=right>Value</th><th align=left>- Meaning</th>
</tr>
<tr valign=top>
<td align=right><tt>FIRST</tt></td><td>- First page of main index.</td>
</tr>
<tr valign=top>
<td align=right><tt>LAST</tt></td><td>- Last page of main index.</td>
</tr>
<tr valign=top>
<td align=right><tt>NEXT</tt></td><td>- Next page of main index.</td>
</tr>
<tr valign=top>
<td align=right><tt>PREV</tt></td><td>- Previous page of main index.</td>
</tr>
<tr valign=top>
<td align=right><tt>TFIRST</tt></td><td>- First page of thread index.</td>
</tr>
<tr valign=top>
<td align=right><tt>TLAST</tt></td><td>- Last page of thread index.</td>
</tr>
<tr valign=top>
<td align=right><tt>TNEXT</tt></td><td>- Next page of thread index.</td>
</tr>
<tr valign=top>
<td align=right><tt>TPREV</tt></td><td>- Previous page of thread index.</td>
</tr>
</table>
<p>If no value is given for <i><tt>idx_page_spec</tt></i>, the resource
variable's value is undefined.
</p>
</dd>

<dt><a name="time_fmt_str"><b><i><tt>time_fmt_str</tt></i></b></a></dt>
<dd><p>A time format string specifies how a date/time will be
printed for a date/time related variable.  The syntax of the format
string is the same as the conversion specification as defined in
the <a href="resources/gmtdatefmt.html">GMTDATEFMT</a> and
<a href="resources/localdatefmt.html">LOCALDATEFMT</a> resources.
</p>
</dd>

</dl>

<h3><a name="variables">Variables</a></h3>

<!--X-Variable-Index-Start-->
<dl>
<dt><strong><a name="A_ATTR"><tt>$A_ATTR$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td>N/A</td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>The <tt>NAME</tt> and <tt>HREF</tt> attributes to use in an anchor
to link to the archived message.
The <tt>NAME</tt> attribute provides a destination location when a message
links to the index page.</td>
</tr>
</table><br></dd>
<dt><strong><a name="A_HREF"><tt>$A_HREF$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td>N/A</td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>The <tt>HREF</tt> attribute to use in an anchor to link to the archived message.</td>
</tr>
</table><br></dd>
<dt><strong><a name="A_NAME"><tt>$A_NAME$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td>N/A</td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>The <tt>NAME</tt> attribute to use in an anchor for messages to link to the index page.</td>
</tr>
</table><br></dd>
<dt><strong><a name="BUTTON"><tt>$BUTTON$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Button markup linking to a message. The value of $BUTTON$ is determined
by the following resources:
<a href="resources/nextbutton.html">NEXTBUTTON</a>,
<a href="resources/nextbuttonia.html">NEXTBUTTONIA</a>,
<a href="resources/prevbutton.html">PREVBUTTON</a>,
<a href="resources/prevbuttonia.html">PREVBUTTONIA</a>,
<a href="resources/tnextbutton.html">TNEXTBUTTON</a>,
<a href="resources/tnextbuttonia.html">TNEXTBUTTONIA</a>.
</td>
</tr>
</table><br></dd>
<dt><strong><a name="DATE"><tt>$DATE$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>The date of the message.</td>
</tr>
</table><br></dd>
<dt><strong><a name="DDMMYYYY"><tt>$DDMMYYYY$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Message date (according to local time) in dd/mm/yyyy format.</td>
</tr>
</table><br></dd>
<dt><strong><a name="DOCURL"><tt>$DOCURL$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td>N/A</td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>URL to MHonArc documentation.  Value of variable set by the
<a href="resources/docurl.html">DOCURL</a> resource.</td>
</tr>
</table><br></dd>
<dt><strong><a name="ENV"><tt>$ENV$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i>variable_name</i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>The value of the environment variable specified by <i>variable_name</i>.
For example, <tt>$ENV(HOME)$</tt> would expand to the value of the
HOME environment variable.</td>
</tr>
</table><br></dd>
<dt><strong><a name="FROM"><tt>$FROM$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>The complete text in the <tt>From:</tt> field of the message.</td>
</tr>
</table><br></dd>
<dt><strong><a name="FROMADDR"><tt>$FROMADDR$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>The full mail address in the <tt>From:</tt> field of the message.</td>
</tr>
</table><br></dd>
<dt><strong><a name="FROMADDRNAME"><tt>$FROMADDRNAME$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>The username/local-part of the mail address in the <tt>From:</tt>
field of the message.  For example, given the address "someuser@foo.com",
<tt>$FROMADDRNAME$</tt> would equal "someuser".</td>
</tr>
</table><br></dd>
<dt><strong><a name="FROMADDR"><tt>$FROMADDRDOMAIN$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>The domain part of the mail address in the <tt>From:</tt>
field of the message.  For example, given the address "someuser@foo.com",
<tt>$FROMADDRDOMAIN$</tt> would equal "foo.com".</td>
</tr>
</table><br></dd>
<dt><strong><a name="FROMNAME"><tt>$FROMNAME$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>The human name of the person in the <tt>From:</tt> field of the message.
If no human name is found, the local-part specified in the mail address
is used.</td>
</tr>
</table><br></dd>
<dt><strong><a name="GMTDATE"><tt>$GMTDATE$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#time_fmt_str">time_fmt_str</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Current GMT date.
Default format of date set by the
<a href="resources/gmtdatefmt.html">GMTDATEFMT</a>
resource.
</td>
</tr>
</table><br></dd>
<dt><strong><a name="ICON"><tt>$ICON$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>The context-type sensistive icon.  The type of icon displayed
is determined by the <a href="resources/icons.html">ICONS</a> resource.</td>
</tr>
</table><br></dd>
<dt><strong><a name="ICONURL"><tt>$ICONURL$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>The URL to the context-type sensistive icon. The URL value is
determined by the <a href="resources/icons.html">ICONS</a> resource.</td>
</tr>
</table><br></dd>
<dt><strong><a name="IDXFNAME"><tt>$IDXFNAME$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td>N/A</td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Filename of main index page.  The value is set by the
<a href="resources/idxfname.html">IDXFNAME</a> or
<a href="resources/idxprefix.html">IDXPREFIX</a> and
<a href="resources/htmlext.html">HTMLEXT</a>
resources.  If the first page, IDXFNAME is used.  For other pages,
the filename is <var>IDXPREFIXpage-number</var><tt>.</tt><var>HTMLEXT</var>.
</td>
</tr>
</table><br></dd>
<dt><strong><a name="IDXLABEL"><tt>$IDXLABEL$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td>N/A</td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Label for main index page.  Value set by the
<a href="resources/idxlabel.html">IDXLABEL</a> resource.</td>
</tr>
</table><br></dd>
<dt><strong><a name="IDXPREFIX"><tt>$IDXPREFIX$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td>N/A</td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Prefix of filenames of main index pages.
Value set by the <a href="resources/idxprefix.html">IDXPREFIX</a> resource.
</td>
</tr>
</table><br></dd>
<dt><strong><a name="IDXSIZE"><tt>$IDXSIZE$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td>N/A</td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Max number of messages that may be listed in index page.
Value set by the <a href="resources/idxsize.html">IDXSIZE</a> resource.
</td>
</tr>
</table><br></dd>
<dt><strong><a name="IDXTITLE"><tt>$IDXTITLE$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td>N/A</td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>The title of the main index page.
Value set by the <a href="resources/title.html">TITLE</a> resource.
</td>
</tr>
</table><br></dd>
<dt><strong><a name="LINK"><tt>$LINK$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Link markup linking to a message.
Value set by the
<a href="resources/nextlink.html">NEXTLINK</a>,
<a href="resources/nextlinkia.html">NEXTLINKIA</a>,
<a href="resources/prevlink.html">PREVLINK</a>,
<a href="resources/prevlinkia.html">PREVLINKIA</a>,
<a href="resources/tnextlink.html">TNEXTLINK</a>,
<a href="resources/tnextlinkia.html">TNEXTLINKIA</a>,
<a href="resources/tprevlink.html">TPREVLINK</a>, and
<a href="resources/tprevlinkia.html">TPREVLINKIA</a>
resources.
</td>
</tr>
</table><br></dd>
<dt><strong><a name="LOCALDATE"><tt>$LOCALDATE$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#time_fmt_str">time_fmt_str</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Current local date.
Default format of date set by the
<a href="resources/localdatefmt.html">LOCALDATEFMT</a>
resource.
</td>
</tr>
</table><br></dd>
<dt><strong><a name="MMDDYYYY"><tt>$MMDDYYYY$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Message (local) date in mm/dd/yyyy format.</td>
</tr>
</table><br></dd>
<dt><strong><a name="MSG"><tt>$MSG$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Filename of message. Filename of the message is determined by the
following resources:
<a href="resources/htmlext.html">HTMLEXT</a>,
<a href="resources/msgprefix.html">MSGPREFIX</a>.
</td>
</tr>
</table><br></dd>
<dt><strong><a name="MSGGMTDATE"><tt>$MSGGMTDATE$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<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>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>GMT date of current message.</td>
</tr>
</table><br></dd>
<dt><strong><a name="MSGID"><tt>$MSGID$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>The message-id of the message.</td>
</tr>
</table><br></dd>
<dt><strong><a name="MSGLOCALDATE"><tt>$MSGLOCALDATE$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<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>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Local date of current message.</td>
</tr>
</table><br></dd>
<dt><strong><a name="MSGNUM"><tt>$MSGNUM$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>The message number assigned to the message by MHonArc (includes leading zeros).</td>
</tr>
</table><br></dd>
<dt><strong><a name="MSGPREFIX"><tt>$MSGPREFIX$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td>N/A</td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Filename prefix for message files.
Value set by the
<a href="resources/msgprefix.html">MSGPREFIX</a>
resource.
</td>
</tr>
</table><br></dd>
<dt><strong><a name="MSGTORDNUM"><tt>$MSGTORDNUM$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>The ordinal message number of the current discussion thread.  Numbering
starts with the first top/root message of a thread and ends with the
last message of the thread, spanning in sub-threads.  The following
illustrates how the numbering works:
<pre>
  <b>1</b>. <var>top/root message</var>
    <b>2</b>. <var>first follow-up to 1</var>
      <b>3</b>. <var>first follow-up to 2</var>
      <b>4</b>. <var>second follow-up to 2</var>
    <b>5</b>. <var>second follow-up to 1</var>
      <b>6</b>. <var>first follow-up to 5</var>
        <b>7</b>. <var>first follow-up to 6</var>
    <b>8</b>. <var>third follow-up to 1</var>
</pre>
The above contains 8 total message in the discussion thread, so numbering
goes from 1 to 8.
</td>
</tr>
</table><br></dd>
<dt><strong><a name="NOTE"><tt>$NOTE$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Message annotation. If annotation text exists for the message,
the <a href="resources/note.html">NOTE</a> resource determines the
value of $NOTE$.  When no annotation text is defined,
<a href="resources/noteia.html">NOTEIA</a> is used.</td>
</tr>
</table><br></dd>
<dt><strong><a name="NOTETEXT"><tt>$NOTETEXT$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Base text of message annotation.  Variable should be used only
within the <a href="resource/note.html">NOTE</a> resource.</td>
</tr>
</table><br></dd>
<dt><strong><a name="NUMFOLUP"><tt>$NUMFOLUP$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Number of explicit follow-ups to the message.  This number does
<b>NOT</b> include subject-based follow-ups.</td>
</tr>
</table><br></dd>
<dt><strong><a name="NUMOFIDXMSG"><tt>$NUMOFIDXMSG$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td>N/A</td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Number of message listed for the current page.</td>
</tr>
</table><br></dd>
<dt><strong><a name="NUMOFMSG"><tt>$NUMOFMSG$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td>N/A</td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Total number of messages in the archive.</td>
</tr>
</table><br></dd>
<dt><strong><a name="NUMOFPAGES"><tt>$NUMOFPAGES$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td>N/A</td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Total number of index pages for a given index type.</td>
</tr>
</table><br></dd>
<dt><strong><a name="ORDNUM"><tt>$ORDNUM$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>The current listing number of the message.</td>
</tr>
</table><br></dd>
<dt><strong><a name="OUTDIR"><tt>$OUTDIR$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td>N/A</td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Pathname of archive.
Value set by the
<a href="resources/outdir.html">OUTDIR</a>
resource.
</td>
</tr>
</table><br></dd>
<dt><strong><a name="PAGENUM"><tt>$PAGENUM$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td>N/A</td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Current index page number.</td>
</tr>
</table><br></dd>
<dt><strong><a name="PG"><tt>$PG$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#idx_page_spec">idx_page_spec</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Filename of an index page.
Value determined by the
<a href="resources/htmlext.html">HTMLEXT</a>,
<a href="resources/idxfname.html">IDXFNAME</a>,
<a href="resources/idxprefix.html">IDXPREFIX</a>,
<a href="resources/tidxfname.html">TIDXFNAME</a>, and
<a href="resources/tidxprefix.html">TIDXPREFIX</a>
resources.  Which resources are in effect depends on the current
context.
</td>
</tr>
</table><br></dd>
<dt><strong><a name="PGLINK"><tt>$PGLINK$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#idx_page_spec">idx_page_spec</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Markup linking to a main index page.
Value determined by the
<a href="resources/nextpglink.html">NEXTPGLINK</a>,
<a href="resources/nextpglinkia.html">NEXTPGLINKIA</a>,
<a href="resources/prevpglink.html">PREVPGLINK</a>,
<a href="resources/prevpglinkia.html">PREVPGLINKIA</a>,
<a href="resources/tnextpglink.html">TNEXTPGLINK</a>,
<a href="resources/tnextpglinkia.html">TNEXTPGLINKIA</a>,
<a href="resources/tprevpglink.html">TPREVPGLINK</a>, and
<a href="resources/tprevpglinkia.html">TPREVPGLINKIA</a>,
resources.  The resource used depends on
<i><a href="#idx_page_spec">idx_page_spec</a></i> and context.
</td>
</tr>
</table><br></dd>
<dt><strong><a name="PGLINKLIST"><tt>$PGLINKLIST$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i>num</i>;<i>num</i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td><p>Markup linking to a list of index pages.  <tt>$PGLINKLIST$</tt> takes
two arguments: the first is the number of pages before the current page
to create links to; the second is the number of pages after the
current page to create links to.  If either number argument is prefixed
with a '<tt><b>T</b></tt>', then the list of links apply to the thread index.
Examples: <tt>$PGLINKLIST(3;3)$</tt>, <tt>$PGLINKLIST(T2;T3)$</tt>.  The
link text for to a give page is the page number.
</p>
</td>
</tr>
</table><br></dd>
<dt><strong><a name="PROG"><tt>$PROG$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td>N/A</td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Program name</td>
</tr>
</table><br></dd>
<dt><strong><a name="SUBJECT"><tt>$SUBJECT$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>The subject text of the message, and if no arguments, wrapped in an
anchor element that hyperlinks to the message.  This behavior exists
for backwards capatibility and a simple way to provide a link to
the current message using the subject as the link text.</td>
</tr>
</table><br></dd>
<dt><strong><a name="SUBJECTNA"><tt>$SUBJECTNA$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>The subject text of the message without the anchor element.</td>
</tr>
</table><br></dd>
<dt><strong><a name="TIDXFNAME"><tt>$TIDXFNAME$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td>N/A</td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Filename of thread index page.  The value is set by the
<a href="resources/tidxfname.html">TIDXFNAME</a> or
<a href="resources/tidxprefix.html">TIDXPREFIX</a> and
<a href="resources/htmlext.html">HTMLEXT</a>
resources.  If the first page, TIDXFNAME is used.  For other pages,
the filename is <var>TIDXPREFIXpage-number</var><tt>.</tt><var>HTMLEXT</var>.
</td>
</tr>
</table><br></dd>
<dt><strong><a name="TIDXLABEL"><tt>$TIDXLABEL$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td>N/A</td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Label for thread index page.  Value set by the
<a href="resources/tidxlabel.html">TIDXLABEL</a> resource.</td>
</tr>
</table><br></dd>
<dt><strong><a name="TIDXPREFIX"><tt>$TIDXPREFIX$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td>N/A</td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Prefix of filenames of thread index pages.
Value set by the
<a href="resources/tidxprefix.html">TIDXPREFIX</a>
resource.
</td>
</tr>
</table><br></dd>
<dt><strong><a name="TIDXTITLE"><tt>$TIDXTITLE$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td>N/A</td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>The title of the thread index page.
Value set by the <a href="resources/ttitle.html">TTITLE</a> resource.
</td>
</tr>
</table><br></dd>
<dt><strong><a name="TO"><tt>$TO$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td>N/A</td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>The mail address.
This variable is only applicable for use in the
<a href="resources/mailtourl.html">MAILTOURL</a>.</td>
</tr>
</table><br></dd>
<dt><strong><a name="TOADDRNAME"><tt>$TOADDRNAME$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td>N/A</td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>The username/local-part of the e-mail address.
For example, given the address "someuser@foo.com",
<tt>$TOADDRNAME$</tt> would equal "someuser".
This variable is only applicable for use in the
<a href="resources/mailtourl.html">MAILTOURL</a>.</td>
</tr>
</table><br></dd>
<dt><strong><a name="TOADDRDOMAIN"><tt>$TOADDRDOMAIN$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td>N/A</td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>The domain part of the e-mail address.
For example, given the address "someuser@foo.com",
<tt>$TOADDRDOMAIN$</tt> would equal "foo.com".
This variable is only applicable for use in the
<a href="resources/mailtourl.html">MAILTOURL</a>.</td>
</tr>
</table><br></dd>
<dt><strong><a name="TSLICE"><tt>$TSLICE$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td>N/A</td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>A <em>slice</em> of the thread listing relative to the current message.
Size of slice determined by the <a href="resources/tslice.html">TSLICE</a>
resource.  Layout appearance of <tt>$TSLICE$</tt> determined by
<a href="tslicebeg.html">TSLICEBEG</a>,
<a href="tsliceend.html">TSLICEEND</a>,
<a href="ttopbegin.html">TTOPBEGIN</a>,
<a href="tlitxt.html">TLITXT</a>,
<a href="tliend.html">TLIEND</a>,
<a href="tsingletxt.html">TSINGLETXT</a>,
<a href="tsubjectbeg.html">TSUBJECTBEG</a>, and
<a href="ttopend.html">TTOPEND</a>
resources.
</td>
</tr>
</table><br></dd>
<dt><strong><a name="VERSION"><tt>$VERSION$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td>N/A</td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Program version.</td>
</tr>
</table><br></dd>
<dt><strong><a name="YYYYMMDD"><tt>$YYYYMMDD$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td>N/A</td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>Message (local) date in yyyy/mm/dd format.</td>
</tr>
</table><br></dd>
</dl>
<!--X-Variable-Index-End-->

<!-- *************************************************************** -->
<hr>
<!--X-NavButtons-Start-->
<p align=center>
<a href="resources.html"><img src="prev.gif" border=0 alt="[Prev]"></a><a href="contacts.html"><img src="next.gif" border=0 alt="[Next]"></a><a href="mhonarc.html"><img src="up.gif" border=0 alt="[TOC]"></a><a href="faq/faq.html"><img src="faq.gif" border=0 alt="[FAQ]"></a><a href="app-bugs.html"><img src="bug.gif" border=0 alt="[Bugs]"></a><a href="http://www.mhonarc.org/"><img src="home.gif" border=0 alt="[Home]"></a>
</p>
<!--X-NavButtons-End-->

<!-- *************************************************************** -->
<hr>
<address>
01/06/10 17:47:40<br>
<img align="top" src="monicon.gif" alt="">
<a href="http://www.mhonarc.org"
><strong>MHonArc</strong></a><br>
Copyright &#169; 1998-1999, <a href="http://www.mhonarc.org/~ehood/"
>Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org"
>mhonarc@mhonarc.org</a><br>
</address>

</body>
</html>