From f11f263bade1738009d6aa8678b4ae381d2d47df Mon Sep 17 00:00:00 2001
From: Lars Thorsen <lars@erlang.org>
Date: Tue, 28 Sep 2010 09:46:32 +0200
Subject: Fix format_man_pages so it handles all man sections and remove
 warnings/errors in man pages

---
 .../priv/dtd_man_entities/xhtml-lat1.ent           | 128 ++++++++++-----------
 lib/erl_docgen/priv/xsl/db_man.xsl                 |  21 +++-
 2 files changed, 83 insertions(+), 66 deletions(-)

(limited to 'lib/erl_docgen/priv')

diff --git a/lib/erl_docgen/priv/dtd_man_entities/xhtml-lat1.ent b/lib/erl_docgen/priv/dtd_man_entities/xhtml-lat1.ent
index 3df9970a43..7a07e2c406 100644
--- a/lib/erl_docgen/priv/dtd_man_entities/xhtml-lat1.ent
+++ b/lib/erl_docgen/priv/dtd_man_entities/xhtml-lat1.ent
@@ -21,26 +21,26 @@
 <!ENTITY sect   "&#167;"> <!-- section sign, U+00A7 ISOnum -->
 <!ENTITY uml    "&#168;"> <!-- diaeresis = spacing diaeresis,
                                   U+00A8 ISOdia -->
-<!ENTITY copy   "&#169;"> <!-- copyright sign, U+00A9 ISOnum -->
+<!ENTITY copy   "(C)"> <!-- copyright sign, U+00A9 ISOnum -->
 <!ENTITY ordf   "&#170;"> <!-- feminine ordinal indicator, U+00AA ISOnum -->
-<!ENTITY laquo  "&#171;"> <!-- left-pointing double angle quotation mark
-                                  = left pointing guillemet, U+00AB ISOnum -->
+<!ENTITY laquo  "&#34;"> <!-- left-pointing double angle quotation mark
+                                  = left pointing guillemetn = " in man pages, U+00AB ISOnum -->
 <!ENTITY not    "&#172;"> <!-- not sign = discretionary hyphen,
                                   U+00AC ISOnum -->
-<!ENTITY shy    "&#173;"> <!-- soft hyphen = discretionary hyphen,
+<!ENTITY shy    ""> <!-- soft hyphen = discretionary hyphen,
                                   U+00AD ISOnum -->
-<!ENTITY reg    "&#174;"> <!-- registered sign = registered trade mark sign,
+<!ENTITY reg    "(R)"> <!-- registered sign = registered trade mark sign,
                                   U+00AE ISOnum -->
 <!ENTITY macr   "&#175;"> <!-- macron = spacing macron = overline
                                   = APL overbar, U+00AF ISOdia -->
 <!ENTITY deg    "&#176;"> <!-- degree sign, U+00B0 ISOnum -->
-<!ENTITY plusmn "&#177;"> <!-- plus-minus sign = plus-or-minus sign,
+<!ENTITY plusmn "+/-"> <!-- plus-minus sign = plus-or-minus sign,
                                   U+00B1 ISOnum -->
 <!ENTITY sup2   "&#178;"> <!-- superscript two = superscript digit two
                                   = squared, U+00B2 ISOnum -->
 <!ENTITY sup3   "&#179;"> <!-- superscript three = superscript digit three
                                   = cubed, U+00B3 ISOnum -->
-<!ENTITY acute  "&#180;"> <!-- acute accent = spacing acute,
+<!ENTITY acute  "'"> <!-- acute accent = spacing acute,
                                   U+00B4 ISOdia -->
 <!ENTITY micro  "&#181;"> <!-- micro sign, U+00B5 ISOnum -->
 <!ENTITY para   "&#182;"> <!-- pilcrow sign = paragraph sign,
@@ -62,134 +62,134 @@
                                   = fraction three quarters, U+00BE ISOnum -->
 <!ENTITY iquest "&#191;"> <!-- inverted question mark
                                   = turned question mark, U+00BF ISOnum -->
