The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
<html>
<head>
<title>MHonArc Resources: SUBJECTBEGIN</title>
<link rel="stylesheet" type="text/css" href="../docstyles.css">
</head>
<body>
<!--x-rc-nav-->
<table border=0><tr valign="top">
<td align="left" width="50%">[Prev:&nbsp;<a href="subjectarticlerxp.html">SUBJECTARTICLERXP</a>]</td><td><nobr>[<a href="../resources.html#subjectbegin">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="subjectend.html">SUBJECTEND</a>]</td></tr></table>
<!--/x-rc-nav-->
<hr>
<h1>SUBJECTBEGIN</h1>
<!--X-TOC-Start-->
<ul>
<li><a href="#syntax">Syntax</a>
<li><a href="#description">Description</a>
<li><a href="#default">Default Setting</a>
<li><a href="#rcvars">Resource Variables</a>
<li><a href="#examples">Examples</a>
<li><a href="#version">Version</a>
<li><a href="#seealso">See Also</a>
</ul>
<!--X-TOC-End-->

<!-- *************************************************************** -->
<hr>
<h2><a name="syntax">Syntax</a></h2>

<dl>

<dt><strong>Envariable</strong></dt>
<dd><p>
N/A
</p>
</dd>

<dt><strong>Element</strong></dt>
<dd><p>
<code>&lt;SUBJECTBEGIN&gt;</code><br>
<var>markup ...</var><br>
<code>&lt;/SUBJECTBEGIN&gt;</code><br>
</p>
</dd>

<dt><strong>Command-line Option</strong></dt>
<dd><p>
N/A
</p>
</dd>

</dl>

<!-- *************************************************************** -->
<hr>
<h2><a name="description">Description</a></h2>

<p>SUBJECTBEGIN defines the beginning markup of a subject group
in the main index if the
<a href="subsort.html">SUBSORT</a>
resource is set.
A subject group is a group of messages with the same subject.
</p>

<p>Any message related resource variables available for the SUBJECTBEGIN
evaluate based on information from the first message in the group.
</p>

<!-- *************************************************************** -->
<hr>
<h2><a name="default">Default Setting</a></h2>

<p>Nil.
</p>

<!-- *************************************************************** -->
<hr>
<h2><a name="rcvars">Resource Variables</a></h2>

