Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / perl-5.8.0 / doc / MHonArc / resources / tidxpgbegin.html
CommitLineData
86530b38
AT
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN">
2<html>
3<head>
4<title>MHonArc Resources: TIDXPGBEGIN</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="tidxlabel.html">TIDXLABEL</a>]</td><td><nobr>[<a href="../resources.html#tidxpgbegin">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="tidxpgend.html">TIDXPGEND</a>]</td></tr></table>
10<!--/x-rc-nav-->
11<hr>
12<h1>TIDXPGBEGIN</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;TIDXPGBEGIN&gt;<br></code>
28<var>markup ...</var><br>
29<code>&lt;/TIDXPGBEGIN&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 TIDXPGBEGIN resource defines the beginning markup for the thread
45index pages. I.e. You can control the opening &lt;HTML&gt; tag, the
46HEAD element contents, the opening &lt;BODY&gt; tag, etc. Therefore,
47if you are not satisfied with the default behavior of how the
48<a href="ttitle.html">TTITLE</a>
49resource is used, or have other needs that require control on the
50beginning markup, you can set the TIDXPGBEGIN resource to what you
51desire.
52</p>
53
54<!-- *************************************************************** -->
55<hr>
56<h2>Default Setting</h2>
57
58<PRE>
59<b>&lt;TIdxPgBegin&gt;</b>
60&lt;!doctype html public "-//W3C//DTD HTML//EN"&gt;
61&lt;html&gt;
62&lt;head&gt;
63&lt;title&gt;<a href="#TIDXTITLE">$TIDXTITLE$</a>&lt;/title&gt;
64&lt;/head&gt;
65&lt;body&gt;
66&lt;h1&gt;<a href="#TIDXTITLE">$TIDXTITLE$</a>&lt;/h1&gt;
67<b>&lt;/TIdxPgBegin&gt;</b>
68</PRE>
69
70<!-- *************************************************************** -->
71<hr>
72<h2>Resource Variables</h2>
73
74<table border=1>
75<tr bgcolor="#C0C0C0">
76<th>Variable</th><th>Value</th>
77</tr>
78<tr valign=top>
79<td align=center><a name="DOCURL" href="../rcvars.html#DOCURL"><strong><code>$DOCURL$</code></strong></a></td>
80<td>URL to documentation.</td>
81</tr>
82<tr valign=top>
83<td align=center><a name="ENV" href="../rcvars.html#ENV"><strong><code>$ENV$</code></strong></a></td>
84<td>Value of an environment variable.</td>
85</tr>
86<tr valign=top>
87<td align=center><a name="GMTDATE" href="../rcvars.html#GMTDATE"><strong><code>$GMTDATE$</code></strong></a></td>
88<td>Current GMT date.</td>
89</tr>
90<tr valign=top>
91<td align=center><a name="IDXFNAME" href="../rcvars.html#IDXFNAME"><strong><code>$IDXFNAME$</code></strong></a></td>
92<td>Filename of main index page.</td>
93</tr>
94<tr valign=top>
95<td align=center><a name="IDXLABEL" href="../rcvars.html#IDXLABEL"><strong><code>$IDXLABEL$</code></strong></a></td>
96<td>Label for main index page.</td>
97</tr>
98<tr valign=top>
99<td align=center><a name="IDXPREFIX" href="../rcvars.html#IDXPREFIX"><strong><code>$IDXPREFIX$</code></strong></a></td>
100<td>Prefix of filenames of main index pages.</td>
101</tr>
102<tr valign=top>
103<td align=center><a name="IDXSIZE" href="../rcvars.html#IDXSIZE"><strong><code>$IDXSIZE$</code></strong></a></td>
104<td>Max number of messages that may be listed in index page.</td>
105</tr>
106<tr valign=top>
107<td align=center><a name="IDXTITLE" href="../rcvars.html#IDXTITLE"><strong><code>$IDXTITLE$</code></strong></a></td>
108<td>The title of the main index page.</td>
109</tr>
110<tr valign=top>
111<td align=center><a name="LOCALDATE" href="../rcvars.html#LOCALDATE"><strong><code>$LOCALDATE$</code></strong></a></td>
112<td>Current local date.</td>
113</tr>
114<tr valign=top>
115<td align=center><a name="NUMOFIDXMSG" href="../rcvars.html#NUMOFIDXMSG"><strong><code>$NUMOFIDXMSG$</code></strong></a></td>
116<td>Number of message listed.</td>
117</tr>
118<tr valign=top>
119<td align=center><a name="NUMOFMSG" href="../rcvars.html#NUMOFMSG"><strong><code>$NUMOFMSG$</code></strong></a></td>
120<td>Number of messages in the archive.</td>
121</tr>
122<tr valign=top>
123<td align=center><a name="NUMOFPAGES" href="../rcvars.html#NUMOFPAGES"><strong><code>$NUMOFPAGES$</code></strong></a></td>
124<td>Number of index pages.</td>
125</tr>
126<tr valign=top>
127<td align=center><a name="OUTDIR" href="../rcvars.html#OUTDIR"><strong><code>$OUTDIR$</code></strong></a></td>
128<td>Pathname of archive.</td>
129</tr>
130<tr valign=top>
131<td align=center><a name="PROG" href="../rcvars.html#PROG"><strong><code>$PROG$</code></strong></a></td>
132<td>Program name</td>
133</tr>
134<tr valign=top>
135<td align=center><a name="TIDXFNAME" href="../rcvars.html#TIDXFNAME"><strong><code>$TIDXFNAME$</code></strong></a></td>
136<td>Filename of thread index page.</td>
137</tr>
138<tr valign=top>
139<td align=center><a name="TIDXLABEL" href="../rcvars.html#TIDXLABEL"><strong><code>$TIDXLABEL$</code></strong></a></td>
140<td>Label for thread index page.</td>
141</tr>
142<tr valign=top>
143<td align=center><a name="TIDXPREFIX" href="../rcvars.html#TIDXPREFIX"><strong><code>$TIDXPREFIX$</code></strong></a></td>
144<td>Prefix of filenames of thread index pages.</td>
145</tr>
146<tr valign=top>
147<td align=center><a name="TIDXTITLE" href="../rcvars.html#TIDXTITLE"><strong><code>$TIDXTITLE$</code></strong></a></td>
148<td>Title of thread index.</td>
149</tr>
150<tr valign=top>
151<td align=center><a name="VERSION" href="../rcvars.html#VERSION"><strong><code>$VERSION$</code></strong></a></td>
152<td>Program version.</td>
153</tr>
154</table>
155
156<!-- *************************************************************** -->
157<hr>
158<h2>Examples</h2>
159
160<p>The following shows how you can set HTML body element attributes
161to control the appearence of the thread index pages:
162</p>
163
164<PRE>
165<b>&lt;TIdxPgBegin&gt;</b>
166&lt;!doctype html public "-//W3C//DTD HTML//EN"&gt;
167&lt;html&gt;
168&lt;head&gt;
169&lt;title&gt;<a href="#TIDXTITLE">$TIDXTITLE$</a>&lt;/title&gt;
170&lt;/head&gt;
171&lt;body <em>background="tidxbg.png" bgproperties="fixed"</em>&gt;
172&lt;h1&gt;<a href="#TIDXTITLE">$TIDXTITLE$</a>&lt;/h1&gt;
173<b>&lt;/TIdxPgBegin&gt;</b>
174</PRE>
175
176
177<!-- *************************************************************** -->
178<hr>
179<h2>Version</h2>
180
181<p>1.2.0
182</p>
183
184<!-- *************************************************************** -->
185<hr>
186<h2>See Also</h2>
187
188<p>
189<a href="tidxpgend.html">TIDXPGEND</a>,
190<a href="ttitle.html">TTITLE</a>
191</p>
192
193<!-- *************************************************************** -->
194<hr>
195<!--x-rc-nav-->
196<table border=0><tr valign="top">
197<td align="left" width="50%">[Prev:&nbsp;<a href="tidxlabel.html">TIDXLABEL</a>]</td><td><nobr>[<a href="../resources.html#tidxpgbegin">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="tidxpgend.html">TIDXPGEND</a>]</td></tr></table>
198<!--/x-rc-nav-->
199<hr>
200<address>
201$Date: 2002/07/27 05:13:11 $ <br>
202<img align="top" src="../monicon.png" alt="">
203<a href="http://www.mhonarc.org/"><strong>MHonArc</strong></a><br>
204Copyright &#169; 1997-1998, <a href="http://www.earlhood.com/">Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org">mhonarc@mhonarc.org</a><br>
205</address>
206
207</body>
208</html>