From: Norman Walsh <ndw@nwalsh.com>
Date: Thu, 21 Jun 2001 13:38:34 +0000 (+0000)
Subject: Use common code to calculate step numbers; support xref to procedures and steps;... 
X-Git-Tag: release/1.79.1~6^2~6458
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=2ea37f2fcf79989eda546d326f1a605c405ed18d;p=docbook-dsssl

Use common code to calculate step numbers; support xref to procedures and steps; added formal.procedures parameter
---

diff --git a/xsl/common/common.xsl b/xsl/common/common.xsl
index b9901a680..851a17ecb 100644
--- a/xsl/common/common.xsl
+++ b/xsl/common/common.xsl
@@ -994,6 +994,65 @@ pointed to by the link is one of the elements listed in
   </xsl:if>
 </xsl:template>
 
+<!-- ====================================================================== -->
+<!-- Procedure Step Numeration -->
+
+<xsl:param name="procedure.step.numeration.formats" select="'1aiAI'"/>
+
+<xsl:template name="procedure.step.numeration">
+  <xsl:param name="context" select="."/>
+  <xsl:variable name="format.length"
+                select="string-length($procedure.step.numeration.formats)"/>
+  <xsl:choose>
+    <xsl:when test="local-name($context) = 'substeps'">
+      <xsl:variable name="ssdepth"
+                    select="count($context/ancestor::substeps)"/>
+      <xsl:variable name="sstype" select="($ssdepth mod $format.length)+2"/>
+      <xsl:choose>
+        <xsl:when test="$sstype &gt; $format.length">
+          <xsl:value-of select="substring($procedure.step.numeration.formats,1,1)"/>
+        </xsl:when>
+        <xsl:otherwise>
+          <xsl:value-of select="substring($procedure.step.numeration.formats,$sstype,1)"/>
+        </xsl:otherwise>
+      </xsl:choose>
+    </xsl:when>
+    <xsl:when test="local-name($context) = 'step'">
+      <xsl:variable name="sdepth"
+                    select="count($context/ancestor::substeps)"/>
+      <xsl:variable name="stype" select="($sdepth mod $format.length)+1"/>
+      <xsl:value-of select="substring($procedure.step.numeration.formats,$stype,1)"/>
+    </xsl:when>
+    <xsl:otherwise>
+      <xsl:message>
+        <xsl:text>Unexpected context in procedure.step.numeration: </xsl:text>
+        <xsl:value-of select="local-name($context)"/>
+      </xsl:message>
+    </xsl:otherwise>
+  </xsl:choose>
+</xsl:template>
+
+<xsl:template match="step" mode="number">
+  <xsl:param name="rest" select="''"/>
+  <xsl:param name="recursive" select="1"/>
+  <xsl:variable name="format">
+    <xsl:call-template name="procedure.step.numeration"/>
+  </xsl:variable>
+  <xsl:variable name="num">
+    <xsl:number count="step" format="{$format}"/>
+  </xsl:variable>
+  <xsl:choose>
+    <xsl:when test="$recursive != 0 and ancestor::step">
+      <xsl:apply-templates select="ancestor::step[1]" mode="number">
+        <xsl:with-param name="rest" select="concat('.', $num, $rest)"/>
+      </xsl:apply-templates>
+    </xsl:when>
+    <xsl:otherwise>
+      <xsl:value-of select="concat($num, $rest)"/>
+    </xsl:otherwise>
+  </xsl:choose>
+</xsl:template>
+
 <!-- ====================================================================== -->
 
 </xsl:stylesheet>
diff --git a/xsl/common/gentext.xsl b/xsl/common/gentext.xsl
index ec3f9a3b3..b62b66fe4 100644
--- a/xsl/common/gentext.xsl
+++ b/xsl/common/gentext.xsl
@@ -31,6 +31,23 @@
   </xsl:choose>
 </xsl:template>
 
+<xsl:template match="procedure" mode="object.title.template">
+  <xsl:choose>
+    <xsl:when test="$formal.procedures != 0">
+      <xsl:call-template name="gentext.template">
+        <xsl:with-param name="context" select="'title'"/>
+        <xsl:with-param name="name" select="'procedure.formal'"/>
+      </xsl:call-template>
+    </xsl:when>
+    <xsl:otherwise>
+      <xsl:call-template name="gentext.template">
+        <xsl:with-param name="context" select="'title'"/>
+        <xsl:with-param name="name" select="local-name(.)"/>
+      </xsl:call-template>
+    </xsl:otherwise>
+  </xsl:choose>
+</xsl:template>
+
 <xsl:template match="article/appendix"
               mode="object.title.template">
   <!-- FIXME: HACK HACK HACK! -->
diff --git a/xsl/common/labels.xsl b/xsl/common/labels.xsl
index a19c23d50..9d534c910 100644
--- a/xsl/common/labels.xsl
+++ b/xsl/common/labels.xsl
@@ -460,7 +460,8 @@ element label.</para>
   </xsl:if>
 </xsl:template>
 
