[Prev: IDXLABEL] | [Resources][TOC] | [Next: IDXPGEND]

# IDXPGBEGIN

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

## Syntax

Envariable

  N/A

Element

  `<IDXPGBEGIN>
  ` markup ...
  `</IDXPGBEGIN>
  `

Command-line Option

  N/A

## Description

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

## Default Setting

    <IdxPgBegin>
    <!doctype html public "-//W3C//DTD HTML//EN">
    <html>
    <head>
    <title>$IDXTITLE$</title>
    </head>
    <body>
    <h1>$IDXTITLE$</h1>
    </IdxPgBegin>

## Resource Variables

Variable | Value
--- | ---
`$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

The following shows how you can set HTML body element attributes to control the appearence of the index page:

    <IdxPgBegin>
    <!doctype html public "-//W3C//DTD HTML//EN">
    <html>
    <head>
    <title>$IDXTITLE$</title>
    </head>
    <body background="idxbg.png" bgproperties="fixed">
    <h1>$IDXTITLE$</h1>
    </IdxPgBegin>

## Version

1.2

## See Also

IDXPGEND, TITLE, TIDXPGBEGIN, TIDXPGEND

[Prev: IDXLABEL] | [Resources][TOC] | [Next: IDXPGEND]