Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / perl-5.8.0 / doc / MHonArc / resources / daybegin.html
CommitLineData
86530b38
AT
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN">
2<html>
3<head>
4<title>MHonArc Resources: DAYBEGIN</title>
5</head>
6<body>
7<!--x-rc-nav-->
8<table border=0><tr valign="top">
9<td align="left" width="50%">[Prev:&nbsp;<a href="datefields.html">DATEFIELDS</a>]</td><td><nobr>[<a href="../resources.html#daybegin">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="dayend.html">DAYEND</a>]</td></tr></table>
10<!--/x-rc-nav-->
11<hr>
12<h1>DAYBEGIN</h1>
13
14<!-- *************************************************************** -->
15<hr>
16<h2>Syntax</h2>
17
18<dl>
19
20<dt><strong>Envariable</strong></dt>
21<dd><p>
22N/A
23</p>
24</dd>
25
26<dt><strong>Element</strong></dt>
27<dd><p>
28<code>&lt;DAYBEGIN&gt;</code><br>
29<var>markup ...</var><br>
30<code>&lt;/DAYBEGIN&gt;</code><br>
31</p>
32</dd>
33
34<dt><strong>Command-line Option</strong></dt>
35<dd><p>
36N/A
37</p>
38</dd>
39
40</dl>
41
42<!-- *************************************************************** -->
43<hr>
44<h2>Description</h2>
45
46<p>DAYBEGIN defines the beginning markup of a day group
47in the main index if the
48<a href="sort.html">SORT</a>
49reosource is set.
50A day group is a group of messages all from the
51same day.
52</p>
53
54<p>Any message related resource variables available for the DAYBEGIN
55evaluate based on information from the first message in the group.
56</p>
57
58<!-- *************************************************************** -->
59<hr>
60<h2>Default Setting</h2>
61
62<p>Nil.
63</p>
64
65<!-- *************************************************************** -->
66<hr>
67<h2>Resource Variables</h2>
68
69<table border=1>
70<tr bgcolor="#C0C0C0">
71<th>Variable</th><th>Value</th>
72</tr>
73<tr valign=top>
74<td align=center><a name="A_ATTR" href="../rcvars.html#A_ATTR"><strong><code>$A_ATTR$</code></strong></a></td>
75<td>The <tt>NAME</tt> and <tt>HREF</tt> attributes to use in an anchor to link to the archived message. The <tt>NAME</tt> attribute links the messages to the index page.</td>
76</tr>
77<tr valign=top>
78<td align=center><a name="A_HREF" href="../rcvars.html#A_HREF"><strong><code>$A_HREF$</code></strong></a></td>
79<td>The <tt>HREF</tt> attribute to use in an anchor to link to the archived message.</td>
80</tr>
81<tr valign=top>
82<td align=center><a name="A_NAME" href="../rcvars.html#A_NAME"><strong><code>$A_NAME$</code></strong></a></td>
83<td>The <tt>NAME</tt> attribute to use in an anchor for messages to link to the index page.</td>
84</tr>
85<tr valign=top>
86<td align=center><a name="DATE" href="../rcvars.html#DATE"><strong><code>$DATE$</code></strong></a></td>
87<td>The date of the message.</td>
88</tr>
89<tr valign=top>
90<td align=center><a name="DDMMYYYY" href="../rcvars.html#DDMMYYYY"><strong><code>$DDMMYYYY$</code></strong></a></td>
91<td>Message date in dd/mm/yyyy format.</td>
92</tr>
93<tr valign=top>
94<td align=center><a name="ENV" href="../rcvars.html#ENV"><strong><code>$ENV$</code></strong></a></td>
95<td>Value of an environment variable.</td>
96</tr>
97<tr valign=top>
98<td align=center><a name="FROM" href="../rcvars.html#FROM"><strong><code>$FROM$</code></strong></a></td>
99<td>The complete text in the <tt>From:</tt> field of the message.</td>
100</tr>
101<tr valign=top>
102<td align=center><a name="FROMADDR" href="../rcvars.html#FROMADDR"><strong><code>$FROMADDR$</code></strong></a></td>
103<td>The e-mail address in the <tt>From:</tt> field of the message.</td>
104</tr>
105<tr valign=top>
106<td align=center><a name="FROMADDRDOMAIN" href="../rcvars.html#FROMADDRDOMAIN"><strong><code>$FROMADDRDOMAIN$</code></strong></a></td>
107<td>The e-mail address domain of the <tt>From:</tt> field of the message.</td>
108</tr>
109<tr valign=top>
110<td align=center><a name="FROMADDRNAME" href="../rcvars.html#FROMADDRNAME"><strong><code>$FROMADDRNAME$</code></strong></a></td>
111<td>The e-mail address "username" (or local-part) of the <tt>From:</tt> field of the message.</td>
112</tr>
113<tr valign=top>
114<td align=center><a name="FROMNAME" href="../rcvars.html#FROMNAME"><strong><code>$FROMNAME$</code></strong></a></td>
115<td>The human name of the person in the <tt>From:</tt> field of the message. If no human name is found, the username specified in the e-mail address is used.</td>
116</tr>
117<tr valign=top>
118<td align=center><a name="ICON" href="../rcvars.html#ICON"><strong><code>$ICON$</code></strong></a></td>
119<td>The context-type sensitive icon.</td>
120</tr>
121<tr valign=top>
122<td align=center><a name="ICONURL" href="../rcvars.html#ICONURL"><strong><code>$ICONURL$</code></strong></a></td>
123<td>The URL to the context-type sensitive icon.</td>
124</tr>
125<tr valign=top>
126<td align=center><a name="MMDDYYYY" href="../rcvars.html#MMDDYYYY"><strong><code>$MMDDYYYY$</code></strong></a></td>
127<td>Message date in mm/dd/yyyy format.</td>
128</tr>
129<tr valign=top>
130<td align=center><a name="MSGGMTDATE" href="../rcvars.html#MSGGMTDATE"><strong><code>$MSGGMTDATE$</code></strong></a></td>
131<td>GMT date of current message.</td>
132</tr>
133<tr valign=top>
134<td align=center><a name="MSGID" href="../rcvars.html#MSGID"><strong><code>$MSGID$</code></strong></a></td>
135<td>The message-id of the message.</td>
136</tr>
137<tr valign=top>
138<td align=center><a name="MSGLOCALDATE" href="../rcvars.html#MSGLOCALDATE"><strong><code>$MSGLOCALDATE$</code></strong></a></td>
139<td>Local date of current message.</td>
140</tr>
141<tr valign=top>
142<td align=center><a name="MSGNUM" href="../rcvars.html#MSGNUM"><strong><code>$MSGNUM$</code></strong></a></td>
143<td>The message number assigned to the message by MHonArc (includes leading zeros).</td>
144</tr>
145<tr valign=top>
146<td align=center><a name="MSGPREFIX" href="../rcvars.html#MSGPREFIX"><strong><code>$MSGPREFIX$</code></strong></a></td>
147<td>Filename prefix for message files.</td>
148</tr>
149<tr valign=top>
150<td align=center><a name="MSGTORDNUM" href="../rcvars.html#MSGTORDNUM"><strong><code>$MSGTORDNUM$</code></strong></a></td>
151<td>The ordinal message number of the current discussion thread.</td>
152</tr>
153<tr valign=top>
154<td align=center><a name="NOTE" href="../rcvars.html#NOTE"><strong><code>$NOTE$</code></strong></a></td>
155<td>Message annotation.</td>
156</tr>
157<tr valign=top>
158<td align=center><a name="NUMFOLUP" href="../rcvars.html#NUMFOLUP"><strong><code>$NUMFOLUP$</code></strong></a></td>
159<td>Number of explicit follow-ups to the message.</td>
160</tr>
161<tr valign=top>
162<td align=center><a name="ORDNUM" href="../rcvars.html#ORDNUM"><strong><code>$ORDNUM$</code></strong></a></td>
163<td>The current listing number of the message.</td>
164</tr>
165<tr valign=top>
166<td align=center><a name="SUBJECT" href="../rcvars.html#SUBJECT"><strong><code>$SUBJECT$</code></strong></a></td>
167<td>The subject text of the message, and if no arguments, wrapped in an anchor element that hyperlinks to the message.</td>
168</tr>
169<tr valign=top>
170<td align=center><a name="SUBJECTNA" href="../rcvars.html#SUBJECTNA"><strong><code>$SUBJECTNA$</code></strong></a></td>
171<td>The subject text of the message without the anchor element.</td>
172</tr>
173<tr valign=top>
174<td align=center><a name="YYYYMMDD" href="../rcvars.html#YYYYMMDD"><strong><code>$YYYYMMDD$</code></strong></a></td>
175<td>Message date in yyyy/mm/dd format.</td>
176</tr>
177</table>
178
179<!-- *************************************************************** -->
180<hr>
181<h2>Examples</h2>
182
183<p>The following example resource settings cause the main index
184to be sorted by date. The listing will contain each different day
185followed by a sub-listing of the messages for that day:
186</p>
187
188<pre>
189<b>&lt;<a href="sort.html">Sort</a>&gt;</b>
190<b>&lt;<a href="msggmtdatefmt.html">MsgGMTDateFmt</a>&gt;</b>
191%B %d, %Y
192<b>&lt;/MsgGMTDateFmt&gt;</b>
193
194<b>&lt;DayBegin&gt;</b>
195&lt;li&gt;&lt;strong&gt;<a href="#MSGGMTDATE">$MSGGMTDATE$</a>&lt;/strong&gt;
196&lt;ul&gt;
197<b>&lt;/DayBegin&gt;</b>
198
199<b>&lt;<a href="dayend.html">DayEnd</a>></b>
200&lt;/ul&gt;&lt;/li&gt;
201<b>&lt;/DayEnd&gt;</b>
202
203<b>&lt;<a href="litemplate.html">LITemplate</a>&gt;</b>
204&lt;li&gt;<a href="#SUBJECT">$SUBJECT$</a>, <a href="#FROMNAME">$FROMNAME$</a>&lt;/li&gt;
205<b>&lt;/LITemplate></b>
206</pre>
207
208<!-- *************************************************************** -->
209<hr>
210<h2>Version</h2>
211
212<p>2.0
213</p>
214
215<!-- *************************************************************** -->
216<hr>
217<h2>See Also</h2>
218
219<p>
220<a href="dayend.html">DAYEND</a>,
221<a href="sort.html">SORT</a>,
222<a href="uselocaltime.html">USELOCALTIME</a>
223</p>
224
225<!-- *************************************************************** -->
226<hr>
227<!--x-rc-nav-->
228<table border=0><tr valign="top">
229<td align="left" width="50%">[Prev:&nbsp;<a href="datefields.html">DATEFIELDS</a>]</td><td><nobr>[<a href="../resources.html#daybegin">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="dayend.html">DAYEND</a>]</td></tr></table>
230<!--/x-rc-nav-->
231<hr>
232<address>
233$Date: 2002/07/27 05:13:10 $ <br>
234<img align="top" src="../monicon.png" alt="">
235<a href="http://www.mhonarc.org/"
236><strong>MHonArc</strong></a><br>
237Copyright &#169; 1997-1999, <a href="http://www.earlhood.com/"
238>Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org"
239>mhonarc@mhonarc.org</a><br>
240</address>
241
242</body>
243</html>