-<xsl:template match="figure|table|example|equation" mode="label.markup">
+<xsl:template match="figure|table|example|equation|procedure"
+              mode="label.markup">
   <xsl:variable name="pchap"
                 select="ancestor::chapter|ancestor::appendix"/>
 
diff --git a/xsl/common/titles.xsl b/xsl/common/titles.xsl
index 2c5e8c275..b915a12c5 100644
--- a/xsl/common/titles.xsl
+++ b/xsl/common/titles.xsl
@@ -254,6 +254,13 @@ title of the element. This does not include the label.
   </xsl:apply-templates>
 </xsl:template>
 
+<xsl:template match="procedure" mode="title.markup">
+  <xsl:param name="allow-anchors" select="'0'"/>
+  <xsl:apply-templates select="title" mode="title.markup">
+    <xsl:with-param name="allow-anchors" select="$allow-anchors"/>
+  </xsl:apply-templates>
+</xsl:template>
+
 <xsl:template match="abstract" mode="title.markup">
   <xsl:param name="allow-anchors" select="'0'"/>
   <xsl:choose>
diff --git a/xsl/fo/lists.xsl b/xsl/fo/lists.xsl
index bdfd9b0dc..9b29539fa 100644
--- a/xsl/fo/lists.xsl
+++ b/xsl/fo/lists.xsl
@@ -321,12 +321,14 @@
 <!-- ==================================================================== -->
 
 <xsl:template match="procedure">
+  <xsl:variable name="id"><xsl:call-template name="object.id"/></xsl:variable>
   <xsl:variable name="title" select="title"/>
   <xsl:variable name="preamble"
                 select="*[not(self::step or self::title)]"/>
   <xsl:variable name="steps" select="step"/>
 
-  <fo:block space-before.optimum="1em"
+  <fo:block id="{$id}"
+            space-before.optimum="1em"
             space-before.minimum="0.8em"
             space-before.maximum="1.2em">
     <xsl:if test="./title">
@@ -361,32 +363,13 @@
 </xsl:template>
 
 <xsl:template match="step">
-  <xsl:variable name="depth" select="count(ancestor::substeps)"/>
-  <xsl:variable name="type" select="$depth mod 5"/>
-
+  <xsl:variable name="id"><xsl:call-template name="object.id"/></xsl:variable>
   <fo:list-item>
     <fo:list-item-label end-indent="label-end()">
-      <fo:block>
-        <xsl:choose>
-          <xsl:when test="$depth = 0">
-            <xsl:number count="step" format="1."/>
-          </xsl:when>
-          <xsl:when test="$type = 1">
-            <xsl:number count="step" format="a."/>
-          </xsl:when>
-          <xsl:when test="$type = 2">
-            <xsl:number count="step" format="i."/>
-          </xsl:when>
-          <xsl:when test="$type = 3">
-            <xsl:number count="step" format="A."/>
-          </xsl:when>
-          <xsl:when test="$type = 4">
-            <xsl:number count="step" format="I."/>
-          </xsl:when>
-          <xsl:when test="$type = 0">
-            <xsl:number count="step" format="1."/>
-          </xsl:when>
-        </xsl:choose>
+      <fo:block id="{$id}">
+        <xsl:apply-templates select="." mode="number">
+          <xsl:with-param name="recursive" select="0"/>
+        </xsl:apply-templates>
       </fo:block>
     </fo:list-item-label>
     <fo:list-item-body start-indent="body-start()">
diff --git a/xsl/fo/param.xsl b/xsl/fo/param.xsl
index 903af931c..668af6d16 100644
--- a/xsl/fo/param.xsl
+++ b/xsl/fo/param.xsl
@@ -1177,5 +1177,16 @@ they will be numbered monotonically throughout each
 </refdescription>
 </doc:param>
 
+<!-- ==================================================================== -->
+<xsl:param name="formal.procedures" select="1" doc:type='boolean'/>
+
+<doc:param name="formal.procedures" xmlns="">
+<refpurpose>Selects formal or informal procedures</refpurpose>
+<refdescription>
+<para>Formal procedures are numbered and always hav a title.
+</para>
+</refdescription>
+</doc:param>
+
 </xsl:stylesheet>
 
diff --git a/xsl/fo/xref.xsl b/xsl/fo/xref.xsl
index d7dc41c3e..1a8e221e9 100644
--- a/xsl/fo/xref.xsl
+++ b/xsl/fo/xref.xsl
@@ -119,6 +119,10 @@
   <xsl:apply-templates select="." mode="object.xref.markup"/>
 </xsl:template>
 
+<xsl:template match="procedure" mode="xref-to">
+  <xsl:apply-templates select="." mode="object.xref.markup"/>
+</xsl:template>
+
 <xsl:template match="cmdsynopsis" mode="xref-to">
   <xsl:apply-templates select="(.//command)[1]" mode="xref"/>
 </xsl:template>
@@ -192,6 +196,14 @@
   <xsl:apply-templates select="." mode="object.xref.markup"/>
 </xsl:template>
 
