Update of /cvsroot/mhonarc/mhonarc/MHonArc/doc/resources
In directory subversions:/tmp/cvs-serv3671/resources
Modified Files:
include.html mimefilters.html msgpgs.html rcfile.html
Log Message:
Some doc updates.
Index: include.html
===================================================================
RCS file: /cvsroot/mhonarc/mhonarc/MHonArc/doc/resources/include.html,v
retrieving revision 1.11
retrieving revision 1.12
diff -C2 -r1.11 -r1.12
*** include.html 10 Dec 2002 04:08:02 -0000 1.11
--- include.html 7 Aug 2003 05:59:39 -0000 1.12
***************
*** 88,94 ****
</p>
! <pre>
<b><Include></b>
! /usr/local/lib/MHonArc/common.rc
<b></Include></b>
</pre>
--- 88,94 ----
</p>
! <pre class="code">
<b><Include></b>
! /usr/local/lib/MHonArc/common.mrc
<b></Include></b>
</pre>
Index: mimefilters.html
===================================================================
RCS file: /cvsroot/mhonarc/mhonarc/MHonArc/doc/resources/mimefilters.html,v
retrieving revision 1.25
retrieving revision 1.26
diff -C2 -r1.25 -r1.26
*** mimefilters.html 19 Jan 2003 01:38:11 -0000 1.25
--- mimefilters.html 7 Aug 2003 05:59:39 -0000 1.26
***************
*** 153,157 ****
<tr valign=top>
! <td><strong><code>$fields_hash_ref</code></strong></td>
<td><p>A reference to hash of message/part header
fields. Keys are field names in lowercase
--- 153,158 ----
<tr valign=top>
! <td><strong><code><a name="fields_hash_ref"
! >$fields_hash_ref</a></code></strong></td>
<td><p>A reference to hash of message/part header
fields. Keys are field names in lowercase
***************
*** 169,189 ****
item.
</p>
! <table class="note" width="100%">
! <tr valign="baseline">
! <td><strong>NOTE:</strong></td>
! <td width="100%"><p>For <tt>text</tt> entities, the key
! <tt>x-mha-charset</tt> will be defined in <code>$fields_hash_ref</code>.
! It represents the character set encoding of the text entity.
! </p>
! <p>Unlike regular <code>$fields_hash_ref</code> keys, the value is
! <strong>not</strong> array. Therefore, to retrieve the character
! set, use something like the following:
</p>
- <pre class="code">
- my $charset = $fields_hash_ref->{'x-mha-charset'}
- </pre>
- </td>
- </tr>
- </table>
</td>
</tr>
--- 170,176 ----
item.
</p>
! <p>See <a href="#xmhafields"><cite>Special Variables and Header
! Fields</a> for more information about this parameter.
</p>
</td>
</tr>
***************
*** 256,259 ****
--- 243,332 ----
</table>
+ <H4><a name="xmhafields">Special Variables and Header Fields</a></H4>
+
+ <p>The following global variables are made available to filters:
+ </p>
+
+ <table cellspacing=1 border=0 cellpadding=4>
+
+ <tr valign=top>
+ <td><b><tt><nobr>$mhonarc::MHAindex</nobr></tt></b></td>
+ <td><p>Index key of message. Various MHonArc data structures and
+ utility routines require the index key of the message.
+ </p>
+ </td>
+ </tr>
+ <tr valign=top>
+ <td><b><tt><nobr>$mhonarc::MHAmsgid</nobr></tt></b></td>
+ <td><p>Message ID of message.
+ </p>
+ </td>
+ </tr>
+ <tr valign=top>
+ <td><b><tt><nobr>$mhonarc::MHAmsgnum</nobr></tt></b></td>
+ <td><p>Message number. The format of the number will at least
+ be five digits wide, with leading zero padding. For example,
+ if the number for a message is <tt>15</tt>, <tt>$mhonarc::$MHAmsgnum</tt>
+ will be equal to <tt>00015</tt>.
+ </p>
+ </td>
+ </tr>
+ <tr valign=top>
+ <td><b><tt><nobr>$mhonarc::OUTDIR</nobr></tt></b></td>
+ <td><p>Pathname to archive directory. This variable is useful for
+ filters that create derived files.
+ </p>
+ </td>
+ </tr>
+ </table>
+
+ <p>The <code><a href="#fields_hash_ref">$fields_hash_ref</a></code>
+ parameter will have special MHonArc-specific keys defined. Unlike
+ regular header field values, the values are <strong>not</strong> arrays
+ (unless noted). The following special keys are defined:
+ </p>
+
+ <dl>
+
+ <dt><b><tt>x-mha-charset</tt></b></dt>
+ <dd><pre class="code">my $charset = $fields_hash_ref->{'x-mha-charset'}</pre>
+ <p>Only defined for <tt>text</tt> entities, the value
+ represents the character set encoding of the text entity.
+ </p>
+ <p>If your filter will take character encoding into account, you
+ should use this value vs what is specified in regular entity header
+ fields because <a href="textencode.html">TEXTENCODE</a> may be affect,
+ so the effective character encoding of the data may be different from
+ the original encoding specified in the message.
+ </p>
+ </dd>
+
+ <dt><b><tt>x-mha-content-type</tt></b></dt>
+ <dd><pre class="code">my $content_type = $fields_hash_ref->{'x-mha-content-type'}</pre>
+ <p>The media type of the entity extracted from content-type entity header.
+ </p>
+ </dd>
+
+ <dt><b><tt>x-mha-part-number</tt></b></dt>
+ <dd><pre class="code">
+ my $part_no = $fields_hash_ref->{'x-mha-part-number'}
+ my $full_part_no = readmail::gen_full_part_number($fields_hash_ref);</pre>
+ <p>The child number of the entity within a multipart entity. Numbering
+ starts with 1, and if data is not part of a multipart entity, this
+ key may not be defined.
+ </p>
+ </dd>
+
+ <dt><b><tt>x-mha-parent-header</tt></b></dt>
+ <dd><pre class="code">
+ my $parent_header = $fields_hash_ref->{'x-mha-parent-header'}
+ </pre>
+ <p>The header field hash for the parent entity, if applicable.
+ </p>
+ </dd>
+
+ </dl>
+
+
<H4>Filter Writing Tips</H4>
***************
*** 2037,2041 ****
<img align="top" src="../monicon.png" alt="">
<a href="http://www.mhonarc.org";><strong>MHonArc</strong></a><br>
! Copyright © 1997-2002 <a href="http://www.mhonarc.org/~ehood/";>Earl Hood</a>, <a href="mailto:mhonarc(_at_)mhonarc(_dot_)org">mhonarc(_at_)mhonarc(_dot_)org</a><br>
</address>
--- 2110,2114 ----
<img align="top" src="../monicon.png" alt="">
<a href="http://www.mhonarc.org";><strong>MHonArc</strong></a><br>
! Copyright © 1997-2003 <a href="http://www.mhonarc.org/~ehood/";>Earl Hood</a>, <a href="mailto:mhonarc(_at_)mhonarc(_dot_)org">mhonarc(_at_)mhonarc(_dot_)org</a><br>
</address>
Index: msgpgs.html
===================================================================
RCS file: /cvsroot/mhonarc/mhonarc/MHonArc/doc/resources/msgpgs.html,v
retrieving revision 1.12
retrieving revision 1.13
diff -C2 -r1.12 -r1.13
*** msgpgs.html 10 Dec 2002 04:08:03 -0000 1.12
--- msgpgs.html 7 Aug 2003 05:59:39 -0000 1.13
***************
*** 44,48 ****
<dt><strong>Command-line Option</strong></dt>
<dd><p>
! <code>-msgpgs</code>
<code>-nomsgpgs</code>
</p>
--- 44,48 ----
<dt><strong>Command-line Option</strong></dt>
<dd><p>
! <code>-msgpgs</code><br>
<code>-nomsgpgs</code>
</p>
***************
*** 55,58 ****
--- 55,69 ----
<h2><a name="description">Description</a></h2>
+ <table class="caution" width="100%">
+ <tr valign="baseline">
+ <td><strong style="color: red;">CAUTION:</strong></td>
+ <td width="100%"><p>MSGPGS should not be changed after the
+ initial creation of an archive. If changed, unexpected behavior
+ and possible errors may occur.
+ </p>
+ </td>
+ </tr>
+ </table>
+
<p>MSGPGS resource determines if MHonArc will generate HTML pages
for messages processed. If set, pages will be created for each
***************
*** 61,68 ****
</p>
! <p>If MSGPGS is not set, no message pages will be created. Having
! no message pages created may be desired if you only want to use
! MHonArc for its index page generation. Note, relevant resources that link
! to message pages would have to be redefined to use URLs that properly
retrieve messages from how they are stored on the system.
</p>
--- 72,79 ----
</p>
! <p>If MSGPGS is not set, no message pages will be created. Having no
! message pages created may be desired if you only want to use MHonArc
! for its index page generation. In this case, relevant resources that
! link to message pages must be redefined to properly
retrieve messages from how they are stored on the system.
</p>
***************
*** 71,75 ****
input data. Hence, processing time is much faster since no message
conversion is performed. The database file is still created to support
! updates to the index pages generated.
</p>
--- 82,86 ----
input data. Hence, processing time is much faster since no message
conversion is performed. The database file is still created to support
! updates to index pages.
</p>
***************
*** 107,110 ****
--- 118,123 ----
<p>
+ <a href="main.html">MAIN</a>,
+ <a href="thread.html">THREAD</a>
</p>
***************
*** 121,125 ****
<a href="http://www.mhonarc.org/";
><strong>MHonArc</strong></a><br>
! Copyright © 1998, <a href="http://www.earlhood.com/";
>Earl Hood</a>, <a href="mailto:mhonarc(_at_)mhonarc(_dot_)org"
>mhonarc(_at_)mhonarc(_dot_)org</a><br>
--- 134,138 ----
<a href="http://www.mhonarc.org/";
><strong>MHonArc</strong></a><br>
! Copyright © 1998,2003, <a href="http://www.earlhood.com/";
>Earl Hood</a>, <a href="mailto:mhonarc(_at_)mhonarc(_dot_)org"
>mhonarc(_at_)mhonarc(_dot_)org</a><br>
Index: rcfile.html
===================================================================
RCS file: /cvsroot/mhonarc/mhonarc/MHonArc/doc/resources/rcfile.html,v
retrieving revision 1.14
retrieving revision 1.15
diff -C2 -r1.14 -r1.15
*** rcfile.html 2 Aug 2003 06:15:37 -0000 1.14
--- rcfile.html 7 Aug 2003 05:59:39 -0000 1.15
***************
*** 64,68 ****
<p>The <tt>-rcfile</tt> command-line option can be specified multiple
! times. Each resource file specified will be loaded in the order
specified on the command-line.
</p>
--- 64,74 ----
<p>The <tt>-rcfile</tt> command-line option can be specified multiple
! times. For example,
! </p>
! <table border="1" width="100%"><tr><td><pre class="shell">
! prompt> <b>mhonarc -rcfile <var>file1.mrc</var> -rcfile <var>file2.mrc</var></b> ...
! </pre></td></tr></table>
!
! <p>Each resource file specified will be loaded in the order
specified on the command-line.
</p>
***************
*** 95,117 ****
<LI><P>The opening tag of an element must occur by itself on a
! single line. Whitespace is allowed before the the open tag. </P>
! <LI><P>No comments are allowed inside elements because the text will
! be treated as element content (unless the comment text is supposed
! to be part of the resource value). </P>
!
! <LI><P>Each element must be closed with a
! <CODE></</CODE><VAR>element_name</VAR><CODE>></CODE> tag on
! its own line unless resource associated with the element is
! a boolean resource.
! Whitespace is allowed
! before the close tag. </P>
<LI><P>Some elements can take an optional attribute called
"<CODE>Override</CODE>", if applicable. This tells MHonArc
that the contents of the element will completely override the default
! behavior of MHonArc, and previous instances of the element.
! <STRONG>Example</STRONG>: "<CODE><EXCS Override></CODE>". If
! "<CODE>Override</CODE>" is not specified, then the contents of the
element augment the current setting. </P>
--- 101,160 ----
<LI><P>The opening tag of an element must occur by itself on a
! single line.</P>
! <p><b>Correct</b>:
! </p>
! <pre class="code">
! <b><u><LiTemplate></u></b>
! <li><strong>$SUBJECT$</strong>
! <ul><li><em>From</em>: $FROM$</li></ul>
! </li>
! </LiTemplate>
! </pre>
! <p><b>Wrong</b>:
! </p>
! <pre class="code">
! <b style="color: red;"><u><LiTemplate></u></b><li><strong>$SUBJECT$</strong>
! <ul><li><em>From</em>: $FROM$</li></ul>
! </li>
! </LiTemplate>
! </pre>
! <p> </p>
! </li>
! <LI><P>Comments inside elements are treated as part of the
! element content.
! </P>
!
! <LI><P>Each element must have a close tag,
! <CODE></</CODE><VAR>element_name</VAR><CODE>></CODE>, on
! its own line.</p>
! <p><b>Correct</b>:
! </p>
! <pre class="code">
! <LiTemplate>
! <li><strong>$SUBJECT$</strong>
! <ul><li><em>From</em>: $FROM$</li></ul>
! </li>
! <b><u></LiTemplate></u></b>
! </pre>
! <p><b>Wrong</b>:
! </p>
! <pre class="code">
! <LiTemplate>
! <li><strong>$SUBJECT$</strong>
! <ul><li><em>From</em>: $FROM$</li></ul>
! </li><b style="color: red;"><u></LiTemplate></u></b>
! </pre>
!
! <p>Close tags are not needed for boolean resources.
! </P>
! </li>
<LI><P>Some elements can take an optional attribute called
"<CODE>Override</CODE>", if applicable. This tells MHonArc
that the contents of the element will completely override the default
! behavior of MHonArc, and previous instances of the element, for
! example: "<tt class="icode"><EXCS Override></tt>". If
! "<tt class="icode">Override</tt>" is not specified, then the contents of the
element augment the current setting. </P>
***************
*** 129,134 ****
<LI><P>Elements can<b>NOT</b> be nested. Many resources define
the values of <a href="../rcvars.html">resource variables</a>, which
! may be used within resource elements.
</P>
</UL>
--- 172,206 ----
<LI><P>Elements can<b>NOT</b> be nested. Many resources define
the values of <a href="../rcvars.html">resource variables</a>, which
! may be used within resource elements:
</P>
+ <p><b>Correct</b>:
+ </p>
+ <pre class="code">
+ <b><u><TTitle>
+ Example List Threads
+ </TTitle></u></b>
+
+ <TIdxPgBegin>
+ <html>
+ <head>
+ <title><b><u>$TIDXTITLE$</u></b></title>
+ ...
+ </TIdxPgBegin>
+ </pre>
+ <p><b>Wrong</b>:
+ </p>
+ <pre class="code">
+ <TIdxPgBegin>
+ <html>
+ <head>
+ <title>
+ <b style="color: red;"><u><TTitle>
+ Example List Threads
+ </TTitle></u></b>
+ </title>
+ ...
+ </TIdxPgBegin>
+ </pre>
+ </li>
</UL>
***************
*** 156,160 ****
</p>
<table border="1" width="100%"><tr><td><pre class="shell">
! prompt> <b>mhonarc -rcfile settings.mrc <a class="shell" href="lang.html">-lang</a> en_US</b> ...
</pre></td></tr></table>
<p>MHonArc will check for and read the following resource files, in order:
--- 228,232 ----
</p>
<table border="1" width="100%"><tr><td><pre class="shell">
! prompt> <b>mhonarc <a class="shell" href="lang.html">-lang</a> en_US -rcfile settings.mrc</b> ...
</pre></td></tr></table>
<p>MHonArc will check for and read the following resource files, in order:
***************
*** 182,186 ****
resource files loaded via multiple
<tt>-rcfile</tt> options and resource
! files loaded via the <a href="otherindexes.html">OTHERINDEXES</a>
resource.
</p>
--- 254,260 ----
resource files loaded via multiple
<tt>-rcfile</tt> options and resource
! files loaded via the
! <a href="include.html">INCLUDE</a> and
! <a href="otherindexes.html">OTHERINDEXES</a>
resource.
</p>
***************
*** 195,199 ****
</p>
<table border="1" width="100%"><tr><td><pre class="shell">
! prompt> <b>mhonarc -rcfile settings.mrc <a class="shell" href="lang.html">-lang</a> fr_CA</b> ...
</pre></td></tr></table>
<p>Causing the following resource files to be examined:
--- 269,273 ----
</p>
<table border="1" width="100%"><tr><td><pre class="shell">
! prompt> <b>mhonarc <a class="shell" href="lang.html">-lang</a> fr_CA -rcfile settings.mrc</b> ...
</pre></td></tr></table>
<p>Causing the following resource files to be examined:
***************
*** 244,248 ****
in the locale specific resource file, all that needs to be done is to
define <tt>$BUTTON-DATE-NEXT-LABEL$</tt>. Continuing with the
! <tt>settings.mrc</tt> filename, the following would be defined in
<tt>settings.mrc.en</tt> to set the English version of the label:
</p>
--- 318,322 ----
in the locale specific resource file, all that needs to be done is to
define <tt>$BUTTON-DATE-NEXT-LABEL$</tt>. Continuing with the
! <tt>settings.mrc</tt> example, the following would be defined in
<tt>settings.mrc.en</tt> to set the English version of the label:
</p>
***************
*** 294,302 ****
<b><<a href="listbegin.html">LISTBEGIN</a>></b>
<address>
! Last updated: $LOCALDATE$<br>
! $NUMOFMSG$ messages in chronological order<br>
</address>
<ul>
! <li><a href="$TIDXFNAME$">Thread Index</a></li>
</ul>
<p>
--- 368,376 ----
<b><<a href="listbegin.html">LISTBEGIN</a>></b>
<address>
! Last updated: <a href="../rcvars.html#LOCALDATE">$LOCALDATE$</a><br>
! <a href="../rcvars.html#NUMOFMSG">$NUMOFMSG$</a> messages in chronological order<br>
</address>
<ul>
! <li><a href="<a href="../rcvars.html#TIDXFNAME">$TIDXFNAME$</a>">Thread Index</a></li>
</ul>
<p>
***************
*** 318,323 ****
<b><<a href="litemplate.html">LITEMPLATE</a>></b>
<li>
! <strong>$SUBJECT:40$</strong>
! ($NUMFOLUP$) <em>$FROMNAME$</em><br>
<b></LITEMPLATE></b>
--- 392,397 ----
<b><<a href="litemplate.html">LITEMPLATE</a>></b>
<li>
! <strong><a href="../rcvars.html#SUBJECT">$SUBJECT:40$</a></strong>
! (<a href="../rcvars.html#NUMFOLUP">$NUMFOLUP$</a>) <em><a href="../rcvars.html#FROMNAME">$FROMNAME$</a></em><br>
<b></LITEMPLATE></b>
***************
*** 327,331 ****
<hr>
<strong>
! <a href="http://foo.org/">Home</a>
</strong>
<p>
--- 401,405 ----
<hr>
<strong>
! <a href="http://example.com/">Home</a>
</strong>
<p>
***************
*** 336,344 ****
<address>
Thread index<br>
! Last updated: $LOCALDATE$<br>
! $NUMOFMSG$ messages<br>
</address>
<ul>
! <li><a href="$IDXFNAME$">Main Index</a></li>
</ul>
<hr>
--- 410,418 ----
<address>
Thread index<br>
! Last updated: <a href="../rcvars.html#LOCALDATE">$LOCALDATE$</a><br>
! <a href="../rcvars.html#NUMOFMSG">$NUMOFMSG$</a> messages<br>
</address>
<ul>
! <li><a href="<a href="../rcvars.html#IDXFNAME">$IDXFNAME$</a>">Main Index</a></li>
</ul>
<hr>
***************
*** 390,396 ****
<b><<a href="msgfoot.html">MSGFOOT</a>></b>
<strong>
! <a href="http://foo.org/">Home</a> |
! <a href="$IDXFNAME$">Main Index</a> |
! <a href="$TIDXFNAME$">Thread Index</a>
</strong>
<b></MSGFOOT></b>
--- 464,470 ----
<b><<a href="msgfoot.html">MSGFOOT</a>></b>
<strong>
! <a href="http://example.com/">Home</a> |
! <a href="<a href="../rcvars.html#IDXFNAME">$IDXFNAME$</a>">Main Index</a> |
! <a href="<a href="../rcvars.html#TIDXFNAME">$TIDXFNAME$</a>">Thread Index</a>
</strong>
<b></MSGFOOT></b>
***************
*** 398,417 ****
<!--=== Icons =============================================================-->
<b><<a href="icons.html">ICONS</a>></b>
! application/octet-stream:http://foo.org/icons/binary.xbm
! application/postscript:http://foo.org/icons/postscript.xbm
! audio/basic:http://foo.org/icons/sound.xbm
! image/gif:http://foo.org/icons/image.xbm
! image/jpeg:http://foo.org/icons/image.xbm
! image/tiff:http://foo.org/icons/image.xbm
! multipart/alternative:http://foo.org/icons/alternative.xbm
! multipart/digest:http://foo.org/icons/text.xbm
! multipart/mixed:http://foo.org/icons/mixed.xbm
! multipart/parallel:http://foo.org/icons/mixed.xbm
! text/richtext:http://foo.org/icons/mixed.xbm
! text/html:http://foo.org/icons/mixed.xbm
! text/plain:http://foo.org/icons/text.xbm
! unknown:http://foo.org/icons/unknown.doc.xbm
! video/mpeg:http://foo.org/icons/movie.xbm
! video/quicktime:http://foo.org/icons/movie.xbm
<b></ICONS></b>
</PRE>
--- 472,502 ----
<!--=== Icons =============================================================-->
<b><<a href="icons.html">ICONS</a>></b>
! application/*;[20x22]/icons/generic.gif
! application/msword;[20x22]/icons/layout.gif
! application/postscript;[20x22]/icons/ps.gif
! application/rtf;[20x22]/icons/layout.gif
! application/x-csh;[20x22]/icons/script.gif
! application/x-dvi;[20x22]/icons/dvi.gif
! application/x-gtar;[20x22]/icons/tar.gif
! application/x-gzip;[20x22]/icons/compressed.gif
! application/x-ksh;[20x22]/icons/script.gif
! application/x-latex;[20x22]/icons/tex.gif
! application/octet-stream;[20x22]/icons/binary.gif
! application/x-patch;[20x22]/icons/patch.gif
! application/pdf;[20x22]/icons/pdf.gif
! application/x-script;[20x22]/icons/script.gif
! application/x-sh;[20x22]/icons/script.gif
! application/x-tar;[20x22]/icons/tar.gif
! application/x-tex;[20x22]/icons/tex.gif
! application/x-zip-compressed;[20x22]/icons/compressed.gif
! application/zip;[20x22]/icons/compressed.gif
! audio/*;[20x22]/icons/sound1.gif
! chemical/*;[20x22]/icons/sphere2.gif
! image/*;[20x22]/icons/image2.gif
! message/external-body;[20x22]/icons/link.gif
! multipart/*;[20x22]/icons/layout.gif
! text/*;[20x22]/icons/text.gif
! video/*;[20x22]/icons/movie.gif
! */*;[20x22]/icons/generic.gif
<b></ICONS></b>
</PRE>
***************
*** 448,452 ****
<a href="http://www.mhonarc.org/";
><strong>MHonArc</strong></a><br>
! Copyright © 1997-1999, <a href="http://www.earlhood.com/";
>Earl Hood</a>, <a href="mailto:mhonarc(_at_)mhonarc(_dot_)org"
> mhonarc(_at_)mhonarc(_dot_)org</a><br>
--- 533,537 ----
<a href="http://www.mhonarc.org/";
><strong>MHonArc</strong></a><br>
! Copyright © 1997-1999,2003, <a href="http://www.earlhood.com/";
>Earl Hood</a>, <a href="mailto:mhonarc(_at_)mhonarc(_dot_)org"
> mhonarc(_at_)mhonarc(_dot_)org</a><br>
---------------------------------------------------------------------
To sign-off this list, send email to majordomo(_at_)mhonarc(_dot_)org with the
message text UNSUBSCRIBE MHONARC-DEV