Sophie

Sophie

distrib > Mandriva > 8.2 > i586 > media > contrib > by-pkgid > 61dabb0b59bf11e80f1327c065cec842 > files > 145

MHonArc-2.4.9-1mdk.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN">
<html>
<head>
<title>MHonArc Resources: IDXPGBEGIN</title>
</head>
<body>

<address>
<a href="../resources.html#idxpgbegin">MHonArc Resource List</a>
</address>

<hr>
<h1>IDXPGBEGIN</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>&lt;IDXPGBEGIN&gt;<br></code>
<var>markup ...</var><br>
<code>&lt;/IDXPGBEGIN&gt;<br></code>
</p>
</dd>

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

</dl>

<!-- *************************************************************** -->
<hr>
<h2>Description</h2>

<p>The IDXPGBEGIN resource defines the beginning markup for the main
index page.  I.e. You can control the opening &lt;HTML&gt; tag, the
HEAD element contents, the opening &lt;BODY&gt; tag, etc. Therefore,
if you are not satisfied with the default behavior of how the
<a href="title.html">TITLE</a>
resource is used, or have other needs that require control over the
beginning markup, you can set the IDXPGBEGIN resource to what you
desire.
</p>

<!-- *************************************************************** -->
<hr>
<h2>Default Setting</h2>

<PRE>
<b>&lt;IdxPgBegin&gt;</b>
&lt;!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN"&gt;
&lt;HTML&gt;
&lt;HEAD&gt;
&lt;TITLE&gt;<a href="#IDXTITLE">$IDXTITLE$</a>&lt;/TITLE&gt;
&lt;/HEAD&gt;
&lt;BODY&gt;
&lt;H1&gt;<a href="#IDXTITLE">$IDXTITLE$</a>&lt;/H1&gt;
<b>&lt;/IdxPgBegin&gt;</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>The following shows how you can set HTML body element attributes
to control the appearence of the index page:
</p>

<PRE>
<b>&lt;IdxPgBegin&gt;</b>
&lt;!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN"&gt;
&lt;HTML&gt;
&lt;HEAD&gt;
&lt;TITLE&gt;<a href="#IDXTITLE">$IDXTITLE$</a>&lt;/TITLE&gt;
&lt;/HEAD&gt;
&lt;BODY <em>background="idxbg.gif" bgproperties="fixed"</em>&gt;
&lt;H1&gt;<a href="#IDXTITLE">$IDXTITLE$</a>&lt;/H1&gt;
<b>&lt;/IdxPgBegin&gt;</b>
</PRE>

<!-- *************************************************************** -->
<hr>
<h2>Version</h2>

<p>1.2
</p>

<!-- *************************************************************** -->
<hr>
<h2>See Also</h2>

<p>
<a href="idxpgend.html">IDXPGEND</a>,
<a href="title.html">TITLE</a>,
<a href="tidxpgbegin.html">TIDXPGBEGIN</a>,
<a href="tidxpgend.html">TIDXPGEND</a>
</p>

<!-- *************************************************************** -->
<hr>
<address>
00/10/28 11:13:02<br>
<img align="top" src="../monicon.gif" alt="">
<a href="http://www.pobox.com/~ehood/mhonarc.html"><strong>MHonArc</strong></a><br>
Copyright &#169; 1997-1998, <a href="http://www.pobox.com/~ehood/">Earl Hood</a>, <a href="mailto:mhonarc@pobox.com">mhonarc@pobox.com</a><br>
</address>

</body>
</html>