-<!ENTITY Agrave "&#192;"> <!-- latin capital letter A with grave
+<!ENTITY Agrave "A"> <!-- latin capital letter A with grave
                                   = latin capital letter A grave,
                                   U+00C0 ISOlat1 -->
-<!ENTITY Aacute "&#193;"> <!-- latin capital letter A with acute,
+<!ENTITY Aacute "A"> <!-- latin capital letter A with acute,
                                   U+00C1 ISOlat1 -->
-<!ENTITY Acirc  "&#194;"> <!-- latin capital letter A with circumflex,
+<!ENTITY Acirc  "A"> <!-- latin capital letter A with circumflex,
                                   U+00C2 ISOlat1 -->
-<!ENTITY Atilde "&#195;"> <!-- latin capital letter A with tilde,
+<!ENTITY Atilde "A"> <!-- latin capital letter A with tilde,
                                   U+00C3 ISOlat1 -->
-<!ENTITY Auml   "&#196;"> <!-- latin capital letter A with diaeresis,
+<!ENTITY Auml   "A"> <!-- latin capital letter A with diaeresis,
                                   U+00C4 ISOlat1 -->
-<!ENTITY Aring  "&#197;"> <!-- latin capital letter A with ring above
+<!ENTITY Aring  "A"> <!-- latin capital letter A with ring above
                                   = latin capital letter A ring,
                                   U+00C5 ISOlat1 -->
-<!ENTITY AElig  "&#198;"> <!-- latin capital letter AE
+<!ENTITY AElig  "AE"> <!-- latin capital letter AE
                                   = latin capital ligature AE,
                                   U+00C6 ISOlat1 -->
-<!ENTITY Ccedil "&#199;"> <!-- latin capital letter C with cedilla,
+<!ENTITY Ccedil "C"> <!-- latin capital letter C with cedilla,
                                   U+00C7 ISOlat1 -->
-<!ENTITY Egrave "&#200;"> <!-- latin capital letter E with grave,
+<!ENTITY Egrave "E"> <!-- latin capital letter E with grave,
                                   U+00C8 ISOlat1 -->
-<!ENTITY Eacute "&#201;"> <!-- latin capital letter E with acute,
+<!ENTITY Eacute "E"> <!-- latin capital letter E with acute,
                                   U+00C9 ISOlat1 -->
-<!ENTITY Ecirc  "&#202;"> <!-- latin capital letter E with circumflex,
+<!ENTITY Ecirc  "E"> <!-- latin capital letter E with circumflex,
                                   U+00CA ISOlat1 -->
-<!ENTITY Euml   "&#203;"> <!-- latin capital letter E with diaeresis,
+<!ENTITY Euml   "E"> <!-- latin capital letter E with diaeresis,
                                   U+00CB ISOlat1 -->
-<!ENTITY Igrave "&#204;"> <!-- latin capital letter I with grave,
+<!ENTITY Igrave "I"> <!-- latin capital letter I with grave,
                                   U+00CC ISOlat1 -->
-<!ENTITY Iacute "&#205;"> <!-- latin capital letter I with acute,
+<!ENTITY Iacute "I"> <!-- latin capital letter I with acute,
                                   U+00CD ISOlat1 -->
-<!ENTITY Icirc  "&#206;"> <!-- latin capital letter I with circumflex,
+<!ENTITY Icirc  "I"> <!-- latin capital letter I with circumflex,
                                   U+00CE ISOlat1 -->
-<!ENTITY Iuml   "&#207;"> <!-- latin capital letter I with diaeresis,
+<!ENTITY Iuml   "I"> <!-- latin capital letter I with diaeresis,
                                   U+00CF ISOlat1 -->
 <!ENTITY ETH    "&#208;"> <!-- latin capital letter ETH, U+00D0 ISOlat1 -->
