From ff19102a14d4d2860a5a0f0228c4d72e7eedee65 Mon Sep 17 00:00:00 2001
From: Bob Stayton <bobs@sagehill.net>
Date: Sun, 18 Apr 2004 19:28:41 +0000
Subject: [PATCH] Add support for generating an index containing only those
 terms with a matching role attribute.

---
 xsl/fo/autoidx.xsl | 66 +++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 65 insertions(+), 1 deletion(-)

diff --git a/xsl/fo/autoidx.xsl b/xsl/fo/autoidx.xsl
index 8b3b58ffe..6aadad74c 100644
--- a/xsl/fo/autoidx.xsl
+++ b/xsl/fo/autoidx.xsl
@@ -9,7 +9,8 @@
 <!ENTITY tertiary  'normalize-space(concat(tertiary/@sortas, tertiary[not(@sortas)]))'>
 
 <!ENTITY sep '" "'>
-<!ENTITY scope 'count(ancestor::node()|$scope) = count(ancestor::node())'>
+<!ENTITY scope 'count(ancestor::node()|$scope) = count(ancestor::node())
+                and ($role = @role or string-length($role) = 0)'>
 ]>
 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
                 xmlns:fo="http://www.w3.org/1999/XSL/Format"
@@ -61,6 +62,12 @@
 <xsl:template name="generate-index">
   <xsl:param name="scope" select="(ancestor::book|/)[last()]"/>
 
+  <xsl:variable name="role">
+    <xsl:if test="$index.on.role != 0">
+      <xsl:value-of select="@role"/>
+    </xsl:if>
+  </xsl:variable>
+
   <xsl:variable name="terms"
                 select="//indexterm[count(.|key('letter',
                                                 translate(substring(&primary;, 1, 1),
@@ -90,6 +97,7 @@
                                      &primary;)[&scope;][1]) = 1]"
                              mode="index-symbol-div">
           <xsl:with-param name="scope" select="$scope"/>
+          <xsl:with-param name="role" select="$role"/>
           <xsl:sort select="translate(&primary;, &lowercase;, &uppercase;)"/>
         </xsl:apply-templates>
       </fo:block>
@@ -100,6 +108,7 @@
                                            &lowercase;,&uppercase;))[&scope;][1]) = 1]"
                          mode="index-div">
       <xsl:with-param name="scope" select="$scope"/>
+      <xsl:with-param name="role" select="$role"/>
       <xsl:sort select="translate(&primary;, &lowercase;, &uppercase;)"/>
     </xsl:apply-templates>
   </fo:block>
@@ -107,6 +116,7 @@
 
 <xsl:template match="indexterm" mode="index-div">
   <xsl:param name="scope" select="."/>
+  <xsl:param name="role" select="''"/>
 
   <xsl:variable name="key"
                 select="translate(substring(&primary;, 1, 1),&lowercase;,&uppercase;)"/>
@@ -127,6 +137,7 @@
                              mode="index-primary">
           <xsl:sort select="translate(&primary;, &lowercase;, &uppercase;)"/>
           <xsl:with-param name="scope" select="$scope"/>
+          <xsl:with-param name="role" select="$role"/>
         </xsl:apply-templates>
       </fo:block>
     </fo:block>
@@ -135,6 +146,7 @@
 
 <xsl:template match="indexterm" mode="index-symbol-div">
   <xsl:param name="scope" select="."/>
+  <xsl:param name="role" select="''"/>
 
   <xsl:variable name="key"
                 select="translate(substring(&primary;, 1, 1),&lowercase;,&uppercase;)"/>
@@ -143,6 +155,7 @@
     <xsl:apply-templates select="key('letter', $key)[&scope;][count(.|key('primary', &primary;)[&scope;][1]) = 1]"
                          mode="index-primary">
       <xsl:with-param name="scope" select="$scope"/>
+      <xsl:with-param name="role" select="$role"/>
       <xsl:sort select="translate(&primary;, &lowercase;, &uppercase;)"/>
     </xsl:apply-templates>
   </fo:block>
