From: Michael Smith <xmldoc@users.sourceforge.net>
Date: Mon, 10 Mar 2008 15:46:03 +0000 (+0000)
Subject: added comment in code explaining why we don't put filename output
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=a995ff783ad4c01abcdbe38e3ad1978018d37e3d;p=docbook-dsssl

added comment in code explaining why we don't put filename output
in italic (despite the fact that man guidelines say we should)
---

diff --git a/xsl/manpages/inline.xsl b/xsl/manpages/inline.xsl
index edb549d46..5a97096b1 100644
--- a/xsl/manpages/inline.xsl
+++ b/xsl/manpages/inline.xsl
@@ -92,6 +92,11 @@
                 $man.break.after.slash = 0">
     <xsl:call-template name="suppress.hyphenation"/>
   </xsl:if>
+  <!-- * part of the old man(7) man page, now man-pages(7), says, -->
+  <!-- * "Filenames (whether pathnames, or references to files in the -->
+  <!-- * /usr/include directory) are always in italics". But that's dumb, -->
+  <!-- * and looks like crap in PS/printed/PDF output, and there's no -->
+  <!-- * sound rationale for it, so we don't do it. -->
   <xsl:call-template name="inline.monoseq"/>
 </xsl:template>
 
diff --git a/xsl/manpages/synop.xsl b/xsl/manpages/synop.xsl
index a888974e8..21ce5b0b7 100644
--- a/xsl/manpages/synop.xsl
+++ b/xsl/manpages/synop.xsl
@@ -44,11 +44,11 @@
     <xsl:apply-templates select="." mode="synopfragment.number"/>
   </xsl:variable>
   <xsl:text>&#10;</xsl:text>
-  If we have a group of Synopfragments, we only want to output a
-  line of space before the first; so when we find a Synopfragment
-  whose first preceding sibling is another Synopfragment, we back
-  use the pinch-together template to close up the line of space
-  that would otherwise be generated by the .HP macro
+  <!-- * If we have a group of Synopfragments, we only want to output a -->
+  <!-- * line of space before the first; so when we find a Synopfragment -->
+  <!-- * whose first preceding sibling is another Synopfragment, we back -->
+  <!-- * use the pinch-together template to close up the line of space -->
+  <!-- * that would otherwise be generated by the .HP macro -->
   <xsl:if test="preceding-sibling::*[1][self::synopfragment]">
     <xsl:call-template name="pinch.together"/>
   </xsl:if>
@@ -221,7 +221,7 @@
 <!-- *           Note about boldface in funcprototype output -->
 <!-- * ***************************************************************** -->
 <!-- * All funcprototype content is by default rendered in bold, -->
-<!-- * because the man(7) man page says this: -->
+<!-- * because the old man(7) man page, now man-pages(7) says this: -->
 <!-- * -->
 <!-- *   For functions, the arguments are always specified using -->
 <!-- *   italics, even in the SYNOPSIS section, where the rest of -->