Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / perl-5.8.0 / doc / MHonArc / resources / tslicetopbegcur.html
CommitLineData
86530b38
AT
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN">
2<html>
3<head>
4<title>MHonArc Resources: TSLICETOPBEGCUR</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="tslicetopbeg.html">TSLICETOPBEG</a>]</td><td><nobr>[<a href="../resources.html#tslicetopbegcur">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="tslicetopend.html">TSLICETOPEND</a>]</td></tr></table>
10<!--/x-rc-nav-->
11<hr>
12<h1>TSLICETOPBEGCUR</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><code>&lt;TSLICETOPBEGCUR&gt;</code><br>
27<var>markup</var><br>
28<code>&lt;/TSLICETOPBEGCUR&gt;</code><br>
29</p>
30</dd>
31
32<dt><strong>Command-line Option</strong></dt>
33<dd><p>N/A
34</p>
35</dd>
36
37</dl>
38
39<!-- *************************************************************** -->
40<hr>
41<h2>Description</h2>
42
43<p>Thread slice markup for the root/start of a thread if current message.
44This resource is used instead of
45<a href="tslicetopbeg.html">TSLICETOPBEG</a> if rendering the
46current message.
47</p>
48
49<!-- *************************************************************** -->
50<hr>
51<h2>Default Setting</h2>
52
53<p>The value of the
54<a href="tslicetopbeg.html">TSLICETOPBEG</a> resource.
55</p>
56
57<!-- *************************************************************** -->
58<hr>
59<h2>Resource Variables</h2>
60
61<table border=1>
62<tr bgcolor="#C0C0C0">
63<th>Variable</th><th>Value</th>
64</tr>
65<tr valign=top>
66<td align=center><a name="BUTTON" href="../rcvars.html#BUTTON"><strong><code>$BUTTON$</code></strong></a></td>
67<td>Button markup linking to a message.</td>
68</tr>
69<tr valign=top>
70<td align=center><a name="DATE" href="../rcvars.html#DATE"><strong><code>$DATE$</code></strong></a></td>
71<td>The date of the message.</td>
72</tr>
73<tr valign=top>
74<td align=center><a name="DDMMYYYY" href="../rcvars.html#DDMMYYYY"><strong><code>$DDMMYYYY$</code></strong></a></td>
75<td>Message date in dd/mm/yyyy format.</td>
76</tr>
77<tr valign=top>
78<td align=center><a name="DOCURL" href="../rcvars.html#DOCURL"><strong><code>$DOCURL$</code></strong></a></td>
79<td>URL to documentation.</td>
80</tr>
81<tr valign=top>
82<td align=center><a name="ENV" href="../rcvars.html#ENV"><strong><code>$ENV$</code></strong></a></td>
83<td>Value of an environment variable.</td>
84</tr>
85<tr valign=top>
86<td align=center><a name="FROM" href="../rcvars.html#FROM"><strong><code>$FROM$</code></strong></a></td>
87<td>The complete text in the <tt>From:</tt> field of the message.</td>
88</tr>
89<tr valign=top>
90<td align=center><a name="FROMADDR" href="../rcvars.html#FROMADDR"><strong><code>$FROMADDR$</code></strong></a></td>
91<td>The e-mail address in the <tt>From:</tt> field of the message.</td>
92</tr>
93<tr valign=top>
94<td align=center><a name="FROMADDRDOMAIN" href="../rcvars.html#FROMADDRDOMAIN"><strong><code>$FROMADDRDOMAIN$</code></strong></a></td>
95<td>The e-mail address domain of the <tt>From:</tt> field of the message.</td>
96</tr>
97<tr valign=top>
98<td align=center><a name="FROMADDRNAME" href="../rcvars.html#FROMADDRNAME"><strong><code>$FROMADDRNAME$</code></strong></a></td>
99<td>The e-mail address "username" (or local-part) of the <tt>From:</tt> field of the message.</td>
100</tr>
101<tr valign=top>
102<td align=center><a name="FROMNAME" href="../rcvars.html#FROMNAME"><strong><code>$FROMNAME$</code></strong></a></td>
103<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>
104</tr>
105<tr valign=top>
106<td align=center><a name="GMTDATE" href="../rcvars.html#GMTDATE"><strong><code>$GMTDATE$</code></strong></a></td>
107<td>Current GMT date.</td>
108</tr>
109<tr valign=top>
110<td align=center><a name="ICON" href="../rcvars.html#ICON"><strong><code>$ICON$</code></strong></a></td>
111<td>The context-type sensitive icon.</td>
112</tr>
113<tr valign=top>
114<td align=center><a name="ICONURL" href="../rcvars.html#ICONURL"><strong><code>$ICONURL$</code></strong></a></td>
115<td>The URL to the context-type sensitive icon.</td>
116</tr>
117<tr valign=top>
118<td align=center><a name="IDXFNAME" href="../rcvars.html#IDXFNAME"><strong><code>$IDXFNAME$</code></strong></a></td>
119<td>Filename of main index page.</td>
120</tr>
121<tr valign=top>
122<td align=center><a name="IDXLABEL" href="../rcvars.html#IDXLABEL"><strong><code>$IDXLABEL$</code></strong></a></td>
123<td>Label for main index page.</td>
124</tr>
125<tr valign=top>
126<td align=center><a name="IDXPREFIX" href="../rcvars.html#IDXPREFIX"><strong><code>$IDXPREFIX$</code></strong></a></td>
127<td>Prefix of filenames of main index pages.</td>
128</tr>
129<tr valign=top>
130<td align=center><a name="IDXSIZE" href="../rcvars.html#IDXSIZE"><strong><code>$IDXSIZE$</code></strong></a></td>
131<td>Max number of messages that may be listed in index page.</td>
132</tr>
133<tr valign=top>
134<td align=center><a name="IDXTITLE" href="../rcvars.html#IDXTITLE"><strong><code>$IDXTITLE$</code></strong></a></td>
135<td>The title of the main index page.</td>
136</tr>
137<tr valign=top>
138<td align=center><a name="LINK" href="../rcvars.html#LINK"><strong><code>$LINK$</code></strong></a></td>
139<td>Link markup linking to a message.</td>
140</tr>
141<tr valign=top>
142<td align=center><a name="LOCALDATE" href="../rcvars.html#LOCALDATE"><strong><code>$LOCALDATE$</code></strong></a></td>
143<td>Current local date.</td>
144</tr>
145<tr valign=top>
146<td align=center><a name="MMDDYYYY" href="../rcvars.html#MMDDYYYY"><strong><code>$MMDDYYYY$</code></strong></a></td>
147<td>Message date in mm/dd/yyyy format.</td>
148</tr>
149<tr valign=top>
150<td align=center><a name="MSG" href="../rcvars.html#MSG"><strong><code>$MSG$</code></strong></a></td>
151<td>Filename of message.</td>
152</tr>
153<tr valign=top>
154<td align=center><a name="MSGGMTDATE" href="../rcvars.html#MSGGMTDATE"><strong><code>$MSGGMTDATE$</code></strong></a></td>
155<td>GMT date of current message.</td>
156</tr>
157<tr valign=top>
158<td align=center><a name="MSGID" href="../rcvars.html#MSGID"><strong><code>$MSGID$</code></strong></a></td>
159<td>The message-id of the message.</td>
160</tr>
161<tr valign=top>
162<td align=center><a name="MSGLOCALDATE" href="../rcvars.html#MSGLOCALDATE"><strong><code>$MSGLOCALDATE$</code></strong></a></td>
163<td>Local date of current message.</td>
164</tr>
165<tr valign=top>
166<td align=center><a name="MSGNUM" href="../rcvars.html#MSGNUM"><strong><code>$MSGNUM$</code></strong></a></td>
167<td>The message number assigned to the message by MHonArc (includes leading zeros).</td>
168</tr>
169<tr valign=top>
170<td align=center><a name="MSGPREFIX" href="../rcvars.html#MSGPREFIX"><strong><code>$MSGPREFIX$</code></strong></a></td>
171<td>Filename prefix for message files.</td>
172</tr>
173<tr valign=top>
174<td align=center><a name="MSGTORDNUM" href="../rcvars.html#MSGTORDNUM"><strong><code>$MSGTORDNUM$</code></strong></a></td>
175<td>The ordinal message number of the current discussion thread.</td>
176</tr>
177<tr valign=top>
178<td align=center><a name="NOTE" href="../rcvars.html#NOTE"><strong><code>$NOTE$</code></strong></a></td>
179<td>Message annotation.</td>
180</tr>
181<tr valign=top>
182<td align=center><a name="NUMFOLUP" href="../rcvars.html#NUMFOLUP"><strong><code>$NUMFOLUP$</code></strong></a></td>
183<td>Number of explicit follow-ups to the message.</td>
184</tr>
185<tr valign=top>
186<td align=center><a name="NUMOFMSG" href="../rcvars.html#NUMOFMSG"><strong><code>$NUMOFMSG$</code></strong></a></td>
187<td>Number of messages in the archive.</td>
188</tr>
189<tr valign=top>
190<td align=center><a name="NUMOFPAGES" href="../rcvars.html#NUMOFPAGES"><strong><code>$NUMOFPAGES$</code></strong></a></td>
191<td>Number of index pages.</td>
192</tr>
193<tr valign=top>
194<td align=center><a name="ORDNUM" href="../rcvars.html#ORDNUM"><strong><code>$ORDNUM$</code></strong></a></td>
195<td>The current listing number of the message.</td>
196</tr>
197<tr valign=top>
198<td align=center><a name="OUTDIR" href="../rcvars.html#OUTDIR"><strong><code>$OUTDIR$</code></strong></a></td>
199<td>Pathname of archive.</td>
200</tr>
201<tr valign=top>
202<td align=center><a name="PROG" href="../rcvars.html#PROG"><strong><code>$PROG$</code></strong></a></td>
203<td>Program name</td>
204</tr>
205<tr valign=top>
206<td align=center><a name="SUBJECT" href="../rcvars.html#SUBJECT"><strong><code>$SUBJECT$</code></strong></a></td>
207<td>The subject text of the message, and if no arguments, wrapped in an anchor element that hyperlinks to the message.</td>
208</tr>
209<tr valign=top>
210<td align=center><a name="SUBJECTNA" href="../rcvars.html#SUBJECTNA"><strong><code>$SUBJECTNA$</code></strong></a></td>
211<td>The subject text of the message without the anchor element.</td>
212</tr>
213<tr valign=top>
214<td align=center><a name="TIDXFNAME" href="../rcvars.html#TIDXFNAME"><strong><code>$TIDXFNAME$</code></strong></a></td>
215<td>Filename of thread index page.</td>
216</tr>
217<tr valign=top>
218<td align=center><a name="TIDXLABEL" href="../rcvars.html#TIDXLABEL"><strong><code>$TIDXLABEL$</code></strong></a></td>
219<td>Label for thread index page.</td>
220</tr>
221<tr valign=top>
222<td align=center><a name="TIDXPREFIX" href="../rcvars.html#TIDXPREFIX"><strong><code>$TIDXPREFIX$</code></strong></a></td>
223<td>Prefix of filenames of thread index pages.</td>
224</tr>
225<tr valign=top>
226<td align=center><a name="TIDXTITLE" href="../rcvars.html#TIDXTITLE"><strong><code>$TIDXTITLE$</code></strong></a></td>
227<td>Title of thread index.</td>
228</tr>
229<tr valign=top>
230<td align=center><a name="TLEVEL" href="../rcvars.html#TLEVEL"><strong><code>$TLEVEL$</code></strong></a></td>
231<td>Numeric level of message in thread, starting with 0.</td>
232</tr>
233<tr valign=top>
234<td align=center><a name="TSLICE" href="../rcvars.html#TSLICE"><strong><code>$TSLICE$</code></strong></a></td>
235<td>A <em>slice</em> of the thread listing relative to the current message. Size of slice determined by the TSLICE resource.</td>
236</tr>
237<tr valign=top>
238<td align=center><a name="VERSION" href="../rcvars.html#VERSION"><strong><code>$VERSION$</code></strong></a></td>
239<td>Program version.</td>
240</tr>
241<tr valign=top>
242<td align=center><a name="YYYYMMDD" href="../rcvars.html#YYYYMMDD"><strong><code>$YYYYMMDD$</code></strong></a></td>
243<td>Message date in yyyy/mm/dd format.</td>
244</tr>
245</table>
246
247<!-- *************************************************************** -->
248<hr>
249<h2>Examples</h2>
250
251<p>The various <nobr><tt>TSLICE</tt>*<tt>CUR</tt></nobr> resource
252allow you to provide a different rendering style for the current
253message in a thread slice. For example, if the default layout
254settings are being used for rendering thread slices, the following
255resource settings can be used to have the current message show
256up in grey within a thread slice:
257</p>
258<pre>
259<b><a href="../resources/tslicetopbegcur.html">&lt;TSliceTopBeginCur&gt;</a></b>
260&lt;li&gt;&lt;font color="#666666"&gt;&lt;strong&gt;<b><a href="../rcvars.html#SUBJECTNA">$SUBJECTNA$</a></b>&lt;/strong&gt;,
261&lt;em&gt;<b><a href="../rcvars.html#FROMNAME">$FROMNAME$</a></b>&lt;/em&gt;&lt;/font&gt;&amp;nbsp;&lt;b&gt;&amp;lt;=&lt;/b&gt;
262<b>&lt;/TSliceTopBeginCur&gt;</b>
263
264<b><a href="../resources/tslicelitxtcur.html">&lt;TSliceLiTxtCur&gt;</a></b>
265&lt;li&gt;&lt;font color="#666666"&gt;&lt;strong&gt;<b><a href="../rcvars.html#SUBJECTNA">$SUBJECTNA$</a></b>&lt;/strong&gt;,
266&lt;em&gt;<b><a href="../rcvars.html#FROMNAME">$FROMNAME$</a></b>&lt;/em&gt;&lt;/font&gt;&amp;nbsp;&lt;b&gt;&amp;lt;=&lt;/b&gt;
267<b>&lt;/TSliceLiTxtCur&gt;</b>
268
269<b><a href="../resources/tslicesingletxtcur.html">&lt;TSliceSingleTxtCur&gt;</a></b>
270&lt;li&gt;&lt;font color="#666666"&gt;&lt;strong&gt;<b><a href="../rcvars.html#SUBJECTNA">$SUBJECTNA$</a></b>&lt;/strong&gt;,
271&lt;em&gt;<b><a href="../rcvars.html#FROMNAME">$FROMNAME$</a></b>&lt;/em&gt;&lt;/font&gt;&amp;nbsp;&lt;b&gt;&amp;lt;=&lt;/b&gt;
272<b>&lt;/TSliceSingleTxtCur&gt;</b>
273</pre>
274
275<!-- *************************************************************** -->
276<hr>
277<h2>Version</h2>
278
279<p>2.5.0
280</p>
281
282<!-- *************************************************************** -->
283<hr>
284<h2>See Also</h2>
285
286<p>
287<a href="../rcvars.html#TSLICE"><tt>$TSLICE$</tt></a>,
288<a href="tslice.html">TSLICE</a>,
289<a href="tslicebeg.html">TSLICEBEG</a>,
290<a href="tslicecontbeg.html">TSLICECONTBEG</a>,
291<a href="tslicecontend.html">TSLICECONTEND</a>,
292<a href="tsliceend.html">TSLICEEND</a>,
293<a href="tsliceindentbeg.html">TSLICEINDENTBEG</a>,
294<a href="tsliceindentend.html">TSLICEINDENTEND</a>,
295<a href="tsliceliend.html">TSLICELIEND</a>,
296<a href="tsliceliendcur.html">TSLICELIENDCUR</a>,
297<a href="tslicelinone.html">TSLICELINONE</a>,
298<a href="tslicelinoneend.html">TSLICELINONEEND</a>,
299<a href="tslicelitxt.html">TSLICELITXT</a>,
300<a href="tslicelitxtcur.html">TSLICELITXTCUR</a>,
301<a href="tslicesingletxt.html">TSLICESINGLETXT</a>,
302<a href="tslicesingletxtcur.html">TSLICESINGLETXTCUR</a>,
303<a href="tslicesubjectbeg.html">TSLICESUBJECTBEG</a>,
304<a href="tslicesubjectend.html">TSLICESUBJECTEND</a>,
305<a href="tslicesublistbeg.html">TSLICESUBLISTBEG</a>,
306<a href="tslicesublistend.html">TSLICESUBLISTEND</a>,
307<a href="tslicetopbeg.html">TSLICETOPBEG</a>,
308<a href="tslicetopend.html">TSLICETOPEND</a>,
309<a href="tslicetopendcur.html">TSLICETOPENDCUR</a>
310</p>
311
312<!-- *************************************************************** -->
313<hr>
314<!--x-rc-nav-->
315<table border=0><tr valign="top">
316<td align="left" width="50%">[Prev:&nbsp;<a href="tslicetopbeg.html">TSLICETOPBEG</a>]</td><td><nobr>[<a href="../resources.html#tslicetopbegcur">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="tslicetopend.html">TSLICETOPEND</a>]</td></tr></table>
317<!--/x-rc-nav-->
318<hr>
319<address>
320$Date: 2002/07/27 05:13:11 $ <br>
321<img align="top" src="../monicon.png" alt="">
322<a href="http://www.mhonarc.org/"><strong>MHonArc</strong></a><br>
323Copyright &#169; 2001, <a href="http://www.earlhood.com/"
324>Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org"
325>mhonarc@mhonarc.org</a><br>
326</address>
327
328</body>
329</html>