From 5bcfdf68b405fa7cc0f759a2403d13f76a9c4ed9 Mon Sep 17 00:00:00 2001
From: Bob Stayton <bobs@sagehill.net>
Date: Sat, 6 Jan 2007 18:14:40 +0000
Subject: [PATCH] Add support for sorting glossary entries

---
 xsl/fo/glossary.xsl | 329 ++++++++++++++++++++++++++++++++++++--------
 xsl/fo/param.ent    |   1 +
 xsl/fo/param.xweb   |   2 +
 3 files changed, 278 insertions(+), 54 deletions(-)

diff --git a/xsl/fo/glossary.xsl b/xsl/fo/glossary.xsl
index 00f44e8cf..4fc922416 100644
--- a/xsl/fo/glossary.xsl
+++ b/xsl/fo/glossary.xsl
@@ -1,4 +1,8 @@
 <?xml version='1.0'?>
+<!DOCTYPE xsl:stylesheet [
+<!ENTITY % common.entities SYSTEM "../common/entities.ent">
+%common.entities;
+]>
 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
                 xmlns:fo="http://www.w3.org/1999/XSL/Format"
                 version='1.0'>
@@ -64,6 +68,10 @@
     </xsl:choose>
   </xsl:variable>
 
+  <xsl:variable name="language">
+    <xsl:call-template name="l10n.language"/>
+  </xsl:variable>
+
   <fo:block id="{$id}">
     <xsl:call-template name="glossary.titlepage"/>
   </fo:block>
@@ -81,17 +89,50 @@
         <fo:list-block provisional-distance-between-starts="{$width}"
                        provisional-label-separation="{$glossterm.separation}"
                        xsl:use-attribute-sets="normal.para.spacing">
-          <xsl:apply-templates select="$entries" mode="glossary.as.list"/>
+          <xsl:choose>
+            <xsl:when test="$glossary.sort != 0">
+              <xsl:apply-templates select="$entries" mode="glossary.as.list">
+                <xsl:sort lang="{$language}"
+                          select="translate(glossterm, &lowercase;, 
+                                            &uppercase;)"/>
+              </xsl:apply-templates>
+            </xsl:when>
+            <xsl:otherwise>
+              <xsl:apply-templates select="$entries" mode="glossary.as.list"/>
+            </xsl:otherwise>
+          </xsl:choose>
         </fo:list-block>
       </xsl:if>
     </xsl:when>
     <xsl:when test="$presentation = 'blocks'">
       <xsl:apply-templates select="$divs" mode="glossary.as.blocks"/>
-      <xsl:apply-templates select="$entries" mode="glossary.as.blocks"/>
+      <xsl:choose>
+        <xsl:when test="$glossary.sort != 0">
+          <xsl:apply-templates select="$entries" mode="glossary.as.blocks">
+            <xsl:sort lang="{$language}"
+                      select="translate(glossterm, &lowercase;, 
+                                        &uppercase;)"/>
+          </xsl:apply-templates>
+        </xsl:when>
+        <xsl:otherwise>
+          <xsl:apply-templates select="$entries" mode="glossary.as.blocks"/>
+        </xsl:otherwise>
+      </xsl:choose>
     </xsl:when>
     <xsl:when test="$glossary.as.blocks != 0">
       <xsl:apply-templates select="$divs" mode="glossary.as.blocks"/>
-      <xsl:apply-templates select="$entries" mode="glossary.as.blocks"/>
+      <xsl:choose>
+        <xsl:when test="$glossary.sort != 0">
+          <xsl:apply-templates select="$entries" mode="glossary.as.blocks">
+            <xsl:sort lang="{$language}"
+                      select="translate(glossterm, &lowercase;, 
+                                        &uppercase;)"/>
+          </xsl:apply-templates>
+        </xsl:when>
+        <xsl:otherwise>
+          <xsl:apply-templates select="$entries" mode="glossary.as.blocks"/>
+        </xsl:otherwise>
+      </xsl:choose>
     </xsl:when>
     <xsl:otherwise>
       <xsl:apply-templates select="$divs" mode="glossary.as.list">
