From 18fe9a097cf390561795bd8e4a039d3e069f510b Mon Sep 17 00:00:00 2001
From: Michael Smith <xmldoc@users.sourceforge.net>
Date: Mon, 13 Mar 2006 15:15:36 +0000
Subject: [PATCH] Provide support for adjusting default indent.  Problem:: By
 default, man pages are output with a indent of 8 characters. That's a lot of
 wasted space that might better be used -- especially in cases where the
 content verbatim stuff that has long lines. Change:: Added support for
 customizing the roff "default indentation value" (value of IN register)
 man.indentation.default.adjust (boolean) and man.indentation.default.value
 params (number, 3n by default). Also made some adjustments to get better
 formatting of sub-subsection titles even without adjusting default
 indentation.

---
 xsl/manpages/docbook.xsl  |  6 ++-
 xsl/manpages/lists.xsl    |  3 --
 xsl/manpages/other.xsl    | 13 +++++-
 xsl/manpages/refentry.xsl | 92 ++++++++++++++++++++++++++++++++++++---
 4 files changed, 102 insertions(+), 12 deletions(-)

diff --git a/xsl/manpages/docbook.xsl b/xsl/manpages/docbook.xsl
index d2aa817f7..da8889bc6 100644
--- a/xsl/manpages/docbook.xsl
+++ b/xsl/manpages/docbook.xsl
@@ -39,6 +39,9 @@
 
   <xsl:param name="generate.manifest">0</xsl:param>
   <xsl:param name="man.manifest.filename">MANIFEST.man</xsl:param>
+  <xsl:param name="man.segtitle.suppress">0</xsl:param>
+  <xsl:param name="man.indentation.default.adjust">1</xsl:param>
+  <xsl:param name="man.indentation.default.value">3n</xsl:param>
 
 <!-- ==================================================================== -->
 
@@ -158,7 +161,8 @@
         <xsl:with-param name="extra3"  select="$refentry.metadata/manual"/>
       </xsl:call-template>
       <!-- * - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
-      <!-- * Set default hyphenation, justification, and line-breaking -->
+      <!-- * Set default hyphenation, justification, indentation, and -->
+      <!-- * line-breaking -->
       <!-- * - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
       <xsl:call-template name="set.default.formatting"/>
       <!-- * - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
diff --git a/xsl/manpages/lists.xsl b/xsl/manpages/lists.xsl
index 28bfd2ae9..e58e47bd4 100644
--- a/xsl/manpages/lists.xsl
+++ b/xsl/manpages/lists.xsl
@@ -11,9 +11,6 @@
      copyright and other information.
 
      ******************************************************************** -->
-<!-- * FIXME: need to document the following parameter -->
-<xsl:param name="man.segtitle.suppress">0</xsl:param>
-
 <xsl:template match="para[ancestor::listitem or ancestor::step or ancestor::glossdef]|
 	             simpara[ancestor::listitem or ancestor::step or ancestor::glossdef]|
 		     remark[ancestor::listitem or ancestor::step or ancestor::glossdef]">
diff --git a/xsl/manpages/other.xsl b/xsl/manpages/other.xsl
index 08f5a5657..a83d540b0 100644
--- a/xsl/manpages/other.xsl
+++ b/xsl/manpages/other.xsl
@@ -196,7 +196,8 @@
   <!-- ============================================================== -->
 
   <xsl:template name="set.default.formatting">
-    <!-- * Set default hyphenation, justification, and line-breaking -->
+    <!-- * Set default hyphenation, justification, indentation and -->
+    <!-- * line-breaking -->
     <!-- * -->
     <!-- * If the value of man.hypenate is zero (the default), then -->
     <!-- * disable hyphenation (".nh" = "no hyphenation") -->
@@ -211,6 +212,16 @@
       <xsl:text> (adjust text to left margin only)&#10;</xsl:text>
       <xsl:text>.ad l&#10;</xsl:text>
     </xsl:if>
+    <xsl:if test="$man.indentation.default.adjust != 0">
+      <xsl:text>.\" store initial "default indentation value"&#10;</xsl:text>
+      <xsl:text>.nr zq \n(IN&#10;</xsl:text>
+      <xsl:text>.\" adjust default indentation&#10;</xsl:text>
+      <xsl:text>.nr IN </xsl:text>
+      <xsl:value-of select="$man.indentation.default.value"/>
+      <xsl:text>&#10;</xsl:text>
+      <xsl:text>.\" adjust indentation of SS headings&#10;</xsl:text>
+      <xsl:text>.nr SN \n(IN&#10;</xsl:text>
+    </xsl:if>
     <!-- * Unless the value of man.break.after.slash is zero (the -->
     <!-- * default), tell groff that it is OK to break a line -->
     <!-- * after a slash when needed. -->
diff --git a/xsl/manpages/refentry.xsl b/xsl/manpages/refentry.xsl
index 53e0e6b02..a9dbde6bb 100644
--- a/xsl/manpages/refentry.xsl
+++ b/xsl/manpages/refentry.xsl
@@ -81,21 +81,99 @@
 
   <xsl:template match="refsect2|refentry/refsection/refsection">
     <xsl:call-template name="mark.subheading"/>
+    <xsl:variable name="title">
+      <xsl:value-of select="(info/title
+                            |refsectioninfo/title
+                            |refsect1info/title
+                            |title)[1]"/>
+    </xsl:variable>
     <xsl:text>.SS "</xsl:text>
-    <xsl:value-of select="(info/title
-                          |refsectioninfo/title
-                          |refsect1info/title
-                          |title)[1]"/>
+    <xsl:value-of select="$title"/>
     <xsl:text>"&#10;</xsl:text>
     <xsl:call-template name="mark.subheading"/>
