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: TTOPBEGIN</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="ttitle.html">TTITLE</a>]</td><td><nobr>[<a href="../resources.html#ttopbegin">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next: <a href="ttopend.html">TTOPEND</a>]</td></tr></table> | |
| 10 | <!--/x-rc-nav--> | |
| 11 | <hr> | |
| 12 | <h1>TTOPBEGIN</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><TTOPBEGIN><br></code> | |
| 27 | <var>markup ...</var><br> | |
| 28 | <code></TTOPBEGIN><br></code> | |
| 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>TTOPBEGIN defines the markup for the <em>root</em>, or start, | |
| 44 | of a thread. TTOPBEGIN should define any starting markup | |
| 45 | for the thread and markup for the root message of the thread. | |
| 46 | </p> | |
| 47 | ||
| 48 | <!-- *************************************************************** --> | |
| 49 | <hr> | |
| 50 | <h2>Default Setting</h2> | |
| 51 | ||
| 52 | <pre> | |
| 53 | <b><TTopBegin></b> | |
| 54 | <li><strong><a href="#SUBJECT">$SUBJECT$</a></strong>, | |
| 55 | <em><a href="#FROMNAME">$FROMNAME$</a></em> | |
| 56 | <b></TTopBegin></b> | |
| 57 | </pre> | |
| 58 | ||
| 59 | <!-- *************************************************************** --> | |
| 60 | <hr> | |
| 61 | <h2>Resource Variables</h2> | |
| 62 | ||
| 63 | <table border=1> | |
| 64 | <tr bgcolor="#C0C0C0"> | |
| 65 | <th>Variable</th><th>Value</th> | |
| 66 | </tr> | |
| 67 | <tr valign=top> | |
| 68 | <td align=center><a name="A_ATTR" href="../rcvars.html#A_ATTR"><strong><code>$A_ATTR$</code></strong></a></td> | |
| 69 | <td>The <tt>NAME</tt> and <tt>HREF</tt> attributes to use in an anchor to link to the archived message. The <tt>NAME</tt> attribute links the messages to the index page.</td> | |
| 70 | </tr> | |
| 71 | <tr valign=top> | |
| 72 | <td align=center><a name="A_HREF" href="../rcvars.html#A_HREF"><strong><code>$A_HREF$</code></strong></a></td> | |
| 73 | <td>The <tt>HREF</tt> attribute to use in an anchor to link to the archived message.</td> | |
| 74 | </tr> | |
| 75 | <tr valign=top> | |
| 76 | <td align=center><a name="A_NAME" href="../rcvars.html#A_NAME"><strong><code>$A_NAME$</code></strong></a></td> | |
| 77 | <td>The <tt>NAME</tt> attribute to use in an anchor for messages to link to the index page.</td> | |
| 78 | </tr> | |
| 79 | <tr valign=top> | |
| 80 | <td align=center><a name="DATE" href="../rcvars.html#DATE"><strong><code>$DATE$</code></strong></a></td> | |
| 81 | <td>The date of the message.</td> | |
| 82 | </tr> | |
| 83 | <tr valign=top> | |
| 84 | <td align=center><a name="DDMMYYYY" href="../rcvars.html#DDMMYYYY"><strong><code>$DDMMYYYY$</code></strong></a></td> | |
| 85 | <td>Message date in dd/mm/yyyy format.</td> | |
| 86 | </tr> | |
| 87 | <tr valign=top> | |
| 88 | <td align=center><a name="ENV" href="../rcvars.html#ENV"><strong><code>$ENV$</code></strong></a></td> | |
| 89 | <td>Value of an environment variable.</td> | |
| 90 | </tr> | |
| 91 | <tr valign=top> | |
| 92 | <td align=center><a name="FROM" href="../rcvars.html#FROM"><strong><code>$FROM$</code></strong></a></td> | |
| 93 | <td>The complete text in the <tt>From:</tt> field of the message.</td> | |
| 94 | </tr> | |
| 95 | <tr valign=top> | |
| 96 | <td align=center><a name="FROMADDR" href="../rcvars.html#FROMADDR"><strong><code>$FROMADDR$</code></strong></a></td> | |
| 97 | <td>The e-mail address in the <tt>From:</tt> field of the message.</td> | |
| 98 | </tr> | |
| 99 | <tr valign=top> | |
| 100 | <td align=center><a name="FROMADDRDOMAIN" href="../rcvars.html#FROMADDRDOMAIN"><strong><code>$FROMADDRDOMAIN$</code></strong></a></td> | |
| 101 | <td>The e-mail address domain of the <tt>From:</tt> field of the message.</td> | |
| 102 | </tr> | |
| 103 | <tr valign=top> | |
| 104 | <td align=center><a name="FROMADDRNAME" href="../rcvars.html#FROMADDRNAME"><strong><code>$FROMADDRNAME$</code></strong></a></td> | |
| 105 | <td>The e-mail address "username" (or local-part) of the <tt>From:</tt> field of the message.</td> | |
| 106 | </tr> | |
| 107 | <tr valign=top> | |
| 108 | <td align=center><a name="FROMNAME" href="../rcvars.html#FROMNAME"><strong><code>$FROMNAME$</code></strong></a></td> | |
| 109 | <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> | |
| 110 | </tr> | |
| 111 | <tr valign=top> | |
| 112 | <td align=center><a name="ICON" href="../rcvars.html#ICON"><strong><code>$ICON$</code></strong></a></td> | |
| 113 | <td>The context-type sensitive icon.</td> | |
| 114 | </tr> | |
| 115 | <tr valign=top> | |
| 116 | <td align=center><a name="ICONURL" href="../rcvars.html#ICONURL"><strong><code>$ICONURL$</code></strong></a></td> | |
| 117 | <td>The URL to the context-type sensitive icon.</td> | |
| 118 | </tr> | |
| 119 | <tr valign=top> | |
| 120 | <td align=center><a name="MMDDYYYY" href="../rcvars.html#MMDDYYYY"><strong><code>$MMDDYYYY$</code></strong></a></td> | |
| 121 | <td>Message date in mm/dd/yyyy format.</td> | |
| 122 | </tr> | |
| 123 | <tr valign=top> | |
| 124 | <td align=center><a name="MSGGMTDATE" href="../rcvars.html#MSGGMTDATE"><strong><code>$MSGGMTDATE$</code></strong></a></td> | |
| 125 | <td>GMT date of current message.</td> | |
| 126 | </tr> | |
| 127 | <tr valign=top> | |
| 128 | <td align=center><a name="MSGID" href="../rcvars.html#MSGID"><strong><code>$MSGID$</code></strong></a></td> | |
| 129 | <td>The message-id of the message.</td> | |
| 130 | </tr> | |
| 131 | <tr valign=top> | |
| 132 | <td align=center><a name="MSGLOCALDATE" href="../rcvars.html#MSGLOCALDATE"><strong><code>$MSGLOCALDATE$</code></strong></a></td> | |
| 133 | <td>Local date of current message.</td> | |
| 134 | </tr> | |
| 135 | <tr valign=top> | |
| 136 | <td align=center><a name="MSGNUM" href="../rcvars.html#MSGNUM"><strong><code>$MSGNUM$</code></strong></a></td> | |
| 137 | <td>The message number assigned to the message by MHonArc (includes leading zeros).</td> | |
| 138 | </tr> | |
| 139 | <tr valign=top> | |
| 140 | <td align=center><a name="MSGPREFIX" href="../rcvars.html#MSGPREFIX"><strong><code>$MSGPREFIX$</code></strong></a></td> | |
| 141 | <td>Filename prefix for message files.</td> | |
| 142 | </tr> | |
| 143 | <tr valign=top> | |
| 144 | <td align=center><a name="MSGTORDNUM" href="../rcvars.html#MSGTORDNUM"><strong><code>$MSGTORDNUM$</code></strong></a></td> | |
| 145 | <td>The ordinal message number of the current discussion thread.</td> | |
| 146 | </tr> | |
| 147 | <tr valign=top> | |
| 148 | <td align=center><a name="NOTE" href="../rcvars.html#NOTE"><strong><code>$NOTE$</code></strong></a></td> | |
| 149 | <td>Message annotation.</td> | |
| 150 | </tr> | |
| 151 | <tr valign=top> | |
| 152 | <td align=center><a name="NUMFOLUP" href="../rcvars.html#NUMFOLUP"><strong><code>$NUMFOLUP$</code></strong></a></td> | |
| 153 | <td>Number of explicit follow-ups to the message.</td> | |
| 154 | </tr> | |
| 155 | <tr valign=top> | |
| 156 | <td align=center><a name="ORDNUM" href="../rcvars.html#ORDNUM"><strong><code>$ORDNUM$</code></strong></a></td> | |
| 157 | <td>The current listing number of the message.</td> | |
| 158 | </tr> | |
| 159 | <tr valign=top> | |
| 160 | <td align=center><a name="SUBJECT" href="../rcvars.html#SUBJECT"><strong><code>$SUBJECT$</code></strong></a></td> | |
| 161 | <td>The subject text of the message, and if no arguments, wrapped in an anchor element that hyperlinks to the message.</td> | |
| 162 | </tr> | |
| 163 | <tr valign=top> | |
| 164 | <td align=center><a name="SUBJECTNA" href="../rcvars.html#SUBJECTNA"><strong><code>$SUBJECTNA$</code></strong></a></td> | |
| 165 | <td>The subject text of the message without the anchor element.</td> | |
| 166 | </tr> | |
| 167 | <tr valign=top> | |
| 168 | <td align=center><a name="TLEVEL" href="../rcvars.html#TLEVEL"><strong><code>$TLEVEL$</code></strong></a></td> | |
| 169 | <td>Numeric level of message in thread, starting with 0.</td> | |
| 170 | </tr> | |
| 171 | <tr valign=top> | |
| 172 | <td align=center><a name="YYYYMMDD" href="../rcvars.html#YYYYMMDD"><strong><code>$YYYYMMDD$</code></strong></a></td> | |
| 173 | <td>Message date in yyyy/mm/dd format.</td> | |
| 174 | </tr> | |
| 175 | </table> | |
| 176 | ||
| 177 | <!-- *************************************************************** --> | |
| 178 | <hr> | |
| 179 | <h2>Examples</h2> | |
| 180 | ||
| 181 | <p>MHonArc has several resources for customizing | |
| 182 | thread page layout. Therefore the following shows a way to | |
| 183 | customize the layout using the various thread resource | |
| 184 | available. | |
| 185 | </p> | |
| 186 | ||
| 187 | <p>For this example, | |
| 188 | The thread index is setup where a thread will have the subject | |
| 189 | in bold at the top of the thread and the names of the authors | |
| 190 | of the messages in the thread will be hyperlinked to the | |
| 191 | actual message. Nested unordered lists are used to provide a | |
| 192 | visual cue of the depths of the thread. | |
| 193 | Unique messages are show in normal text. | |
| 194 | </p> | |
| 195 | ||
| 196 | <pre> | |
| 197 | <!-- TTOPBEGIN is the markup for the beginning of a thread, and the | |
| 198 | first message in a thread. | |
| 199 | --> | |
| 200 | <b><TTOPBEGIN></b> | |
| 201 | <p> | |
| 202 | <li><a <a href="#A_NAME">$A_NAME$</a>><strong><a href="#SUBJECTNA">$SUBJECTNA$</a></strong></a><br> | |
| 203 | <a <a href="#A_HREF">$A_HREF$</a>><a href="#FROMNAME">$FROMNAME$</a></a> | |
| 204 | <b></TTOPBEGIN></b> | |
| 205 | ||
| 206 | <!-- <a href="ttopend.html">TTOPEND</a> is the markup for closing a main thread. | |
| 207 | --> | |
| 208 | <b><<a href="ttopend.html">TTOPEND</a>></b> | |
| 209 | </li> | |
| 210 | </p> | |
| 211 | <b></TTOPEND></b> | |
| 212 | ||
| 213 | <!-- <a href="tlitxt.html">TLITXT</a> is the markup for a message *within* a thread | |
| 214 | --> | |
| 215 | <b><<a href="tlitxt.html">TLITXT</a>></b> | |
| 216 | <li><a <a href="#A_ATTR">$A_ATTR$</a>><a href="#FROMNAME">$FROMNAME$</a></a> | |
| 217 | <b></TLITXT></b> | |
| 218 | ||
| 219 | <b><<a href="tliend.html">TLIEND</a>></b> | |
| 220 | </li> | |
| 221 | <b></TLIEND></b> | |
| 222 | ||
| 223 | <!-- <a href="tsingletxt.html">TSINGLETXT</a> is the markup for a message not in a thread. I.e. | |
| 224 | it does not start a thread or is part of a thread. | |
| 225 | --> | |
| 226 | <b><<a href="tsingletxt.html">TSINGLETXT</a>></b> | |
| 227 | <li><a <a href="#A_NAME">$A_NAME$</a>><a href="#SUBJECTNA">$SUBJECTNA$</a></a>, | |
| 228 | <a <a href="#A_HREF">$A_HREF$</a>><a href="#FROMNAME">$FROMNAME$</a></a> | |
| 229 | </li> | |
| 230 | <b></TSINGLETXT></b> | |
| 231 | ||
| 232 | <!-- <a href="tsubjectbeg.html">TSUBJECTBEG</a> is any markup at the beginning of a sub-thread that | |
| 233 | is based on the subject of the message. We just put in a | |
| 234 | comment declaration so the reader will see nothing. | |
| 235 | --> | |
| 236 | <b><<a href="tsubjectbeg.html">TSUBJECTBEG</a>></b> | |
| 237 | <!-- Possible follow-ups --> | |
| 238 | <b></TSUBJECTBEG></b> | |
| 239 | </pre> | |
| 240 | ||
| 241 | <p>An item to note is how the example includes the proper resource | |
| 242 | variables, <tt>$A_NAME$</tt> and <tt>$A_ATTR$</tt>, to allow the | |
| 243 | index hyperlinks in messages to behave properly. | |
| 244 | </p> | |
| 245 | ||
| 246 | <!-- *************************************************************** --> | |
| 247 | <hr> | |
| 248 | <h2>Version</h2> | |
| 249 | ||
| 250 | <p>2.0 | |
| 251 | </p> | |
| 252 | ||
| 253 | <!-- *************************************************************** --> | |
| 254 | <hr> | |
| 255 | <h2>See Also</h2> | |
| 256 | ||
| 257 | <p> | |
| 258 | <a href="tlitxt.html">TLITXT</a>, | |
| 259 | <a href="tsingletxt.html">TSINGLETXT</a>, | |
| 260 | <a href="tsubjectbeg.html">TSUBJECTBEG</a>, | |
| 261 | <a href="ttopend.html">TTOPEND</a> | |
| 262 | </p> | |
| 263 | <p> | |
| 264 | <a href="../layout.html"><strong>Page Layout</strong></a> | |
| 265 | </p> | |
| 266 | ||
| 267 | <!-- *************************************************************** --> | |
| 268 | <hr> | |
| 269 | <!--x-rc-nav--> | |
| 270 | <table border=0><tr valign="top"> | |
| 271 | <td align="left" width="50%">[Prev: <a href="ttitle.html">TTITLE</a>]</td><td><nobr>[<a href="../resources.html#ttopbegin">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next: <a href="ttopend.html">TTOPEND</a>]</td></tr></table> | |
| 272 | <!--/x-rc-nav--> | |
| 273 | <hr> | |
| 274 | <address> | |
| 275 | $Date: 2002/07/27 05:13:11 $ <br> | |
| 276 | <img align="top" src="../monicon.png" alt=""> | |
| 277 | <a href="http://www.mhonarc.org/"><strong>MHonArc</strong></a><br> | |
| 278 | Copyright © 1997-1998, <a href="http://www.earlhood.com/">Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org">mhonarc@mhonarc.org</a><br> | |
| 279 | </address> | |
| 280 | ||
| 281 | </body> | |
| 282 | </html> |