@@ -101,7 +142,18 @@
         <fo:list-block provisional-distance-between-starts="{$width}"
                        provisional-label-separation="{$glossterm.separation}"
                        xsl:use-attribute-sets="normal.para.spacing">
-          <xsl:apply-templates select="$entries" mode="glossary.as.list"/>
+          <xsl:choose>
+            <xsl:when test="$glossary.sort != 0">
+              <xsl:apply-templates select="$entries" mode="glossary.as.list">
+                <xsl:sort lang="{$language}"
+                          select="translate(glossterm, &lowercase;, 
+                                            &uppercase;)"/>
+              </xsl:apply-templates>
+            </xsl:when>
+            <xsl:otherwise>
+              <xsl:apply-templates select="$entries" mode="glossary.as.list"/>
+            </xsl:otherwise>
+          </xsl:choose>
         </fo:list-block>
       </xsl:if>
     </xsl:otherwise>
@@ -122,6 +174,7 @@
     <xsl:attribute name="language">
       <xsl:call-template name="l10n.language"/>
     </xsl:attribute>
+
     <xsl:attribute name="format">
       <xsl:call-template name="page.number.format">
         <xsl:with-param name="master-reference" select="$master-reference"/>
@@ -210,6 +263,10 @@
     </xsl:choose>
   </xsl:variable>
 
+  <xsl:variable name="language">
+    <xsl:call-template name="l10n.language"/>
+  </xsl:variable>
+
   <xsl:if test="title or info/title">
     <xsl:apply-templates select="(title|info/title)[1]" mode="list.title.mode"/>
   </xsl:if>
@@ -219,20 +276,64 @@
       <fo:list-block provisional-distance-between-starts="{$width}"
                      provisional-label-separation="{$glossterm.separation}"
                      xsl:use-attribute-sets="normal.para.spacing">
-        <xsl:apply-templates mode="glossary.as.list" select="glossentry"/>
+        <xsl:choose>
+          <xsl:when test="$glossary.sort != 0">
+            <xsl:apply-templates select="glossentry" mode="glossary.as.list">
+              <xsl:sort lang="{$language}"
+                        select="translate(glossterm, &lowercase;, 
+                                          &uppercase;)"/>
+            </xsl:apply-templates>
+          </xsl:when>
+          <xsl:otherwise>
+            <xsl:apply-templates select="glossentry" mode="glossary.as.list"/>
+          </xsl:otherwise>
+        </xsl:choose>
       </fo:list-block>
     </xsl:when>
     <xsl:when test="$presentation = 'blocks'">
-      <xsl:apply-templates mode="glossary.as.blocks" select="glossentry"/>
+      <xsl:choose>
+        <xsl:when test="$glossary.sort != 0">
+          <xsl:apply-templates select="glossentry" mode="glossary.as.blocks">
+            <xsl:sort lang="{$language}"
+                      select="translate(glossterm, &lowercase;, 
+                                        &uppercase;)"/>
+          </xsl:apply-templates>
+        </xsl:when>
+        <xsl:otherwise>
+          <xsl:apply-templates select="glossentry" mode="glossary.as.blocks"/>
+        </xsl:otherwise>
+      </xsl:choose>
     </xsl:when>
     <xsl:when test="$glosslist.as.blocks != 0">
-      <xsl:apply-templates mode="glossary.as.blocks" select="glossentry"/>
+      <xsl:choose>
+        <xsl:when test="$glossary.sort != 0">
+          <xsl:apply-templates select="glossentry" mode="glossary.as.blocks">
+            <xsl:sort lang="{$language}"
+                      select="translate(glossterm, &lowercase;, 
+                                        &uppercase;)"/>
+          </xsl:apply-templates>
+        </xsl:when>
+        <xsl:otherwise>
+          <xsl:apply-templates select="glossentry" mode="glossary.as.blocks"/>
+        </xsl:otherwise>
+      </xsl:choose>
     </xsl:when>
     <xsl:otherwise>
       <fo:list-block provisional-distance-between-starts="{$width}"
                      provisional-label-separation="{$glossterm.separation}"
                      xsl:use-attribute-sets="normal.para.spacing">
