[Prev][Next][TOC][FAQ][Bugs][Home]

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, subject, author, or message number. 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 the main index layout since threading is more complex. 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))+
	    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.

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
    MSGBODYEND
    (FOLUPBEGIN
	FOLUPLITXT+
     FOLUPEND)?
    (REFSBEGIN
	REFSLITXT+
     REFSEND)?
    BOTLINKS
    MSGFOOT
MSGPGEND

NOTE

If the SINGLE resource is set, TOPLINKS and BOTLINKS are are not applicable. If the FOLREFS is off, FOLUPBEGIN, FOLUPLITXT, FOLUPEND, REFSBEGIN, REFSLITXT, and REFSEND resources are not applicable.

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]

97/06/05 17:59:02