mhonarc-commits
[Top] [All Lists]

CVS: mhonarc/MHonArc/doc/resources charsetconverters.html,1.18,1.19

2002-12-09 21:55:03
Update of /cvsroot/mhonarc/mhonarc/MHonArc/doc/resources
In directory subversions:/tmp/cvs-serv21017

Modified Files:
	charsetconverters.html 
Log Message:
* Added documentation for MHonArc::UTF8::str2sgml converter.


Index: charsetconverters.html
===================================================================
RCS file: /cvsroot/mhonarc/mhonarc/MHonArc/doc/resources/charsetconverters.html,v
retrieving revision 1.18
retrieving revision 1.19
diff -C2 -r1.18 -r1.19
*** charsetconverters.html	10 Dec 2002 04:08:02 -0000	1.18
--- charsetconverters.html	10 Dec 2002 04:54:58 -0000	1.19
***************
*** 19,22 ****
--- 19,23 ----
  <li><small><a href="#mhonarc::htmlize"><tt>mhonarc::htmlize</tt></a></small>
  <li><small><a href="#MHonArc::CharEnt"><tt>MHonArc::CharEnt::str2sgml</tt></a></small>
+ <li><small><a href="#MHonArc::UTF8"><tt>MHonArc::UTF8::str2sgml</tt></a></small>
  <li><small><a href="#iso2022jp"><tt>iso2022jp::str2html</tt></a></small>
  </ul>
***************
*** 299,302 ****
--- 300,342 ----
      See the <a href="charsetaliases.html">CHARSETALIASES</a> resource
      for details.
+     </p>
+     </dd>
+ </dl>
+ 
+ <h3><a name="MHonArc::UTF8"><tt>MHonArc::UTF8::str2sgml</tt></a></h3>
+ <dl>
+ <dt><strong>Usage</strong></dt>
+ <dd><pre class="code">
+ <b>&lt;CharsetConverters&gt;</b>
+ <var>charset-name</var>; MHonArc::UTF8::str2sgml; MHonArc/UTF8.pm
+ <b>&lt;/CharsetConverters&gt;</b></pre>
+     </dd>
+ <dt><strong>Description</strong></dt>
+     <dd><p><tt>MHonArc::UTF8::str2sgml</tt> converts data to
+     UTF-8.
+     </p>
+     <table class="note" width="100%">
+     <tr valign="baseline">
+     <td><strong>NOTE:</strong></td>
+     <td width="100%"><p>This converter requires that the
+     <b><tt>Unicode::String</tt></b> and <b><tt>Unicode::MapUTF8</tt></b>
+     modules are installed and that you are using Perl v5.6, or later.
+     </p>
+     </td>
+     </tr>
+     </table>
+     <p>Typical use of this converter is to have it registered
+     for all charsets.  For example:
+     </p>
+     <pre class="code">
+ <b>&lt;CharsetConverters override&gt;</b>
+ plain;    mhonarc::htmlize
+ us-ascii; mhonarc::htmlize
+ default;  MHonArc::UTF8::str2sgml; MHonArc/UTF8.pm
+ <b>&lt;/CharsetConverters&gt;</b></pre>
+     <p>See the
+     <a href="../rcfileexs/utf-8.mrc.html"><tt>utf-8.mrc</tt></a> example
+     resource file more details on how this converter can be
+     used.
      </p>
      </dd>

---------------------------------------------------------------------
To sign-off this list, send email to majordomo(_at_)mhonarc(_dot_)org with the
message text UNSUBSCRIBE MHONARC-DEV