projects / OpenSPARC-T2-DV / blame
| Commit | Line | Data |
|---|---|---|
| 86530b38 AT |
1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN"> |
| 2 | <html> | |
| 3 | <head> | |
| 4 | <title>MHonArc Resources: LISTBEGIN</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="lastpglink.html">LASTPGLINK</a>]</td><td><nobr>[<a href="../resources.html#listbegin">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next: <a href="listend.html">LISTEND</a>]</td></tr></table> | |
| 10 | <!--/x-rc-nav--> | |
| 11 | <hr> | |
| 12 | <h1>LISTBEGIN</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><LISTBEGIN><br></code> | |
| 28 | <var>markup ...</var><br> | |
| 29 | <code></LISTBEGIN><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 LISTBEGIN resource specifies the markup to | |
| 45 | begin the message list. This resource works in conjuction | |
| 46 | with | |
| 47 | <a href="litemplate.html">LITEMPLATE</a> and | |
| 48 | <a href="listend.html">LISTEND</a> resources | |
| 49 | to format the main index page(es). | |
| 50 | </p> | |
| 51 | ||
| 52 | <!-- *************************************************************** --> | |
| 53 | <hr> | |
| 54 | <h2>Default Setting</h2> | |
| 55 | ||
| 56 | <p>If <a href="multipg.html">MULTIPG</a> is not active: | |
| 57 | </p> | |
| 58 | ||
| 59 | <PRE> | |
| 60 | <b><ListBegin></b> | |
| 61 | <ul> | |
| 62 | <li><a href="<a href="#TIDXFNAME">$TIDXFNAME$</a>">Thread Index</a></li> | |
| 63 | </ul> | |
| 64 | <hr> | |
| 65 | <ul> | |
| 66 | <b></ListBegin></b> | |
| 67 | </PRE> | |
| 68 | ||
| 69 | <p>If <a href="multipg.html">MULTIPG</a> is active: | |
| 70 | </p> | |
| 71 | ||
| 72 | <PRE> | |
| 73 | <b><ListBegin></b> | |
| 74 | <ul> | |
| 75 | <li><a href="<a href="#TIDXFNAME">$TIDXFNAME$</a>">Thread Index</a></li> | |
| 76 | </ul> | |
| 77 | <a href="#PGLINK">$PGLINK(PREV)$</a><a href="#PGLINK">$PGLINK(NEXT)$</a> | |
| 78 | <hr> | |
| 79 | <ul> | |
| 80 | <b></ListBegin></b> | |
| 81 | </PRE> | |
| 82 | ||
| 83 | <!-- *************************************************************** --> | |
| 84 | <hr> | |
| 85 | <h2>Resource Variables</h2> | |
| 86 | ||
| 87 | <table border=1> | |
| 88 | <tr bgcolor="#C0C0C0"> | |
| 89 | <th>Variable</th><th>Value</th> | |
| 90 | </tr> | |
| 91 | <tr valign=top> | |
| 92 | <td align=center><a name="DOCURL" href="../rcvars.html#DOCURL"><strong><code>$DOCURL$</code></strong></a></td> | |
| 93 | <td>URL to documentation.</td> | |
| 94 | </tr> | |
| 95 | <tr valign=top> | |
| 96 | <td align=center><a name="ENV" href="../rcvars.html#ENV"><strong><code>$ENV$</code></strong></a></td> | |
| 97 | <td>Value of an environment variable.</td> | |
| 98 | </tr> | |
| 99 | <tr valign=top> | |
| 100 | <td align=center><a name="GMTDATE" href="../rcvars.html#GMTDATE"><strong><code>$GMTDATE$</code></strong></a></td> | |
| 101 | <td>Current GMT date.</td> | |
| 102 | </tr> | |
| 103 | <tr valign=top> | |
| 104 | <td align=center><a name="IDXFNAME" href="../rcvars.html#IDXFNAME"><strong><code>$IDXFNAME$</code></strong></a></td> | |
| 105 | <td>Filename of main index page.</td> | |
| 106 | </tr> | |
| 107 | <tr valign=top> | |
| 108 | <td align=center><a name="IDXLABEL" href="../rcvars.html#IDXLABEL"><strong><code>$IDXLABEL$</code></strong></a></td> | |
| 109 | <td>Label for main index page.</td> | |
| 110 | </tr> | |
| 111 | <tr valign=top> | |
| 112 | <td align=center><a name="IDXPREFIX" href="../rcvars.html#IDXPREFIX"><strong><code>$IDXPREFIX$</code></strong></a></td> | |
| 113 | <td>Prefix of filenames of main index pages.</td> | |
| 114 | </tr> | |
| 115 | <tr valign=top> | |
| 116 | <td align=center><a name="IDXSIZE" href="../rcvars.html#IDXSIZE"><strong><code>$IDXSIZE$</code></strong></a></td> | |
| 117 | <td>Max number of messages that may be listed in index page.</td> | |
| 118 | </tr> | |
| 119 | <tr valign=top> | |
| 120 | <td align=center><a name="IDXTITLE" href="../rcvars.html#IDXTITLE"><strong><code>$IDXTITLE$</code></strong></a></td> | |
| 121 | <td>The title of the main index page.</td> | |
| 122 | </tr> | |
| 123 | <tr valign=top> | |
| 124 | <td align=center><a name="LOCALDATE" href="../rcvars.html#LOCALDATE"><strong><code>$LOCALDATE$</code></strong></a></td> | |
| 125 | <td>Current local date.</td> | |
| 126 | </tr> | |
| 127 | <tr valign=top> | |
| 128 | <td align=center><a name="NUMOFIDXMSG" href="../rcvars.html#NUMOFIDXMSG"><strong><code>$NUMOFIDXMSG$</code></strong></a></td> | |
| 129 | <td>Number of message listed.</td> | |
| 130 | </tr> | |
| 131 | <tr valign=top> | |
| 132 | <td align=center><a name="NUMOFMSG" href="../rcvars.html#NUMOFMSG"><strong><code>$NUMOFMSG$</code></strong></a></td> | |
| 133 | <td>Number of messages in the archive.</td> | |
| 134 | </tr> | |
| 135 | <tr valign=top> | |
| 136 | <td align=center><a name="NUMOFPAGES" href="../rcvars.html#NUMOFPAGES"><strong><code>$NUMOFPAGES$</code></strong></a></td> | |
| 137 | <td>Number of index pages.</td> | |
| 138 | </tr> | |
| 139 | <tr valign=top> | |
| 140 | <td align=center><a name="OUTDIR" href="../rcvars.html#OUTDIR"><strong><code>$OUTDIR$</code></strong></a></td> | |
| 141 | <td>Pathname of archive.</td> | |
| 142 | </tr> | |
| 143 | <tr valign=top> | |
| 144 | <td align=center><a name="PAGENUM" href="../rcvars.html#PAGENUM"><strong><code>$PAGENUM$</code></strong></a></td> | |
| 145 | <td>Current index page number.</td> | |
| 146 | </tr> | |
| 147 | <tr valign=top> | |
| 148 | <td align=center><a name="PG" href="../rcvars.html#PG"><strong><code>$PG$</code></strong></a></td> | |
| 149 | <td>Filename of an index page.</td> | |
| 150 | </tr> | |
| 151 | <tr valign=top> | |
| 152 | <td align=center><a name="PGLINK" href="../rcvars.html#PGLINK"><strong><code>$PGLINK$</code></strong></a></td> | |
| 153 | <td>Markup linking to an index page.</td> | |
| 154 | </tr> | |
| 155 | <tr valign=top> | |
| 156 | <td align=center><a name="PGLINKLIST" href="../rcvars.html#PGLINKLIST"><strong><code>$PGLINKLIST$</code></strong></a></td> | |
| 157 | <td>List of links to index pages.</td> | |
| 158 | </tr> | |
| 159 | <tr valign=top> | |
| 160 | <td align=center><a name="PROG" href="../rcvars.html#PROG"><strong><code>$PROG$</code></strong></a></td> | |
| 161 | <td>Program name</td> | |
| 162 | </tr> | |
| 163 | <tr valign=top> | |
| 164 | <td align=center><a name="TIDXFNAME" href="../rcvars.html#TIDXFNAME"><strong><code>$TIDXFNAME$</code></strong></a></td> | |
| 165 | <td>Filename of thread index page.</td> | |
| 166 | </tr> | |
| 167 | <tr valign=top> | |
| 168 | <td align=center><a name="TIDXLABEL" href="../rcvars.html#TIDXLABEL"><strong><code>$TIDXLABEL$</code></strong></a></td> | |
| 169 | <td>Label for thread index page.</td> | |
| 170 | </tr> | |
| 171 | <tr valign=top> | |
| 172 | <td align=center><a name="TIDXPREFIX" href="../rcvars.html#TIDXPREFIX"><strong><code>$TIDXPREFIX$</code></strong></a></td> | |
| 173 | <td>Prefix of filenames of thread index pages.</td> | |
| 174 | </tr> | |
| 175 | <tr valign=top> | |
| 176 | <td align=center><a name="TIDXTITLE" href="../rcvars.html#TIDXTITLE"><strong><code>$TIDXTITLE$</code></strong></a></td> | |
| 177 | <td>Title of thread index.</td> | |
| 178 | </tr> | |
| 179 | <tr valign=top> | |
| 180 | <td align=center><a name="VERSION" href="../rcvars.html#VERSION"><strong><code>$VERSION$</code></strong></a></td> | |
| 181 | <td>Program version.</td> | |
| 182 | </tr> | |
| 183 | </table> | |
| 184 | ||
| 185 | <!-- *************************************************************** --> | |
| 186 | <hr> | |
| 187 | <h2>Examples</h2> | |
| 188 | ||
| 189 | <p>Here is an example that includes links for the first and | |
| 190 | last page of the index for a mult-page index: | |
| 191 | </p> | |
| 192 | ||
| 193 | <PRE> | |
| 194 | <b><ListBegin></b> | |
| 195 | <ul> | |
| 196 | <li><a href="<a href="#TIDXFNAME">$TIDXFNAME$</a>">Thread Index</a></li> | |
| 197 | </ul> | |
| 198 | <table width="100%" border=0 cols=2 cellpadding=0 cellspacing=0> | |
| 199 | <tbody> | |
| 200 | <tr align="center"> | |
| 201 | <th colspan=4>Page <a href="#PAGENUM">$PAGENUM$</a> of <a href="#NUMOFPAGES">$NUMOFPAGES$</a> | |
| 202 | <tr> | |
| 203 | <td align="left"><a href="#PGLINK">$PGLINK(PREV)$</a> | |
| 204 | <td align="right">[<a href="<a href="#FIRSTPG">$PG(FIRST)$</a>">First Page</a>] | |
| 205 | <td align="left">[<a href="<a href="#LASTPG">$PG(LAST)$</a>">Last Page</a>] | |
| 206 | <td align="right"><a href="#PGLINK">$PGLINK(NEXT)</a> | |
| 207 | </tbody> | |
| 208 | </table> | |
| 209 | <hr> | |
| 210 | <ul> | |
| 211 | <b></ListBegin></b> | |
| 212 | </PRE> | |
| 213 | ||
| 214 | <!-- *************************************************************** --> | |
| 215 | <hr> | |
| 216 | <h2>Version</h2> | |
| 217 | ||
| 218 | <p>1.0 | |
| 219 | </p> | |
| 220 | ||
| 221 | <!-- *************************************************************** --> | |
| 222 | <hr> | |
| 223 | <h2>See Also</h2> | |
| 224 | ||
| 225 | <p> | |
| 226 | <a href="listend.html">LISTEND</a>, | |
| 227 | <a href="litemplate.html">LITEMPLATE</a>, | |
| 228 | <a href="multipg.html">MULTIPG</a> | |
| 229 | </p> | |
| 230 | ||
| 231 | <!-- *************************************************************** --> | |
| 232 | <hr> | |
| 233 | <!--x-rc-nav--> | |
| 234 | <table border=0><tr valign="top"> | |
| 235 | <td align="left" width="50%">[Prev: <a href="lastpglink.html">LASTPGLINK</a>]</td><td><nobr>[<a href="../resources.html#listbegin">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next: <a href="listend.html">LISTEND</a>]</td></tr></table> | |
| 236 | <!--/x-rc-nav--> | |
| 237 | <hr> | |
| 238 | <address> | |
| 239 | $Date: 2002/07/27 05:13:10 $ <br> | |
| 240 | <img align="top" src="../monicon.png" alt=""> | |
| 241 | <a href="http://www.mhonarc.org/"><strong>MHonArc</strong></a><br> | |
| 242 | Copyright © 1997-1998, <a href="http://www.earlhood.com/">Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org">mhonarc@mhonarc.org</a><br> | |
| 243 | </address> | |
| 244 | ||
| 245 | </body> | |
| 246 | </html> |