- Notifications
You must be signed in to change notification settings - Fork 92
/
Copy pathcustomizing.html
478 lines (424 loc) · 16.6 KB
/
customizing.html
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
"http://www.w3.org/TR/REC-html40/loose.dtd">
<HTML>
<HEAD>
<TITLE>Hypermail Documentation</TITLE>
<LINKREV="made" HREF="mailto:webmaster@hypermail.org">
</HEAD>
<BODYBGCOLOR="#ffffff" TEXT="#000000">
<H1ALIGN=CENTER><IMGSRC="hypermail.png" WIDTH="60" ALIGN="middle" HEIGHT="60" ALT=""> Customizing Hypermail Pages</H1>
<HR>
<P>
<STRONG>Contents:</STRONG>
<UL>
<LI><AHREF="#1">Hypermail Pages</A>
<P>
<LI><AHREF="#2">Definitions</A>
<P>
<LI><AHREF="#3">Choosing the Default Look of Your Pages</A>
<UL>
<LI><AHREF="#3-1">Standard Page HTML</A>
<UL>
<LI><AHREF="#3-1-1">Index Page Headers</A>
<LI><AHREF="#3-1-2">Message Pages</A>
<LI><AHREF="#3-1-3">Page Footer</A>
</UL>
<LI><AHREF="#3-2">Table Menu Display</A>
</UL>
<P>
<LI><AHREF="#4">Using Template Files to Customize Your Pages</A>
<UL>
<LI><AHREF="#4-1">Substitution Cookies</A>
<LI><AHREF="#4-2">Specifying template file locations</A>
<UL>
<LI><AHREF="#4-2-1">Using Environment Variables</A>
<LI><AHREF="#4-2-2">Using Configuration File Entries</A>
<LI><AHREF="#4-2-3">Examples</A>
</UL>
<LI><AHREF="#4-3">Message Pages</A>
</UL>
<P>
<LI><AHREF="#5">Including Reference Links</A>
<LI><AHREF="#6">In-lining Images</A>
<LI><AHREF="#7">Changing The HTML File Suffix</A>
</UL>
<P><HR><P>
<H2><ANAME="1" HREF="#">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>HTML message pages,
<LI>MIME enclosure attactment files.
</UL>
<P>
The attachment files are a copy of the attachment the user included and
are not altered.
<P>
This version of hypermail allows you to
customize both index and message pages separately as described below.
<P><HR><P>
<H2><ANAME="2" HREF="#">Definitions</A></H2>
<P>
In the examples below, the following terms are used.
<P>
<STRONG><EM>label</EM></STRONG> - the label passed in via the
command line or specified in the list configuration file.
<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>
<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>
<STRONG><EM>subject-of-message</EM></STRONG> - the contents of the message's
<AHREF="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</A> Subject:
header.
<P>
<STRONG><EM>HMURL</EM></STRONG> - Used to contain a link to the Hypermail
Development Center. Defined in hypermail.h.
<P>
<STRONG><EM>PROGNAME</EM></STRONG> - contains the name of the executable.
Defined in hypermail.h.
<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><P>
<H2><ANAME="3" HREF="#">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><ANAME="3-1" HREF="#">Standard Page HTML</A></H3>
<P>
If you are not <AHREF="#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><ANAME="3-1-1" HREF="#">Index Page Headers</A></H4>
<P>
The default Index page headers used in hypermail look like:
<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>
<P>
<H4><ANAME="3-1-2" HREF="#">Message Pages</A></H4>
<P>
The default Message page headers used in hypermail look like:
<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>
<P>
<H4><ANAME="3-1-3" HREF="#">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:
<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>
<P>
<H3><ANAME="3-2" HREF="#">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:
<H1ALIGN=CENTER>TITLE HERE</H1>
<P>
<DIVALIGN=CENTER>
<TABLEBORDER=2WIDTH="100%">
<TR>
<TH><AHREF="mailto:hypermail@hypermail.org">New Message</A></TH>
<TH><AHREF="mailto:hypermail@hypermail.org?subject=Re:%20TITLE%20HERE">Reply</A></TH>
<TH><AHREF="http://www.hypermail.org/">About this list</A></TH>
<TH><AHREF="customizing.html">Date view</A></TH>
<TH><AHREF="customizing.html">Thread view</A></TH>
<TH><AHREF="customizing.html">Subject view</A></TH>
<TH><AHREF="customizing.html">Author view</A></TH>
</TR>
</TABLE>
</DIV>
<P>
<STRONG>Kent Landfield</STRONG> (<AHREF="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><AHREF="customizing.html">Kent Landfield: "Re: Getting started"</A>
<LI><STRONG>Previous message:</STRONG><AHREF="customizing.html">Crispen, Bob: "RE: Ideas"</A>
<LI><STRONG>Next in thread:</STRONG><AHREF="customizing.html">Andrew Kuchling: "Re: Getting started"</A>
</UL>
<HR>
<PALIGN=CENTER><STRONG><EM>BODY OF MESSAGE HERE</EM></STRONG></P>
<HR>
<P>
<UL>
<LI><STRONG>Next message:</STRONG><AHREF="customizing.html">Kent Landfield: "Ideas"</A>
<LI><STRONG>Next in thread:</STRONG><AHREF="customizing.html">Guido van Rossum: "Re: Getting started"</A>
</UL>
<DIVALIGN=CENTER>
<TABLEBORDER=2WIDTH="100%">
<TR>
<TH><AHREF="mailto:hypermail@hypermail.org">New Message</A></TH>
<TH><AHREF="mailto:hypermail@hypermail.org?subject=Re:%20TITLE%20HERE">Reply</A></TH>
<TH><AHREF="http://www.hypermail.org/">About this list</A></TH>
<TH><AHREF="customizing.html">Date view</A></TH>
<TH><AHREF="customizing.html">Thread view</A></TH>
<TH><AHREF="customizing.html">Subject view</A></TH>
<TH><AHREF="customizing.html">Author view</A></TH>
</TR>
</TABLE>
</DIV>
<P>
<SMALL>
<EM>
This archive was generated by <AHREF="http://www.hypermail.org/">hypermail 2.0x</A>
on <EM>Thu Jun 04 1998 - 10:05:34 CDT</EM>
</EM>
</SMALL>
<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>
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><P>
<H2><ANAME="4" HREF="#">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><ANAME="4-1" HREF="#">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>
<STRONG>Substitution cookies supported:</STRONG>
<P>
<BLOCKQUOTE>
<TABLECELLPADDING=0CELLSPACING=0BORDER=0WIDTH="75%">
<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>
<BLOCKQUOTE>
<TABLECELLPADDING=0CELLSPACING=0BORDER=0WIDTH="75%">
<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>
<P>
<H3><ANAME="4-2" HREF="#">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><ANAME="4-2-1" HREF="#">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.
<UL>
<LI><STRONG>HM_IHTMLHEADERFILE</STRONG> - the location of the INDEX header template.
<LI><STRONG>HM_IHTMLFOOTERFILE</STRONG> - the location of the INDEX footer template.
<LI><STRONG>HM_MHTMLHEADERFILE</STRONG> - the location of the MESSAGE header template.
<LI><STRONG>HM_MHTMLFOOTERFILE</STRONG> - the location of the MESSAGE footer template.
</UL>
<P>
<H4><ANAME="4-2-2" HREF="#">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><STRONG>hm_ihtmlfooterfile</STRONG> - the location of the INDEX footer template.
<LI><STRONG>hm_mhtmlheaderfile</STRONG> - the location of the MESSAGE header template.
<LI><STRONG>hm_mhtmlfooterfile</STRONG> - the location of the MESSAGE footer template.
</UL>
<P>
<H4><ANAME="4-2-3" HREF="#">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><ANAME="4-3" HREF="#">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>the name and email address of the sender,
<LI>the date the article was sent,
<LI>links to the next and previous messages in the archive,
<LI>a link to the message the article is in reply to, and
<LI>a link to the message next in the current thread.
</UL>
<P><HR><P>
<H3><ANAME="5" HREF="#">Including Reference Links</A></H3>
<P>
Reference links such as the following
<UL>
<LI><STRONG>Next message:</STRONG><AHREF="customizing.html">Kent Landfield: "Re: Getting started"</A>
<LI><STRONG>Previous message:</STRONG><AHREF="customizing.html">Crispen, Bob: "RE: Ideas"</A>
<LI><STRONG>Next in thread:</STRONG><AHREF="customizing.html">Andrew Kuchling: "Re: Getting started"</A>
</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,
<UL>
<LI><STRONG>In reply to:</STRONG><AHREF="customizing.html">Kent Landfield: "Getting started"</A>
<LI><STRONG>Reply:</STRONG><AHREF="customizing.html">Guido van Rossum: "Re: Getting started"</A>
<LI><STRONG>Reply:</STRONG><AHREF="customizing.html">Andrew Kuchling: "Re: Getting started"</A>
<LI><STRONG>Reply:</STRONG><AHREF="customizing.html">Kent Landfield: "Re: Getting started"</A>
</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.
<P><HR><P>
<H3><ANAME="6" HREF="#">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>
For example, if you listed
<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.
<P><HR><P>
<H3><ANAME="7" HREF="#">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>
<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><P>
<H2>See Also</H2>
<BLOCKQUOTE>
<STRONG>hypermail.(1)</STRONG>,
<STRONG>hmrc.(4)</STRONG>,
<STRONG><AHREF="hypermail.html">Hypermail</A></STRONG>
and
<STRONG><AHREF="hmrc.html">Hypermail List Configuration File</A></STRONG>.
and <STRONG><AHREF="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>
