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