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: DEFINEDERIVED</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="decodeheads.html">DECODEHEADS</a>]</td><td><nobr>[<a href="../resources.html#definederived">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next: <a href="definevar.html">DEFINEVAR</a>]</td></tr></table> | |
| 10 | <!--/x-rc-nav--> | |
| 11 | <hr> | |
| 12 | <h1>DEFINEDERIVED</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><DEFINEDERIVED><br></code> | |
| 28 | <var>filename</var><br> | |
| 29 | <var>file contents ...</var><br> | |
| 30 | <code></DEFINEDERIVED><br></code> | |
| 31 | </p> | |
| 32 | </dd> | |
| 33 | ||
| 34 | <dt><strong>Command-line Option</strong></dt> | |
| 35 | <dd><p>N/A | |
| 36 | </p> | |
| 37 | </dd> | |
| 38 | ||
| 39 | </dl> | |
| 40 | ||
| 41 | <!-- *************************************************************** --> | |
| 42 | <hr> | |
| 43 | <h2>Description</h2> | |
| 44 | ||
| 45 | <p>DEFINEDERIVED is used to define extra files that are generated | |
| 46 | for each message processed. DEFINEDERIVED can only be specified | |
| 47 | in a resource file and may occur mutliple times to define multiple | |
| 48 | files to be created. The first line of the DEFINEDERIVED | |
| 49 | element is the name of the file. All subsequent lines represent | |
| 50 | the content of the file. | |
| 51 | </p> | |
| 52 | ||
| 53 | ||
| 54 | <!-- *************************************************************** --> | |
| 55 | <hr> | |
| 56 | <h2>Default Setting</h2> | |
| 57 | ||
| 58 | <p>N/A | |
| 59 | </p> | |
| 60 | ||
| 61 | <!-- *************************************************************** --> | |
| 62 | <hr> | |
| 63 | <h2>Resource Variables</h2> | |
| 64 | ||
| 65 | <table border=1> | |
| 66 | <tr bgcolor="#C0C0C0"> | |
| 67 | <th>Variable</th><th>Value</th> | |
| 68 | </tr> | |
| 69 | <tr valign=top> | |
| 70 | <td align=center><a name="BUTTON" href="../rcvars.html#BUTTON"><strong><code>$BUTTON$</code></strong></a></td> | |
| 71 | <td>Button markup linking to a message.</td> | |
| 72 | </tr> | |
| 73 | <tr valign=top> | |
| 74 | <td align=center><a name="DATE" href="../rcvars.html#DATE"><strong><code>$DATE$</code></strong></a></td> | |
| 75 | <td>The date of the message.</td> | |
| 76 | </tr> | |
| 77 | <tr valign=top> | |
| 78 | <td align=center><a name="DDMMYYYY" href="../rcvars.html#DDMMYYYY"><strong><code>$DDMMYYYY$</code></strong></a></td> | |
| 79 | <td>Message date in dd/mm/yyyy format.</td> | |
| 80 | </tr> | |
| 81 | <tr valign=top> | |
| 82 | <td align=center><a name="DOCURL" href="../rcvars.html#DOCURL"><strong><code>$DOCURL$</code></strong></a></td> | |
| 83 | <td>URL to documentation.</td> | |
| 84 | </tr> | |
| 85 | <tr valign=top> | |
| 86 | <td align=center><a name="ENV" href="../rcvars.html#ENV"><strong><code>$ENV$</code></strong></a></td> | |
| 87 | <td>Value of an environment variable.</td> | |
| 88 | </tr> | |
| 89 | <tr valign=top> | |
| 90 | <td align=center><a name="FROM" href="../rcvars.html#FROM"><strong><code>$FROM$</code></strong></a></td> | |
| 91 | <td>The complete text in the <tt>From:</tt> field of the message.</td> | |
| 92 | </tr> | |
| 93 | <tr valign=top> | |
| 94 | <td align=center><a name="FROMADDR" href="../rcvars.html#FROMADDR"><strong><code>$FROMADDR$</code></strong></a></td> | |
| 95 | <td>The e-mail address in the <tt>From:</tt> field of the message.</td> | |
| 96 | </tr> | |
| 97 | <tr valign=top> | |
| 98 | <td align=center><a name="FROMADDRDOMAIN" href="../rcvars.html#FROMADDRDOMAIN"><strong><code>$FROMADDRDOMAIN$</code></strong></a></td> | |
| 99 | <td>The e-mail address domain of the <tt>From:</tt> field of the message.</td> | |
| 100 | </tr> | |
| 101 | <tr valign=top> | |
| 102 | <td align=center><a name="FROMADDRNAME" href="../rcvars.html#FROMADDRNAME"><strong><code>$FROMADDRNAME$</code></strong></a></td> | |
| 103 | <td>The e-mail address "username" (or local-part) of the <tt>From:</tt> field of the message.</td> | |
| 104 | </tr> | |
| 105 | <tr valign=top> | |
| 106 | <td align=center><a name="FROMNAME" href="../rcvars.html#FROMNAME"><strong><code>$FROMNAME$</code></strong></a></td> | |
| 107 | <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> | |
| 108 | </tr> | |
| 109 | <tr valign=top> | |
| 110 | <td align=center><a name="GMTDATE" href="../rcvars.html#GMTDATE"><strong><code>$GMTDATE$</code></strong></a></td> | |
| 111 | <td>Current GMT date.</td> | |
| 112 | </tr> | |
| 113 | <tr valign=top> | |
| 114 | <td align=center><a name="ICON" href="../rcvars.html#ICON"><strong><code>$ICON$</code></strong></a></td> | |
| 115 | <td>The context-type sensitive icon.</td> | |
| 116 | </tr> | |
| 117 | <tr valign=top> | |
| 118 | <td align=center><a name="ICONURL" href="../rcvars.html#ICONURL"><strong><code>$ICONURL$</code></strong></a></td> | |
| 119 | <td>The URL to the context-type sensitive icon.</td> | |
| 120 | </tr> | |
| 121 | <tr valign=top> | |
| 122 | <td align=center><a name="IDXFNAME" href="../rcvars.html#IDXFNAME"><strong><code>$IDXFNAME$</code></strong></a></td> | |
| 123 | <td>Filename of main index page.</td> | |
| 124 | </tr> | |
| 125 | <tr valign=top> | |
| 126 | <td align=center><a name="IDXLABEL" href="../rcvars.html#IDXLABEL"><strong><code>$IDXLABEL$</code></strong></a></td> | |
| 127 | <td>Label for main index page.</td> | |
| 128 | </tr> | |
| 129 | <tr valign=top> | |
| 130 | <td align=center><a name="IDXPREFIX" href="../rcvars.html#IDXPREFIX"><strong><code>$IDXPREFIX$</code></strong></a></td> | |
| 131 | <td>Prefix of filenames of main index pages.</td> | |
| 132 | </tr> | |
| 133 | <tr valign=top> | |
| 134 | <td align=center><a name="IDXSIZE" href="../rcvars.html#IDXSIZE"><strong><code>$IDXSIZE$</code></strong></a></td> | |
| 135 | <td>Max number of messages that may be listed in index page.</td> | |
| 136 | </tr> | |
| 137 | <tr valign=top> | |
| 138 | <td align=center><a name="IDXTITLE" href="../rcvars.html#IDXTITLE"><strong><code>$IDXTITLE$</code></strong></a></td> | |
| 139 | <td>The title of the main index page.</td> | |
| 140 | </tr> | |
| 141 | <tr valign=top> | |
| 142 | <td align=center><a name="LINK" href="../rcvars.html#LINK"><strong><code>$LINK$</code></strong></a></td> | |
| 143 | <td>Link markup linking to a message.</td> | |
| 144 | </tr> | |
| 145 | <tr valign=top> | |
| 146 | <td align=center><a name="LOCALDATE" href="../rcvars.html#LOCALDATE"><strong><code>$LOCALDATE$</code></strong></a></td> | |
| 147 | <td>Current local date.</td> | |
| 148 | </tr> | |
| 149 | <tr valign=top> | |
| 150 | <td align=center><a name="MMDDYYYY" href="../rcvars.html#MMDDYYYY"><strong><code>$MMDDYYYY$</code></strong></a></td> | |
| 151 | <td>Message date in mm/dd/yyyy format.</td> | |
| 152 | </tr> | |
| 153 | <tr valign=top> | |
| 154 | <td align=center><a name="MSG" href="../rcvars.html#MSG"><strong><code>$MSG$</code></strong></a></td> | |
| 155 | <td>Filename of message.</td> | |
| 156 | </tr> | |
| 157 | <tr valign=top> | |
| 158 | <td align=center><a name="MSGGMTDATE" href="../rcvars.html#MSGGMTDATE"><strong><code>$MSGGMTDATE$</code></strong></a></td> | |
| 159 | <td>GMT date of current message.</td> | |
| 160 | </tr> | |
| 161 | <tr valign=top> | |
| 162 | <td align=center><a name="MSGID" href="../rcvars.html#MSGID"><strong><code>$MSGID$</code></strong></a></td> | |
| 163 | <td>The message-id of the message.</td> | |
| 164 | </tr> | |
| 165 | <tr valign=top> | |
| 166 | <td align=center><a name="MSGLOCALDATE" href="../rcvars.html#MSGLOCALDATE"><strong><code>$MSGLOCALDATE$</code></strong></a></td> | |
| 167 | <td>Local date of current message.</td> | |
| 168 | </tr> | |
| 169 | <tr valign=top> | |
| 170 | <td align=center><a name="MSGNUM" href="../rcvars.html#MSGNUM"><strong><code>$MSGNUM$</code></strong></a></td> | |
| 171 | <td>The message number assigned to the message by MHonArc (includes leading zeros).</td> | |
| 172 | </tr> | |
| 173 | <tr valign=top> | |
| 174 | <td align=center><a name="MSGPREFIX" href="../rcvars.html#MSGPREFIX"><strong><code>$MSGPREFIX$</code></strong></a></td> | |
| 175 | <td>Filename prefix for message files.</td> | |
| 176 | </tr> | |
| 177 | <tr valign=top> | |
| 178 | <td align=center><a name="MSGTORDNUM" href="../rcvars.html#MSGTORDNUM"><strong><code>$MSGTORDNUM$</code></strong></a></td> | |
| 179 | <td>The ordinal message number of the current discussion thread.</td> | |
| 180 | </tr> | |
| 181 | <tr valign=top> | |
| 182 | <td align=center><a name="NOTE" href="../rcvars.html#NOTE"><strong><code>$NOTE$</code></strong></a></td> | |
| 183 | <td>Message annotation.</td> | |
| 184 | </tr> | |
| 185 | <tr valign=top> | |
| 186 | <td align=center><a name="NUMFOLUP" href="../rcvars.html#NUMFOLUP"><strong><code>$NUMFOLUP$</code></strong></a></td> | |
| 187 | <td>Number of explicit follow-ups to the message.</td> | |
| 188 | </tr> | |
| 189 | <tr valign=top> | |
| 190 | <td align=center><a name="NUMOFMSG" href="../rcvars.html#NUMOFMSG"><strong><code>$NUMOFMSG$</code></strong></a></td> | |
| 191 | <td>Number of messages in the archive.</td> | |
| 192 | </tr> | |
| 193 | <tr valign=top> | |
| 194 | <td align=center><a name="NUMOFPAGES" href="../rcvars.html#NUMOFPAGES"><strong><code>$NUMOFPAGES$</code></strong></a></td> | |
| 195 | <td>Number of index pages.</td> | |
| 196 | </tr> | |
| 197 | <tr valign=top> | |
| 198 | <td align=center><a name="ORDNUM" href="../rcvars.html#ORDNUM"><strong><code>$ORDNUM$</code></strong></a></td> | |
| 199 | <td>The current listing number of the message.</td> | |
| 200 | </tr> | |
| 201 | <tr valign=top> | |
| 202 | <td align=center><a name="OUTDIR" href="../rcvars.html#OUTDIR"><strong><code>$OUTDIR$</code></strong></a></td> | |
| 203 | <td>Pathname of archive.</td> | |
| 204 | </tr> | |
| 205 | <tr valign=top> | |
| 206 | <td align=center><a name="PROG" href="../rcvars.html#PROG"><strong><code>$PROG$</code></strong></a></td> | |
| 207 | <td>Program name</td> | |
| 208 | </tr> | |
| 209 | <tr valign=top> | |
| 210 | <td align=center><a name="SUBJECT" href="../rcvars.html#SUBJECT"><strong><code>$SUBJECT$</code></strong></a></td> | |
| 211 | <td>The subject text of the message, and if no arguments, wrapped in an anchor element that hyperlinks to the message.</td> | |
| 212 | </tr> | |
| 213 | <tr valign=top> | |
| 214 | <td align=center><a name="SUBJECTNA" href="../rcvars.html#SUBJECTNA"><strong><code>$SUBJECTNA$</code></strong></a></td> | |
| 215 | <td>The subject text of the message without the anchor element.</td> | |
| 216 | </tr> | |
| 217 | <tr valign=top> | |
| 218 | <td align=center><a name="TIDXFNAME" href="../rcvars.html#TIDXFNAME"><strong><code>$TIDXFNAME$</code></strong></a></td> | |
| 219 | <td>Filename of thread index page.</td> | |
| 220 | </tr> | |
| 221 | <tr valign=top> | |
| 222 | <td align=center><a name="TIDXLABEL" href="../rcvars.html#TIDXLABEL"><strong><code>$TIDXLABEL$</code></strong></a></td> | |
| 223 | <td>Label for thread index page.</td> | |
| 224 | </tr> | |
| 225 | <tr valign=top> | |
| 226 | <td align=center><a name="TIDXPREFIX" href="../rcvars.html#TIDXPREFIX"><strong><code>$TIDXPREFIX$</code></strong></a></td> | |
| 227 | <td>Prefix of filenames of thread index pages.</td> | |
| 228 | </tr> | |
| 229 | <tr valign=top> | |
| 230 | <td align=center><a name="TIDXTITLE" href="../rcvars.html#TIDXTITLE"><strong><code>$TIDXTITLE$</code></strong></a></td> | |
| 231 | <td>Title of thread index.</td> | |
| 232 | </tr> | |
| 233 | <tr valign=top> | |
| 234 | <td align=center><a name="TLEVEL" href="../rcvars.html#TLEVEL"><strong><code>$TLEVEL$</code></strong></a></td> | |
| 235 | <td>Numeric level of message in thread, starting with 0.</td> | |
| 236 | </tr> | |
| 237 | <tr valign=top> | |
| 238 | <td align=center><a name="TSLICE" href="../rcvars.html#TSLICE"><strong><code>$TSLICE$</code></strong></a></td> | |
| 239 | <td>A <em>slice</em> of the thread listing relative to the current message. Size of slice determined by the TSLICE resource.</td> | |
| 240 | </tr> | |
| 241 | <tr valign=top> | |
| 242 | <td align=center><a name="VERSION" href="../rcvars.html#VERSION"><strong><code>$VERSION$</code></strong></a></td> | |
| 243 | <td>Program version.</td> | |
| 244 | </tr> | |
| 245 | <tr valign=top> | |
| 246 | <td align=center><a name="YYYYMMDD" href="../rcvars.html#YYYYMMDD"><strong><code>$YYYYMMDD$</code></strong></a></td> | |
| 247 | <td>Message date in yyyy/mm/dd format.</td> | |
| 248 | </tr> | |
| 249 | </table> | |
| 250 | ||
| 251 | <!-- *************************************************************** --> | |
| 252 | <hr> | |
| 253 | <h2>Examples</h2> | |
| 254 | ||
| 255 | <p>The following example shows how user defined files can be | |
| 256 | used to provide a framed navigational view of an archive. Note | |
| 257 | how the filenames contain resource variables to uniquely qualify | |
| 258 | the name for each message. | |
| 259 | </p> | |
| 260 | ||
| 261 | <dl> | |
| 262 | <dt><strong>Note</strong></dt> | |
| 263 | <dd><p>This | |
| 264 | example is not complete since other resources need to be defined | |
| 265 | to make everything work. | |
| 266 | </p> | |
| 267 | </dd> | |
| 268 | </dl> | |
| 269 | ||
| 270 | <p>The following derived file is the main file the index pages | |
| 271 | will link to. It defines the subframe definitions for the | |
| 272 | navigational links and the message data: | |
| 273 | </p> | |
| 274 | ||
| 275 | <pre> | |
| 276 | <b><DefineDerived></b> | |
| 277 | frm<a href="#MSGNUM">$MSGNUM$</a>.html | |
| 278 | <html> | |
| 279 | <head> | |
| 280 | <title>Message View</title> | |
| 281 | </head> | |
| 282 | <frameset rows="75,*"> | |
| 283 | <frame src="nav<a href="#MSGNUM">$MSGNUM$</a>.html" name="NAV"> | |
| 284 | <frame src="msg<a href="#MSGNUM">$MSGNUM$</a>.html" name="MESSAGE"> | |
| 285 | </frameset> | |
| 286 | </html> | |
| 287 | <b></DefineDerived></b> | |
| 288 | </pre> | |
| 289 | ||
| 290 | <p>The following derived file defines the navigational links | |
| 291 | for a message. The links will be displayed in a frame | |
| 292 | above the converted message. | |
| 293 | </p> | |
| 294 | ||
| 295 | <pre> | |
| 296 | <b><DefineDerived></b> | |
| 297 | nav<a href="#MSGNUM">$MSGNUM$</a>.html | |
| 298 | <html> | |
| 299 | <head> | |
| 300 | <title>Message Navigation</title> | |
| 301 | </head> | |
| 302 | <body> | |
| 303 | <table cellpadding=0 cellspacing=0 cols=3 border=1 width="100%"> | |
| 304 | <tbody> | |
| 305 | <tr align="center"> | |
| 306 | <th colspan=3><strong>Thread Links</strong></th> | |
| 307 | <th colspan=3><strong>Date Links</strong></th> | |
| 308 | </tr> | |
| 309 | <tr align="center"> | |
| 310 | <td><a href="#TPREVBUTTON">$TPREVBUTTON$</a></td> | |
| 311 | <td><a href="#TNEXTBUTTON">$TNEXTBUTTON$</a></td> | |
| 312 | <td><a $FRAME-IDX$ href="<a href="#TIDXFNAME">$TIDXFNAME$</a>#<a href="#MSGNUM">$MSGNUM$</a>">Index</a></td> | |
| 313 | <td><a href="#PREVBUTTON">$PREVBUTTON$</a></td> | |
| 314 | <td><a href="#NEXTBUTTON">$NEXTBUTTON$</a></td> | |
| 315 | <td><a $FRAME-IDX$ href="<a href="#IDXFNAME">$IDXFNAME$</a>#<a href="#MSGNUM">$MSGNUM$</a>">Index</a></td> | |
| 316 | </tr> | |
| 317 | </tbody> | |
| 318 | </table> | |
| 319 | </body> | |
| 320 | </html> | |
| 321 | <b></DefineDerived></b> | |
| 322 | </pre> | |
| 323 | ||
| 324 | ||
| 325 | <!-- *************************************************************** --> | |
| 326 | <hr> | |
| 327 | <h2>Version</h2> | |
| 328 | ||
| 329 | <p>2.0 | |
| 330 | </p> | |
| 331 | ||
| 332 | <!-- *************************************************************** --> | |
| 333 | <hr> | |
| 334 | <h2>See Also</h2> | |
| 335 | ||
| 336 | <p> | |
| 337 | </p> | |
| 338 | ||
| 339 | <!-- *************************************************************** --> | |
| 340 | <hr> | |
| 341 | <!--x-rc-nav--> | |
| 342 | <table border=0><tr valign="top"> | |
| 343 | <td align="left" width="50%">[Prev: <a href="decodeheads.html">DECODEHEADS</a>]</td><td><nobr>[<a href="../resources.html#definederived">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next: <a href="definevar.html">DEFINEVAR</a>]</td></tr></table> | |
| 344 | <!--/x-rc-nav--> | |
| 345 | <hr> | |
| 346 | <address> | |
| 347 | $Date: 2002/07/27 05:13:10 $ <br> | |
| 348 | <img align="top" src="../monicon.png" alt=""> | |
| 349 | <a href="http://www.mhonarc.org/"><strong>MHonArc</strong></a><br> | |
| 350 | Copyright © 1997-1998, <a href="http://www.earlhood.com/">Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org">mhonarc@mhonarc.org</a><br> | |
| 351 | </address> | |
| 352 | ||
| 353 | </body> | |
| 354 | </html> |