@@ -150,6 +163,7 @@
 
 <xsl:template match="indexterm" mode="index-primary">
   <xsl:param name="scope" select="."/>
+  <xsl:param name="role" select="''"/>
 
   <xsl:variable name="key" select="&primary;"/>
   <xsl:variable name="refs" select="key('primary', $key)[&scope;]"/>
@@ -183,6 +197,7 @@
                                 and not(secondary)]">
             <xsl:apply-templates select="." mode="reference">
               <xsl:with-param name="scope" select="$scope"/>
+              <xsl:with-param name="role" select="$role"/>
             </xsl:apply-templates>
           </xsl:for-each>
         </xsl:variable>
@@ -204,6 +219,7 @@
       <xsl:apply-templates select="$refs[generate-id() = generate-id(key('see', concat(&primary;, &sep;, &sep;, &sep;, see))[&scope;][1])]"
                            mode="index-see">
          <xsl:with-param name="scope" select="$scope"/>
+         <xsl:with-param name="role" select="$role"/>
          <xsl:sort select="translate(see, &lowercase;, &uppercase;)"/>
       </xsl:apply-templates>
     </xsl:if>
@@ -215,11 +231,13 @@
       <xsl:apply-templates select="$refs[generate-id() = generate-id(key('see-also', concat(&primary;, &sep;, &sep;, &sep;, seealso))[&scope;][1])]"
                            mode="index-seealso">
          <xsl:with-param name="scope" select="$scope"/>
+         <xsl:with-param name="role" select="$role"/>
          <xsl:sort select="translate(seealso, &lowercase;, &uppercase;)"/>
       </xsl:apply-templates>
       <xsl:apply-templates select="$refs[secondary and count(.|key('secondary', concat($key, &sep;, &secondary;))[&scope;][1]) = 1]"
                            mode="index-secondary">
        <xsl:with-param name="scope" select="$scope"/>
+       <xsl:with-param name="role" select="$role"/>
        <xsl:sort select="translate(&secondary;, &lowercase;, &uppercase;)"/>
       </xsl:apply-templates>
     </fo:block>
@@ -228,6 +246,7 @@
 
 <xsl:template match="indexterm" mode="index-secondary">
   <xsl:param name="scope" select="."/>
+  <xsl:param name="role" select="''"/>
 
   <xsl:variable name="key" select="concat(&primary;, &sep;, &secondary;)"/>
   <xsl:variable name="refs" select="key('secondary', $key)[&scope;]"/>
@@ -272,6 +291,7 @@
                                 and not(tertiary)]">
             <xsl:apply-templates select="." mode="reference">
               <xsl:with-param name="scope" select="$scope"/>
+              <xsl:with-param name="role" select="$role"/>
             </xsl:apply-templates>
           </xsl:for-each>
         </xsl:variable>
@@ -293,6 +313,7 @@
       <xsl:apply-templates select="$refs[generate-id() = generate-id(key('see', concat(&primary;, &sep;, &secondary;, &sep;, &sep;, see))[&scope;][1])]"
                            mode="index-see">
         <xsl:with-param name="scope" select="$scope"/>
+        <xsl:with-param name="role" select="$role"/>
         <xsl:sort select="translate(see, &lowercase;, &uppercase;)"/>
       </xsl:apply-templates>
     </xsl:if>
@@ -304,11 +325,13 @@
       <xsl:apply-templates select="$refs[generate-id() = generate-id(key('see-also', concat(&primary;, &sep;, &secondary;, &sep;, &sep;, seealso))[&scope;][1])]"
                            mode="index-seealso">
           <xsl:with-param name="scope" select="$scope"/>
+          <xsl:with-param name="role" select="$role"/>
           <xsl:sort select="translate(seealso, &lowercase;, &uppercase;)"/>
       </xsl:apply-templates>
       <xsl:apply-templates select="$refs[tertiary and count(.|key('tertiary', concat($key, &sep;, &tertiary;))[&scope;][1]) = 1]" 
                            mode="index-tertiary">
           <xsl:with-param name="scope" select="$scope"/>
