<!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML//EN">
<title>MHonArc v2.5 -- Resource Variables
</title>
<BODY background="ssbg75.jpg"
text="#000000" link="#0000ee" vlink="#551a8b" alink="ff0000">
<!--X-NavButtons-Start-->
<td align=
"left"><nobr><a href=
"resources.html"><img src=
"prev.png"border=
0 alt=
"[Prev]"></a> </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> <a href=
"contacts.html"><img src=
"next.png" border=
0 alt=
"[Next]"></a></nobr></td></tr></table>
<h1><a name=
"rcvars">Resource Variables
</a></h1>
<li><a href=
"#overview">Overview
</a>
<li><a href=
"#rcvar_syntax">Resource Variable Syntax
</a>
<li><a href=
"#rcvar_index">Resource Variable Index
</a>
<li><small><a href=
"#variables">Variables
</a></small>
<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
<li
><strong
><b>$SUBJECT$
</b></strong
>
<ul
><li
><em
>From
</em
>:
<b>$FROM$
</b></li
></ul
>
<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>Some resource variables take arguments. Take the following
<a href=
"resources/nextlink.html">NEXTLINK
</a> resource setting for
<strong
><a
href=
"<b>$MSG(NEXT)$</b>"><b>$SUBJECT(NEXT)$
</b></a
></strong
>
<p>The resource setting uses two resource variables:
<tt>$MSG$
</tt> and
However, an argument is given to each resource variable
delimited by
<b><tt>(
)
</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.
<table border=
0 cellpadding=
4>
<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.
<!-- *************************************************************** -->
<h2><a name=
"rcvar_syntax">Resource Variable Syntax
</a></h2>
<P>The syntax of resource variables in resources
$
<i>VARIABLE
</i>[[:[
<i>N
</i>][U][J]][(
<i>arglist
</i>)]]$
^-----------------------^
<p>The items in
<tt>[]
</tt>'s are optional. The
"<tt>^---^</tt>" are used to
highlight the nested optional groupings.
<p>Definition of each part:
</P>
<dd><p>The start of a resource variable. Everything (including
next
<tt>$
</tt> is part of the resource variable.
<dt><tt><i>VARIABLE
</i></tt></dt>
<dd><p>The name of the variable. Variable names are case-sensitive.
<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:
<table border=
0 cellpadding=
4>
<td><p>Length specification. MHonArc will clip the expanded text
to
<i>N
</i> if the text length is greater than
<i>N
</i>.
<table border=
0 cellpadding=
4>
<td><strong>NOTE
</strong></td>
<td>Not all resource variables support clipping.
If a length specification is given for these variables, then
<p>How MHonArc clips text is determined by the
<a href=
"resources/textclipfunc.html">TEXTCLIPFUNC
</a> resource.
<td><p>Treat the text as part of a URL string. MHonArc will escape
any characters that are considered special in a URL.
<td><p>Treat the text as a JavaScript string. MHonArc will escape
any quote characters so the text can be part of a JavaScript
<dt><tt>(
<i>arglist
</i>)
</tt> <em>(optional)
</em></dt>
<dd>An optional argument list delimited by parentheses:
<tt>(
)
</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><p>The end of a resource variable.
<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>".
<table border=
0 cellpadding=
4>
<td><strong>NOTE
</strong></td>
<a href=
"resources/mailtourl.html">MAILTOURL
</a>
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>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.
<!-- *************************************************************** -->
<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:
<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:
<th align=right
>Value
-
</th><th align=left
>Meaning
</th>
<td align=right
><tt>CUR
</tt> -
</td>
<td>Current message.
</td>
<td align=right
><tt>FIRST
</tt> -
</td>
<td>First message listed in main index.
</td>
<td align=right
><tt>LAST
</tt> -
</td>
<td>Last message listed in main index.
</td>
<td align=right
><tt>NEXT
</tt> -
</td>
<td>Next message by main sort order.
</td>
<td align=right
><tt>PREV
</tt> -
</td>
<td>Previous message by main sort order.
</td>
<td align=right
><tt>TEND
</tt> -
</td>
<td>Last message of current discussion thread.
</td>
<td align=right
><tt>TFIRST
</tt> -
</td>
<td>First message listed thread index.
</td>
<td align=right
><tt>TLAST
</tt> -
</td>
<td>Last message listed thread index.
</td>
<td align=right
><tt>TNEXT
</tt> -
</td>
<td>Next message by thread.
</td>
<td align=right
><tt>TNEXTIN
</tt> -
</td>
<td>Next message within current thread. This differs from
<tt>TNEXT
</tt> in that it does not cross discussion thread boundaries.
</td>
<td align=right
><tt>TNEXTTOP
</tt> -
</td>
<td>First message of next discussion thread.
</td>
<td align=right
><tt>TPARENT
</tt> -
</td>
<td>Parent message of current thread.
</td>
<td align=right
><tt>TPREV
</tt> -
</td>
<td>Previous message by thread.
</td>
<td align=right
><tt>TPREVIN
</tt> -
</td>
<td>Previous message within current thread. This differs from
<tt>TPREV
</tt> in that it does not cross discussion thread boundaries.
</td>
<td align=right
><tt>TPREVTOP
</tt> -
</td>
<td>First message of previous discussion thread.
</td>
<td align=right
><tt>TTOP
</tt> -
</td>
<td>Top/root message of current discussion thread.
</td>
<p>"<tt>CUR</tt>" is the default if nothing is specified for
<i><tt>mesg_spec
</tt></i>.
<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:
<th align=right
>Value
</th><th align=left
>- Meaning
</th>
<td align=right
><tt>FIRST
</tt></td><td>- First page of main index.
</td>
<td align=right
><tt>LAST
</tt></td><td>- Last page of main index.
</td>
<td align=right
><tt>NEXT
</tt></td><td>- Next page of main index.
</td>
<td align=right
><tt>PREV
</tt></td><td>- Previous page of main index.
</td>
<td align=right
><tt>TFIRST
</tt></td><td>- First page of thread index.
</td>
<td align=right
><tt>TLAST
</tt></td><td>- Last page of thread index.
</td>
<td align=right
><tt>TNEXT
</tt></td><td>- Next page of thread index.
</td>
<td align=right
><tt>TPREV
</tt></td><td>- Previous page of thread index.
</td>
<p>If no value is given for
<i><tt>idx_page_spec
</tt></i>, the resource
variable's value is undefined.
<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.
<h3><a name=
"variables">Variables
</a></h3>
<!--X-Variable-Index-Start-->
<dt><strong><a name=
"A_ATTR"><tt>$A_ATTR$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<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. This resource variable is equivalent to
"<nobr><tt><a href="#A_NAME
">$A_NAME$</a> <a href="#A_HREF
">$A_HREF$</a></tt></nobr>".
<dt><strong><a name=
"A_HREF"><tt>$A_HREF$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td align=right
><b>Description:
</b></td>
<td>The
<tt>HREF
</tt> attribute to use in an anchor to link to the
This variable is equivalent to
"<tt>href="<a href=
"#MSG">$MSG$
</a>"</tt>".
<dt><strong><a name=
"A_NAME"><tt>$A_NAME$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td align=right
><b>Description:
</b></td>
<td>The
<tt>NAME
</tt> attribute to use in an anchor for messages to link
This variable is equivalent to
"<tt>name="<a href=
"#MSGNUM">$MSGNUM$
</a>"</tt>".
<dt><strong><a name=
"BUTTON"><tt>$BUTTON$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i><a href=
"#mesg_spec">mesg_spec
</a></i></tt></td>
<td align=right
><b>Description:
</b></td>
<td>Button markup linking to a message. The value of
<tt>$BUTTON$
</tt>
is determined by the following resources based on
<tt><i><a href=
"#mesg_spec">mesg_spec
</a></i></tt> value:
<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>,
<a href=
"resources/tnextinbutton.html">TNEXTINBUTTON
</a>,
<a href=
"resources/tnextinbuttonia.html">TNEXTINBUTTONIA
</a>,
<a href=
"resources/tnexttopbutton.html">TNEXTTOPBUTTON
</a>,
<a href=
"resources/tnexttopbuttonia.html">TNEXTTOPBUTTONIA
</a>,
<a href=
"resources/tprevbutton.html">TPREVBUTTON
</a>,
<a href=
"resources/tprevbuttonia.html">TPREVBUTTONIA
</a>,
<a href=
"resources/tprevinbutton.html">TPREVINBUTTON
</a>,
<a href=
"resources/tprevinbuttonia.html">TPREVINBUTTONIA
</a>,
<a href=
"resources/tprevtopbutton.html">TPREVTOPBUTTON
</a>,
<a href=
"resources/tprevtopbuttonia.html">TPREVTOPBUTTONIA
</a>.
<dt><strong><a name=
"DATE"><tt>$DATE$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i><a href=
"#mesg_spec">mesg_spec
</a></i></tt></td>
<td align=right
><b>Description:
</b></td>
<td>The date of the message.
</td>
<dt><strong><a name=
"DDMMYYYY"><tt>$DDMMYYYY$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i><a href=
"#mesg_spec">mesg_spec
</a></i></tt></td>
<td align=right
><b>Description:
</b></td>
<td>Message date (according to local time) in dd/mm/yyyy format.
</td>
<dt><strong><a name=
"DOCURL"><tt>$DOCURL$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<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>
<dt><strong><a name=
"ENV"><tt>$ENV$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i>variable_name
</i></tt></td>
<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><dt><strong><a name=
"FROM"><tt>$FROM$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i><a href=
"#mesg_spec">mesg_spec
</a></i></tt></td>
<td align=right
><b>Description:
</b></td>
<td>The complete text in the
<tt>From:
</tt> field of the message.
</td>
<dt><strong><a name=
"FROMADDR"><tt>$FROMADDR$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i><a href=
"#mesg_spec">mesg_spec
</a></i></tt></td>
<td align=right
><b>Description:
</b></td>
<td>The full mail address in the
<tt>From:
</tt> field of the message.
</td>
<dt><strong><a name=
"FROMADDRNAME"><tt>$FROMADDRNAME$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i><a href=
"#mesg_spec">mesg_spec
</a></i></tt></td>
<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@mhonarc.org",
<tt>$FROMADDRNAME$
</tt> would equal
"someuser".
</td>
<dt><strong><a name=
"FROMADDR"><tt>$FROMADDRDOMAIN$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i><a href=
"#mesg_spec">mesg_spec
</a></i></tt></td>
<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@mhonarc.org",
<tt>$FROMADDRDOMAIN$
</tt> would equal
"mhonarc.org".
</td>
<dt><strong><a name=
"FROMNAME"><tt>$FROMNAME$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i><a href=
"#mesg_spec">mesg_spec
</a></i></tt></td>
<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
<dt><strong><a name=
"GMTDATE"><tt>$GMTDATE$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i><a href=
"#time_fmt_str">time_fmt_str
</a></i></tt></td>
<td align=right
><b>Description:
</b></td>
Default format of date set by the
<a href=
"resources/gmtdatefmt.html">GMTDATEFMT
</a>
<dt><strong><a name=
"ICON"><tt>$ICON$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i><a href=
"#mesg_spec">mesg_spec
</a></i></tt></td>
<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><dt><strong><a name=
"ICONURL"><tt>$ICONURL$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i><a href=
"#mesg_spec">mesg_spec
</a></i></tt></td>
<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><dt><strong><a name=
"IDXFNAME"><tt>$IDXFNAME$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<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>.
<dt><strong><a name=
"IDXLABEL"><tt>$IDXLABEL$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<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>
<dt><strong><a name=
"IDXPREFIX"><tt>$IDXPREFIX$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<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.
<dt><strong><a name=
"IDXSIZE"><tt>$IDXSIZE$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<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.
<dt><strong><a name=
"IDXTITLE"><tt>$IDXTITLE$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<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.
<dt><strong><a name=
"LINK"><tt>$LINK$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i><a href=
"#mesg_spec">mesg_spec
</a></i></tt></td>
<td align=right
><b>Description:
</b></td>
<td>Link markup linking to a message.
The value of
<tt>$LINK$
</tt> is determined
by the following resources based on
<tt><i><a href=
"#mesg_spec">mesg_spec
</a></i></tt> value:
<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/tnextinlink.html">TNEXTINLINK
</a>,
<a href=
"resources/tnextinlinkia.html">TNEXTINLINKIA
</a>,
<a href=
"resources/tnexttoplink.html">TNEXTTOPLINK
</a>,
<a href=
"resources/tnexttoplinkia.html">TNEXTTOPLINKIA
</a>,
<a href=
"resources/tprevlink.html">TPREVLINK
</a>,
<a href=
"resources/tprevlinkia.html">TPREVLINKIA
</a>,
<a href=
"resources/tprevinlink.html">TPREVINLINK
</a>,
<a href=
"resources/tprevinlinkia.html">TPREVINLINKIA
</a>,
<a href=
"resources/tprevtoplink.html">TPREVTOPLINK
</a>,
<a href=
"resources/tprevtoplinkia.html">TPREVTOPLINKIA
</a>.
<dt><strong><a name=
"LOCALDATE"><tt>$LOCALDATE$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i><a href=
"#time_fmt_str">time_fmt_str
</a></i></tt></td>
<td align=right
><b>Description:
</b></td>
Default format of date set by the
<a href=
"resources/localdatefmt.html">LOCALDATEFMT
</a>
<dt><strong><a name=
"MMDDYYYY"><tt>$MMDDYYYY$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i><a href=
"#mesg_spec">mesg_spec
</a></i></tt></td>
<td align=right
><b>Description:
</b></td>
<td>Message (local) date in mm/dd/yyyy format.
</td>
<dt><strong><a name=
"MSG"><tt>$MSG$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i><a href=
"#mesg_spec">mesg_spec
</a></i></tt></td>
<td align=right
><b>Description:
</b></td>
<td>Filename of message. Filename of the message is determined by the
<a href=
"resources/htmlext.html">HTMLEXT
</a>,
<a href=
"resources/msgprefix.html">MSGPREFIX
</a>.
<dt><strong><a name=
"MSGGMTDATE"><tt>$MSGGMTDATE$
</tt></a></strong></dt>
<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>
<td align=right
><b>Description:
</b></td>
<td>GMT date of current message.
</td>
<dt><strong><a name=
"MSGID"><tt>$MSGID$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i><a href=
"#mesg_spec">mesg_spec
</a></i></tt></td>
<td align=right
><b>Description:
</b></td>
<td>The message-id of the message.
</td>
<dt><strong><a name=
"MSGLOCALDATE"><tt>$MSGLOCALDATE$
</tt></a></strong></dt>
<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>
<td align=right
><b>Description:
</b></td>
<td>Local date of current message.
</td>
<dt><strong><a name=
"MSGNUM"><tt>$MSGNUM$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i><a href=
"#mesg_spec">mesg_spec
</a></i></tt></td>
<td align=right
><b>Description:
</b></td>
<td>The message number assigned to the message by MHonArc (includes leading zeros).
</td>
<dt><strong><a name=
"MSGPREFIX"><tt>$MSGPREFIX$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td align=right
><b>Description:
</b></td>
<td>Filename prefix for message files.
<a href=
"resources/msgprefix.html">MSGPREFIX
</a>
<dt><strong><a name=
"MSGTORDNUM"><tt>$MSGTORDNUM$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i><a href=
"#mesg_spec">mesg_spec
</a></i></tt></td>
<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:
<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>
The above contains
8 total message in the discussion thread, so numbering
<dt><strong><a name=
"NOTE"><tt>$NOTE$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i><a href=
"#mesg_spec">mesg_spec
</a></i></tt></td>
<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>
<dt><strong><a name=
"NOTETEXT"><tt>$NOTETEXT$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i><a href=
"#mesg_spec">mesg_spec
</a></i></tt></td>
<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><dt><strong><a name=
"NUMFOLUP"><tt>$NUMFOLUP$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i><a href=
"#mesg_spec">mesg_spec
</a></i></tt></td>
<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>
<dt><strong><a name=
"NUMOFIDXMSG"><tt>$NUMOFIDXMSG$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td align=right
><b>Description:
</b></td>
<td>Number of message listed for the current page.
</td>
<dt><strong><a name=
"NUMOFMSG"><tt>$NUMOFMSG$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td align=right
><b>Description:
</b></td>
<td>Total number of messages in the archive.
</td>
<dt><strong><a name=
"NUMOFPAGES"><tt>$NUMOFPAGES$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td align=right
><b>Description:
</b></td>
<td>Total number of index pages for a given index type.
</td>
<dt><strong><a name=
"ORDNUM"><tt>$ORDNUM$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i><a href=
"#mesg_spec">mesg_spec
</a></i></tt></td>
<td align=right
><b>Description:
</b></td>
<td>The current listing number of the message.
</td>
<dt><strong><a name=
"OUTDIR"><tt>$OUTDIR$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td align=right
><b>Description:
</b></td>
<a href=
"resources/outdir.html">OUTDIR
</a>
<dt><strong><a name=
"PAGENUM"><tt>$PAGENUM$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td align=right
><b>Description:
</b></td>
<td>Current index page number.
</td>
<dt><strong><a name=
"PG"><tt>$PG$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i><a href=
"#idx_page_spec">idx_page_spec
</a></i></tt></td>
<td align=right
><b>Description:
</b></td>
<td>Filename of an index page.
<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
<dt><strong><a name=
"PGLINK"><tt>$PGLINK$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i><a href=
"#idx_page_spec">idx_page_spec
</a></i></tt></td>
<td align=right
><b>Description:
</b></td>
<td>Markup linking to a main index page.
<a href=
"resources/firstpglink.html">FIRSTPGLINK
</a>,
<a href=
"resources/lastpglink.html">LASTPGLINK
</a>,
<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/tfirstpglink.html">TFIRSTPGLINK
</a>,
<a href=
"resources/tlastpglink.html">TLASTPGLINK
</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.
<dt><strong><a name=
"PGLINKLIST"><tt>$PGLINKLIST$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i>num
</i>;
<i>num
</i></tt></td>
<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>If no arguments are provided to
<tt>$PGLINKLIST$
</tt>, then the
links to all index pages will be printed. To get the entire list
for a thread index, use
<tt>$PGLINKLIST(T)$
</tt>.
<dt><strong><a name=
"PROG"><tt>$PROG$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td align=right
><b>Description:
</b></td>
<dt><strong><a name=
"SUBJECT"><tt>$SUBJECT$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i><a href=
"#mesg_spec">mesg_spec
</a></i></tt></td>
<td align=right
><b>Description:
</b></td>
<td>The subject text of the message,
<em>and if no arguments
</em>, 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. The
no argument version is equivalent to:
"<nobr><tt><a <a href="#A_ATTR
">$A_ATTR$</a>><a href="#SUBJECTNA
">$SUBJECTNA$</a></a></tt></nobr>".
<dt><strong><a name=
"SUBJECTNA"><tt>$SUBJECTNA$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i><a href=
"#mesg_spec">mesg_spec
</a></i></tt></td>
<td align=right
><b>Description:
</b></td>
<td>The subject text of the message without the anchor element.
</td>
<dt><strong><a name=
"TIDXFNAME"><tt>$TIDXFNAME$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<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>.
<dt><strong><a name=
"TIDXLABEL"><tt>$TIDXLABEL$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<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>
<dt><strong><a name=
"TIDXPREFIX"><tt>$TIDXPREFIX$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td align=right
><b>Description:
</b></td>
<td>Prefix of filenames of thread index pages.
<a href=
"resources/tidxprefix.html">TIDXPREFIX
</a>
<dt><strong><a name=
"TIDXTITLE"><tt>$TIDXTITLE$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<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.
<dt><strong><a name=
"TLEVEL"><tt>$TLEVEL$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i><a href=
"#mesg_spec">mesg_spec
</a></i></tt></td>
<td align=right
><b>Description:
</b></td>
<td>Numeric level of message in current thread, starting with zero.
<dt><strong><a name=
"TO"><tt>$TO$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td align=right
><b>Description:
</b></td>
This variable is only applicable for use in the
<a href=
"resources/mailtourl.html">MAILTOURL
</a>.
</td>
<dt><strong><a name=
"TOADDRNAME"><tt>$TOADDRNAME$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td align=right
><b>Description:
</b></td>
<td>The username/local-part of the e-mail address.
For example, given the address
"someuser@mhonarc.org",
<tt>$TOADDRNAME$
</tt> would equal
"someuser".
This variable is only applicable for use in the
<a href=
"resources/mailtourl.html">MAILTOURL
</a>.
</td>
<dt><strong><a name=
"TOADDRDOMAIN"><tt>$TOADDRDOMAIN$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td align=right
><b>Description:
</b></td>
<td>The domain part of the e-mail address.
For example, given the address
"someuser@mhonarc.org",
<tt>$TOADDRDOMAIN$
</tt> would equal
"mhonarc.org".
This variable is only applicable for use in the
<a href=
"resources/mailtourl.html">MAILTOURL
</a>.
</td>
<dt><strong><a name=
"TSLICE"><tt>$TSLICE$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td><tt><i>number
</i>;
<i>number
</i>;
<i>flag
</i></tt></td>
<td align=right
><b>Description:
</b></td>
<td>A
<em>slice
</em> of the thread listing relative to the current message.
Size of slice is determined by the
<a href=
"resources/tslice.html">TSLICE
</a>resource, or explicitly by the arguments provided. The first argument
is the number of maximum messages to list before the current message.
The second argument is the number of maximum message messages to list
after the current message. The third argument is a flag,
<tt>0</tt>or
<tt>1</tt>, denoting if slice should cross discussion thread
boundaries or not. If any of the arguments are blank, the value
defined in the
<a href=
"resources/tslice.html">TSLICE
</a> resource
<p>Layout appearance of
<tt>$TSLICE$
</tt> is determined by
<a href=
"resources/tslicebeg.html">TSLICEBEG
</a>,
<a href=
"resources/tslicecontbeg.html">TSLICECONTBEG
</a>,
<a href=
"resources/tslicecontend.html">TSLICECONTEND
</a>,
<a href=
"resources/tsliceend.html">TSLICEEND
</a>,
<a href=
"resources/tsliceindentbeg.html">TSLICEINDENTBEG
</a>,
<a href=
"resources/tsliceindentend.html">TSLICEINDENTEND
</a>,
<a href=
"resources/tsliceliend.html">TSLICELIEND
</a>,
<a href=
"resources/tsliceliendcur.html">TSLICELIENDCUR
</a>,
<a href=
"resources/tslicelinone.html">TSLICELINONE
</a>,
<a href=
"resources/tslicelinoneend.html">TSLICELINONEEND
</a>,
<a href=
"resources/tslicelitxt.html">TSLICELITXT
</a>,
<a href=
"resources/tslicelitxtcur.html">TSLICELITXTCUR
</a>,
<a href=
"resources/tslicesingletxt.html">TSLICESINGLETXT
</a>,
<a href=
"resources/tslicesingletxtcur.html">TSLICESINGLETXTCUR
</a>,
<a href=
"resources/tslicesubjectbeg.html">TSLICESUBJECTBEG
</a>,
<a href=
"resources/tslicesubjectend.html">TSLICESUBJECTEND
</a>,
<a href=
"resources/tslicesublistbeg.html">TSLICESUBLISTBEG
</a>,
<a href=
"resources/tslicesublistend.html">TSLICESUBLISTEND
</a>,
<a href=
"resources/tslicetopbeg.html">TSLICETOPBEG
</a>,
<a href=
"resources/tslicetopbegcur.html">TSLICETOPBEGCUR
</a>,
<a href=
"resources/tslicetopend.html">TSLICETOPEND
</a>, and
<a href=
"resources/tslicetopendcur.html">TSLICETOPENDCUR
</a>
<dt><strong><a name=
"VERSION"><tt>$VERSION$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td align=right
><b>Description:
</b></td>
<td>Program version.
</td>
<dt><strong><a name=
"YYYYMMDD"><tt>$YYYYMMDD$
</tt></a></strong></dt>
<td align=right
><b>Arguments:
</b></td>
<td align=right
><b>Description:
</b></td>
<td>Message (local) date in yyyy/mm/dd format.
</td>
<!--X-Variable-Index-End-->
<!-- *************************************************************** -->
<!--X-NavButtons-Start-->
<td align=
"left"><nobr><a href=
"resources.html"><img src=
"prev.png"border=
0 alt=
"[Prev]"></a> </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> <a href=
"contacts.html"><img src=
"next.png" border=
0 alt=
"[Next]"></a></nobr></td></tr></table>
<!-- *************************************************************** -->
$Date:
2002/
07/
27 05:
13:
10 $
<br><img align=
"top" src=
"monicon.png" alt=
"">
<a href=
"http://www.mhonarc.org"
><strong>MHonArc
</strong></a><br>
Copyright
© 1998-
1999,
<a href=
"http://www.mhonarc.org/~ehood/">Earl Hood
</a>,
<a href=
"mailto:mhonarc@mhonarc.org"
>mhonarc@mhonarc.org
</a><br>
projects / OpenSPARC-T2-DV / blob