From: Michael Smith <xmldoc@users.sourceforge.net>
Date: Tue, 12 Jul 2005 10:37:47 +0000 (+0000)
Subject: Added support for suppressing hyphenation of "computer inlines"
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=b3365db3d970cb1a8e243568f301eef59dfefdb3;p=docbook-dsssl

Added support for suppressing hyphenation of "computer inlines"
and filenames and URLs. More details to follow with param
checkins.
---

diff --git a/xsl/manpages/inline.xsl b/xsl/manpages/inline.xsl
index 776a96dc9..7734e2d49 100644
--- a/xsl/manpages/inline.xsl
+++ b/xsl/manpages/inline.xsl
@@ -13,16 +13,43 @@
 
      ******************************************************************** -->
 
+<xsl:param name="man.hyphenate.computer.inlines">0</xsl:param>
+<xsl:param name="man.hyphenate.filenames">0</xsl:param>
+<xsl:param name="man.hyphenate.urls">0</xsl:param>
+
 <!-- ==================================================================== -->
 
-<xsl:template match="filename|replaceable|varname">
+<xsl:template match="replaceable|varname">
+  <xsl:if test="$man.hyphenate.computer.inlines = 0">
+    <xsl:call-template name="suppress.hyphenation"/>
+  </xsl:if>
   <xsl:apply-templates mode="italic" select="."/>
 </xsl:template>
 
 <xsl:template match="option|userinput|envar|errorcode|constant|type">
+  <xsl:if test="$man.hyphenate.computer.inlines = 0">
+    <xsl:call-template name="suppress.hyphenation"/>
+  </xsl:if>
   <xsl:apply-templates mode="bold" select="."/>
 </xsl:template>
 
+<xsl:template match="classname">
+  <xsl:if test="$man.hyphenate.computer.inlines = 0">
+    <xsl:call-template name="suppress.hyphenation"/>
+  </xsl:if>
+  <xsl:apply-templates/>
+</xsl:template>
+
+<xsl:template match="filename">
+  <!-- * add hyphenation suppression in Filename output only if -->
+  <!-- * break.after.slash is also non-zero -->
+  <xsl:if test="$man.hyphenate.filenames = 0 and
+                $man.break.after.slash = 0">
+    <xsl:call-template name="suppress.hyphenation"/>
+  </xsl:if>
+  <xsl:apply-templates mode="italic" select="."/>
+</xsl:template>
+
 <xsl:template match="emphasis">
   <xsl:choose>
     <xsl:when test="@role = 'bold' or @role = 'strong'">
diff --git a/xsl/manpages/links.xsl b/xsl/manpages/links.xsl
index 88d0212be..10c2bed52 100644
--- a/xsl/manpages/links.xsl
+++ b/xsl/manpages/links.xsl
@@ -127,8 +127,16 @@
         <xsl:apply-templates/>
       </xsl:when>
       <xsl:otherwise>
-        <!-- * the element is empty, so we just get the value of the URL; -->
+        <!-- * The element is empty, so we just get the value of the URL; -->
         <!-- * note that we don't number empty links -->
+        <!-- * -->
+        <!-- * Add hyphenation suppression in URL output only if -->
+        <!-- * break.after.slash is also non-zero -->
+        <xsl:if test="$man.hyphenate.urls = 0 and
+                      $man.break.after.slash = 0">
+          <xsl:call-template name="suppress.hyphenation"/>
+          <xsl:text>\%</xsl:text>
+        </xsl:if>
         <xsl:value-of select="$url"/>
       </xsl:otherwise>
     </xsl:choose>
@@ -154,9 +162,31 @@
     <!-- * formatting could be made user-configurable - something -->
     <!-- * other than square brackets. But what else would work? -->
     <!-- * <10> Angle brackets? {10} Braces? -->