<table border=1>
<tr bgcolor="#C0C0C0">
<th>Variable</th><th>Value</th>
</tr>
<tr valign=top>
<td align=center><a name="ATTACHMENTURL" href="../rcvars.html#ATTACHMENTURL"><strong><code>$ATTACHMENTURL$</code></strong></a></td>
<td>Base URL to attachments</td>
</tr>
<tr valign=top>
<td align=center><a name="A_ATTR" href="../rcvars.html#A_ATTR"><strong><code>$A_ATTR$</code></strong></a></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 links the messages to the index page.</td>
</tr>
<tr valign=top>
<td align=center><a name="A_HREF" href="../rcvars.html#A_HREF"><strong><code>$A_HREF$</code></strong></a></td>
<td>The <tt>HREF</tt> attribute to use in an anchor to link to the archived message.</td>
</tr>
<tr valign=top>
<td align=center><a name="A_NAME" href="../rcvars.html#A_NAME"><strong><code>$A_NAME$</code></strong></a></td>
<td>The <tt>NAME</tt> attribute to use in an anchor for messages to link to the index page.</td>
</tr>
<tr valign=top>
<td align=center><a name="DATE" href="../rcvars.html#DATE"><strong><code>$DATE$</code></strong></a></td>
<td>The date of the message.</td>
</tr>
<tr valign=top>
<td align=center><a name="DDMMYYYY" href="../rcvars.html#DDMMYYYY"><strong><code>$DDMMYYYY$</code></strong></a></td>
<td>Message date in dd/mm/yyyy format.</td>
</tr>
<tr valign=top>
<td align=center><a name="DOCURL" href="../rcvars.html#DOCURL"><strong><code>$DOCURL$</code></strong></a></td>
<td>URL to documentation.</td>
</tr>
<tr valign=top>
<td align=center><a name="ENV" href="../rcvars.html#ENV"><strong><code>$ENV$</code></strong></a></td>
<td>Value of an environment variable.</td>
</tr>
<tr valign=top>
<td align=center><a name="FROM" href="../rcvars.html#FROM"><strong><code>$FROM$</code></strong></a></td>
<td>The complete text in the <tt>From:</tt> field of the message.</td>
</tr>
<tr valign=top>
<td align=center><a name="FROMADDR" href="../rcvars.html#FROMADDR"><strong><code>$FROMADDR$</code></strong></a></td>
<td>The e-mail address in the <tt>From:</tt> field of the message.</td>
</tr>
<tr valign=top>
<td align=center><a name="FROMADDRDOMAIN" href="../rcvars.html#FROMADDRDOMAIN"><strong><code>$FROMADDRDOMAIN$</code></strong></a></td>
<td>The e-mail address domain of the <tt>From:</tt> field of the message.</td>
</tr>
<tr valign=top>
<td align=center><a name="FROMADDRNAME" href="../rcvars.html#FROMADDRNAME"><strong><code>$FROMADDRNAME$</code></strong></a></td>
<td>The e-mail address "username" (or local-part) of the <tt>From:</tt> field of the message.</td>
</tr>
<tr valign=top>
<td align=center><a name="FROMNAME" href="../rcvars.html#FROMNAME"><strong><code>$FROMNAME$</code></strong></a></td>
<td>The human name of the person in the <tt>From:</tt> field of the message. If no human name is found, the username specified in the e-mail address is used.</td>
</tr>
<tr valign=top>
<td align=center><a name="GMTDATE" href="../rcvars.html#GMTDATE"><strong><code>$GMTDATE$</code></strong></a></td>
<td>Current GMT date.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICON" href="../rcvars.html#ICON"><strong><code>$ICON$</code></strong></a></td>
<td>The content-type sensitive icon.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICONURL" href="../rcvars.html#ICONURL"><strong><code>$ICONURL$</code></strong></a></td>
<td>URL to the content-type sensitive icon.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICONURLPREFIX" href="../rcvars.html#ICONURLPREFIX"><strong><code>$ICONURLPREFIX$</code></strong></a></td>
<td>Value of ICONURLPREFIX resource.</td>
</tr>
<tr valign=top>
<td align=center><a name="IDXFNAME" href="../rcvars.html#IDXFNAME"><strong><code>$IDXFNAME$</code></strong></a></td>
<td>Filename of main index page.</td>
</tr>
<tr valign=top>
<td align=center><a name="IDXLABEL" href="../rcvars.html#IDXLABEL"><strong><code>$IDXLABEL$</code></strong></a></td>
<td>Label for main index page.</td>
</tr>
<tr valign=top>
<td align=center><a name="IDXPREFIX" href="../rcvars.html#IDXPREFIX"><strong><code>$IDXPREFIX$</code></strong></a></td>
<td>Prefix of filenames of main index pages.</td>
</tr>
<tr valign=top>
<td align=center><a name="IDXSIZE" href="../rcvars.html#IDXSIZE"><strong><code>$IDXSIZE$</code></strong></a></td>
<td>Max number of messages that may be listed in index page.</td>
</tr>
<tr valign=top>
<td align=center><a name="IDXTITLE" href="../rcvars.html#IDXTITLE"><strong><code>$IDXTITLE$</code></strong></a></td>
<td>The title of the main index page.</td>
</tr>
<tr valign=top>
<td align=center><a name="LOCALDATE" href="../rcvars.html#LOCALDATE"><strong><code>$LOCALDATE$</code></strong></a></td>
<td>Current local date.</td>
</tr>
<tr valign=top>
<td align=center><a name="MMDDYYYY" href="../rcvars.html#MMDDYYYY"><strong><code>$MMDDYYYY$</code></strong></a></td>
<td>Message date in mm/dd/yyyy format.</td>
</tr>
<tr valign=top>
<td align=center><a name="MSG" href="../rcvars.html#MSG"><strong><code>$MSG$</code></strong></a></td>
<td>Filename of message.</td>
</tr>
<tr valign=top>
<td align=center><a name="MSGGMTDATE" href="../rcvars.html#MSGGMTDATE"><strong><code>$MSGGMTDATE$</code></strong></a></td>
<td>GMT date of current message.</td>
</tr>
<tr valign=top>
<td align=center><a name="MSGHFIELD" href="../rcvars.html#MSGHFIELD"><strong><code>$MSGHFIELD$</code></strong></a></td>
<td>Message header field</td>
</tr>
<tr valign=top>
<td align=center><a name="MSGID" href="../rcvars.html#MSGID"><strong><code>$MSGID$</code></strong></a></td>
<td>The message-id of the message.</td>
</tr>
<tr valign=top>
<td align=center><a name="MSGLOCALDATE" href="../rcvars.html#MSGLOCALDATE"><strong><code>$MSGLOCALDATE$</code></strong></a></td>
<td>Local date of current message.</td>
</tr>
<tr valign=top>
<td align=center><a name="MSGNUM" href="../rcvars.html#MSGNUM"><strong><code>$MSGNUM$</code></strong></a></td>
<td>The message number assigned to the message by MHonArc (includes leading zeros).</td>
</tr>
<tr valign=top>
<td align=center><a name="MSGPREFIX" href="../rcvars.html#MSGPREFIX"><strong><code>$MSGPREFIX$</code></strong></a></td>
<td>Filename prefix for message files.</td>
</tr>
<tr valign=top>
<td align=center><a name="MSGTORDNUM" href="../rcvars.html#MSGTORDNUM"><strong><code>$MSGTORDNUM$</code></strong></a></td>
<td>The ordinal message number of the current discussion thread.</td>
</tr>
<tr valign=top>
<td align=center><a name="NOTE" href="../rcvars.html#NOTE"><strong><code>$NOTE$</code></strong></a></td>
<td>Message annotation.</td>
</tr>
<tr valign=top>
<td align=center><a name="NUMFOLUP" href="../rcvars.html#NUMFOLUP"><strong><code>$NUMFOLUP$</code></strong></a></td>
<td>Number of explicit follow-ups to the message.</td>
</tr>
<tr valign=top>
<td align=center><a name="ORDNUM" href="../rcvars.html#ORDNUM"><strong><code>$ORDNUM$</code></strong></a></td>
<td>The current listing number of the message.</td>
</tr>
<tr valign=top>
<td align=center><a name="OUTDIR" href="../rcvars.html#OUTDIR"><strong><code>$OUTDIR$</code></strong></a></td>
<td>Pathname of archive.</td>
</tr>
<tr valign=top>
<td align=center><a name="PROG" href="../rcvars.html#PROG"><strong><code>$PROG$</code></strong></a></td>
<td>Program name</td>
</tr>
<tr valign=top>
<td align=center><a name="SUBJECT" href="../rcvars.html#SUBJECT"><strong><code>$SUBJECT$</code></strong></a></td>
<td>The subject text of the message, and if no arguments, wrapped in an anchor element that hyperlinks to the message.</td>
</tr>
<tr valign=top>
<td align=center><a name="SUBJECTNA" href="../rcvars.html#SUBJECTNA"><strong><code>$SUBJECTNA$</code></strong></a></td>
<td>The subject text of the message without the anchor element.</td>
</tr>
<tr valign=top>
<td align=center><a name="TIDXFNAME" href="../rcvars.html#TIDXFNAME"><strong><code>$TIDXFNAME$</code></strong></a></td>
<td>Filename of thread index page.</td>
</tr>
<tr valign=top>
<td align=center><a name="TIDXLABEL" href="../rcvars.html#TIDXLABEL"><strong><code>$TIDXLABEL$</code></strong></a></td>
<td>Label for thread index page.</td>
</tr>
<tr valign=top>
<td align=center><a name="TIDXPREFIX" href="../rcvars.html#TIDXPREFIX"><strong><code>$TIDXPREFIX$</code></strong></a></td>
<td>Prefix of filenames of thread index pages.</td>
</tr>
<tr valign=top>
<td align=center><a name="TIDXTITLE" href="../rcvars.html#TIDXTITLE"><strong><code>$TIDXTITLE$</code></strong></a></td>
<td>Title of thread index.</td>
</tr>
<tr valign=top>
<td align=center><a name="VERSION" href="../rcvars.html#VERSION"><strong><code>$VERSION$</code></strong></a></td>
<td>Program version.</td>
</tr>
<tr valign=top>
<td align=center><a name="YYYYMMDD" href="../rcvars.html#YYYYMMDD"><strong><code>$YYYYMMDD$</code></strong></a></td>
<td>Message date in yyyy/mm/dd format.</td>
</tr>
</table>