+          <xsl:with-param name="role" select="$role"/>
           <xsl:sort select="translate(&tertiary;, &lowercase;, &uppercase;)"/>
       </xsl:apply-templates>
     </fo:block>
@@ -317,6 +340,7 @@
 
 <xsl:template match="indexterm" mode="index-tertiary">
   <xsl:param name="scope" select="."/>
+  <xsl:param name="role" select="''"/>
   <xsl:variable name="key" select="concat(&primary;, &sep;, &secondary;, &sep;, &tertiary;)"/>
   <xsl:variable name="refs" select="key('tertiary', $key)[&scope;]"/>
   <fo:block>
@@ -364,6 +388,7 @@
           <xsl:for-each select="$refs[not(see) and not(seealso)]">
             <xsl:apply-templates select="." mode="reference">
               <xsl:with-param name="scope" select="$scope"/>
+              <xsl:with-param name="role" select="$role"/>
             </xsl:apply-templates>
           </xsl:for-each>
         </xsl:variable>
@@ -385,6 +410,7 @@
       <xsl:apply-templates select="$refs[generate-id() = generate-id(key('see', concat(&primary;, &sep;, &secondary;, &sep;, &tertiary;, &sep;, see))[&scope;][1])]"
                            mode="index-see">
         <xsl:with-param name="scope" select="$scope"/>
+        <xsl:with-param name="role" select="$role"/>
         <xsl:sort select="translate(see, &lowercase;, &uppercase;)"/>
       </xsl:apply-templates>
     </xsl:if>
@@ -396,6 +422,7 @@
       <xsl:apply-templates select="$refs[generate-id() = generate-id(key('see-also', concat(&primary;, &sep;, &secondary;, &sep;, &tertiary;, &sep;, seealso))[&scope;][1])]"
                            mode="index-seealso">
         <xsl:with-param name="scope" select="$scope"/>
+        <xsl:with-param name="role" select="$role"/>
         <xsl:sort select="translate(seealso, &lowercase;, &uppercase;)"/>
       </xsl:apply-templates>
     </fo:block>
@@ -404,6 +431,7 @@
 
 <xsl:template match="indexterm" mode="reference">
   <xsl:param name="scope" select="."/>
+  <xsl:param name="role" select="''"/>
   <xsl:param name="separator" select="', '"/>
 
   <xsl:if test="$passivetex.extensions = '0'">
@@ -415,6 +443,7 @@
       <xsl:call-template name="reference">
         <xsl:with-param name="zones" select="normalize-space(@zone)"/>
         <xsl:with-param name="scope" select="$scope"/>
+        <xsl:with-param name="role" select="$role"/>
       </xsl:call-template>
     </xsl:when>
     <xsl:otherwise>
@@ -430,6 +459,7 @@
         <xsl:apply-templates select="key('endofrange', @id)[&scope;][last()]"
                              mode="reference">
           <xsl:with-param name="scope" select="$scope"/>
+          <xsl:with-param name="role" select="$role"/>
           <xsl:with-param name="separator" select="'-'"/>
         </xsl:apply-templates>
       </xsl:if>
@@ -439,6 +469,7 @@
 
 <xsl:template name="reference">
   <xsl:param name="scope" select="."/>
+  <xsl:param name="role" select="''"/>
   <xsl:param name="zones"/>
 
   <xsl:choose>
@@ -462,6 +493,7 @@
       <xsl:call-template name="reference">
         <xsl:with-param name="zones" select="substring-after($zones, ' ')"/>
         <xsl:with-param name="scope" select="$scope"/>
+        <xsl:with-param name="role" select="$role"/>
       </xsl:call-template>
     </xsl:when>
     <xsl:otherwise>
@@ -483,6 +515,7 @@
 
 <xsl:template match="indexterm" mode="index-see">
    <xsl:param name="scope" select="."/>
