Page Layout

The section describes the layout of the pages created by MHonArc. Each page's layout is controlled by resources (see MHonArc Resources). To simplify the description of each type of page created by MHonArc, the following notation is used:

( ): Parentheses denote a group of resources.
?: Denotes that preceding resource, or group, is optional.
*: Denotes that preceding resource, or group, can occur zero or more times.
+: Denotes that preceding resource, or group, can occur one or more times.

Main Index Page

The main index is normally the default index of an archive. The main index list messages by date or subject. Since date listing is the default, the main index is commonly referred to as the date index.

Main index page resource layout

IDXPGBEGIN HEADER LISTBEGIN (AUTHORBEGIN | DAYBEGIN | SUBJECTBEGIN)? LITEMPLATE+ (AUTHOREND | DAYEND | SUBJECTEND)? LISTEND FOOTER DOC
IDXPGEND

Main index pages also contain comment declarations. Some of the comment declarations are vital markers to allow MHonArc to properly edit the index during archive updates.

Thread Index Page

The thread index list messages by thread. Threads are based upon In-Reply-To and References fields of messages and by same Subjects.

The layout of a thread index page is more complicated than other pages since threads are more complex than a regular date or subject listing. Also, MHonArc tries to provide the greatest flexibility for customizing thread listing layout.

Thread index page resource layout

TIDXPGBEGIN
THEAD
(
(TTOPBEGIN
TSUBLISTBEG
((TLITXT
... [possible subthread listing]

  TLIEND)|
(TLINONE
... [possible subthread listing]

  TLINONEEND))+

(TSUBJECTBEG
((TLITXT
... [possible subthread listing]

  TLIEND)|
(TLINONE
... [possible subthread listing]

  TLINONEEND))+

TSUBJECTEND)?

  TTOPEND)
|
TSINGLETXT [message w/o references or follow-ups]
)*

TFOOT
DOC
TIDXPGEND

Message Page

The message page contains a single message converted to HTML and archive navigational links.

Message page resource layout

MSGPGBEGIN MSGHEAD TOPLINKS SUBJECTHEADER Converted message header HEADBODYSEP Converted message body FOLREFS BOTLINKS MSGFOOT
MSGPGEND

Message pages also contain comment declarations. Some of the comment declarations are vital markers to allow MHonArc to properly edit the message when needed during updates.

[Table of Contents]

97/02/06 19:10:01