LISTBEGIN

Syntax
Description
Default Setting
Resource Variables
Examples
Version
See Also

Syntax

Envariable: N/A
Element: <LISTBEGIN> markup ...
</LISTBEGIN>
Command-line Option: N/A

Description

The LISTBEGIN resource specifies the markup to begin the message list. This resource works in conjuction with LITEMPLATE and LISTEND resources to format the main index page(es).

Default Setting

If MULTIPG is not active:

<ListBegin>
<ul>
<li><a href="$TIDXFNAME$">Thread Index</a></li>
</ul>
<hr>
<ul>
</ListBegin>

If MULTIPG is active:

<ListBegin>
<ul>
<li><a href="$TIDXFNAME$">Thread Index</a></li>
</ul>
$PGLINK(PREV)$$PGLINK(NEXT)$
<hr>
<ul>
</ListBegin>

Resource Variables

Variable	Value
$ATTACHMENTURL$	Base URL to attachments
$DOCURL$	URL to documentation.
$ENV$	Value of an environment variable.
$GMTDATE$	Current GMT date.
$ICONURLPREFIX$	Value of ICONURLPREFIX resource.
$IDXFNAME$	Filename of main index page.
$IDXLABEL$	Label for main index page.
$IDXPREFIX$	Prefix of filenames of main index pages.
$IDXSIZE$	Max number of messages that may be listed in index page.
$IDXTITLE$	The title of the main index page.
$LOCALDATE$	Current local date.
$NUMOFIDXMSG$	Number of message listed.
$NUMOFMSG$	Number of messages in the archive.
$NUMOFPAGES$	Number of index pages.
$OUTDIR$	Pathname of archive.
$PAGENUM$	Current index page number.
$PG$	Filename of an index page.
$PGLINK$	Markup linking to an index page.
$PGLINKLIST$	List of links to index pages.
$PROG$	Program name
$TIDXFNAME$	Filename of thread index page.
$TIDXLABEL$	Label for thread index page.
$TIDXPREFIX$	Prefix of filenames of thread index pages.
$TIDXTITLE$	Title of thread index.
$VERSION$	Program version.

Examples

Here is an example that includes links for the first and last page of the index for a mult-page index:

<ListBegin>
<ul>
<li><a href="$TIDXFNAME$">Thread Index</a></li>
</ul>
<table width="100%" border=0 cols=2 cellpadding=0 cellspacing=0>
<tbody>
<tr align="center">
<th colspan=4>Page $PAGENUM$ of $NUMOFPAGES$
<tr>
<td align="left">$PGLINK(PREV)$
<td align="right">[<a href="$PG(FIRST)$">First Page</a>]
<td align="left">[<a href="$PG(LAST)$">Last Page</a>]
<td align="right">$PGLINK(NEXT)
</tbody>
</table>
<hr>
<ul>
</ListBegin>

Version

1.0