+  <xsl:param name="role" select="''"/>
 
    <fo:inline>
      <xsl:text> (</xsl:text>
@@ -497,6 +530,7 @@
 
 <xsl:template match="indexterm" mode="index-seealso">
    <xsl:param name="scope" select="."/>
+  <xsl:param name="role" select="''"/>
 
    <fo:block>
      <xsl:text>(</xsl:text>
@@ -514,6 +548,8 @@
 <xsl:template name="generate-index-markup">
   <xsl:param name="scope" select="(ancestor::book|/)[last()]"/>
 
+  <xsl:variable name="role" select="@role"/>
+
   <xsl:variable name="terms" select="$scope//indexterm[count(.|key('letter',
                                      translate(substring(&primary;, 1, 1),&lowercase;,&uppercase;))[&scope;][1]) = 1]"/>
   <xsl:variable name="alphabetical"
@@ -535,6 +571,7 @@
                                  &primary;)[&scope;][1]) = 1]"
                          mode="index-symbol-div-markup">
       <xsl:with-param name="scope" select="$scope"/>
+      <xsl:with-param name="role" select="$role"/>
       <xsl:sort select="translate(&primary;, &lowercase;, &uppercase;)"/>
     </xsl:apply-templates>
     <xsl:text>&lt;/indexdiv&gt;&#10;</xsl:text>
@@ -544,6 +581,7 @@
                                translate(substring(&primary;, 1, 1),&lowercase;,&uppercase;))[&scope;][1]) = 1]"
                        mode="index-div-markup">
       <xsl:with-param name="scope" select="$scope"/>
+      <xsl:with-param name="role" select="$role"/>
       <xsl:sort select="translate(&primary;, &lowercase;, &uppercase;)"/>
   </xsl:apply-templates>
   <xsl:text>&lt;/index&gt;&#10;</xsl:text>
@@ -551,17 +589,20 @@
 
 <xsl:template match="*" mode="index-markup">
   <xsl:param name="scope" select="."/>
+  <xsl:param name="role" select="''"/>
 
   <xsl:text>&lt;</xsl:text>
   <xsl:value-of select="name(.)"/>
   <xsl:text>&gt;&#10;</xsl:text>
   <xsl:apply-templates mode="index-markup">
     <xsl:with-param name="scope" select="$scope"/>
+    <xsl:with-param name="role" select="$role"/>
   </xsl:apply-templates>
 </xsl:template>
 
 <xsl:template match="indexterm" mode="index-div-markup">
   <xsl:param name="scope" select="."/>
+  <xsl:param name="role" select="''"/>
   <xsl:variable name="key" select="translate(substring(&primary;, 1, 1),&lowercase;,&uppercase;)"/>
   <xsl:text>&#10;&lt;indexdiv&gt;&#10;</xsl:text>
   <xsl:text>&lt;title&gt;</xsl:text>
@@ -571,6 +612,7 @@
   <xsl:apply-templates select="key('letter', $key)[&scope;][count(.|key('primary', &primary;)[&scope;][1]) = 1]"
                        mode="index-primary-markup">
     <xsl:with-param name="scope" select="$scope"/>
+    <xsl:with-param name="role" select="$role"/>
     <xsl:sort select="translate(&primary;, &lowercase;, &uppercase;)"/>
   </xsl:apply-templates>
   <xsl:text>&lt;/indexdiv&gt;&#10;</xsl:text>
@@ -578,17 +620,20 @@
 
 <xsl:template match="indexterm" mode="index-symbol-div-markup">
   <xsl:param name="scope" select="."/>
+  <xsl:param name="role" select="''"/>
   <xsl:variable name="key" select="translate(substring(&primary;, 1, 1),&lowercase;,&uppercase;)"/>
 
   <xsl:apply-templates select="key('letter', $key)[&scope;][count(.|key('primary', &primary;)[&scope;][1]) = 1]"
                        mode="index-primary-markup">
     <xsl:with-param name="scope" select="$scope"/>
+    <xsl:with-param name="role" select="$role"/>
     <xsl:sort select="translate(&primary;, &lowercase;, &uppercase;)"/>
   </xsl:apply-templates>
 </xsl:template>
 
 <xsl:template match="indexterm" mode="index-primary-markup">
   <xsl:param name="scope" select="."/>
