From 4f46ce477e09e5f14ee8c90a9e42e06382fafc28 Mon Sep 17 00:00:00 2001
From: Michael Smith <xmldoc@users.sourceforge.net>
Date: Tue, 14 Jun 2005 11:03:40 +0000
Subject: [PATCH] Created an other.xsl file and moved some templates into it.

---
 xsl/manpages/docbook.xsl | 192 +++++++++++----------------------------
 xsl/manpages/other.xsl   | 128 ++++++++++++++++++++++++++
 2 files changed, 183 insertions(+), 137 deletions(-)
 create mode 100644 xsl/manpages/other.xsl

diff --git a/xsl/manpages/docbook.xsl b/xsl/manpages/docbook.xsl
index 7f7446dba..b49169337 100644
--- a/xsl/manpages/docbook.xsl
+++ b/xsl/manpages/docbook.xsl
@@ -20,12 +20,12 @@
   <xsl:include href="param.xsl"/>
   <xsl:include href="general.xsl"/>
   <xsl:include href="info.xsl"/>
+  <xsl:include href="other.xsl"/>
   <xsl:include href="refentry.xsl"/>
   <xsl:include href="block.xsl"/>
   <xsl:include href="inline.xsl"/>
   <xsl:include href="synop.xsl"/>
   <xsl:include href="lists.xsl"/>
-  <xsl:include href="xref.xsl"/>
 
   <!-- * Needed for chunker.xsl (for now): -->
   <xsl:param name="chunker.output.method" select="'text'"/>
@@ -88,152 +88,70 @@
     </xsl:variable>
     <xsl:variable name="metadata" select="exsl:node-set($get.metadata)"/>
 
