SUBJECTBEGIN

Syntax

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

Description

SUBJECTBEGIN defines the beginning markup of a subject group in the main index if the SUBSORT resource is set. A subject group is a group of messages with the same subject.

Any message related resource variables available for the SUBJECTBEGIN evaluate based on information from the first message in the group.

Default Setting

Nil.

Resource Variables

Variable	Value
$ATTACHMENTURL$	Base URL to attachments
$A_ATTR$	The `NAME` and `HREF` attributes to use in an anchor to link to the archived message. The `NAME` attribute links the messages to the index page.
$A_HREF$	The `HREF` attribute to use in an anchor to link to the archived message.
$A_NAME$	The `NAME` attribute to use in an anchor for messages to link to the index page.
$DATE$	The date of the message.
$DDMMYYYY$	Message date in dd/mm/yyyy format.
$DOCURL$	URL to documentation.
$ENV$	Value of an environment variable.
$FROM$	The complete text in the `From:` field of the message.
$FROMADDR$	The e-mail address in the `From:` field of the message.
$FROMADDRDOMAIN$	The e-mail address domain of the `From:` field of the message.
$FROMADDRNAME$	The e-mail address "username" (or local-part) of 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 content-type sensitive icon.
$ICONURL$	URL to the content-type sensitive icon.
$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.
$MMDDYYYY$	Message date in mm/dd/yyyy format.
$MSG$	Filename of message.
$MSGGMTDATE$	GMT date of current message.
$MSGHFIELD$	Message header field
$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.
$MSGTORDNUM$	The ordinal message number of the current discussion thread.
$NOTE$	Message annotation.
$NUMFOLUP$	Number of explicit follow-ups to the message.
$ORDNUM$	The current listing number of the message.
$OUTDIR$	Pathname of archive.
$PROG$	Program name
$SUBJECT$	The subject text of the message, and if no arguments, wrapped in an anchor element that hyperlinks to the message.
$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.
$VERSION$	Program version.
$YYYYMMDD$	Message date in yyyy/mm/dd format.

Examples

The following example resource settings cause the main index to be sorted by subject. The listing will contain each subject followed by an author sub-listing:

<SubSort>

<SubjectBegin>
<li><strong>$SUBJECTNA$</strong>
<ul>
</SubjectBegin>

<SubjectEnd>
</li></ul>
</SubjectEnd>

<LITemplate>
<li><a $A_ATTR$>$FROMNAME$</a></li>
</LITemplate>

Version

2.0