-        <xsl:apply-templates mode="glossary.as.list" select="glossentry"/>
+        <xsl:choose>
+          <xsl:when test="$glossary.sort != 0">
+            <xsl:apply-templates select="glossentry" mode="glossary.as.list">
+              <xsl:sort lang="{$language}"
+                        select="translate(glossterm, &lowercase;, 
+                                          &uppercase;)"/>
+            </xsl:apply-templates>
+          </xsl:when>
+          <xsl:otherwise>
+            <xsl:apply-templates select="glossentry" mode="glossary.as.list"/>
+          </xsl:otherwise>
+        </xsl:choose>
       </fo:list-block>
     </xsl:otherwise>
   </xsl:choose>
@@ -301,6 +402,10 @@
     </xsl:choose>
   </xsl:variable>
 
+  <xsl:variable name="language">
+    <xsl:call-template name="l10n.language"/>
+  </xsl:variable>
+
   <xsl:if test="$glossary.collection = ''">
     <xsl:message>
       <xsl:text>Warning: processing automatic glossary </xsl:text>
@@ -363,40 +468,84 @@
           <fo:list-block provisional-distance-between-starts="{$width}"
                          provisional-label-separation="{$glossterm.separation}"
                          xsl:use-attribute-sets="normal.para.spacing">
-            <xsl:for-each select="$collection//glossentry">
-              <xsl:variable name="cterm" select="glossterm"/>
-              <xsl:if test="$terms[@baseform = $cterm or . = $cterm]">
-                <xsl:apply-templates select="." mode="auto-glossary-as-list"/>
-              </xsl:if>
-            </xsl:for-each>
+            <xsl:choose>
+              <xsl:when test="$glossary.sort != 0">
+                <xsl:for-each select="$collection//glossentry">
+                  <xsl:sort lang="{$language}"
+                            select="translate(glossterm, &lowercase;, 
+                                              &uppercase;)"/>
+                  <xsl:variable name="cterm" select="glossterm"/>
+                  <xsl:if test="$terms[@baseform = $cterm or . = $cterm]">
+                    <xsl:apply-templates select="." 
+                                         mode="auto-glossary-as-list"/>
+                  </xsl:if>
+                </xsl:for-each>
+              </xsl:when>
+              <xsl:otherwise>
+                <xsl:for-each select="$collection//glossentry">
+                  <xsl:variable name="cterm" select="glossterm"/>
+                  <xsl:if test="$terms[@baseform = $cterm or . = $cterm]">
+                    <xsl:apply-templates select="." 
+                                         mode="auto-glossary-as-list"/>
+                  </xsl:if>
+                </xsl:for-each>
+              </xsl:otherwise>
+            </xsl:choose>
           </fo:list-block>
         </xsl:when>
-        <xsl:when test="$presentation = 'blocks'">
-          <xsl:for-each select="$collection//glossentry">
-            <xsl:variable name="cterm" select="glossterm"/>
-            <xsl:if test="$terms[@baseform = $cterm or . = $cterm]">
-              <xsl:apply-templates select="." mode="auto-glossary-as-blocks"/>
-            </xsl:if>
-          </xsl:for-each>
-        </xsl:when>
-        <xsl:when test="$glossary.as.blocks != 0">
-          <xsl:for-each select="$collection//glossentry">
-            <xsl:variable name="cterm" select="glossterm"/>
-            <xsl:if test="$terms[@baseform = $cterm or . = $cterm]">
-              <xsl:apply-templates select="." mode="auto-glossary-as-blocks"/>
-            </xsl:if>
-          </xsl:for-each>
+        <xsl:when test="$presentation = 'blocks' or
+                        $glossary.as.blocks != 0">
+          <xsl:choose>
+            <xsl:when test="$glossary.sort != 0">
+              <xsl:for-each select="$collection//glossentry">
+                <xsl:sort lang="{$language}"
+                          select="translate(glossterm, &lowercase;, 
+                                            &uppercase;)"/>
+                <xsl:variable name="cterm" select="glossterm"/>
+                <xsl:if test="$terms[@baseform = $cterm or . = $cterm]">
+                  <xsl:apply-templates select="." 
+                                       mode="auto-glossary-as-blocks"/>
+                </xsl:if>
+              </xsl:for-each>
+            </xsl:when>
+            <xsl:otherwise>
+              <xsl:for-each select="$collection//glossentry">
+                <xsl:variable name="cterm" select="glossterm"/>
+                <xsl:if test="$terms[@baseform = $cterm or . = $cterm]">
+                  <xsl:apply-templates select="." 
+                                       mode="auto-glossary-as-blocks"/>
+                </xsl:if>
+              </xsl:for-each>
+            </xsl:otherwise>
+          </xsl:choose>
         </xsl:when>
         <xsl:otherwise>
           <fo:list-block provisional-distance-between-starts="{$width}"
                          provisional-label-separation="{$glossterm.separation}"
                          xsl:use-attribute-sets="normal.para.spacing">
