projects / OpenSPARC-T2-DV / blame
? search:
summary | tags | clone url | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / perl-5.8.0 / doc / MHonArc / layout.html
CommitLineData
86530b38
AT		 1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN">
2<HTML>
3<HEAD>
4<TITLE>MHonArc v2.5 -- Page Layout</TITLE>
5</HEAD>
6<!--
7<BODY background="ssbg75.jpg"
8 text="#000000" link="#0000ee" vlink="#551a8b" alink="ff0000">
9-->
10<BODY>
11
12<!--X-NavButtons-Start-->
13<table width="100%">
14<tr valign="top">
15<td align="left"><nobr><a href="commontasks.html"><img src="prev.png"border=0 alt="[Prev]"></a>&nbsp;&nbsp;&nbsp;</nobr></td><td align="center" width="99%"><a href="mhonarc.html"><img src="up.png" border=0 alt="[TOC]"></a><a href="faq/faq.html"><img src="faq.png" border=0 alt="[FAQ]"></a><a href="app-bugs.html"><img src="bug.png" border=0 alt="[Bugs]"></a><a href="http://www.mhonarc.org/"><img src="home.png" border=0 alt="[Home]"></a></td><td align="right"><nobr>&nbsp;&nbsp;&nbsp;<a href="resources.html"><img src="next.png" border=0 alt="[Next]"></a></nobr></td></tr></table>
16<!--X-NavButtons-End-->
17<HR>
18
19<!-- ******************************************************************** -->
20<H1><a name="pagelayout">Page Layout</a></H1>
21
22<p>The section describes the layout of the pages created by
23MHonArc. Each page's layout is controled by
24<a href="resources.html">resources</a>
25(see Section <a href="resources.html">Resources</a>). Layout
26resources can be changed as you see fit to achieve the
27appearence you desire for your mail archives.
28
29<!--X-TOC-Start-->
30<ul>
31<li><a href="#notaion">Notation</a>
32<li><a href="#mainidxpg">Main Index Page</a>
33<ul>
34<li><small><a href="#mainidxlayout">Main index page resource layout</a></small>
35</ul>
36<li><a href="#threadidxpg">Thread Index Page</a>
37<ul>
38<li><small><a href="#tidxlayout">Thread index page resource layout</a></small>
39</ul>
40<li><a href="#msgpg">Message Page</a>
41<ul>
42<li><small><a href="#msgpglayout">Message page resource layout</a></small>
43<li><small><a href="#msgheaderlayout">Converted message header</a></small>
44<li><small><a href="#msgbodylayout">Converted message body</a></small>
45<li><small><a href="#tslice">Thread slices</a></small>
46</ul>
47</ul>
48<!--X-TOC-End-->
49
50
51<!-- ******************************************************************** -->
52<hr>
53<h2><a name="notaion">Notation</a></h2>
54
55<p>To simplify the description of the various pages created
56by MHonArc, the following notation is used:
57</p>
58
59<dl>
60<dt><strong>(&#160;)</strong></dt>
61<dd>Parentheses denote a <em>group</em> of resources.
62</dd>
63<dt><strong>|</strong></dt>
64<dd>The vertical bar is use within a <em>group</em> to denote
65a boolean OR. For example, "<tt>(X&nbsp;|&nbsp;Y&nbsp;|&nbsp;Z)</tt>"
66states that either X, Y, or Z may apply.
67</dd>
68<dt><strong>?</strong></dt>
69<dd>Denotes that preceding resource, or group, is
70optional.
71</dd>
72<dt><strong>*</strong></dt>
73<dd>Denotes that preceding resource, or group, can
74occur zero or more times.
75</dd>
76<dt><strong>+</strong></dt>
77<dd>Denotes that preceding resource, or group, can
78occur one or more times.
79</dd>
80</dl>
81
82<!-- ******************************************************************** -->
83<hr>
84<h2><a name="mainidxpg">Main Index Page</a></h2>
85
86<p>The main index is normally the default index of an
87archive. The main index list messages by date,
88subject, author, or message number.
89Since date listing is the default, the
90main index is commonly referred to as the date index.
91</p>
92
93<h3><a name="mainidxlayout">Main index page resource layout</a></h3>
94
95<pre>
96<a href="resources/idxpgssmarkup.html"><b>IDXPGSSMARKUP</b></a>
97<a href="resources/idxpgbegin.html"><b>IDXPGBEGIN</b></a>
98 <a href="resources/listbegin.html"><b>LISTBEGIN</b></a>
99 <b>(</b><a href="resources/authorbegin.html"><b>AUTHORBEGIN</b></a> <b>|</b>
100 <a href="resources/daybegin.html"><b>DAYBEGIN</b></a> <b>|</b>
101 <a href="resources/subjectbegin.html"><b>SUBJECTBEGIN</b></a><b>)?</b>
102 <a href="resources/litemplate.html"><b>LITEMPLATE</b></a><b>+</b>
103 <b>(</b><a href="resources/authorend.html"><b>AUTHOREND</b></a> <b>|</b>
104 <a href="resources/dayend.html"><b>DAYEND</b></a> <b>|</b>
105 <a href="resources/subjectend.html"><b>SUBJECTEND</b></a><b>)?</b>
106 <a href="resources/listend.html"><b>LISTEND</b></a>
107 <a href="resources/doc.html"><b>DOC</b></a><b>?</b>
108<a href="resources/idxpgend.html"><b>IDXPGEND</b></a>
109</pre>
110
111<!-- ******************************************************************** -->
112<hr>
113<h2><a name="threadidxpg">Thread Index Page</a></h2>
114
115<p>The thread index list messages by thread. Threads
116are based upon <tt>In-Reply-To</tt> and <tt>References</tt> fields of
117messages and by same <tt>Subject</tt>s.
118</p>
119
120<p>The layout of a thread index page is more complicated
121than the main index layout since threading is more
122complex.
123Also, MHonArc tries to provide the greatest
124flexibility for customizing thread listing layout.
125</p>
126
127<h3><a name="tidxlayout">Thread index page resource layout</a></h3>
128
129<pre>
130<a href="resources/tidxpgssmarkup.html"><b>TIDXPGSSMARKUP</b></a>
131<a href="resources/tidxpgbegin.html"><b>TIDXPGBEGIN</b></a>
132 <a href="resources/thead.html"><b>THEAD</b></a>
133 <b>((</b><a href="resources/ttopbegin.html"><b>TTOPBEGIN</b></a>
134 <a href="resources/tsublistbeg.html"><b>TSUBLISTBEG</b></a>
135 <b>((</b><a href="resources/tlitxt.html"><b>TLITXT</b></a>
136 <small>[possible subthread listing]</small>
137 <a href="resources/tliend.html"><b>TLIEND</b></a><b>)|</b>
138 <b>(</b><a href="resources/tlinone.html"><b>TLINONE</b></a>
139 <small>[possible subthread listing]</small>
140 <a href="resources/tlinoneend.html"><b>TLINONEEND</b></a><b>))+</b>
141 <b>(</b><a href="resources/tsubjectbeg.html"><b>TSUBJECTBEG</b></a>
142 <b>((</b><a href="resources/tlitxt.html"><b>TLITXT</b></a>
143 <small>[possible subthread listing]</small>
144 <a href="resources/tliend.html"><b>TLIEND</b></a><b>)|</b>
145 <b>(</b><a href="resources/tlinone.html"><b>TLINONE</b></a>
146 <small>[possible subthread listing]</small>
147 <a href="resources/tlinoneend.html"><b>TLINONEEND</b></a><b>))+</b>
148 <a href="resources/tsubjectend.html"><b>TSUBJECTEND</b></a><b>)?</b>
149 <a href="resources/tsublistend.html"><b>TSUBLISTEND</b></a><b></b>
150 <a href="resources/ttopend.html"><b>TTOPEND</b></a><b>)</b>
151 <b>|</b>
152 <a href="resources/tsingletxt.html"><b>TSINGLETXT</b></a><b>)*</b> <small>[message w/o references or follow-ups]</small>
153 <a href="resources/tfoot.html"><b>TFOOT</b></a>
154 <a href="resources/doc.html"><b>DOC</b></a><b>?</b>
155<a href="resources/tidxpgend.html"><b>TIDXPGEND</b></a>
156</pre>
157
158<p>If the previous is not confusing enough, there are four other resources
159for controlling the thread index page layout:
160<a href="resources/tcontbegin.html">TCONTBEGIN</a>,
161<a href="resources/tcontend.html">TCONTEND</a>,
162<a href="resources/tindentbegin.html">TINDENTBEGIN</a>,
163<a href="resources/tindentend.html">TINDENTEND</a>.
164If the <a href="resources/multipg.html">multiple page resource</a> is
165set, it is possible that a thread can span more than one page. These
166resources are used to restart a thread that has been clipped due to
167a page boundary.
168</p>
169
170<!-- ******************************************************************** -->
171<hr>
172<h2><a name="msgpg">Message Page</a></h2>
173
174<p>The message page contains a single message converted
175to HTML and archive navigational links.
176</p>
177
178<h3><a name="msgpglayout">Message page resource layout</a></h3>
179
180<pre>
181<a href="resources/msgpgssmarkup.html"><b>MSGPGSSMARKUP</b></a>
182<a href="resources/msgpgbegin.html"><b>MSGPGBEGIN</b></a>
183 <a href="resources/msghead.html"><b>MSGHEAD</b></a>
184 <a href="resources/toplinks.html"><b>TOPLINKS</b></a>
185 <a href="resources/subjectheader.html"><b>SUBJECTHEADER</b></a>
186 <a href="#msgheaderlayout"><i>Converted message header</i></a>
187 <a href="resources/headbodysep.html"><b>HEADBODYSEP</b></a>
188 <a href="#msgbodylayout"><i>Converted message body</i></a>
189 <a href="resources/msgbodyend.html"><b>MSGBODYEND</b></a>
190 <b>(</b><a href="resources/folupbegin.html"><b>FOLUPBEGIN</b></a>
191 <a href="resources/foluplitxt.html"><b>FOLUPLITXT</b></a><b>+</b>
192 <a href="resources/folupend.html"><b>FOLUPEND</b></a><b>)?</b>
193 <b>(</b><a href="resources/refsbegin.html"><b>REFSBEGIN</b></a>
194 <a href="resources/refslitxt.html"><b>REFSLITXT</b></a><b>+</b>
195 <a href="resources/refsend.html"><b>REFSEND</b></a><b>)?</b>
196 <a href="resources/botlinks.html"><b>BOTLINKS</b></a>
197 <a href="resources/msgfoot.html"><b>MSGFOOT</b></a>
198<a href="resources/msgpgend.html"><b>MSGPGEND</b></a>
199</pre>
200
201<table border=0 cellpadding=4>
202<tr valign=top>
203<td><strong>NOTE</strong></td>
204<td><p>If the <a href="resources/single.html">SINGLE</a> resource
205is set, <a href="resources/toplinks.html">TOPLINKS</a>
206and <a href="resources/botlinks.html">BOTLINKS</a>
207are are not applicable. If the
208<a href="resources/folrefs.html">FOLREFS</a> is off,
209<a href="resources/folupbegin.html">FOLUPBEGIN</a>,
210<a href="resources/foluplitxt.html">FOLUPLITXT</a>,
211<a href="resources/folupend.html">FOLUPEND</a>,
212<a href="resources/refsbegin.html">REFSBEGIN</a>,
213<a href="resources/refslitxt.html">REFSLITXT</a>, and
214<a href="resources/refsend.html">REFSEND</a> resources
215are not applicable.
216</p>
217</td>
218</tr>
219</table>
220
221<p>Message pages also contain comment declarations. Some of the
222comment declarations are vital markers to allow MHonArc
223to properly edit the message when needed during updates.
224</p>
225
226<h3><a name="msgheaderlayout">Converted message header</a></h3>
227
228<p>The format of converted message headers are determined by the
229following resource layout:
230</p>
231<pre>
232<a href="resources/fieldsbeg.html">FIELDSBEG</a>
233 (<a href="resources/labelbeg.html">LABELBEG</a>
234 <i>label text</i>
235 <a href="resources/labelend.html">LABELEND</a>
236 <a href="resources/fldbeg.html">FLDBEG</a>
237 <i>field text</i>
238 <a href="resources/fldend.html">FLDEND</a>)*
239<a href="resources/fieldsend.html">FIELDSEND</a>
240</pre>
241
242<table border=0 cellpadding=4>
243<tr valign=top>
244<td><strong>NOTE</strong></td>
245<td><p>The line breaks above are used to show the sequence order of
246the resources and do not indicate any actual line breaks in the final
247markup generated.
248</p>
249</td>
250</tr>
251</table>
252
253<h3><a name="msgbodylayout">Converted message body</a></h3>
254
255<p>The formatting of message body data is controled by filter routines.
256See the <a href="resources/mimefilters.html">MIMEFILTERS</a> resource
257page for more information.
258</p>
259
260<h3><a name="tslice">Thread slices</a></h3>
261
262<p>MHonArc supports the ability to include thread listings on messages
263pages via the
264<a href="rcvars.html#TSLICE"><tt>$TSLICE$</tt></a> resource variable.
265The formatting of the <tt>$TSLICE$</tt> resource variable is controled
266by the following resources:
267<a href="resources/tslicebeg.html">TSLICEBEG</a>,
268<a href="resources/tslicecontbeg.html">TSLICECONTBEG</a>,
269<a href="resources/tslicecontend.html">TSLICECONTEND</a>,
270<a href="resources/tsliceend.html">TSLICEEND</a>,
271<a href="resources/tsliceindentbeg.html">TSLICEINDENTBEG</a>,
272<a href="resources/tsliceindentend.html">TSLICEINDENTEND</a>,
273<a href="resources/tsliceliend.html">TSLICELIEND</a>,
274<a href="resources/tsliceliendcur.html">TSLICELIENDCUR</a>,
275<a href="resources/tslicelinone.html">TSLICELINONE</a>,
276<a href="resources/tslicelinoneend.html">TSLICELINONEEND</a>,
277<a href="resources/tslicelitxt.html">TSLICELITXT</a>,
278<a href="resources/tslicelitxtcur.html">TSLICELITXTCUR</a>,
279<a href="resources/tslicesingletxt.html">TSLICESINGLETXT</a>,
280<a href="resources/tslicesingletxtcur.html">TSLICESINGLETXTCUR</a>,
281<a href="resources/tslicesubjectbeg.html">TSLICESUBJECTBEG</a>,
282<a href="resources/tslicesubjectend.html">TSLICESUBJECTEND</a>,
283<a href="resources/tslicesublistbeg.html">TSLICESUBLISTBEG</a>,
284<a href="resources/tslicesublistend.html">TSLICESUBLISTEND</a>,
285<a href="resources/tslicetopbeg.html">TSLICETOPBEG</a>,
286<a href="resources/tslicetopbegcur.html">TSLICETOPBEGCUR</a>,
287<a href="resources/tslicetopend.html">TSLICETOPEND</a>, and
288<a href="resources/tslicetopendcur.html">TSLICETOPENDCUR</a>
289</p>
290
291<p>The structure of the resources parallels the thread resource
292layout structure described for the <a href="#threadidxpg">thread
293index page</a>, and the above thread slice resources will default to
294the corresponding non-tslice resources, allowing you to provide a
295consistent look to all thread listings without having to define two
296sets of resources.
297</p>
298
299<p>One key difference to the <tt>TSLICE</tt>* resources is the ability
300to customize the look for current message item in the
301the slice listing. I.e. You can actually highlight, grey-out, etc,
302the current message to give the reader a visual cue of where they are
303in the thread. See
304<a href="resources/tslicetopbegcur.html">TSLICETOPBEGCUR</a> for
305an example.
306</p>
307
308<hr>
309<!--X-NavButtons-Start-->
310<table width="100%">
311<tr valign="top">
312<td align="left"><nobr><a href="commontasks.html"><img src="prev.png"border=0 alt="[Prev]"></a>&nbsp;&nbsp;&nbsp;</nobr></td><td align="center" width="99%"><a href="mhonarc.html"><img src="up.png" border=0 alt="[TOC]"></a><a href="faq/faq.html"><img src="faq.png" border=0 alt="[FAQ]"></a><a href="app-bugs.html"><img src="bug.png" border=0 alt="[Bugs]"></a><a href="http://www.mhonarc.org/"><img src="home.png" border=0 alt="[Home]"></a></td><td align="right"><nobr>&nbsp;&nbsp;&nbsp;<a href="resources.html"><img src="next.png" border=0 alt="[Next]"></a></nobr></td></tr></table>
313<!--X-NavButtons-End-->
314
315<!-- ******************************************************************** -->
316<HR>
317<address>
318$Date: 2002/06/27 00:06:14 $ <br>
319<img align="top" src="monicon.png" alt="">
320<a href="http://www.mhonarc.org"
321><strong>MHonArc</strong></a><br>
322Copyright &#169; 1997-1999, <a href="http://www.mhonarc.org/~ehood/"
323>Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org"
324>mhonarc@mhonarc.org</a><br>
325</address>
326
327</BODY>
328</HTML>
Full OpenSPARC design & verification tarball including full HDL.