MHonArc Resource List

DEFINEDERIVED


Syntax

Envariable

N/A

Element

<DEFINEDERIVED>
filename
file contents ...
</DEFINEDERIVED>

Command-line Option

N/A


Description

DEFINEDERIVED is used to define extra files that are generated for each message processed. DEFINEDERIVED can only be specified in a resource file and may occur mutliple times to define multiple files to be created. The first line of the <DEFINEDERIVED> element is the name of the file. All subsequent lines represent the content of the file.


Default Setting

N/A


Resource Variables

VariableValue
$DATE$ The date of the message.
$DDMMYY$ Message date in dd/mm/yy 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.
$LOCALDATE$ Current local date.
$MMDDYY$ Message date in mm/dd/yy format.
$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).
$NEXTBUTTON$ Next button markup linking to the next message according to the main index list order.
$NEXTFROM$ Content of From field of the next message according to the list order of the main index.
$NEXTFROMADDR$ E-mail address contained in From field of the next message according to the list order of the main index.
$NEXTFROMNAME$ Human name contained in From field of the next message according to the list order of the main index.
$NEXTLINK$ Next link markup linking to the next message according to the main index list order.
$NEXTMSG$ Filename of next message according to the list order of the main index.
$NEXTMSGNUM$ Number assigned to next message according to the list order of the main index.
$NEXTSUBJECT$ Subject of next message according to the list order of the main index.
$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.
$PREVBUTTON$ Previous button markup linking to the previous message according to the main index list order.
$PREVFROM$ Content of From field of the previous message according to the list order of the main index.
$PREVFROMADDR$ E-mail address contained in From field of the previous message according to the list order of the main index.
$PREVFROMNAME$ Human name contained in From field of the previous message according to the list order of the main index.
$PREVLINK$ Previous link markup linking to the previous message according to the main index list order.
$PREVMSG$ Filename of previous message according to the list order of the main index.
$PREVMSGNUM$ Number assigned to previous message according to the list order of the main index.
$PREVSUBJECT$ Subject of previous message according to the list order of the main index.
$PROG$ Program name
$SUBJECTNA$ The subject text of the message without the anchor element.
$TFIRSTPG$ Filename of first page of thread index.
$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.
$TLASTPG$ Filename of last page of thread index.
$TNEXTBUTTON$ Next button markup linking to the next message according to the thread index list order.
$TNEXTFROM$ Content of From field of the next message according to the list order of the thread index.
$TNEXTFROMADDR$ E-mail address contained in From field of the next message according to the list order of the thread index.
$TNEXTFROMNAME$ Human name contained in From field of the next message according to the list order of the thread index.
$TNEXTLINK$ Next link markup linking to the next message according to the thread index list order.
$TNEXTMSG$ Filename of next message according to the list order of the thread index.
$TNEXTMSGNUM$ Number assigned to next message according to the list order of the thread index.
$TNEXTSUBJECT$ Subject of next message according to the list order of the thread index.
$TPREVBUTTON$ Previous button markup linking to the previous message according to the thread index list order.
$TPREVFROM$ Content of From field of the previous message according to the list order of the thread index.
$TPREVFROMADDR$ E-mail address contained in From field of the previous message according to the list order of the thread index.
$TPREVFROMNAME$ Human name contained in From field of the previous message according to the list order of the thread index.
$TPREVLINK$ Previous link markup linking to the previous message according to the thread index list order.
$TPREVMSG$ Filename of previous message according to the list order of the thread index.
$TPREVMSGNUM$ Number assigned to previous message according to the list order of the thread index.
$TPREVSUBJECT$ Subject of previous message according to the list order of the thread index.
$VERSION$ Program version.
$YYMMDD$ Message date in yy/mm/dd format.

Examples

The following example shows how user defined files can be used to provide a framed navigational view of an archive. Note how the filenames contain resource variables to uniquely qualify the name for each message.

Note

This example is not complete since other resources need to be defined to make everything work.

The following derived file is the main file the index pages will link to. It defines the subframe definitions for the navigational links and the message data:

<DefineDerived>
frm$MSGNUM$.html
<html>
<head>
<title>Message View</title>
</head>
<frameset rows="75,*">
<frame src="nav$MSGNUM$.html" name="NAV">
<frame src="msg$MSGNUM$.html" name="MESSAGE">
</frameset>
</html>
</DefineDerived>

The following derived file defines the navigational links for a message. The links will be displayed in a frame above the converted message.

<DefineDerived>
nav$MSGNUM$.html
<html>
<head>
<title>Message Navigation</title>
</head>
<body>
<table cellpadding=0 cellspacing=0 cols=3 border=1 width="100%">
<tbody>
<tr align="center">
<th colspan=3><strong>Thread Links</strong></th>
<th colspan=3><strong>Date Links</strong></th>
</tr>
<tr align="center">
<td>$TPREVBUTTON$</td>
<td>$TNEXTBUTTON$</td>
<td><a $FRAME-IDX$ href="$TIDXFNAME$#$MSGNUM$">Index</a></td>
<td>$PREVBUTTON$</td>
<td>$NEXTBUTTON$</td>
<td><a $FRAME-IDX$ href="$IDXFNAME$#$MSGNUM$">Index</a></td>
</tr>
</tbody>
</table>
</body>
</html>
</DEFINEDERIVED>

Version

2.0


See Also


97/02/18 16:27:10
MHonArc
Copyright © 1997, Earl Hood, ehood@medusa.acs.uci.edu