-    <xsl:apply-templates/>
+    <xsl:choose>
+      <!-- * If default-indentation adjustment is on, then indent the -->
+      <!-- * child content of this Refsect2 -->
+      <xsl:when test="$man.indentation.default.adjust != 0">
+        <xsl:text>.RS&#10;</xsl:text>
+        <xsl:apply-templates/>
+        <xsl:text>.RE&#10;</xsl:text>
+      </xsl:when>
+      <xsl:otherwise>
+        <!-- * If default-indentation adjustment is on, then do not -->
+        <!-- * indent the child content of thie Refsect2, because -->
+        <!-- * the title is already "sticking out to the left" -->
+        <!-- * (as the groff_man(7) man page describes it), which -->
+        <!-- * actually means the title is indented by the value of -->
+        <!-- * the SN register, which appears by default to be -->
+        <!-- * about half of the default indentation value -->
+        <xsl:apply-templates/>
+      </xsl:otherwise>
+    </xsl:choose>
+    <xsl:text>.\" end of SS subsection "</xsl:text>
+    <xsl:value-of select="$title"/>
+    <xsl:text>"&#10;</xsl:text>
   </xsl:template>
 
-  <xsl:template match="refsect3|refsection">
+  <xsl:template match="refsect3|refentry/refsection/refsection/refsection">
+    <xsl:variable name="title">
+      <xsl:value-of select="(info/title
+                            |refsectioninfo/title
+                            |refsect1info/title
+                            |title)[1]"/>
+    </xsl:variable>
+    <xsl:choose>
+      <!-- * If default-indentation adjustment is on, then indent the -->
+      <!-- * child content of this Refsect3 or Refsection. -->
+      <xsl:when test="$man.indentation.default.adjust != 0">
+        <xsl:call-template name="nested-section-title"/>
+        <xsl:text>.RS&#10;</xsl:text>
+        <xsl:apply-templates/>
+        <xsl:text>.RE&#10;</xsl:text>
+      </xsl:when>
+      <xsl:otherwise>
+        <!-- * If default-indentation adjustment is on, then do not -->
+        <!-- * indent the child content of thie Refsect2, because -->
+        <!-- * the title is already "sticking out to the left" -->
+        <!-- * (as the groff_man(7) man page describes it), which -->
+        <!-- * actually means the title is indented by the value of -->
+        <!-- * the SN register, which appears by default to be -->
+        <!-- * about half of the default indentation value -->
+        <xsl:text>.ti (\n(SNu * 5u / 3u)&#10;</xsl:text>
+        <xsl:call-template name="nested-section-title"/>
+        <xsl:apply-templates/>
+      </xsl:otherwise>
+    </xsl:choose>
+    <xsl:text>.\" end of subsection "</xsl:text>
+    <xsl:value-of select="$title"/>
+    <xsl:text>"&#10;</xsl:text>
+  </xsl:template>
+
+  <xsl:template match="refsection">
+    <!-- * This template is used for a nested Refsection that is -->
+    <!-- * is a child of a Refsect3-level section (The numberd -->
+    <!-- * Refsect hierarchy in DocBook ends with Refsect3, so -->
+    <!-- * there is not actually a Refsect4 element.) -->
+    <xsl:variable name="title">
+      <xsl:value-of select="(info/title
+                            |refsectioninfo/title
+                            |refsect1info/title
+                            |title)[1]"/>
+    </xsl:variable>
+    <xsl:variable name="indent-width">
+      <xsl:if test="$man.indentation.default.adjust != 0">
+        <!-- * If default-indentation adjustment is on, then indent the -->
+        <!-- * child content of this Refsect3 or Refsection. -->
+        <xsl:text>(\n(SNu)&#10;</xsl:text>
+      </xsl:if>
+    </xsl:variable>
     <xsl:call-template name="nested-section-title"/>
-    <xsl:text>.RS 3&#10;</xsl:text>
+    <xsl:text>.RS (\n(SNu)&#10;</xsl:text>
     <xsl:apply-templates/>
     <xsl:text>.RE&#10;</xsl:text>
+    <xsl:text>.\" end of subsection "</xsl:text>
+    <xsl:value-of select="$title"/>
+    <xsl:text>"&#10;</xsl:text>
   </xsl:template>
 
   <!-- ==================================================================== -->
-- 
2.40.0