<!-- *************************************************************** -->
<hr>
<h2><a name="examples">Examples</a></h2>

<p>The following example resource settings cause the main index
to be sorted by subject.  The listing will contain each subject
followed by an author sub-listing:
</p>

<pre>
<b>&lt;<a href="subsort.html">SubSort</a>></b>

<b>&lt;SubjectBegin></b>
&lt;li&gt;&lt;strong&gt;$SUBJECTNA$&lt;/strong&gt;
&lt;ul&gt;
<b>&lt;/SubjectBegin></b>

<b>&lt;<a href="subjectend.html">SubjectEnd</a>></b>
&lt;/li&gt;&lt;/ul&gt;
<b>&lt;/SubjectEnd></b>

<b>&lt;<a href="litemplate.html">LITemplate</a>></b>
&lt;li&gt;&lt;a <a href="#A_ATTR">$A_ATTR$</a>&gt;<a href="#FROMNAME">$FROMNAME$</a>&lt;/a&gt;&lt;/li&gt;
<b>&lt;/LITemplate></b>
</pre>

<!-- *************************************************************** -->
<hr>
<h2><a name="version">Version</a></h2>

<p>2.0
</p>

<!-- *************************************************************** -->
<hr>
<h2><a name="seealso">See Also</a></h2>

<p>
<a href="subjectend.html">SUBJECTEND</a>,
<a href="subsort.html">SUBSORT</a>
</p>

<!-- *************************************************************** -->
<hr>
<!--x-rc-nav-->
<table border=0><tr valign="top">
<td align="left" width="50%">[Prev:&nbsp;<a href="subjectarticlerxp.html">SUBJECTARTICLERXP</a>]</td><td><nobr>[<a href="../resources.html#subjectbegin">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="subjectend.html">SUBJECTEND</a>]</td></tr></table>
<!--/x-rc-nav-->
<hr>
<address>
$Date: 2003/10/06 22:04:20 $ <br>
<img align="top" src="../monicon.png" alt="">
<a href="http://www.mhonarc.org/"
><strong>MHonArc</strong></a><br>
Copyright &#169; 1997-1998, <a href="http://www.earlhood.com/"
>Earl Hood</a>, <a href="mailto:mhonarc&#37;40mhonarc.org"
>mhonarc<!--
-->&#64;<!--
-->mhonarc.org</a><br>
</address>

</body>
</html>