<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN"> <html> <head> <title>MHonArc Resources: LISTBEGIN</title> </head> <body> <em><a href="../resources.html#listbegin">MHonArc Resource List</a></em> | <a href="../mhonarc.html">TOC</a> <hr> <h1>LISTBEGIN</h1> <!-- *************************************************************** --> <hr> <h2>Syntax</h2> <dl> <dt><strong>Envariable</strong></dt> <dd><p>N/A </p> </dd> <dt><strong>Element</strong></dt> <dd><p> <code><LISTBEGIN><br></code> <var>markup ...</var><br> <code></LISTBEGIN><br></code> </p> </dd> <dt><strong>Command-line Option</strong></dt> <dd><p>N/A </p> </dd> </dl> <!-- *************************************************************** --> <hr> <h2>Description</h2> <P>The LISTBEGIN resource specifies the markup to begin the message list. This resource works in conjuction with <a href="litemplate.html">LITEMPLATE</a> and <a href="listend.html">LISTEND</a> resources to format the main index page(es). </p> <!-- *************************************************************** --> <hr> <h2>Default Setting</h2> <p>If <a href="multipg.html">MULTIPG</a> is not active: </p> <PRE> <b><ListBegin></b> <UL> <LI><A HREF="<a href="#TIDXFNAME">$TIDXFNAME$</a>">Thread Index</A></LI> </UL> <HR> <UL> <b></ListBegin></b> </PRE> <p>If <a href="multipg.html">MULTIPG</a> is active: </p> <PRE> <b><ListBegin></b> <UL> <LI><A HREF="<a href="#TIDXFNAME">$TIDXFNAME$</a>">Thread Index</A></LI> </UL> <a href="#PGLINK">$PGLINK(PREV)$</a><a href="#PGLINK">$PGLINK(NEXT)$</a> <HR> <UL> <b></ListBegin></b> </PRE> <!-- *************************************************************** --> <hr> <h2>Resource Variables</h2> <table border=1> <tr bgcolor="#C0C0C0"> <th>Variable</th><th>Value</th> </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="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="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="NUMOFIDXMSG" href="../rcvars.html#NUMOFIDXMSG"><strong><code>$NUMOFIDXMSG$</code></strong></a></td> <td>Number of message listed.</td> </tr> <tr valign=top> <td align=center><a name="NUMOFMSG" href="../rcvars.html#NUMOFMSG"><strong><code>$NUMOFMSG$</code></strong></a></td> <td>Number of messages in the archive.</td> </tr> <tr valign=top> <td align=center><a name="NUMOFPAGES" href="../rcvars.html#NUMOFPAGES"><strong><code>$NUMOFPAGES$</code></strong></a></td> <td>Number of index pages.</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="PAGENUM" href="../rcvars.html#PAGENUM"><strong><code>$PAGENUM$</code></strong></a></td> <td>Current index page number.</td> </tr> <tr valign=top> <td align=center><a name="PG" href="../rcvars.html#PG"><strong><code>$PG$</code></strong></a></td> <td>Filename of an index page.</td> </tr> <tr valign=top> <td align=center><a name="PGLINK" href="../rcvars.html#PGLINK"><strong><code>$PGLINK$</code></strong></a></td> <td>Markup linking to an index page.</td> </tr> <tr valign=top> <td align=center><a name="PGLINKLIST" href="../rcvars.html#PGLINKLIST"><strong><code>$PGLINKLIST$</code></strong></a></td> <td>List of links to index pages.</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="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> </table> <!-- *************************************************************** --> <hr> <h2>Examples</h2> <p>Here is an example that includes links for the first and last page of the index for a mult-page index: </p> <PRE> <b><ListBegin></b> <ul> <li><a href="<a href="#TIDXFNAME">$TIDXFNAME$</a>">Thread Index</a></li> </ul> <table width="100%" border=0 cols=2 cellpadding=0 cellspacing=0> <tbody> <tr align="center"> <th colspan=4>Page <a href="#PAGENUM">$PAGENUM$</a> of <a href="#NUMOFPAGES">$NUMOFPAGES$</a> <tr> <td align="left"><a href="#PGLINK">$PGLINK(PREV)$</a> <td align="right">[<a href="<a href="#FIRSTPG">$PG(FIRST)$</a>">First Page</a>] <td align="left">[<a href="<a href="#LASTPG">$PG(LAST)$</a>">Last Page</a>] <td align="right"><a href="#PGLINK">$PGLINK(NEXT)</a> </tbody> </table> <hr> <ul> <b></ListBegin></b> </PRE> <!-- *************************************************************** --> <hr> <h2>Version</h2> <p>1.0 </p> <!-- *************************************************************** --> <hr> <h2>See Also</h2> <p> <a href="listend.html">LISTEND</a>, <a href="litemplate.html">LITEMPLATE</a>, <a href="multipg.html">MULTIPG</a> </p> <!-- *************************************************************** --> <hr> <address> $Date: 2002/04/01 20:37:31 $ <br> <img align="top" src="../monicon.png" alt=""> <a href="http://www.mhonarc.org/"><strong>MHonArc</strong></a><br> Copyright © 1997-1998, <a href="http://www.earlhood.com/">Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org">mhonarc@mhonarc.org</a><br> </address> </body> </html>
