[Prev: TFOOT] | [Resources][TOC] | [Next: THREAD]

# THEAD

- Syntax
- Description
- Default Setting
- Resource Variables
- Examples
- Version
- See Also

## Syntax

Envariable

  N/A

Element

  `<THEAD>
  ` markup ...
  `</THEAD>
  `

Command-line Option

  N/A

## Description

THEAD defines the header markup of thread index pages. It is also responsible for defining the opening markup for the thread listing.

## Default Setting

If MULTIPG is on:

    <THead>
    <ul>
    <li><a href="$IDXFNAME$">Main Index</a></li>
    </ul>
    $PGLINK(TPREV)$$PGLINK(TNEXT)$
    <hr>
    <ul>
    </THead>

If MULTIPG is off:

    <THead>
    <ul>
    <li><a href="$IDXFNAME$">Main Index</a></li>
    </ul>
    <hr>
    <ul>
    </THead>

## 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.
`$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

The following example sets THEAD to contain page links for a multi-page thread index:

    <THead>
    <ul>
    <li><a href="$IDXFNAME$">Date Index</a></li>
    </ul>
    <hr>
    <table border=0 width="100%">
    <tbody>
    <tr align="center">
    <th colspan=4>Page $PAGENUM$ of $NUMOFPAGES$
    <tr>
    <td align="left">$PGLINK(TPREV)$
    <td align="right">[<a href="$TFIRSTPG(TFIRST)$">First Page</a>]
    <td align="left">[<a href="$PG(TLAST)$">Last Page</a>]
    <td align="right">$PGLINK(TNEXT)$
    </tbody>
    </table>
    <hr>
    <ul>
    </THead>

## Version

1.1

## See Also

MULTIPG, TFOOT, TNEXTPGLINK, TPREVPGLINK

[Prev: TFOOT] | [Resources][TOC] | [Next: THREAD]