Commit | Line | Data |
---|---|---|
86530b38 AT |
1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN"> |
2 | <html> | |
3 | <head> | |
4 | <title>MHonArc Resources: THEAD</title> | |
5 | </head> | |
6 | <body> | |
7 | <!--x-rc-nav--> | |
8 | <table border=0><tr valign="top"> | |
9 | <td align="left" width="50%">[Prev: <a href="tfoot.html">TFOOT</a>]</td><td><nobr>[<a href="../resources.html#thead">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next: <a href="thread.html">THREAD</a>]</td></tr></table> | |
10 | <!--/x-rc-nav--> | |
11 | <hr> | |
12 | <h1>THEAD</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><THEAD><br></code> | |
28 | <var>markup ...</var><br> | |
29 | <code></THEAD><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>THEAD defines the header markup of thread index pages. It | |
45 | is also responsible for defining the opening markup for the | |
46 | thread listing. | |
47 | </p> | |
48 | ||
49 | <!-- *************************************************************** --> | |
50 | <hr> | |
51 | <h2>Default Setting</h2> | |
52 | ||
53 | <p>If <a href="multipg.html">MULTIPG</a> is on: | |
54 | </p> | |
55 | ||
56 | <pre> | |
57 | <b><THead></b> | |
58 | <ul> | |
59 | <li><a href="<a href="#IDXFNAME">$IDXFNAME$</a>">Main Index</a></li> | |
60 | </ul> | |
61 | <a href="#PGLINK">$PGLINK(TPREV)$</a><a href="#PGLINK">$PGLINK(TNEXT)$</a> | |
62 | <hr> | |
63 | <ul> | |
64 | <b></THead></b> | |
65 | </pre> | |
66 | ||
67 | <p>If <a href="multipg.html">MULTIPG</a> is off: | |
68 | </p> | |
69 | ||
70 | <pre> | |
71 | <b><THead></b> | |
72 | <ul> | |
73 | <li><a href="<a href="#IDXFNAME">$IDXFNAME$</a>">Main Index</a></li> | |
74 | </ul> | |
75 | <hr> | |
76 | <ul> | |
77 | <b></THead></b> | |
78 | </pre> | |
79 | ||
80 | <!-- *************************************************************** --> | |
81 | <hr> | |
82 | <h2>Resource Variables</h2> | |
83 | ||
84 | <table border=1> | |
85 | <tr bgcolor="#C0C0C0"> | |
86 | <th>Variable</th><th>Value</th> | |
87 | </tr> | |
88 | <tr valign=top> | |
89 | <td align=center><a name="DOCURL" href="../rcvars.html#DOCURL"><strong><code>$DOCURL$</code></strong></a></td> | |
90 | <td>URL to documentation.</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="GMTDATE" href="../rcvars.html#GMTDATE"><strong><code>$GMTDATE$</code></strong></a></td> | |
98 | <td>Current GMT date.</td> | |
99 | </tr> | |
100 | <tr valign=top> | |
101 | <td align=center><a name="IDXFNAME" href="../rcvars.html#IDXFNAME"><strong><code>$IDXFNAME$</code></strong></a></td> | |
102 | <td>Filename of main index page.</td> | |
103 | </tr> | |
104 | <tr valign=top> | |
105 | <td align=center><a name="IDXLABEL" href="../rcvars.html#IDXLABEL"><strong><code>$IDXLABEL$</code></strong></a></td> | |
106 | <td>Label for main index page.</td> | |
107 | </tr> | |
108 | <tr valign=top> | |
109 | <td align=center><a name="IDXPREFIX" href="../rcvars.html#IDXPREFIX"><strong><code>$IDXPREFIX$</code></strong></a></td> | |
110 | <td>Prefix of filenames of main index pages.</td> | |
111 | </tr> | |
112 | <tr valign=top> | |
113 | <td align=center><a name="IDXSIZE" href="../rcvars.html#IDXSIZE"><strong><code>$IDXSIZE$</code></strong></a></td> | |
114 | <td>Max number of messages that may be listed in index page.</td> | |
115 | </tr> | |
116 | <tr valign=top> | |
117 | <td align=center><a name="IDXTITLE" href="../rcvars.html#IDXTITLE"><strong><code>$IDXTITLE$</code></strong></a></td> | |
118 | <td>The title of the main index page.</td> | |
119 | </tr> | |
120 | <tr valign=top> | |
121 | <td align=center><a name="LOCALDATE" href="../rcvars.html#LOCALDATE"><strong><code>$LOCALDATE$</code></strong></a></td> | |
122 | <td>Current local date.</td> | |
123 | </tr> | |
124 | <tr valign=top> | |
125 | <td align=center><a name="NUMOFIDXMSG" href="../rcvars.html#NUMOFIDXMSG"><strong><code>$NUMOFIDXMSG$</code></strong></a></td> | |
126 | <td>Number of message listed.</td> | |
127 | </tr> | |
128 | <tr valign=top> | |
129 | <td align=center><a name="NUMOFMSG" href="../rcvars.html#NUMOFMSG"><strong><code>$NUMOFMSG$</code></strong></a></td> | |
130 | <td>Number of messages in the archive.</td> | |
131 | </tr> | |
132 | <tr valign=top> | |
133 | <td align=center><a name="NUMOFPAGES" href="../rcvars.html#NUMOFPAGES"><strong><code>$NUMOFPAGES$</code></strong></a></td> | |
134 | <td>Number of index pages.</td> | |
135 | </tr> | |
136 | <tr valign=top> | |
137 | <td align=center><a name="OUTDIR" href="../rcvars.html#OUTDIR"><strong><code>$OUTDIR$</code></strong></a></td> | |
138 | <td>Pathname of archive.</td> | |
139 | </tr> | |
140 | <tr valign=top> | |
141 | <td align=center><a name="PROG" href="../rcvars.html#PROG"><strong><code>$PROG$</code></strong></a></td> | |
142 | <td>Program name</td> | |
143 | </tr> | |
144 | <tr valign=top> | |
145 | <td align=center><a name="TIDXFNAME" href="../rcvars.html#TIDXFNAME"><strong><code>$TIDXFNAME$</code></strong></a></td> | |
146 | <td>Filename of thread index page.</td> | |
147 | </tr> | |
148 | <tr valign=top> | |
149 | <td align=center><a name="TIDXLABEL" href="../rcvars.html#TIDXLABEL"><strong><code>$TIDXLABEL$</code></strong></a></td> | |
150 | <td>Label for thread index page.</td> | |
151 | </tr> | |
152 | <tr valign=top> | |
153 | <td align=center><a name="TIDXPREFIX" href="../rcvars.html#TIDXPREFIX"><strong><code>$TIDXPREFIX$</code></strong></a></td> | |
154 | <td>Prefix of filenames of thread index pages.</td> | |
155 | </tr> | |
156 | <tr valign=top> | |
157 | <td align=center><a name="TIDXTITLE" href="../rcvars.html#TIDXTITLE"><strong><code>$TIDXTITLE$</code></strong></a></td> | |
158 | <td>Title of thread index.</td> | |
159 | </tr> | |
160 | <tr valign=top> | |
161 | <td align=center><a name="VERSION" href="../rcvars.html#VERSION"><strong><code>$VERSION$</code></strong></a></td> | |
162 | <td>Program version.</td> | |
163 | </tr> | |
164 | </table> | |
165 | ||
166 | <!-- *************************************************************** --> | |
167 | <hr> | |
168 | <h2>Examples</h2> | |
169 | ||
170 | <p>The following example sets THEAD to contain page links | |
171 | for a multi-page thread index: | |
172 | </p> | |
173 | ||
174 | <pre> | |
175 | <b><THead></b> | |
176 | <ul> | |
177 | <li><a href="<a href="#IDXFNAME">$IDXFNAME$</a>">Date Index</a></li> | |
178 | </ul> | |
179 | <hr> | |
180 | <table border=0 width="100%"> | |
181 | <tbody> | |
182 | <tr align="center"> | |
183 | <th colspan=4>Page <a href="#PAGENUM">$PAGENUM$</a> of <a href="#NUMOFPAGES">$NUMOFPAGES$</a> | |
184 | <tr> | |
185 | <td align="left"><a href="#PGLINK">$PGLINK(TPREV)$</a> | |
186 | <td align="right">[<a href="<a href="#PG">$TFIRSTPG(TFIRST)$</a>">First Page</a>] | |
187 | <td align="left">[<a href="<a href="#PG">$PG(TLAST)$</a>">Last Page</a>] | |
188 | <td align="right"><a href="#PGLINK">$PGLINK(TNEXT)$</a> | |
189 | </tbody> | |
190 | </table> | |
191 | <hr> | |
192 | <ul> | |
193 | <b></THead></b> | |
194 | </pre> | |
195 | ||
196 | <!-- *************************************************************** --> | |
197 | <hr> | |
198 | <h2>Version</h2> | |
199 | ||
200 | <p>1.1 | |
201 | </p> | |
202 | ||
203 | <!-- *************************************************************** --> | |
204 | <hr> | |
205 | <h2>See Also</h2> | |
206 | ||
207 | <p> | |
208 | <a href="multipg.html">MULTIPG</a>, | |
209 | <a href="tfoot.html">TFOOT</a>, | |
210 | <a href="tnextpglink.html">TNEXTPGLINK</a>, | |
211 | <a href="tprevpglink.html">TPREVPGLINK</a> | |
212 | </p> | |
213 | ||
214 | <!-- *************************************************************** --> | |
215 | <hr> | |
216 | <!--x-rc-nav--> | |
217 | <table border=0><tr valign="top"> | |
218 | <td align="left" width="50%">[Prev: <a href="tfoot.html">TFOOT</a>]</td><td><nobr>[<a href="../resources.html#thead">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next: <a href="thread.html">THREAD</a>]</td></tr></table> | |
219 | <!--/x-rc-nav--> | |
220 | <hr> | |
221 | <address> | |
222 | $Date: 2002/07/27 05:13:11 $ <br> | |
223 | <img align="top" src="../monicon.png" alt=""> | |
224 | <a href="http://www.mhonarc.org/"><strong>MHonArc</strong></a><br> | |
225 | Copyright © 1997-1998, <a href="http://www.earlhood.com/">Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org">mhonarc@mhonarc.org</a><br> | |
226 | </address> | |
227 | ||
228 | </body> | |
229 | </html> |