+    <!-- * Assemble the various parts into a complete page, then store into -->
+    <!-- * $page.contents so that we can manipluate further. -->
+    <xsl:variable name="page.contents">
+      <!-- * top.comment = commented-out section at top of roff source -->
+      <xsl:call-template name="top.comment"/>
+      <!-- * TH.title.line = title line in header/footer of man page -->
+      <xsl:call-template name="TH.title.line">
+        <!-- * .TH "TITLE" "SECTION" "extra1" "extra2" "extra3" -->
+        <!-- *  -->
+        <!-- * extra1 = date of publication of the man page (almost universally) -->
+        <!-- * extra2 = version and/or name of some kind (usually) -->
+        <!-- * extra3 = context description (e.g., often a description of the -->
+        <!-- *          group of related applications that the item documented -->
+        <!-- *          in the man page belongs to -->
+        <!-- * -->
+        <!-- * .TH TITLE SECTION DATE VERSION/NAME CONTEXT -->
+        <!-- * -->
+        <!-- * If you want to chenge how the .TH line is constructed, change the -->
+        <!-- * order/content of the values of the "select" attributes below. -->
+        <xsl:with-param name="title"   select="$metadata/title"/>
+        <xsl:with-param name="section" select="$metadata/section"/>
+        <xsl:with-param name="extra1"  select="$metadata/date"/>
+        <xsl:with-param name="extra2"  select="$metadata/versionorname"/>
+        <xsl:with-param name="extra3"  select="$metadata/othermetadata"/>
+      </xsl:call-template>
+      <!-- * main body of man page -->
+      <xsl:apply-templates/>
+      <!-- * AUTHOR section (at end of man page) -->
+      <xsl:call-template name="author.section">
+        <xsl:with-param name="info" select="$info"/>
+        <xsl:with-param name="parentinfo" select="$parentinfo"/>
+      </xsl:call-template>
+    </xsl:variable>
+
+    <!-- * Prepare the page contents for final output, then store in -->
+    <!-- * $page.contents.prepared so the we can pass it on to the -->
+    <!-- * write.text.chunk() function -->
+    <xsl:variable name="page.contents.prepared">
+      <!-- * "Preparing" the page contents involves, at a minimum, -->
+      <!-- * converting our internal @dot@, @esc & @dash@ pseudo-markup -->
+      <!-- * into real roff; that is: literal . and \ and - characters. -->
+      <!-- * -->
+      <!-- * If $charmap.enabled is true, "preparing" the page contents also -->
+      <!-- * involves applying a character map to convert Unicode symbols and -->
+      <!-- * special characters into corresponding roff escape sequences. -->
+      <xsl:call-template name="prepare.page.contents">
+        <xsl:with-param name="content" select="$page.contents"/>
+      </xsl:call-template>
+    </xsl:variable>
+    
+    <!-- * At last: Write the prepared page contents to disk to create -->
+    <!-- * the final man page. -->
     <xsl:call-template name="write.text.chunk">
       <xsl:with-param name="filename" select="$metadata/filename"/>
-      <xsl:with-param name="content">
-
-        <!-- * top.comment = commented-out section at top of roff source -->
-        <xsl:call-template name="top.comment"/>
-        
-        <!-- * TH.title.line = title line in header/footer of man page -->
-        <xsl:call-template name="TH.title.line">
-
-          <!-- * .TH "TITLE" "SECTION" "extra1" "extra2" "extra3" -->
-          <!-- *  -->
-          <!-- * extra1 = date of publication of the man page (almost universally) -->
-          <!-- * extra2 = version and/or name of some kind (usually) -->
-          <!-- * extra3 = context description (e.g., often a description of the -->
-          <!-- *          group of related applications that the item documented -->
-          <!-- *          in the man page belongs to -->
-          <!-- * -->
-          <!-- * .TH TITLE SECTION DATE VERSION/NAME CONTEXT -->
-          <!-- * -->
-          <!-- * If you want to chenge how the .TH line is constructed, change the -->
-          <!-- * order/content of the values of the "select" attributes below. -->
-
-          <xsl:with-param name="title" select="$metadata/title"/>
-          <xsl:with-param name="section" select="$metadata/section"/>
-          <xsl:with-param name="extra1" select="$metadata/date"/>
-          <xsl:with-param name="extra2" select="$metadata/versionorname"/>
-          <xsl:with-param name="extra3" select="$metadata/othermetadata"/>
-        </xsl:call-template>
-        
-        <!-- * main body of man page -->
-        <xsl:apply-templates/>
-
-        <!-- * AUTHOR section (at end of man page) -->
-        <xsl:call-template name="author.section">
-          <xsl:with-param name="info" select="$info"/>
-          <xsl:with-param name="parentinfo" select="$parentinfo"/>
-        </xsl:call-template>
-        
-      </xsl:with-param>
+      <xsl:with-param name="content" select="$page.contents.prepared"/>
     </xsl:call-template>
 
-    <!-- generate "stub" pages (if any) -->
+    <!-- * Finish up by generating "stub" (alias) pages (if any needed) -->
     <xsl:call-template name="write.stubs">
       <xsl:with-param name="metadata" select="$metadata"/>
     </xsl:call-template>
 
   </xsl:template>
 
-  <!-- * ============================================================== -->
-  <!-- * -->
-  <!-- * top comment     comment part at top of roff source; unrendered -->
-  <!-- * TH title line   rendererd "title" lines in header/footer of page -->
-  <!-- * -->
-  <!-- * ============================================================== -->
-
-  <xsl:template name="top.comment">
-    <xsl:text>.\" Generated by: DocBook XSL Stylesheets V</xsl:text>
-    <xsl:value-of select="$VERSION"/>
-    <xsl:text>&#10;</xsl:text>
-    <xsl:text>.\"       ** Do not edit this file **&#10;</xsl:text>
-    <xsl:text>.\" Instead, edit the DocBook XML source and then use the&#10;</xsl:text>
-    <xsl:text>.\" DocBook XSL Stylesheets to regenerate this.&#10;</xsl:text>
-  </xsl:template>
-
-  <xsl:template name="TH.title.line">
-    
-    <!-- * FYI: Here is how the .TH contents show up in a rendered man page: -->
-    <!-- * -->
-    <!-- *   title(section)      extra3      title(section)  <- page header -->
-    <!-- * -->
-    <!-- *   extra2              extra1      title(section)  <- page footer-->
-    <!-- * -->
-    <!-- * Note the while extra1, extra2, and extra3 are all optional, almost all -->
-    <!-- * pages include an "extra1", which is almost always a date. -->
-
-    <!-- * Here are a couple of examples of real-world man pages that have -->
-    <!-- * useful page headers/footers: -->
-    <!-- * -->
-    <!-- *   GIMP(1)           GIMP Manual Pages           GIMP(1) -->
-    <!-- *   Version 2.2.6     March 23 2004               GIMP(1) -->
-    <!-- * -->
-    <!-- *   QT2KDOC(1)        KDOC Documentation System   QT2KDOC(1) -->
-    <!-- *   2.0a54            2002-03-18                  QT2KDOC(1) -->
-    <!-- * -->
-    <!-- * In those examples, extra2 has version data, while extra3 has "context" -->
-    <!-- * data about some larger system the documented item belongs to -->
-
-    <xsl:param name="title"/>
-    <xsl:param name="section"/>
-    <xsl:param name="extra1"/>
-    <xsl:param name="extra2"/>
-    <xsl:param name="extra3"/>
-
-    <!-- * FIXME: th.title.max.length needs to be made into a documented -->
-    <!-- * user-configurable parameter -->
-    <xsl:variable name="th.title.max.length" select="'20'"/>
-
-    <xsl:text>.TH "</xsl:text>
-    <xsl:value-of select="translate(
-                          substring($title, 1, $th.title.max.length),
-                          'abcdefghijklmnopqrstuvwxyz',
-                          'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
-                          )"/>
-    <xsl:text>" </xsl:text>
-    <xsl:value-of select="$section"/>
-    <xsl:text> "</xsl:text>
-    <xsl:value-of select="normalize-space($extra1)"/>
-    <xsl:text>" "</xsl:text>
-    <xsl:value-of select="normalize-space($extra2)"/>
-    <xsl:text>" "</xsl:text>
-    <xsl:value-of select="normalize-space($extra3)"/>
-    <xsl:text>"&#10;</xsl:text>
-  </xsl:template>
-
-  <!-- ============================================================== -->
-
-  <!-- A "stub" is sort of alias for another file - it's simply a file whose -->
-  <!-- complete contents are just a single line of the following form: -->
-  <!-- * -->
-  <!-- *  .so manX/realname.X -->
-  <!-- * -->
-  <!-- * "realname" is a name of another man-page file. That .so line is -->
-  <!-- * basically a *roff "include" statement.  When the man command finds it, -->
-  <!-- * it includes and displays the contents of the manX/realqname.X file. -->
-  <!-- * -->
-  <!-- * If a refentry has multiple refnames, we generate a "stub" page for -->
-  <!-- * additional refname found. -->
-
-  <xsl:template name="write.stubs">
-    <xsl:param name="metadata"/>
-    <xsl:for-each select="refnamediv/refname">
-      <xsl:if test=". != $metadata/name">
-        <xsl:call-template name="write.text.chunk">
-          <xsl:with-param name="filename"
-                          select="concat(normalize-space(.), '.',
-                                  $metadata/section)"/>
-          <xsl:with-param
-              name="content"
-              select="concat('.so man', $metadata/section, '/',
-                      $metadata/name, '.', $metadata/section, '&#10;')"/>
-        </xsl:call-template>
-      </xsl:if>
-    </xsl:for-each>
-  </xsl:template>
-
   <!-- ============================================================== -->
 
   <xsl:template match="refmeta"></xsl:template>