-            <xsl:for-each select="$collection//glossentry">
-              <xsl:variable name="cterm" select="glossterm"/>
-              <xsl:if test="$terms[@baseform = $cterm or . = $cterm]">
-                <xsl:apply-templates select="." mode="auto-glossary-as-list"/>
-              </xsl:if>
-            </xsl:for-each>
+            <xsl:choose>
+              <xsl:when test="$glossary.sort != 0">
+                <xsl:for-each select="$collection//glossentry">
+                  <xsl:sort lang="{$language}"
+                            select="translate(glossterm, &lowercase;, 
+                                              &uppercase;)"/>
+                  <xsl:variable name="cterm" select="glossterm"/>
+                  <xsl:if test="$terms[@baseform = $cterm or . = $cterm]">
+                    <xsl:apply-templates select="." 
+                                         mode="auto-glossary-as-list"/>
+                  </xsl:if>
+                </xsl:for-each>
+              </xsl:when>
+              <xsl:otherwise>
+                <xsl:for-each select="$collection//glossentry">
+                  <xsl:variable name="cterm" select="glossterm"/>
+                  <xsl:if test="$terms[@baseform = $cterm or . = $cterm]">
+                    <xsl:apply-templates select="." 
+                                         mode="auto-glossary-as-list"/>
+                  </xsl:if>
+                </xsl:for-each>
+              </xsl:otherwise>
+            </xsl:choose>
           </fo:list-block>
         </xsl:otherwise>
       </xsl:choose>
@@ -406,7 +555,7 @@
 
 <xsl:template match="book/glossary[@role='auto']|
                      part/glossary[@role='auto']|
-		     /glossary[@role='auto']" priority="2.5">
+                     /glossary[@role='auto']" priority="2.5">
   <xsl:variable name="id"><xsl:call-template name="object.id"/></xsl:variable>
 
   <xsl:variable name="master-reference">
@@ -481,6 +630,10 @@
   <xsl:param name="width" select="$glossterm.width"/>
   <xsl:param name="terms" select="."/>
 
+  <xsl:variable name="language">
+    <xsl:call-template name="l10n.language"/>
+  </xsl:variable>
+
   <xsl:variable name="preamble"
                 select="*[not(self::title
                             or self::subtitle
@@ -493,12 +646,26 @@
   <fo:list-block provisional-distance-between-starts="{$width}"
                  provisional-label-separation="{$glossterm.separation}"
                  xsl:use-attribute-sets="normal.para.spacing">
