[Prev][Next][TOC][FAQ][Bugs][Home]
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:
The main index is normally the default index of an archive. The main index list messages by date, subject, author, or message number. Since date listing is the default, the main index is commonly referred to as the date index.
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.
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.
TIDXPGBEGIN
THEAD
((TTOPBEGIN
TSUBLISTBEG
((TLITXT
[possible subthread listing]
TLIEND)|
(TLINONE
[possible subthread listing]
TLINONEEND))+
TSUBLISTEND
(TSUBJECTBEG
((TLITXT
[possible subthread listing]
TLIEND)|
(TLINONE
[possible subthread listing]
TLINONEEND))+
TSUBJECTEND)?
TTOPEND)
|
TSINGLETXT)* [message w/o references or follow-ups]
TFOOT
DOC
TIDXPGEND
If the previous is not confusing enough, there are four other resources for controlling the thread index page layout: TCONTBEGIN, TCONTEND, TINDENTBEGIN, TINDENTEND. If the multiple page resource is set, it is possible that a thread can span more than one page. These resources are used to restart a thread that has been clipped due to a page boundary.
The message page contains a single message converted to HTML and archive navigational links.
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.
[Prev][Next][TOC][FAQ][Bugs][Home]