diff --git a/xsl/manpages/other.xsl b/xsl/manpages/other.xsl
new file mode 100644
index 000000000..0e3315e1a
--- /dev/null
+++ b/xsl/manpages/other.xsl
@@ -0,0 +1,128 @@
+<?xml version='1.0'?>
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+                version='1.0'>
+
+<!-- ********************************************************************
+     $Id$
+     ********************************************************************
+
+     This file is part of the XSL DocBook Stylesheet distribution.
+     See ../README or http://docbook.sf.net/release/xsl/current/ for
+     copyright and other information.
+
+     ******************************************************************** -->
+
+<!-- * This file contains named templates for generating content other than -->
+<!-- * what appears in the main text flow of each man page. This "other" -->
+<!-- * stuff currently amounts to: -->
+<!-- * -->
+<!-- *  - a commented-out section in top part of roff source of each page -->
+<!-- *  - the .TH title line for controlling the page header/footer -->
+<!-- *  - any related "stub" pages (which end up getting read by soelim(1) -->
+
+<!-- ==================================================================== -->
+
+  <xsl:template name="top.comment">
+    <xsl:text>@dot@@esc@" ** You probably do not want to</xsl:text>
+    <xsl:text> edit this file directly **&#10;</xsl:text>
+    <xsl:text>@dot@@esc@" It was generated using the DocBook</xsl:text>
+    <xsl:text> XSL Stylesheets (version </xsl:text>
+    <xsl:call-template name="string.subst">
+      <xsl:with-param name="string" select="$VERSION" />
+      <xsl:with-param name="target" select="'.'" />
+      <xsl:with-param name="replacement" select="'@dot@'" />
+    </xsl:call-template>
+    <xsl:text>)@dot@</xsl:text>
+    <xsl:text>&#10;</xsl:text>
+    <xsl:text>@dot@@esc@" Instead of manually editing it, you</xsl:text>
+    <xsl:text> probably should edit the DocBook XML&#10;</xsl:text>
+    <xsl:text>@dot@@esc@" source for it and then use the DocBook</xsl:text>
+    <xsl:text> XSL Stylesheets to regenerate it@dot@&#10;</xsl:text>
+  </xsl:template>
+
+<!-- ==================================================================== -->
+
+  <xsl:template name="TH.title.line">
+    
+    <!-- * FYI: Here is how the .TH contents show up in a rendered man page: -->
+    <!-- * -->
+    <!-- *   title(section)      extra3      title(section)  <- page header -->
+    <!-- * -->
+    <!-- *   extra2              extra1      title(section)  <- page footer-->
+    <!-- * -->
+    <!-- * Note the while extra1, extra2, and extra3 are all optional, almost all -->
+    <!-- * pages include an "extra1", which is almost always a date. -->
+
+    <!-- * Here are a couple of examples of real-world man pages that have -->
+    <!-- * useful page headers/footers: -->
+    <!-- * -->
+    <!-- *   GIMP(1)           GIMP Manual Pages           GIMP(1) -->
+    <!-- *   Version 2.2.6     March 23 2004               GIMP(1) -->
+    <!-- * -->
+    <!-- *   QT2KDOC(1)        KDOC Documentation System   QT2KDOC(1) -->
+    <!-- *   2.0a54            2002-03-18                  QT2KDOC(1) -->
+    <!-- * -->
+    <!-- * In those examples, extra2 has version data, while extra3 has "context" -->
+    <!-- * data about some larger system the documented item belongs to -->
+
+    <xsl:param name="title"/>
+    <xsl:param name="section"/>
+    <xsl:param name="extra1"/>
+    <xsl:param name="extra2"/>
+    <xsl:param name="extra3"/>
+
+    <!-- * FIXME: th.title.max.length needs to be made into a documented -->
+    <!-- * user-configurable parameter -->
+    <xsl:variable name="th.title.max.length" select="'20'"/>
+
+    <xsl:text>@dot@TH "</xsl:text>
+    <xsl:value-of select="translate(
+                          substring($title, 1, $th.title.max.length),
+                          'abcdefghijklmnopqrstuvwxyz',
+                          'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
+                          )"/>
+    <xsl:text>" </xsl:text>
+    <xsl:value-of select="$section"/>
+    <xsl:text> "</xsl:text>
+    <xsl:value-of select="normalize-space($extra1)"/>
+    <xsl:text>" "</xsl:text>
+    <xsl:value-of select="normalize-space($extra2)"/>
+    <xsl:text>" "</xsl:text>
+    <xsl:value-of select="normalize-space($extra3)"/>
+    <xsl:text>"&#10;</xsl:text>
+  </xsl:template>
+
+  <!-- ============================================================== -->
+
+  <!-- * A "stub" is sort of alias for another file, intended to be read -->
+  <!-- * and expanded by soelim(1); it's simply a file whose complete -->
+  <!-- * contents are just a single line of the following form: -->
+  <!-- * -->
+  <!-- *  .so manX/realname.X -->
+  <!-- * -->
+  <!-- * "realname" is a name of another man-page file. That .so line is -->
+  <!-- * basically a *roff "include" statement.  When the man command finds -->
+  <!-- * it, it calls soelim(1) (I think) and includes and displays the -->
+  <!-- * contents of the manX/realqname.X file. -->
+  <!-- * -->
+  <!-- * If a refentry has multiple refnames, we generate a "stub" page for -->
+  <!-- * each additional refname found. -->
+
+  <xsl:template name="write.stubs">
+    <xsl:param name="metadata"/>
+    <xsl:for-each select="refnamediv/refname">
+      <xsl:if test=". != $metadata/name">
+        <xsl:call-template name="write.text.chunk">
+          <xsl:with-param name="filename"
+                          select="concat(normalize-space(.), '.',
+                                  $metadata/section)"/>
+          <xsl:with-param
+              name="content"
+              select="concat('.so man', $metadata/section, '/',
+                      $metadata/name, '.', $metadata/section, '&#10;')"/>
+        </xsl:call-template>
+      </xsl:if>
+    </xsl:for-each>
+  </xsl:template>
+
+</xsl:stylesheet>
-- 
2.40.0