MHonArc Resources: DEFINEDERIVED

[Prev: DEFCHARSET] | [Resources][TOC] | [Next: DEFINEVAR]

# DEFINEDERIVED

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

## 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

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.
`$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.
`$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.
`$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.
`$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
`$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.
`$TLEVEL$` | Numeric level of message in thread, starting with 0.
`$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 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

[Prev: DEFCHARSET] | [Resources][TOC] | [Next: DEFINEVAR]