Repository navigation
Expand file tree
/
Copy pathcustomizing.html
More file actions
514 lines (510 loc) · 18.9 KB
/
Copy pathcustomizing.html
File metadata and controls
514 lines (510 loc) · 18.9 KB
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
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="generator" content=
"HTML Tidy for HTML5 for Linux version 5.6.0" />
<title>Hypermail Documentation - Customizing Hypermail Pages</title>
<link rel="author" href="https://github.com/hypermail-project" />
<style>
/*<![CDATA[*/
body {
background-color: #FFFFFF;
color: #000000;
}
.center {
text-align: center;
}
table.c1
{
width: 100%;
border: 2px solid darkgray;
border-right-color: black;
border-bottom-color: black;
}
table.c1 th
{
border: 1px solid;
}
table.c2
{
width: 75%;
border: none;
padding: 0;
border-collapse: collapse;
}
/*]]>*/
</style>
</head>
<body>
<h1><img src="hypermail.png" width=
"60" height="60" alt="hypermail logo" />Customizing Hypermail Pages</h1>
<hr />
<p><strong>Contents:</strong></p>
<ul>
<li><a href="#1">Hypermail Pages</a></li>
<li><a href="#2">Definitions</a></li>
<li>
<a href="#3">Choosing the Default Look of Your Pages</a>
<ul>
<li>
<a href="#3-1">Standard Page HTML</a>
<ul>
<li><a href="#3-1-1">Index Page Headers</a></li>
<li><a href="#3-1-2">Message Pages</a></li>
<li><a href="#3-1-3">Page Footer</a></li>
</ul>
</li>
<li><a href="#3-2">Table Menu Display</a></li>
</ul>
</li>
<li>
<a href="#4">Using Template Files to Customize Your Pages</a>
<ul>
<li><a href="#4-1">Substitution Cookies</a></li>
<li>
<a href="#4-2">Specifying template file locations</a>
<ul>
<li><a href="#4-2-1">Using Environment
Variables</a></li>
<li><a href="#4-2-2">Using Configuration File
Entries</a></li>
<li><a href="#4-2-3">Examples</a></li>
</ul>
</li>
<li><a href="#4-3">Message Pages</a></li>
</ul>
</li>
<li><a href="#5">Including Reference Links</a></li>
<li><a href="#6">In-lining Images</a></li>
<li><a href="#7">Changing The HTML File Suffix</a></li>
</ul>
<hr />
<h2><a href="#" id="1">Hypermail Pages</a></h2>You can
customize hypermail generated pages to suit your local web site
needs as well as the needs of the list. Hypermail generates three
types of files:
<ul>
<li>HTML index pages,</li>
<li>HTML message pages,</li>
<li>MIME enclosure attactment files.</li>
</ul>
<p>The attachment files are a copy of the attachment the user
included and are not altered.</p>
<p>This version of hypermail allows you to customize both index
and message pages separately as described below.</p>
<hr />
<h2><a href="#" id="2">Definitions</a></h2>
<p>In the examples below, the following terms are used.</p>
<p><strong><em>label</em></strong> - the label passed in via the
command line or specified in the list configuration file.</p>
<p><strong><em>indextype</em></strong> - depends on the type of
index being presented. It could be <strong><em>By Author, By
Date, By Subject, or By Thread</em></strong>.</p>
<p><strong><em>mailto-address</em></strong> - the
<strong>MAILTO</strong> value compiled into hypermail, specified
in the environment with the <strong>HM_MAILTO</strong> variable,
or specified in the <strong>hm_mailto</strong> variable in the
list specific configuration file.</p>
<p><strong><em>subject-of-message</em></strong> - the contents of
the message's <a href="http://www.faqs.org/rfcs/rfc2822.html">RFC
2822</a> Subject: header.</p>
<p><strong><em>HMURL</em></strong> - Used to contain a link to
the Hypermail Development Center. Defined in hypermail.h.</p>
<p><strong><em>PROGNAME</em></strong> - contains the name of the
executable. Defined in hypermail.h.</p>
<p><strong><em>VERSION</em></strong> - contains the version of
the software that generated the page this appears on. Defined in
src/hypermail.h.</p>
<hr />
<h2><a href="#" id="3">Choosing the Default Look of Your
Pages</a></h2>
<p>There is no need to customize hypermail pages unless you have
a specific need. There are two different default page layouts
provided with hypermail, the Table Menu Display and the Standard
Display.</p>
<h3><a href="#" id="3-1">Standard Page HTML</a></h3>
<p>If you are not <a href="#4">using the HTML template files</a>
described below then Hypermail generates headers and footers that
look similar to the following. Note that you can substitute a
<BODY> statement by either defining <strong>BODY</strong>
in options.h or by using the <strong>hm_body</strong> variable in
a list specific configuration file.</p>
<h4><a href="#" id="3-1-1">Index Page
Headers</a></h4>
<p>The default Index page headers used in hypermail look
like:</p>
<blockquote>
<strong><small><!DOCTYPE HTML PUBLIC "-//IETF//DTD
HTML//EN"><br />
<HTML><br />
<HEAD><br />
<TITLE><em>label</em>: <em>indextype</em></TITLE><br />
<LINK REV="made"
HREF="mailto:<em>mailto-address</em>"><br />
<HEAD><br />
<BODY BGCOLOR="#ffffff" TEXT="#000000"><br />
<H1
ALIGN=CENTER><em>label</em><BR>By <em>indextype</em></H1><br />
<HR WIDTH=400></small></strong>
</blockquote>
<h4><a href="#" id="3-1-2">Message Pages</a></h4>
<p>The default Message page headers used in hypermail look
like:</p>
<blockquote>
<strong><small><!DOCTYPE HTML PUBLIC "-//IETF//DTD
HTML//EN"><br />
<HTML><br />
<HEAD><br />
<TITLE><em>label: subject-of-message</em></TITLE><br />
<LINK REV="made"
HREF="mailto:<em>mailto-address</em>"><br />
<HEAD><br />
<BODY BGCOLOR="#ffffff" TEXT="#000000"> <H1
ALIGN=CENTER><em>subject</em></H1><br />
<HR></small></strong>
</blockquote>
<h4><a href="#" id="3-1-3">Page Footer</a></h4>
<p>The default page footer shown below is used in hypermail on
both the index and the message pages look like:</p>
<blockquote>
<strong><small><HR><br />
<P><br />
<SMALL><br />
<EM><br />
This archive was generated by <A
HREF="HMURL">PROGNAME VERSION</A> on DATE and
TIME<br />
</EM><br />
</SMALL><br />
</BODY><br />
</HTML></small></strong>
</blockquote>
<h3><a href="#" id="3-2">Table Menu Display</a></h3>
<p>The table menu display generates pages that have a menu bar at
the top and the bottom of the page that looks something like the
following. If you have enabled the "About" and "Other Archives"
links are displayed if you have enabled them in options.h, the
environment variables or in the list configuration file. A
example page:</p>
<h1 class="center">TITLE HERE</h1>
<div class="center">
<table class="c1">
<tr>
<th><a href="mailto:hypermail@hypermail.org">New
Message</a></th>
<th><a href=
"mailto:hypermail@hypermail.org?subject=Re:%20TITLE%20HERE">
Reply</a></th>
<th><a href="http://www.hypermail.org/">About this
list</a></th>
<th><a href="customizing.html">Date view</a></th>
<th><a href="customizing.html">Thread view</a></th>
<th><a href="customizing.html">Subject view</a></th>
<th><a href="customizing.html">Author view</a></th>
</tr>
</table>
</div>
<p><strong>Kent Landfield</strong> (<a href=
"mailto:kent@landfield.com?subject=Re:%20TITLE%20HERE"><em>kent@landfield.com</em></a>)<br />
<em>Wed, 17 Jun 1998 22:28:29 -0500 (CDT)</em></p>
<ul>
<li><strong>Next message:</strong> <a href=
"customizing.html">Kent Landfield: "Re: Getting
started"</a></li>
<li><strong>Previous message:</strong> <a href=
"customizing.html">Crispen, Bob: "RE: Ideas"</a></li>
<li><strong>Next in thread:</strong> <a href=
"customizing.html">Andrew Kuchling: "Re: Getting
started"</a></li>
</ul>
<hr />
<p class="center"><strong><em>BODY OF MESSAGE
HERE</em></strong></p>
<hr />
<ul>
<li><strong>Next message:</strong> <a href=
"customizing.html">Kent Landfield: "Ideas"</a></li>
<li><strong>Next in thread:</strong> <a href=
"customizing.html">Guido van Rossum: "Re: Getting
started"</a></li>
</ul>
<div class="center">
<table class="c1">
<tr>
<th><a href="mailto:hypermail@hypermail.org">New
Message</a></th>
<th><a href=
"mailto:hypermail@hypermail.org?subject=Re:%20TITLE%20HERE">
Reply</a></th>
<th><a href="http://www.hypermail.org/">About this
list</a></th>
<th><a href="customizing.html">Date view</a></th>
<th><a href="customizing.html">Thread view</a></th>
<th><a href="customizing.html">Subject view</a></th>
<th><a href="customizing.html">Author view</a></th>
</tr>
</table>
</div>
<p><small><em>This archive was generated by <a href=
"http://www.hypermail.org/">hypermail 2.0x</a> on <em>Thu Jun 04
1998 - 10:05:34 CDT</em></em></small></p>
<p>If you do not want to use the table display then make sure
that <strong>USETABLE</strong> is not defined in options.h and
the <strong>hm_usetable</strong> is not enabled in the list
configuration file. When you do so you will get the standard look
and feel of the hypermail you have grown acustomed to.</p>
<p>Also note that <strong>New Message</strong> allows you to
provide a means for someone to post a message to the list. This
feature is currently only availabe on the Table Menu Display. It
can be enabled or disabled by defining <strong>HMAIL</strong> in
options.h or by setting the <strong>hm_hmail</strong> variable in
the list specific configuration file.</p>
<hr />
<h2><a href="#" id="4">Using Template Files to Customize
Your Pages</a></h2>
<p>You can customize your page headers and footers by specifying
HTML template files. Hypermail reads template files and uses
those in generating the header and footer sections of the index
and message pages. Template files contain the actual HTML that
you want used when generating the pages. Template files may also
contain "Substitution Cookies".</p>
<h3><a href="#" id="4-1">Substitution Cookies</a></h3>
<p>You can insert "substitution cookies" in the header and footer
template files so the appropriate information is filled in at
runtime.</p>
<p><strong>Substitution cookies supported:</strong></p>
<blockquote>
<table class="c2">
<tr>
<td><strong>%%</strong></td>
<td>- '%' character</td>
</tr>
<tr>
<td><strong>%~</strong></td>
<td>- Storage directory</td>
</tr>
<tr>
<td><strong>%a</strong></td>
<td>- Other Archives URL</td>
</tr>
<tr>
<td><strong>%b</strong></td>
<td>- About Archive URL</td>
</tr>
<tr>
<td><strong>%e</strong></td>
<td>- Email address of message Author - Not valid on index
pages</td>
</tr>
<tr>
<td><strong>%g</strong></td>
<td>- Date and time archive generated</td>
</tr>
<tr>
<td><strong>%h</strong></td>
<td>- HMURL</td>
</tr>
<tr>
<td><strong>%i</strong></td>
<td>- Message-id - Not valid on index pages</td>
</tr>
<tr>
<td><strong>%l</strong></td>
<td>- Archive label</td>
</tr>
<tr>
<td><strong>%m</strong></td>
<td>- Mailto address</td>
</tr>
<tr>
<td><strong>%p</strong></td>
<td>- PROGNAME</td>
</tr>
<tr>
<td><strong>%s</strong></td>
<td>- Subject of message or Index Title</td>
</tr>
<tr>
<td><strong>%v</strong></td>
<td>- VERSION</td>
</tr>
<tr>
<td><strong>%u</strong></td>
<td>- Expanded version link (HMURL,PROGNAME,VERSION)</td>
</tr>
<tr>
<td><strong>\n</strong></td>
<td>- newline character</td>
</tr>
<tr>
<td><strong>\t</strong></td>
<td>- tab character</td>
</tr>
</table>
</blockquote>
<p><strong>Additional cookies generate the complete HTML
lines:</strong></p>
<blockquote>
<table class="c2">
<tr>
<td><strong>%A</strong></td>
<td>- Author META HTML - Not valid on index pages</td>
</tr>
<tr>
<td><strong>%B</strong></td>
<td>- BODY HTML statement</td>
</tr>
<tr>
<td><strong>%S</strong></td>
<td>- Subject META HTML</td>
</tr>
</table>
</blockquote>
<h3><a href="#" id="4-2">Specifying template file
locations</a></h3>
<p>You can specify the location of the template files either via
environment variables or via entries in the list specific
configuration file.</p>
<h4><a href="#" id="4-2-1">Using Environment
Variables</a></h4>
<p>If you wish to use environment variables, make sure they are
exported and correctly available for hypermail to use. How to do
this is dependent on the type of shell in use. See the
appropriate man pages if you need more information.</p>
<ul>
<li><strong>HM_IHTMLHEADERFILE</strong> - the location of the
INDEX header template.</li>
<li><strong>HM_IHTMLFOOTERFILE</strong> - the location of the
INDEX footer template.</li>
<li><strong>HM_MHTMLHEADERFILE</strong> - the location of the
MESSAGE header template.</li>
<li><strong>HM_MHTMLFOOTERFILE</strong> - the location of the
MESSAGE footer template.</li>
</ul>
<h4><a href="#" id="4-2-2">Using Configuration File
Entries</a></h4>
<p>An easy way is to tell hypermail where the template files are
is via a list specific configuration file. The following entries
can be used.</p>
<ul>
<li><strong>hm_ihtmlheaderfile</strong> - the location of the
INDEX header template.</li>
<li><strong>hm_ihtmlfooterfile</strong> - the location of the
INDEX footer template.</li>
<li><strong>hm_mhtmlheaderfile</strong> - the location of the
MESSAGE header template.</li>
<li><strong>hm_mhtmlfooterfile</strong> - the location of the
MESSAGE footer template.</li>
</ul>
<h4><a href="#" id="4-2-3">Examples</a></h4>
<p>It is acceptable to have a single configuration file listed in
more than one entry. Suppose you want to have a common footer for
all pages and separate headers. The following example shows
that.</p>
<blockquote>
hm_ihtmlheaderfile = /lists/wu-ftpd/wu-ftpd-index.hyp<br />
hm_mhtmlheaderfile = /lists/wu-ftpd/wu-ftpd-msg.hyp<br />
hm_ihtmlfooterfile = /lists/wu-ftpd/wu-ftpd-msgfooter.hyp<br />
hm_mhtmlfooterfile = /lists/wu-ftpd/wu-ftpd-msgfooter.hyp
</blockquote>
<p>If an entry is left blank and a location is not specified via
an environment variable then the hypermail default headers are
used.</p>
<blockquote>
hm_ihtmlheaderfile = /lists/wu-ftpd/wu-ftpd-index.hyp<br />
hm_ihtmlfooterfile =<br />
hm_mhtmlheaderfile = /lists/wu-ftpd/wu-ftpd-msg.hyp<br />
hm_mhtmlfooterfile = /lists/wu-ftpd/wu-ftpd-msgfooter.hyp<br />
</blockquote>The above example informs hypermail to use the
template files listed for the Index header and the Message header
and footer. The hypermail default page footer would be used on
the index pages.
<p><strong>NOTE:</strong> While it is not necessary to provide
absolute paths, it is a good idea to.</p>
<h3><a href="#" id="4-3">Message Pages</a></h3>
<p>Each HTML file that is generated for a message contains (where
applicable):</p>
<ul>
<li>the subject of the article,</li>
<li>the name and email address of the sender,</li>
<li>the date the article was sent,</li>
<li>links to the next and previous messages in the
archive,</li>
<li>a link to the message the article is in reply to, and</li>
<li>a link to the message next in the current thread.</li>
</ul>
<hr />
<h3><a href="#" id="5">Including Reference
Links</a></h3>
<p>Reference links such as the following</p>
<ul>
<li><strong>Next message:</strong> <a href=
"customizing.html">Kent Landfield: "Re: Getting
started"</a></li>
<li><strong>Previous message:</strong> <a href=
"customizing.html">Crispen, Bob: "RE: Ideas"</a></li>
<li><strong>Next in thread:</strong> <a href=
"customizing.html">Andrew Kuchling: "Re: Getting
started"</a></li>
</ul>are normally included on each of the message pages. If this
is not what you want you can disable them by using the
<strong>SHOW_MESSAGE_LINKS</strong> define in options.h or the
<strong>hm_show_msg_links</strong> in the list's configuration
file.
<p>Additionally, if you want to list <strong>all</strong> replies
to a message such as the following,</p>
<ul>
<li><strong>In reply to:</strong> <a href=
"customizing.html">Kent Landfield: "Getting started"</a></li>
<li><strong>Reply:</strong> <a href="customizing.html">Guido
van Rossum: "Re: Getting started"</a></li>
<li><strong>Reply:</strong> <a href="customizing.html">Andrew
Kuchling: "Re: Getting started"</a></li>
<li><strong>Reply:</strong> <a href="customizing.html">Kent
Landfield: "Re: Getting started"</a></li>
</ul>you can do so by setting the <strong>SHOWREPLIES</strong>
define in options.h or the <strong>hm_showreplies</strong> in the
list's configuration file.
<hr />
<h3><a href="#" id="6">In-lining Images</a></h3>
<p>It is possible to have images that are sent in email
automatically displayed when the message is presented. To do this
you need to set the <strong>hm_inline_types</strong> in the list
configuration file.</p>
<p>For example, if you listed</p>
<blockquote>
hm_inline_types = image/gif image/jpeg
</blockquote>then both GIF files and JPEG files would be
displayed as part of the message. Types that are not "in-lined"
are linked as a simple attachment requiring the user to click on
it to have it displayed.
<hr />
<h3><a href="#" id="7">Changing The HTML File
Suffix</a></h3>
<p>You may wish to have the pages generated use a different HTML
file suffix other than the default ".html". To do this you need
to either set the default define <strong>HTMLSUFFIX</strong> in
options.h, set the environment variable
<strong>HM_HTMLSUFFIX</strong> or set it in the list's
configuration file by using the <strong>hm_htmlsuffix</strong>
variable.</p>
<p><strong>Note:</strong> Do not include a "." in the suffix; If
you do you will end up with filenames that look like.
"..html"</p>
<hr />
<h2>See Also</h2>
<blockquote>
<strong>hypermail.(1)</strong>,
<strong>hmrc.(4)</strong>, <strong><a href=
"hypermail.html">Hypermail</a></strong> and
<strong><a href="hmrc.html">Hypermail List Configuration
File</a></strong>. and <strong><a href=
"archive_search.html">Adding a Search Engines to your Hypermail
Archive</a></strong>
</blockquote>
<hr />
<small><em><strong>Last updated April 10,
2003</strong></em></small>
</body>
</html>