TOPLINKS

Syntax

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

Description

TOPLINKS defines the markup for the navigational links at the top of a message page. Its usage is analagous to the BOTLINKS resource, but tends to be terser. However, you can define the resource anyway you desire.

Default Setting

The following represents the default setting when there are main and thread indexes. References to either index will not show up if either index does not exist.

<TopLinks>
<HR>
$BUTTON(PREV)$$BUTTON(NEXT)$$BUTTON(TPREV)$$BUTTON(TNEXT)$[<A
HREF="$IDXFNAME$#$MSGNUM$">Date Index</A>][<A
HREF="$TIDXFNAME$#$MSGNUM$">Thread Index</A>]
</TopLinks>

Resource Variables

Variable	Value
$BUTTON$	Button markup linking to a message.
$DATE$	The date of the message.
$DDMMYYYY$	Message date in dd/mm/yyyy format.
$DOCURL$	URL to documentation.
$FIRSTPG$	Filename of first page of main index.
$FROM$	The complete text in the `From:` field of the message.
$FROMADDR$	The e-mail address in the `From:` field of the message.
$FROMNAME$	The human name of the person in the `From:` field of the message. If no human name is found, the username specified in the e-mail address is used.
$GMTDATE$	Current GMT date.
$ICON$	The context-type sensistive icon.
$ICONURL$	The URL to the context-type sensistive icon.
$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.
$LASTPG$	Filename of last page in of main index.
$LINK$	Link markup linking to a message.
$LOCALDATE$	Current local date.
$MMDDYYYY$	Message date in mm/dd/yyyy format.
$MSG$	Filename of message.
$MSGGMTDATE$	GMT date of current message.
$MSGID$	The message-id of the message.
$MSGLOCALDATE$	Local date of current message.
$MSGNUM$	The message number assigned to the message by MHonArc (includes leading zeros).
$MSGPREFIX$	Filename prefix for message files.
$NUMFOLUP$	Number of explicit follow-ups to the message.
$NUMOFMSG$	Number of messages in the archive.
$NUMOFPAGES$	Number of index pages.
$ORDNUM$	The current listing number of the message.
$OUTDIR$	Pathname of archive.
$PROG$	Program name
$SUBJECTNA$	The subject text of the message without the anchor element.
$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.
$TSLICE$	A slice of the thread listing relative to the current message. Size of slice determined by the TSLICE resource.
$VERSION$	Program version.
$YYYYMMDD$	Message date in yyyy/mm/dd format.

Examples

The following shows an example of using button icons for links to the index pages:

<TopLinks>
<HR>
$BUTTON(PREV)$$BUTTON(NEXT)$$BUTTON(TPREV)$$BUTTON(TNEXT)$<A
HREF="$IDXFNAME$#$MSGNUM$"><IMG
SRC="dateidx.gif" ALT="[Date Index]"></A><A
HREF="$TIDXFNAME$#$MSGNUM$"><IMG
SRC="thrdidx.gif" ALT="[Thread Index]"></A>]
</TopLinks>

Version

1.2