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