-<!ENTITY Ntilde "&#209;"> <!-- latin capital letter N with tilde,
+<!ENTITY Ntilde "N"> <!-- latin capital letter N with tilde,
                                   U+00D1 ISOlat1 -->
-<!ENTITY Ograve "&#210;"> <!-- latin capital letter O with grave,
+<!ENTITY Ograve "O"> <!-- latin capital letter O with grave,
                                   U+00D2 ISOlat1 -->
-<!ENTITY Oacute "&#211;"> <!-- latin capital letter O with acute,
+<!ENTITY Oacute "O"> <!-- latin capital letter O with acute,
                                   U+00D3 ISOlat1 -->
-<!ENTITY Ocirc  "&#212;"> <!-- latin capital letter O with circumflex,
+<!ENTITY Ocirc  "O"> <!-- latin capital letter O with circumflex,
                                   U+00D4 ISOlat1 -->
-<!ENTITY Otilde "&#213;"> <!-- latin capital letter O with tilde,
+<!ENTITY Otilde "O"> <!-- latin capital letter O with tilde,
                                   U+00D5 ISOlat1 -->
-<!ENTITY Ouml   "&#214;"> <!-- latin capital letter O with diaeresis,
+<!ENTITY Ouml   "O"> <!-- latin capital letter O with diaeresis,
                                   U+00D6 ISOlat1 -->
-<!ENTITY times  "&#215;"> <!-- multiplication sign, U+00D7 ISOnum -->
+<!ENTITY times  "x"> <!-- multiplication sign, U+00D7 ISOnum -->
 <!ENTITY Oslash "&#216;"> <!-- latin capital letter O with stroke
                                   = latin capital letter O slash,
                                   U+00D8 ISOlat1 -->
-<!ENTITY Ugrave "&#217;"> <!-- latin capital letter U with grave,
+<!ENTITY Ugrave "U"> <!-- latin capital letter U with grave,
                                   U+00D9 ISOlat1 -->
-<!ENTITY Uacute "&#218;"> <!-- latin capital letter U with acute,
+<!ENTITY Uacute "U"> <!-- latin capital letter U with acute,
                                   U+00DA ISOlat1 -->
-<!ENTITY Ucirc  "&#219;"> <!-- latin capital letter U with circumflex,
+<!ENTITY Ucirc  "U"> <!-- latin capital letter U with circumflex,
                                   U+00DB ISOlat1 -->
-<!ENTITY Uuml   "&#220;"> <!-- latin capital letter U with diaeresis,
+<!ENTITY Uuml   "U"> <!-- latin capital letter U with diaeresis,
                                   U+00DC ISOlat1 -->
-<!ENTITY Yacute "&#221;"> <!-- latin capital letter Y with acute,
+<!ENTITY Yacute "Y"> <!-- latin capital letter Y with acute,
                                   U+00DD ISOlat1 -->
 <!ENTITY THORN  "&#222;"> <!-- latin capital letter THORN,
                                   U+00DE ISOlat1 -->
 <!ENTITY szlig  "&#223;"> <!-- latin small letter sharp s = ess-zed,
                                   U+00DF ISOlat1 -->
-<!ENTITY agrave "&#224;"> <!-- latin small letter a with grave
+<!ENTITY agrave "a"> <!-- latin small letter a with grave
                                   = latin small letter a grave,
                                   U+00E0 ISOlat1 -->
-<!ENTITY aacute "&#225;"> <!-- latin small letter a with acute,
+<!ENTITY aacute "a"> <!-- latin small letter a with acute,
                                   U+00E1 ISOlat1 -->
-<!ENTITY acirc  "&#226;"> <!-- latin small letter a with circumflex,
+<!ENTITY acirc  "a"> <!-- latin small letter a with circumflex,
                                   U+00E2 ISOlat1 -->
-<!ENTITY atilde "&#227;"> <!-- latin small letter a with tilde,
+<!ENTITY atilde "a"> <!-- latin small letter a with tilde,
                                   U+00E3 ISOlat1 -->