-    <xsl:for-each select="glossentry">
-      <xsl:variable name="cterm" select="glossterm"/>
-      <xsl:if test="$terms[@baseform = $cterm or . = $cterm]">
-        <xsl:apply-templates select="." mode="auto-glossary-as-list"/>
-      </xsl:if>
-    </xsl:for-each>
+    <xsl:choose>
+      <xsl:when test="$glossary.sort != 0">
+        <xsl:for-each select="glossentry">
+          <xsl:sort lang="{$language}"
+                    select="translate(glossterm, &lowercase;, &uppercase;)"/>
+          <xsl:variable name="cterm" select="glossterm"/>
+          <xsl:if test="$terms[@baseform = $cterm or . = $cterm]">
+            <xsl:apply-templates select="." mode="auto-glossary-as-list"/>
+          </xsl:if>
+        </xsl:for-each>
+      </xsl:when>
+      <xsl:otherwise>
+        <xsl:for-each select="glossentry">
+          <xsl:variable name="cterm" select="glossterm"/>
+          <xsl:if test="$terms[@baseform = $cterm or . = $cterm]">
+            <xsl:apply-templates select="." mode="auto-glossary-as-list"/>
+          </xsl:if>
+        </xsl:for-each>
+      </xsl:otherwise>
+    </xsl:choose>
   </fo:list-block>
 </xsl:template>
 
@@ -509,6 +676,10 @@
 <xsl:template match="glossdiv" mode="auto-glossary-as-blocks">
   <xsl:param name="terms" select="."/>
 
+  <xsl:variable name="language">
+    <xsl:call-template name="l10n.language"/>
+  </xsl:variable>
+
   <xsl:variable name="preamble"
                 select="*[not(self::title
                             or self::subtitle
@@ -518,12 +689,27 @@
 
   <xsl:apply-templates select="$preamble"/>
 
-  <xsl:for-each select="glossentry">
-    <xsl:variable name="cterm" select="glossterm"/>
-    <xsl:if test="$terms[@baseform = $cterm or . = $cterm]">
-      <xsl:apply-templates select="." mode="auto-glossary-as-blocks"/>
-    </xsl:if>
-  </xsl:for-each>
+  <xsl:choose>
+    <xsl:when test="$glossary.sort != 0">
+      <xsl:for-each select="glossentry">
+        <xsl:sort lang="{$language}"
+                  select="translate(glossterm, &lowercase;, &uppercase;)"/>
+        <xsl:variable name="cterm" select="glossterm"/>
+        <xsl:if test="$terms[@baseform = $cterm or . = $cterm]">
+          <xsl:apply-templates select="." mode="auto-glossary-as-blocks"/>
+        </xsl:if>
+      </xsl:for-each>
+    </xsl:when>
+    <xsl:otherwise>
+      <xsl:for-each select="glossentry">
+        <xsl:variable name="cterm" select="glossterm"/>
+        <xsl:if test="$terms[@baseform = $cterm or . = $cterm]">
+          <xsl:apply-templates select="." mode="auto-glossary-as-blocks"/>
+        </xsl:if>
+      </xsl:for-each>
+    </xsl:otherwise>
+  </xsl:choose>
+
 </xsl:template>
 
 <xsl:template match="glossentry" mode="auto-glossary-as-blocks">
@@ -537,6 +723,11 @@
   <xsl:param name="width" select="$glossterm.width"/>
 
   <xsl:variable name="entries" select="glossentry"/>
+
+  <xsl:variable name="language">
+    <xsl:call-template name="l10n.language"/>
+  </xsl:variable>
+
   <xsl:variable name="preamble"
                 select="*[not(self::title
                             or self::subtitle
@@ -549,7 +740,18 @@
   <fo:list-block provisional-distance-between-starts="{$width}"
                  provisional-label-separation="{$glossterm.separation}"
                  xsl:use-attribute-sets="normal.para.spacing">
-    <xsl:apply-templates select="$entries" mode="glossary.as.list"/>
+    <xsl:choose>
+      <xsl:when test="$glossary.sort != 0">
+        <xsl:apply-templates select="$entries" mode="glossary.as.list">
+          <xsl:sort lang="{$language}"
+                    select="translate(glossterm, &lowercase;, 
+                                      &uppercase;)"/>
+        </xsl:apply-templates>
+      </xsl:when>
+      <xsl:otherwise>
+        <xsl:apply-templates select="$entries" mode="glossary.as.list"/>
+      </xsl:otherwise>
+    </xsl:choose>
   </fo:list-block>
 </xsl:template>
 
