[MKDoc-commit] [MKDoc-Text-Structured] Documented entity substitution

[bruno at mkdoc.demon.co.uk]

Log Message:
-----------
[MKDoc-Text-Structured] Documented entity substitution

Modified Files:
--------------
    MKDoc-Text-Structured:
        Changes
    MKDoc-Text-Structured/lib/MKDoc/Text:
        Structured.pm

-------------- next part --------------
Index: Changes
===================================================================
RCS file: /var/spool/cvs/MKDoc-Text-Structured/Changes,v
retrieving revision 1.16
retrieving revision 1.17
diff -LChanges -LChanges -u -r1.16 -r1.17
--- Changes
+++ Changes
@@ -2,6 +2,7 @@
 
 0.81
     - removed defunct email address
+    - Documented entity substitution
 
 0.8 Thu Jul 22 17:51:30 2004
     - Fixed Bruno's broken trailing spaces patch ;-)
Index: Structured.pm
===================================================================
RCS file: /var/spool/cvs/MKDoc-Text-Structured/lib/MKDoc/Text/Structured.pm,v
retrieving revision 1.23
retrieving revision 1.24
diff -Llib/MKDoc/Text/Structured.pm -Llib/MKDoc/Text/Structured.pm -u -r1.23 -r1.24
--- lib/MKDoc/Text/Structured.pm
+++ lib/MKDoc/Text/Structured.pm
@@ -209,6 +209,23 @@
 
 Same notes as for bold / strong text also applied for emphasized text.
 
+=head2 Entity substitution
+
+Characters that would otherwise be interpreted as XML are encoded. i.e. &, <
+and > become &amp; &lt; and &gt;
+
+Additionally some standard typed versions of special characters are
+substituted with a richer and better-looking HTML entity:
+
+  --   surrounded by whitespace becomes &mdash;
+  -    surrounded by whitespace becomes &ndash;
+  ...  becomes &hellip;
+  (tm) becomes &trade;
+  (r)  becomes &reg;
+  (c)  becomes &copy;
+  x    between numbers becomes &times;
+  ''   surrounding text becomes &lsquo; &rsquo;
+  ""   surrounding text becomes &ldquo; &rdquo;
 
 =head1 Nested Structures