-<!ENTITY auml   "&#228;"> <!-- latin small letter a with diaeresis,
+<!ENTITY auml   "a"> <!-- latin small letter a with diaeresis,
                                   U+00E4 ISOlat1 -->
-<!ENTITY aring  "&#229;"> <!-- latin small letter a with ring above
+<!ENTITY aring  "a"> <!-- latin small letter a with ring above
                                   = latin small letter a ring,
                                   U+00E5 ISOlat1 -->
-<!ENTITY aelig  "&#230;"> <!-- latin small letter ae
+<!ENTITY aelig  "ae"> <!-- latin small letter ae
                                   = latin small ligature ae, U+00E6 ISOlat1 -->
-<!ENTITY ccedil "&#231;"> <!-- latin small letter c with cedilla,
+<!ENTITY ccedil "c"> <!-- latin small letter c with cedilla,
                                   U+00E7 ISOlat1 -->
-<!ENTITY egrave "&#232;"> <!-- latin small letter e with grave,
+<!ENTITY egrave "e"> <!-- latin small letter e with grave,
                                   U+00E8 ISOlat1 -->
-<!ENTITY eacute "&#233;"> <!-- latin small letter e with acute,
+<!ENTITY eacute "e"> <!-- latin small letter e with acute,
                                   U+00E9 ISOlat1 -->
-<!ENTITY ecirc  "&#234;"> <!-- latin small letter e with circumflex,
+<!ENTITY ecirc  "e"> <!-- latin small letter e with circumflex,
                                   U+00EA ISOlat1 -->
-<!ENTITY euml   "&#235;"> <!-- latin small letter e with diaeresis,
+<!ENTITY euml   "e"> <!-- latin small letter e with diaeresis,
                                   U+00EB ISOlat1 -->
-<!ENTITY igrave "&#236;"> <!-- latin small letter i with grave,
+<!ENTITY igrave "i"> <!-- latin small letter i with grave,
                                   U+00EC ISOlat1 -->
-<!ENTITY iacute "&#237;"> <!-- latin small letter i with acute,
+<!ENTITY iacute "i"> <!-- latin small letter i with acute,
                                   U+00ED ISOlat1 -->
-<!ENTITY icirc  "&#238;"> <!-- latin small letter i with circumflex,
+<!ENTITY icirc  "i"> <!-- latin small letter i with circumflex,
                                   U+00EE ISOlat1 -->
-<!ENTITY iuml   "&#239;"> <!-- latin small letter i with diaeresis,
+<!ENTITY iuml   "i"> <!-- latin small letter i with diaeresis,
                                   U+00EF ISOlat1 -->
 <!ENTITY eth    "&#240;"> <!-- latin small letter eth, U+00F0 ISOlat1 -->
-<!ENTITY ntilde "&#241;"> <!-- latin small letter n with tilde,
+<!ENTITY ntilde "n"> <!-- latin small letter n with tilde,
                                   U+00F1 ISOlat1 -->
-<!ENTITY ograve "&#242;"> <!-- latin small letter o with grave,
+<!ENTITY ograve "o"> <!-- latin small letter o with grave,
                                   U+00F2 ISOlat1 -->
-<!ENTITY oacute "&#243;"> <!-- latin small letter o with acute,
+<!ENTITY oacute "o"> <!-- latin small letter o with acute,
                                   U+00F3 ISOlat1 -->
-<!ENTITY ocirc  "&#244;"> <!-- latin small letter o with circumflex,
+<!ENTITY ocirc  "o"> <!-- latin small letter o with circumflex,
                                   U+00F4 ISOlat1 -->
-<!ENTITY otilde "&#245;"> <!-- latin small letter o with tilde,
+<!ENTITY otilde "o"> <!-- latin small letter o with tilde,
                                   U+00F5 ISOlat1 -->
-<!ENTITY ouml   "&#246;"> <!-- latin small letter o with diaeresis,
+<!ENTITY ouml   "o"> <!-- latin small letter o with diaeresis,
                                   U+00F6 ISOlat1 -->
 <!ENTITY divide "&#247;"> <!-- division sign, U+00F7 ISOnum -->
