Update of /cvsroot/mhonarc/mhonarc/MHonArc/doc
In directory subversions:/tmp/cvs-serv7632
Modified Files:
app-mimeconf.html install.html relnotes.html
Log Message:
* Added iso-2022-jp release note.
* Update charsetconverters to reflect default value change to iso-8859-{1,jp}.
* Added documentation for available charsetconverter converter functions.
* Moved filter description in mimefilters to its own section.
* Added inline TOCs to all resource pages.
Index: app-mimeconf.html
===================================================================
RCS file: /cvsroot/mhonarc/mhonarc/MHonArc/doc/app-mimeconf.html,v
retrieving revision 1.12
retrieving revision 1.13
diff -C2 -r1.12 -r1.13
*** app-mimeconf.html 24 Nov 2002 04:18:35 -0000 1.12
--- app-mimeconf.html 10 Dec 2002 04:08:02 -0000 1.13
***************
*** 36,52 ****
RFC 2049: (MIME) Part Five: Conformance Criteria and Examples</a>.
Following is the text extracted from section 2 of RFC 2049 with
! annotations added on how MHonArc conforms to each criteria listed.
It should be noted that the criteria listed in RFC 2049 is geared
towards interactive MUAs; therefore, some criteria may not be
applicable to MHonArc.
</p>
! <table border=0 cellpadding=4>
<tr valign=top>
! <td><strong>NOTE</strong></td>
! <td><p>All notes about conformance is based upon the default MIME-related
resource settings:
<a href="resources/mimefilters.html">MIMEFILTERS</a>,
<a href="resources/charsetconverters.html">CHARSETCONVERTERS</a>,
! <a href="resources/mimeargs.html">MIMEARGS</a>
</p>
</td>
--- 36,55 ----
RFC 2049: (MIME) Part Five: Conformance Criteria and Examples</a>.
Following is the text extracted from section 2 of RFC 2049 with
! annotations — denoted by
! <strong><img src="monicon.png" alt="MHonArc"></strong> —
! added on how MHonArc conforms to each criteria listed.
It should be noted that the criteria listed in RFC 2049 is geared
towards interactive MUAs; therefore, some criteria may not be
applicable to MHonArc.
</p>
! <table class="note" width="100%">
<tr valign=top>
! <td><strong>NOTE:</strong></td>
! <td width="100%"><p>All notes about conformance is based upon the default MIME-related
resource settings:
<a href="resources/mimefilters.html">MIMEFILTERS</a>,
+ <a href="resources/mimeargs.html">MIMEARGS</a> ,
<a href="resources/charsetconverters.html">CHARSETCONVERTERS</a>,
! <a href="resources/charsetconverters.html">CHARSETALIASES</a>.
</p>
</td>
***************
*** 64,68 ****
<td><p>Not applicable.
</p>
- <br>
</td>
</tr>
--- 67,70 ----
***************
*** 82,86 ****
<tt>x-uue</tt>.
</p>
- <br>
</td>
</tr>
--- 84,87 ----
***************
*** 99,103 ****
<td><p>Not applicable.
</p>
- <br>
</td>
</tr>
--- 100,103 ----
***************
*** 119,123 ****
MHonArc process a message with an unrecognized Content-Transfer-Encoding.
</p>
- <br>
</td>
</tr>
--- 119,122 ----
***************
*** 138,142 ****
The second sentence is not applicable.
</p>
- <br>
</td>
</tr>
--- 137,140 ----
***************
*** 152,156 ****
<td><p>Yes.
</p>
- <br>
</td>
</tr>
--- 150,153 ----
***************
*** 173,177 ****
<td><p>Yes.
</p>
- <br>
</td>
</tr>
--- 170,173 ----
***************
*** 187,191 ****
if a character set is encountered that is not recognized.
</p>
- <br>
</td>
</tr>
--- 183,186 ----
***************
*** 201,205 ****
<td><p>Yes.
</p>
- <br>
</td>
</tr>
--- 196,199 ----
***************
*** 215,219 ****
<td><p>MHonArc will treat the data as text/plain and convert.
</p>
- <br>
</td>
</tr>
--- 209,212 ----
***************
*** 230,234 ****
are known to give incorrect charset parameters.
</p>
- <br>
</td>
</tr>
--- 223,226 ----
***************
*** 250,254 ****
are inlined unless the image has an attachment content-disposition.
</p>
- <br>
</td>
</tr>
--- 242,245 ----
***************
*** 289,293 ****
media-type.
</p>
- <br>
</td>
</tr>
--- 280,283 ----
***************
*** 300,306 ****
<tr valign=top>
<td><strong><img src="monicon.png" alt="MHonArc"></strong></td>
! <td><p>Yes.
</p>
- <br>
</td>
</tr>
--- 290,298 ----
<tr valign=top>
<td><strong><img src="monicon.png" alt="MHonArc"></strong></td>
! <td><p>Yes. MHonArc also provides the
! <a href="resources/mimealtprefs.html">MIMEALTPREFS</a> resource to
! allow users to control media-type preferences for
! <tt>multipart/alternative</tt> mail.
</p>
</td>
</tr>
***************
*** 316,320 ****
<td><p>Yes.
</p>
- <br>
</td>
</tr>
--- 308,311 ----
***************
*** 328,332 ****
<td><p>Yes.
</p>
- <br>
</td>
</tr>
--- 319,322 ----
***************
*** 348,352 ****
<td><p>Yes.
</p>
- <br>
</td>
</tr>
--- 338,341 ----
***************
*** 360,364 ****
<td><p>Yes.
</p>
- <br>
</td>
</tr>
--- 349,352 ----
***************
*** 382,386 ****
to be saved to an external file.
</p>
- <br>
</td>
</tr>
--- 370,373 ----
***************
*** 407,413 ****
<a href="resources/mimefilters.html#m2h_text_plain">m2h_text_plain::filter</a>
supports an option to specify what character set to use if no character
! set is specified. By default, ISO-8859-1 is assumed.
</p>
- <br>
</td>
</tr>
--- 394,399 ----
<a href="resources/mimefilters.html#m2h_text_plain">m2h_text_plain::filter</a>
supports an option to specify what character set to use if no character
! set is specified. By default, US-ASCII is assumed.
</p>
</td>
</tr>
***************
*** 427,431 ****
<td><p>Not applicable.
</p>
- <br>
</td>
</tr>
--- 413,416 ----
***************
*** 446,450 ****
<td><p>Yes.
</p>
- <br>
</td>
</tr>
--- 431,434 ----
***************
*** 465,475 ****
<td><strong><img src="monicon.png" alt="MHonArc"></strong></td>
<td><p>MHonArc supports non-ASCII encoding of text in message headers,
! including the "B" and "Q" encodings. By default, US-ASCII,
! ISO-8859-[1-10], and ISO-2022-JP are supported. For encoded
! words with an unrecognized character set, the word is left in
! encoded form. Additional character set support can be added via the
! <a href="resources/charsetconverters.html">CHARSETCONVERTERS</a> resource.
</p>
- <br>
</td>
</tr>
--- 449,456 ----
<td><strong><img src="monicon.png" alt="MHonArc"></strong></td>
<td><p>MHonArc supports non-ASCII encoding of text in message headers,
! including the "B" and "Q" encodings. See
! <a href="resources/charsetconverters.html">CHARSETCONVERTERS</a> for
! a list of charsets supported.
</p>
</td>
</tr>
***************
*** 497,500 ****
--- 478,487 ----
these types, they are saved to a separate file with a link to the
file inserted in the converted HTML message data.
+ </p>
+ </li>
+
+ <li><p>The ability to explicitly control media-type preferences
+ of <tt>multipart/alternative</tt> data via the
+ <a href="resources/mimealtprefs.html">MIMEALTPREFS</a> resource
</p>
</li>
Index: install.html
===================================================================
RCS file: /cvsroot/mhonarc/mhonarc/MHonArc/doc/install.html,v
retrieving revision 1.19
retrieving revision 1.20
diff -C2 -r1.19 -r1.20
*** install.html 24 Nov 2002 04:18:35 -0000 1.19
--- install.html 10 Dec 2002 04:08:02 -0000 1.20
***************
*** 189,194 ****
cygwin build of Perl, then the installation and usage of MHonArc is
the same as a Unix-based environment. MHonArc treats the
! cygwin environment as a Unix-type environment for determine default
! resource values and for operational purposes.
</p>
</td>
--- 189,193 ----
cygwin build of Perl, then the installation and usage of MHonArc is
the same as a Unix-based environment. MHonArc treats the
! cygwin environment as a Unix-type environment.
</p>
</td>
Index: relnotes.html
===================================================================
RCS file: /cvsroot/mhonarc/mhonarc/MHonArc/doc/relnotes.html,v
retrieving revision 1.11
retrieving revision 1.12
diff -C2 -r1.11 -r1.12
*** relnotes.html 24 Nov 2002 04:18:35 -0000 1.11
--- relnotes.html 10 Dec 2002 04:08:02 -0000 1.12
***************
*** 38,41 ****
--- 38,42 ----
<li><a href="#important">Compatibility Notes</a>
<ul>
+ <li><small><a href="#v2.4.x-defrcname">UPGRADING FROM v2.5.x OR EARLIER: Default iso-2022-jp Converter Changed</a></small>
<li><small><a href="#v2.4.x-defrcname">UPGRADING FROM v2.4.x OR EARLIER: DEFRCNAME Change</a></small>
<li><small><a href="#v2.4.x-header-footer">UPGRADING FROM v2.4.x OR EARLIER: HEADER and FOOTER Removed</a></small>
***************
*** 45,48 ****
--- 46,59 ----
</ul>
<li><a href="#general">General Notes</a>
+ <ul>
+ <li><small><a href="#japanese">Japanese and MHonArc</a></small>
+ <li><small><a href="#html_filter">Auto-loaded URL attributes stripped in HTML messages</a></small>
+ <li><small><a href="#iso8859_pl"><tt>iso8859.pl</tt> deprecated</a></small>
+ <li><small><a href="#tslice">TSLICE range setting</a></small>
+ <li><small><a href="#reffol_chng">Reference and follow-up data format change</a></small>
+ <li><small><a href="#namespace">MHonArc code under the <tt>mhonarc</tt> namespace</a></small>
+ <li><small><a href="#htmlext">HTMLEXT and MSGPREFIX usage warning</a></small>
+ <li><small><a href="#mimefilters">Applying new MIMEFILTERS settings</a></small>
+ </ul>
</ul>
<!--X-TOC-End-->
***************
*** 56,59 ****
--- 67,104 ----
</p>
+ <h3><a name="v2.4.x-defrcname">UPGRADING FROM v2.5.x OR EARLIER: Default iso-2022-jp Converter Changed</a></h3>
+
+ <p>In v2.6, the <strong>default</strong>
+ <a href="resources/charsetconverters.html">charset
+ converter</a> for <tt>iso-2022-jp</tt> has changed to the following:
+ </p>
+ <pre class="code">
+ <b><CharsetConverters></b>
+ iso-2022-jp; MHonArc::CharEnt::str2sgml; MHonArc/CharEnt.pm
+ <b></CharsetConverters></b></pre>
+ <p>This filter converts all Japanese characters into Unicode character
+ entity references (e.g. <tt class="icode">&#x7279;</tt>)
+ removing the iso-2022-jp encoding. For some
+ Japanese locales, this type of conversion may not be desired since
+ some Japanese-aware processing tools may not support Unicode character
+ entity references. If you want to preserve the iso-2022-jp encoding,
+ you must explicitly specify the use of <tt>iso_2022_jp::str2html</tt>
+ via the <a href="resources/charsetconverters.html">CHARSETCONVERTERS</a>
+ resource as follows:
+ </p>
+ <pre class="code">
+ <b><CharsetConverters></b>
+ iso-2022-jp; iso_2022_jp::str2html; iso2022jp.pl
+ <b></CharsetConverters></b></pre>
+ <p>The change to <tt>MHonArc::CharEnt::str2sgml</tt> as the default
+ converter for iso-2022-jp was done to make MHonArc as locale neutral
+ as possible in its default configuration.
+ </p>
+ <p>For more information about using MHonArc in a Japanese locale,
+ see (documents in Japanese):<br>
+ <a href="http://www.shiratori.riec.tohoku.ac.jp/~p-katoh/Hack/Docs/mhonarc-jp/index.html";><http://www.shiratori.riec.tohoku.ac.jp/~p-katoh/Hack/Docs/mhonarc-jp/index.html></a><br>
+ <a href="http://www.shiratori.riec.tohoku.ac.jp/~p-katoh/Hack/Docs/mhonarc-jp/mhonarc-jp-2_4.html";><http://www.shiratori.riec.tohoku.ac.jp/~p-katoh/Hack/Docs/mhonarc-jp/mhonarc-jp-2_4.html></a>
+ </p>
+
<h3><a name="v2.4.x-defrcname">UPGRADING FROM v2.4.x OR EARLIER: DEFRCNAME Change</a></h3>
***************
*** 180,186 ****
<h2><a name="general">General Notes</a></h2>
! <ul>
! <li><p>For v2.5, the default text/html filter (mhtxthtml.pl) will
disable auto-loaded URL attributes for some HTML elements --
<tt>IMG</tt>, <tt>BODY</tt>, <tt>IFRAME</tt>, <tt>FRAME</tt>,
--- 225,237 ----
<h2><a name="general">General Notes</a></h2>
! <h3><a name="japanese">Japanese and MHonArc</a></h3>
! <p>Information on using MHonArc in a Japanese locale is available
! at the following locations (documents in Japanese):<br>
! <a href="http://www.shiratori.riec.tohoku.ac.jp/~p-katoh/Hack/Docs/mhonarc-jp/index.html";><http://www.shiratori.riec.tohoku.ac.jp/~p-katoh/Hack/Docs/mhonarc-jp/index.html></a><br>
! <a href="http://www.shiratori.riec.tohoku.ac.jp/~p-katoh/Hack/Docs/mhonarc-jp/mhonarc-jp-2_4.html";><http://www.shiratori.riec.tohoku.ac.jp/~p-katoh/Hack/Docs/mhonarc-jp/mhonarc-jp-2_4.html></a>
! </p>
! <h3><a name="html_filter">Auto-loaded URL attributes stripped in HTML messages</a></h3>
! <p>For v2.5, the default text/html filter (mhtxthtml.pl) will
disable auto-loaded URL attributes for some HTML elements --
<tt>IMG</tt>, <tt>BODY</tt>, <tt>IFRAME</tt>, <tt>FRAME</tt>,
***************
*** 196,200 ****
</li>
! <li><p>ISO-8859 character set data processing now defaults to using
the <tt>MHonArc::CharEnt</tt> module in v2.5. The old <tt>iso8859.pl</tt>
library is still provided for compatibility with older
--- 247,252 ----
</li>
! <h3><a name="iso8859_pl"><tt>iso8859.pl</tt> deprecated</a></h3>
! <p>ISO-8859 character set data processing now defaults to using
the <tt>MHonArc::CharEnt</tt> module in v2.5. The old <tt>iso8859.pl</tt>
library is still provided for compatibility with older
***************
*** 225,229 ****
</li>
! <li><p>The value of the <a href="resources/tslice.html">TSLICE</a>
resource is used to determine the number of messages to update,
before and after by thread, of each new message added. To
--- 277,282 ----
</li>
! <h3><a name="tslice">TSLICE range setting</a></h3>
! <p>The value of the <a href="resources/tslice.html">TSLICE</a>
resource is used to determine the number of messages to update,
before and after by thread, of each new message added. To
***************
*** 243,247 ****
</p>
! <li><p>If updgrading from v2.4.x, or earlier, reference and follow-up
information of a message is now stored in a different format
in the database (and internally). MHonArc will auto-update
--- 296,301 ----
</p>
! <h3><a name="reffol_chng">Reference and follow-up data format change</a></h3>
! <p>If updgrading from v2.4.x, or earlier, reference and follow-up
information of a message is now stored in a different format
in the database (and internally). MHonArc will auto-update
***************
*** 251,255 ****
</li>
! <li><p>If upgrading from v2.1.x, or earlier, any custom filters you
have developed may need to modified. If your filter accessed
some main variables, your filter will not operate properly.
--- 305,310 ----
</li>
! <h3><a name="namespace">MHonArc code under the <tt>mhonarc</tt> namespace</a></h3>
! <p>If upgrading from v2.1.x, or earlier, any custom filters you
have developed may need to modified. If your filter accessed
some main variables, your filter will not operate properly.
***************
*** 262,266 ****
</li>
! <li><p>See the warnings in the documentation for the
<a href="resources/htmlext.html">HTMLEXT</a> and
<a href="resources/msgprefix.html">MSGPREFIX</a>
--- 317,322 ----
</li>
! <h3><a name="htmlext">HTMLEXT and MSGPREFIX usage warning</a></h3>
! <p>See the warnings in the documentation for the
<a href="resources/htmlext.html">HTMLEXT</a> and
<a href="resources/msgprefix.html">MSGPREFIX</a>
***************
*** 269,273 ****
</li>
! <li><p>Occasionally, a new release of MHonArc may contain new
MIME filters. See the <tt>CHANGES</tt> file to check if any new filters
have been added.
--- 325,330 ----
</li>
! <h3><a name="mimefilters">Applying new MIMEFILTERS settings</a></h3>
! <p>Occasionally, a new release of MHonArc may contain new
MIME filters. See the <tt>CHANGES</tt> file to check if any new filters
have been added.
***************
*** 312,318 ****
and use the variant version when updating your archives.
</p>
- </li>
-
- </ul>
<hr>
--- 369,372 ----
---------------------------------------------------------------------
To sign-off this list, send email to majordomo(_at_)mhonarc(_dot_)org with the
message text UNSUBSCRIBE MHONARC-DEV