@@ -583,13 +785,16 @@ GlossEntry ::=
           <xsl:when test="$glossentry.show.acronym = 'primary'">
             <xsl:choose>
               <xsl:when test="acronym|abbrev">
-                <xsl:apply-templates select="acronym|abbrev" mode="glossary.as.list"/>
+                <xsl:apply-templates select="acronym|abbrev" 
+                                     mode="glossary.as.list"/>
                 <xsl:text> (</xsl:text>
-                <xsl:apply-templates select="glossterm" mode="glossary.as.list"/>
+                <xsl:apply-templates select="glossterm" 
+                                     mode="glossary.as.list"/>
                 <xsl:text>)</xsl:text>
               </xsl:when>
               <xsl:otherwise>
-                <xsl:apply-templates select="glossterm" mode="glossary.as.list"/>
+                <xsl:apply-templates select="glossterm" 
+                                     mode="glossary.as.list"/>
               </xsl:otherwise>
             </xsl:choose>
           </xsl:when>
@@ -599,7 +804,8 @@ GlossEntry ::=
 
             <xsl:if test="acronym|abbrev">
               <xsl:text> (</xsl:text>
-              <xsl:apply-templates select="acronym|abbrev" mode="glossary.as.list"/>
+              <xsl:apply-templates select="acronym|abbrev" 
+                                   mode="glossary.as.list"/>
               <xsl:text>)</xsl:text>
             </xsl:if>
           </xsl:when>
@@ -754,11 +960,26 @@ GlossEntry ::=
                             or self::subtitle
                             or self::glossentry)]"/>
 
+  <xsl:variable name="language">
+    <xsl:call-template name="l10n.language"/>
+  </xsl:variable>
+
   <xsl:call-template name="glossdiv.titlepage"/>
 
   <xsl:apply-templates select="$preamble"/>
 
-  <xsl:apply-templates select="$entries" mode="glossary.as.blocks"/>
+  <xsl:choose>
+    <xsl:when test="$glossary.sort != 0">
+      <xsl:apply-templates select="$entries" mode="glossary.as.blocks">
+        <xsl:sort lang="{$language}"
+                  select="translate(glossterm, &lowercase;, 
+                                    &uppercase;)"/>
+      </xsl:apply-templates>
+    </xsl:when>
+    <xsl:otherwise>
+      <xsl:apply-templates select="$entries" mode="glossary.as.blocks"/>
+    </xsl:otherwise>
+  </xsl:choose>
 </xsl:template>
 
 <!--
diff --git a/xsl/fo/param.ent b/xsl/fo/param.ent
index aa3e51b3d..8f8c316ef 100644
--- a/xsl/fo/param.ent
+++ b/xsl/fo/param.ent
@@ -314,3 +314,4 @@
 <!ENTITY insert.link.page.number SYSTEM "../params/insert.link.page.number.xml">
 <!ENTITY index.method SYSTEM "../params/index.method.xml">
 <!ENTITY reference.autolabel SYSTEM "../params/reference.autolabel.xml">
+<!ENTITY glossary.sort SYSTEM "../params/glossary.sort.xml">
diff --git a/xsl/fo/param.xweb b/xsl/fo/param.xweb
index e794c62cc..50800aad6 100644
--- a/xsl/fo/param.xweb
+++ b/xsl/fo/param.xweb
@@ -218,6 +218,7 @@ generate.section.toc.level;
 &glossary.as.blocks;
 &glosslist.as.blocks;
 &glossentry.show.acronym;
+&glossary.sort;
 </reference>
 
 <reference id="misc"><title>Miscellaneous</title>
@@ -633,6 +634,7 @@ around all these parameters.</para>
 <src:fragref linkend="generate.toc.frag"/>
 <src:fragref linkend="glossary.as.blocks.frag"/>
 <src:fragref linkend="glossary.collection.frag"/>
+<src:fragref linkend="glossary.sort.frag"/>
 <src:fragref linkend="glossentry.show.acronym.frag"/>
 <src:fragref linkend="glosslist.as.blocks.frag"/>
 <src:fragref linkend="glossterm.auto.link.frag"/>
-- 
2.40.0