-<!ENTITY oslash "&#248;"> <!-- latin small letter o with stroke,
+<!ENTITY oslash "o"> <!-- latin small letter o with stroke,
                                   = latin small letter o slash,
                                   U+00F8 ISOlat1 -->
-<!ENTITY ugrave "&#249;"> <!-- latin small letter u with grave,
+<!ENTITY ugrave "u"> <!-- latin small letter u with grave,
                                   U+00F9 ISOlat1 -->
-<!ENTITY uacute "&#250;"> <!-- latin small letter u with acute,
+<!ENTITY uacute "u"> <!-- latin small letter u with acute,
                                   U+00FA ISOlat1 -->
-<!ENTITY ucirc  "&#251;"> <!-- latin small letter u with circumflex,
+<!ENTITY ucirc  "u"> <!-- latin small letter u with circumflex,
                                   U+00FB ISOlat1 -->
-<!ENTITY uuml   "&#252;"> <!-- latin small letter u with diaeresis,
+<!ENTITY uuml   "u"> <!-- latin small letter u with diaeresis,
                                   U+00FC ISOlat1 -->
-<!ENTITY yacute "&#253;"> <!-- latin small letter y with acute,
+<!ENTITY yacute "y"> <!-- latin small letter y with acute,
                                   U+00FD ISOlat1 -->
 <!ENTITY thorn  "&#254;"> <!-- latin small letter thorn with,
                                   U+00FE ISOlat1 -->
-<!ENTITY yuml   "&#255;"> <!-- latin small letter y with diaeresis,
+<!ENTITY yuml   "y"> <!-- latin small letter y with diaeresis,
                                   U+00FF ISOlat1 -->
diff --git a/lib/erl_docgen/priv/xsl/db_man.xsl b/lib/erl_docgen/priv/xsl/db_man.xsl
index 2ed0d95c6d..2a8fb9fe3e 100644
--- a/lib/erl_docgen/priv/xsl/db_man.xsl
+++ b/lib/erl_docgen/priv/xsl/db_man.xsl
@@ -323,7 +323,7 @@
   <xsl:template match="list">
     <xsl:text>&#10;.RS 2</xsl:text>
     <xsl:apply-templates/>
-    <xsl:text>&#10;.RE</xsl:text>
+    <xsl:text>&#10;.RE&#10;</xsl:text>
   </xsl:template>
 
   <xsl:template match="list/item">
@@ -336,7 +336,7 @@
   <xsl:template match="taglist">
     <xsl:text>&#10;.RS 2</xsl:text>
     <xsl:apply-templates select="tag|item"/>
-    <xsl:text>&#10;.RE</xsl:text>
+    <xsl:text>&#10;.RE&#10;</xsl:text>
   </xsl:template>
 
   <xsl:template match="taglist/tag">
@@ -622,6 +622,23 @@
     <xsl:text>&gt;</xsl:text>
   </xsl:template>
 
+  <!-- Do not noramlize any text within pre and code tags. -->
+  <xsl:template match="pre/text()">
+      <xsl:call-template name="replace-string">
+        <xsl:with-param name="text" select="." />
+        <xsl:with-param name="replace" select="&quot;\&quot;" />
+        <xsl:with-param name="with" select="&quot;\\&quot;" />
+      </xsl:call-template>
+  </xsl:template>
+
+  <xsl:template match="code/text()">
+      <xsl:call-template name="replace-string">
+        <xsl:with-param name="text" select="." />
+        <xsl:with-param name="replace" select="&quot;\&quot;" />
+        <xsl:with-param name="with" select="&quot;\\&quot;" />
+      </xsl:call-template>
+  </xsl:template>
+
   <!-- Replace ' by \&' ans . by \&. -->
   <xsl:template match="text()">
     <xsl:variable name="startstring">
-- 
cgit v1.2.3