From 6b3b22537e488b270f921102c0b15976538a58b4 Mon Sep 17 00:00:00 2001
From: Eelco Dolstra <eelco.dolstra@logicblox.com>
Date: Mon, 5 Oct 2009 23:15:06 +0000
Subject: [PATCH] * Generate valid DocBook.  <emphasis> isn't allowed in a
 <filename>.

* For manpage generation, work around a bug in the DocBook XSL
  stylesheet by using a <simplelist> instead of a <itemizedlist>
  (which is arguably better anyway).  The indentation of an
  <itemizedlist> lasts beyond the end of that element under certain
  circumstances, it seems.

* Disable the man.endnotes.are.numbered option to prevent endnotes to
  be generated for each xlink:href in the Declarations/Definitions
  lists (which we don't want anyway, I guess).  This causes libxslt to
  get stuck in an infinite (?) loop.

svn path=/nixos/trunk/; revision=17659
---
 doc/manual/default.nix            | 10 ++++------
 doc/manual/options-to-docbook.xsl | 14 +++++++-------
 doc/manual/style.css              |  5 +++++
 3 files changed, 16 insertions(+), 13 deletions(-)

diff --git a/doc/manual/default.nix b/doc/manual/default.nix
index 8433feec0989..1e9581e8dd45 100644
--- a/doc/manual/default.nix
+++ b/doc/manual/default.nix
@@ -4,6 +4,7 @@
 }:
 
 let
+
   # To prevent infinite recursion, remove system.path from the
   # options.  Not sure why this happens.
   options_ =
@@ -33,7 +34,7 @@ let
   '';
 
   optionsDocBook = pkgs.runCommand "options-db.xml" {} ''
-    ${pkgs.libxslt}/bin/xsltproc -o $out ${./options-to-docbook.xsl} ${optionsXML}
+    ${pkgs.libxslt}/bin/xsltproc -o $out ${./options-to-docbook.xsl} ${optionsXML_}
   '';
 
   manual = pkgs.stdenv.mkDerivation {
@@ -67,14 +68,10 @@ let
       dst=$out/share/doc/nixos
       ensureDir $dst
       xsltproc $xsltFlags --nonet --xinclude \
-        --output ./manual.html \
+        --output $dst/manual.html \
         ${pkgs.docbook5_xsl}/xml/xsl/docbook/xhtml/docbook.xsl \
         ./manual.xml
 
-      sed '
-        s,!\([^!]*\)!!\([^!]*\)!,<a class="link" href="\1" target="_top"><code class="filename">\2</code></a>,g
-      ' ./manual.html > $dst/manual.html
-
       ln -s ${pkgs.docbook5_xsl}/xml/xsl/docbook/images $dst/
       cp ${./style.css} $dst/style.css
 
@@ -83,6 +80,7 @@ let
       xsltproc --nonet --xinclude \
         --param man.output.in.separate.dir 1 \
         --param man.output.base.dir "'$out/share/man/'" \
+        --param man.endnotes.are.numbered 0 \
         ${pkgs.docbook5_xsl}/xml/xsl/docbook/manpages/docbook.xsl \
         ./man-pages.xml
       
diff --git a/doc/manual/options-to-docbook.xsl b/doc/manual/options-to-docbook.xsl
index a9d77da977df..d8cd057ac295 100644
--- a/doc/manual/options-to-docbook.xsl
+++ b/doc/manual/options-to-docbook.xsl
@@ -62,15 +62,15 @@
                <xsl:if test="count(attr[@name = 'declarations']/list/*) != 0">
                  <para>
                    <emphasis>Declared by:</emphasis>
-                   <xsl:apply-templates select="attr[@name = 'declarations']" />
                  </para>
+                 <xsl:apply-templates select="attr[@name = 'declarations']" />
                </xsl:if>
 
                <xsl:if test="count(attr[@name = 'definitions']/list/*) != 0">
                  <para>
                    <emphasis>Defined by:</emphasis>
-                   <xsl:apply-templates select="attr[@name = 'definitions']" />
                  </para>
+                 <xsl:apply-templates select="attr[@name = 'definitions']" />
                </xsl:if>
                
              </listitem>
@@ -129,20 +129,20 @@
   <xsl:template match="derivation">
     <xsl:choose>
       <xsl:when test="attr[@name = 'url']/string/@value">
-        <emphasis>(download of <xsl:value-of select="attr[@name = 'url']/string/@value" />)</emphasis>
+        <replaceable>(download of <xsl:value-of select="attr[@name = 'url']/string/@value" />)</replaceable>
       </xsl:when>
       <xsl:otherwise>
-        <emphasis>(build of <xsl:value-of select="attr[@name = 'name']/string/@value" />)</emphasis>
+        <replaceable>(build of <xsl:value-of select="attr[@name = 'name']/string/@value" />)</replaceable>
       </xsl:otherwise>
     </xsl:choose>
   </xsl:template>
 
   <xsl:template match="attr[@name = 'declarations' or @name = 'definitions']">
-    <itemizedlist>
+    <simplelist>
       <xsl:for-each select="list/string">
-        <listitem><xsl:text> </xsl:text><xsl:value-of select="@value" /></listitem>
+        <member><filename xlink:href="http://example.org"><xsl:value-of select="@value" /></filename></member>
       </xsl:for-each>
-    </itemizedlist>
+    </simplelist>
   </xsl:template>  
   
 </xsl:stylesheet>
diff --git a/doc/manual/style.css b/doc/manual/style.css
index e992a9a85dd9..5756d60eba3c 100644
--- a/doc/manual/style.css
+++ b/doc/manual/style.css
@@ -281,3 +281,8 @@ div.calloutlist td
 {
     padding-bottom: 1em;
 }
+
+table
+{
+    margin-bottom: 1em;
+}