-    <xsl:text>[</xsl:text> 
+    <xsl:text>[</xsl:text>
     <xsl:value-of select="$link.number"/>
-    <xsl:text>]</xsl:text>
+    <xsl:text>]\&amp;</xsl:text>
+    <!-- * Note that the reason for the \& after the closing bracket -->
+    <!-- * is to prevent a hyphen character from being rendered -->
+    <!-- * between the closing bracket and the following text - even -->
+    <!-- * when the following text is preceded by a "hyphenation -->
+    <!-- * character"; for example: -->
+    <!-- * -->
+    <!-- *  [26]\&\fI\%COUNTRY\fR\fR -->
+    <!-- * -->
+    <!-- * Where COUNTRY is marked up with as <envar>COUNTRY</envar> -->
+    <!-- * in the source (we generate \% before all Envar output (and -->
+    <!-- * all other "computer inlines") to prevent it from being -->
+    <!-- * broken across lines. -->
+    <!-- * -->
+    <!-- * Without the \& after the closing bracket, if the -->
+    <!-- * [26]\fI\%COUNTRY\fR\fR instance fell at the end of a line, -->
+    <!-- * a hyphen could end up being inserted; for example: -->
+    <!-- * -->
+    <!-- *   if you are uncertain, check the value of the [26]- -->
+    <!-- *   COUNTRY environment variable -->
+    <!-- * -->
+    <!-- * The \& causes [26]COUNTRY to be treated as a unit, -->
+    <!-- * preventing insertion of the stray hyphen. -->
   </xsl:if>
   <xsl:choose>
     <!-- * if user wants links underlined, underline (ital) it -->
@@ -321,6 +351,13 @@
     <xsl:text>&#10;</xsl:text>
     <xsl:text>.br&#10;</xsl:text>
     <!-- * Print the link's URL -->
+    <!-- * Add hyphenation suppression in URL output only if -->
+    <!-- * break.after.slash is also non-zero -->
+    <xsl:if test="$man.hyphenate.urls = 0 and
+                  $man.break.after.slash = 0">
+      <xsl:call-template name="suppress.hyphenation"/>
+      <xsl:text>\%</xsl:text>
+    </xsl:if>
     <xsl:value-of select="@url"/>
     <xsl:text>&#10;</xsl:text>
   </xsl:for-each>
diff --git a/xsl/manpages/synop.xsl b/xsl/manpages/synop.xsl
index 92e59bfd0..edd1210eb 100644
--- a/xsl/manpages/synop.xsl
+++ b/xsl/manpages/synop.xsl
@@ -97,14 +97,17 @@
 </xsl:template>
 
 <xsl:template match="command">
+  <xsl:call-template name="suppress.hyphenation"/>
   <xsl:apply-templates mode="bold" select="."/>
 </xsl:template>
 
 <xsl:template match="function[not(ancestor::command)]">
+  <xsl:call-template name="suppress.hyphenation"/>
   <xsl:apply-templates mode="bold" select="."/>
 </xsl:template>
 
 <xsl:template match="parameter[not(ancestor::command)]">
+  <xsl:call-template name="suppress.hyphenation"/>
   <xsl:apply-templates mode="italic" select="."/>
 </xsl:template>
 
diff --git a/xsl/manpages/utility.xsl b/xsl/manpages/utility.xsl
index 1a2613be5..3d5dd6559 100644
--- a/xsl/manpages/utility.xsl
+++ b/xsl/manpages/utility.xsl
@@ -88,6 +88,19 @@
 
   <!-- ================================================================== -->
 
+  <xsl:template name="suppress.hyphenation">
+    <!-- * we need to suppress hyphenation inline only if hyphenation is -->
+    <!-- * actually on, and even then only outside of Cmdsynopsis and -->
+    <!-- * Funcsynopsis, where it is already always turned off -->
+    <xsl:if test="$man.hyphenate != 0 and
+                  not(ancestor::cmdsynopsis) and
+                  not(ancestor::funcsynopsis)">
+      <xsl:text>\%</xsl:text>
+    </xsl:if>
+  </xsl:template>
+
+  <!-- ================================================================== -->
+
   <!-- * The nested-section-title template is called for refsect3, and any -->
   <!-- * refsection nested more than 2 levels deep, and for formalpara. -->
   <xsl:template name="nested-section-title">