+<xsl:template match="step" mode="xref-to">
+  <xsl:call-template name="gentext">
+    <xsl:with-param name="key" select="'Step'"/>
+  </xsl:call-template>
+  <xsl:text> </xsl:text>
+  <xsl:apply-templates select="." mode="number"/>
+</xsl:template>
+
 <xsl:template match="co" mode="xref-to">
   <xsl:apply-templates select="." mode="callout-bug"/>
 </xsl:template>
diff --git a/xsl/html/lists.xsl b/xsl/html/lists.xsl
index 7a9d1c359..f35cc7a58 100644
--- a/xsl/html/lists.xsl
+++ b/xsl/html/lists.xsl
@@ -404,16 +404,17 @@
 <!-- ==================================================================== -->
 
 <xsl:template match="procedure">
-  <xsl:variable name="id">
-    <xsl:call-template name="object.id"/>
-  </xsl:variable>
   <div class="{name(.)}">
-    <a name="{$id}"/>
-    <xsl:if test="title">
-      <xsl:apply-templates select="title" mode="procedure.title.mode"/>
+    <xsl:if test="title or $formal.procedures != 0">
+      <xsl:call-template name="formal.object.heading"/>
     </xsl:if>
-    <xsl:apply-templates select="*[local-name()!='step']"/>     
-    <ol><xsl:apply-templates select="step"/></ol>              
+    <xsl:apply-templates select="*[local-name()!='step']"/>
+    <ol>
+      <xsl:attribute name="type">
+        <xsl:value-of select="substring($procedure.step.numeration.formats,1,1)"/>
+      </xsl:attribute>
+      <xsl:apply-templates select="step"/>
+    </ol>
   </div>
 </xsl:template>
 
@@ -429,16 +430,8 @@
 </xsl:template>
 
 <xsl:template match="substeps">
-  <xsl:variable name="depth" select="count(ancestor::substeps)"/>
-  <xsl:variable name="type" select="$depth mod 5"/>
   <xsl:variable name="numeration">
-    <xsl:choose>
-      <xsl:when test="$type = 0">a</xsl:when>
-      <xsl:when test="$type = 1">i</xsl:when>
-      <xsl:when test="$type = 2">A</xsl:when>
-      <xsl:when test="$type = 3">I</xsl:when>
-      <xsl:when test="$type = 4">1</xsl:when>
-    </xsl:choose>
+    <xsl:call-template name="procedure.step.numeration"/>
   </xsl:variable>
 
   <ol type="{$numeration}">
diff --git a/xsl/html/param.xsl b/xsl/html/param.xsl
index b36aec408..6c73d6b53 100644
--- a/xsl/html/param.xsl
+++ b/xsl/html/param.xsl
@@ -1148,5 +1148,15 @@ in default.encoding, set this parameter to value <literal>native</literal>.
 </refdescription>
 </doc:param>
 
+<!-- ==================================================================== -->
+<xsl:param name="formal.procedures" select="1" doc:type='boolean'/>
+
+<doc:param name="formal.procedures" xmlns="">
+<refpurpose>Selects formal or informal procedures</refpurpose>
+<refdescription>
+<para>Formal procedures are numbered and always hav a title.
+</para>
+</refdescription>
+</doc:param>
 
 </xsl:stylesheet>
diff --git a/xsl/html/xref.xsl b/xsl/html/xref.xsl
index f022a5de0..f3612da93 100644
--- a/xsl/html/xref.xsl
+++ b/xsl/html/xref.xsl
@@ -139,6 +139,10 @@
   <xsl:apply-templates select="." mode="object.xref.markup"/>
 </xsl:template>
 
+<xsl:template match="procedure" mode="xref-to">
+  <xsl:apply-templates select="." mode="object.xref.markup"/>
+</xsl:template>
+
 <xsl:template match="cmdsynopsis" mode="xref-to">
   <xsl:apply-templates select="(.//command)[1]" mode="xref"/>
 </xsl:template>
@@ -212,6 +216,14 @@
   <xsl:apply-templates select="." mode="object.xref.markup"/>
 </xsl:template>
 
+<xsl:template match="step" mode="xref-to">
+  <xsl:call-template name="gentext">
+    <xsl:with-param name="key" select="'Step'"/>
+  </xsl:call-template>
+  <xsl:text> </xsl:text>
+  <xsl:apply-templates select="." mode="number"/>
+</xsl:template>
+
 <xsl:template match="co" mode="xref-to">
   <xsl:apply-templates select="." mode="callout-bug"/>
 </xsl:template>
@@ -280,6 +292,14 @@
   <xsl:value-of select="$title"/>
 </xsl:template>
 
+<xsl:template match="step" mode="xref-title">
+  <xsl:call-template name="gentext">
+    <xsl:with-param name="key" select="'Step'"/>
+  </xsl:call-template>
+  <xsl:text> </xsl:text>
+  <xsl:apply-templates select="." mode="number"/>
+</xsl:template>
+
 <xsl:template match="co" mode="xref-title">
   <xsl:variable name="title">
     <xsl:apply-templates select="." mode="callout-bug"/>