+  <xsl:param name="role" select="''"/>
   <xsl:variable name="key" select="&primary;"/>
   <xsl:variable name="refs" select="key('primary', $key)[&scope;]"/>
   <xsl:variable name="pages" select="$refs[not(see) and not(seealso)]"/>
@@ -606,6 +651,7 @@
   <xsl:for-each select="$pages">
     <xsl:apply-templates select="." mode="reference-markup">
       <xsl:with-param name="scope" select="$scope"/>
+      <xsl:with-param name="role" select="$role"/>
     </xsl:apply-templates>
   </xsl:for-each>
 
@@ -615,18 +661,21 @@
     <xsl:apply-templates select="$refs[generate-id() = generate-id(key('see', concat(&primary;, &sep;, &sep;, &sep;, see))[&scope;][1])]"
                          mode="index-see-markup">
       <xsl:with-param name="scope" select="$scope"/>
+      <xsl:with-param name="role" select="$role"/>
       <xsl:sort select="translate(see, &lowercase;, &uppercase;)"/>
     </xsl:apply-templates>
 
     <xsl:apply-templates select="$refs[generate-id() = generate-id(key('see-also', concat(&primary;, &sep;, &sep;, &sep;, seealso))[&scope;][1])]"
                          mode="index-seealso-markup">
       <xsl:with-param name="scope" select="$scope"/>
+      <xsl:with-param name="role" select="$role"/>
       <xsl:sort select="translate(seealso, &lowercase;, &uppercase;)"/>
     </xsl:apply-templates>
 
     <xsl:apply-templates select="$refs[secondary and count(.|key('secondary', concat($key, &sep;, &secondary;))[&scope;][1]) = 1]" 
                          mode="index-secondary-markup">
       <xsl:with-param name="scope" select="$scope"/>
+      <xsl:with-param name="role" select="$role"/>
       <xsl:sort select="translate(&secondary;, &lowercase;, &uppercase;)"/>
     </xsl:apply-templates>
   </xsl:if>
@@ -635,6 +684,7 @@
 
 <xsl:template match="indexterm" mode="index-secondary-markup">
   <xsl:param name="scope" select="."/>
+  <xsl:param name="role" select="''"/>
   <xsl:variable name="key" select="concat(&primary;, &sep;, &secondary;)"/>
   <xsl:variable name="refs" select="key('secondary', $key)[&scope;]"/>
   <xsl:variable name="pages" select="$refs[not(see) and not(seealso)]"/>
@@ -651,6 +701,7 @@
   <xsl:for-each select="$pages">
     <xsl:apply-templates select="." mode="reference-markup">
       <xsl:with-param name="scope" select="$scope"/>
+      <xsl:with-param name="role" select="$role"/>
     </xsl:apply-templates>
   </xsl:for-each>
 
@@ -660,16 +711,19 @@
     <xsl:apply-templates select="$refs[generate-id() = generate-id(key('see', concat(&primary;, &sep;, &secondary;, &sep;, &sep;, see))[&scope;][1])]"
                          mode="index-see-markup">
       <xsl:with-param name="scope" select="$scope"/>
+      <xsl:with-param name="role" select="$role"/>
       <xsl:sort select="translate(see, &lowercase;, &uppercase;)"/>
     </xsl:apply-templates>
     <xsl:apply-templates select="$refs[generate-id() = generate-id(key('see-also', concat(&primary;, &sep;, &secondary;, &sep;, &sep;, seealso))[&scope;][1])]"
                          mode="index-seealso-markup">
       <xsl:with-param name="scope" select="$scope"/>
+      <xsl:with-param name="role" select="$role"/>
       <xsl:sort select="translate(seealso, &lowercase;, &uppercase;)"/>
     </xsl:apply-templates>
     <xsl:apply-templates select="$refs[tertiary and count(.|key('tertiary', concat($key, &sep;, &tertiary;))[&scope;][1]) = 1]" 
                          mode="index-tertiary-markup">
       <xsl:with-param name="scope" select="$scope"/>
+      <xsl:with-param name="role" select="$role"/>
       <xsl:sort select="translate(&tertiary;, &lowercase;, &uppercase;)"/>
     </xsl:apply-templates>
   </xsl:if>
@@ -677,6 +731,7 @@
 
 <xsl:template match="indexterm" mode="index-tertiary-markup">
   <xsl:param name="scope" select="."/>
+  <xsl:param name="role" select="''"/>
   <xsl:variable name="key" select="concat(&primary;, &sep;, &secondary;, &sep;, &tertiary;)"/>
   <xsl:variable name="refs" select="key('tertiary', $key)[&scope;]"/>
   <xsl:variable name="pages" select="$refs[not(see) and not(seealso)]"/>
@@ -693,6 +748,7 @@
   <xsl:for-each select="$pages">
     <xsl:apply-templates select="." mode="reference-markup">
       <xsl:with-param name="scope" select="$scope"/>
+      <xsl:with-param name="role" select="$role"/>
     </xsl:apply-templates>
   </xsl:for-each>
 
@@ -703,11 +759,13 @@
     <xsl:apply-templates select="$refs[generate-id() = generate-id(key('see', concat(&primary;, &sep;, &secondary;, &sep;, &tertiary;, &sep;, see))[&scope;][1])]"
                          mode="index-see-markup">
       <xsl:with-param name="scope" select="$scope"/>
+      <xsl:with-param name="role" select="$role"/>
       <xsl:sort select="translate(see, &lowercase;, &uppercase;)"/>
     </xsl:apply-templates>
     <xsl:apply-templates select="$refs[generate-id() = generate-id(key('see-also', concat(&primary;, &sep;, &secondary;, &sep;, &tertiary;, &sep;, seealso))[&scope;][1])]"
                          mode="index-seealso-markup">
       <xsl:with-param name="scope" select="$scope"/>
+      <xsl:with-param name="role" select="$role"/>
       <xsl:sort select="translate(seealso, &lowercase;, &uppercase;)"/>
     </xsl:apply-templates>
   </xsl:if>
@@ -715,11 +773,13 @@
 
 <xsl:template match="indexterm" mode="reference-markup">
   <xsl:param name="scope" select="."/>
+  <xsl:param name="role" select="''"/>
   <xsl:choose>
     <xsl:when test="@zone and string(@zone)">
       <xsl:call-template name="reference-markup">
         <xsl:with-param name="zones" select="normalize-space(@zone)"/>
         <xsl:with-param name="scope" select="$scope"/>
+        <xsl:with-param name="role" select="$role"/>
       </xsl:call-template>
     </xsl:when>
     <xsl:otherwise>
@@ -764,6 +824,7 @@
 
 <xsl:template name="reference-markup">
   <xsl:param name="scope" select="."/>
+  <xsl:param name="role" select="''"/>
   <xsl:param name="zones"/>
   <xsl:choose>
     <xsl:when test="contains($zones, ' ')">
@@ -793,6 +854,7 @@
       <xsl:call-template name="reference">
         <xsl:with-param name="zones" select="substring-after($zones, ' ')"/>
         <xsl:with-param name="scope" select="$scope"/>
+        <xsl:with-param name="role" select="$role"/>
       </xsl:call-template>
     </xsl:when>
     <xsl:otherwise>
@@ -824,6 +886,7 @@
 
 <xsl:template match="indexterm" mode="index-see-markup">
   <xsl:param name="scope" select="."/>
+  <xsl:param name="role" select="''"/>
   <fo:block>
     <xsl:text>&lt;seeie&gt;</xsl:text>
     <xsl:text>&lt;phrase&gt;</xsl:text>
@@ -837,6 +900,7 @@
 
 <xsl:template match="indexterm" mode="index-seealso-markup">
   <xsl:param name="scope" select="."/>
+  <xsl:param name="role" select="''"/>
   <fo:block>
     <xsl:text>&lt;seealsoie&gt;</xsl:text>
     <xsl:text>&lt;phrase&gt;</xsl:text>
-- 
2.40.0