GNOME.org
 

[yelp-xsl/wip/html5] Support for automatic indexes in DocBook

commit f0fe845d8c36fda5b7eaf3d9641ead0ec8cdb5f0
Author: Shaun McCance <shaunm gnome org>
Date:   Sat Mar 18 09:04:06 2017 -0400

    Support for automatic indexes in DocBook

 xslt/docbook/common/db-title.xsl    |   43 +++----
 xslt/docbook/html/db2html-css.xsl   |   30 +++++
 xslt/docbook/html/db2html-index.xsl |  225 +++++++++++++++++++++++++++++++++--
 3 files changed, 264 insertions(+), 34 deletions(-)
---
diff --git a/xslt/docbook/common/db-title.xsl b/xslt/docbook/common/db-title.xsl
index 25f8a7e..76f4c26 100644
--- a/xslt/docbook/common/db-title.xsl
+++ b/xslt/docbook/common/db-title.xsl
@@ -13,10 +13,14 @@ details.
 You should have received a copy of the GNU Lesser General Public License
 along with this program; see the file COPYING.LGPL.  If not, see <http://www.gnu.org/licenses/>.
 -->
+<!DOCTYPE xsl:stylesheet [
+<!ENTITY % selectors SYSTEM "db-selectors.mod">
+%selectors;
+]>
 
 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform";
                 xmlns:db="http://docbook.org/ns/docbook";
-                                                               
xmlns:msg="http://projects.gnome.org/yelp/gettext/";
+                xmlns:msg="http://projects.gnome.org/yelp/gettext/";
                 exclude-result-prefixes="db msg"
                 version="1.0">
 
@@ -34,24 +38,20 @@ elements with optional titles.
 <!--**==========================================================================
 db.title
 Output a title for an element.
-:Revision:version="3.4" date="2011-11-10" status="final"
+:Revision:version="3.next" date="2017-03-18" status="final"
 $node: The element to output the title of.
 $info: The info child element of ${node}.
 
 This template outputs the title of the element ${node} as it might be used for
 a heading or for link text. For certain types of elements, this templates will
 use a localized automatic title if no explicit title is provided.
+
+When ${node} is an element for which this template cannot construct a title,
+it calls itself recursively passing the parent element of ${node}.
 -->
 <xsl:template name="db.title">
   <xsl:param name="node" select="."/>
-  <xsl:param name="info" select="
-    $node/appendixinfo   | $node/articleinfo        | $node/bibliographyinfo | $node/blockinfo    |
-    $node/bookinfo       | $node/chapterinfo        | $node/glossaryinfo     | $node/indexinfo    |
-    $node/objectinfo     | $node/partinfo           | $node/prefaceinfo      | $node/refentryinfo |
-    $node/referenceinfo  | $node/refsect1info       | $node/refsect2info     | $node/refsect3info |
-    $node/refsectioninfo | $node/refsynopsisdivinfo | $node/sect1info        | $node/sect2info    |
-    $node/sect3infof     | $node/sect4info          | $node/sect5info        | $node/sectioninfo  |
-    $node/setindexinfo   | $node/db:info "/>
+  <xsl:param name="info" select="$node/&db_infos;"/>
   <xsl:choose>
     <xsl:when test="$node/self::anchor or $node/self::db:anchor">
       <xsl:variable name="target_chunk_id">
@@ -124,6 +124,11 @@ use a localized automatic title if no explicit title is provided.
         <xsl:with-param name="msgid" select="'Synopsis'"/>
       </xsl:call-template>
     </xsl:when>
+    <xsl:when test="$node/..">
+      <xsl:call-template name="db.title">
+        <xsl:with-param name="node" select="$node/.."/>
+      </xsl:call-template>
+    </xsl:when>
   </xsl:choose>
 </xsl:template>
 
@@ -141,14 +146,7 @@ this template just calls *{db.title}.
 -->
 <xsl:template name="db.titleabbrev">
   <xsl:param name="node" select="."/>
-  <xsl:param name="info" select="
-    $node/appendixinfo   | $node/articleinfo        | $node/bibliographyinfo | $node/blockinfo    |
-    $node/bookinfo       | $node/chapterinfo        | $node/glossaryinfo     | $node/indexinfo    |
-    $node/objectinfo     | $node/partinfo           | $node/prefaceinfo      | $node/refentryinfo |
-    $node/referenceinfo  | $node/refsect1info       | $node/refsect2info     | $node/refsect3info |
-    $node/refsectioninfo | $node/refsynopsisdivinfo | $node/sect1info        | $node/sect2info    |
-    $node/sect3infof     | $node/sect4info          | $node/sect5info        | $node/sectioninfo  |
-    $node/setindexinfo   | $node/db:info "/>
+  <xsl:param name="info" select="$node/&db_infos;"/>
   <xsl:variable name="titleabbrev" select="
     $node/titleabbrev | $node/db:titleabbrev | $info/titleabbrev | $info/db:titleabbrev"/>
   <xsl:choose>
@@ -180,14 +178,7 @@ a subtitle is not found.
 -->
 <xsl:template name="db.subtitle">
   <xsl:param name="node" select="."/>
-  <xsl:param name="info" select="
-    $node/appendixinfo   | $node/articleinfo        | $node/bibliographyinfo | $node/blockinfo    |
-    $node/bookinfo       | $node/chapterinfo        | $node/glossaryinfo     | $node/indexinfo    |
-    $node/objectinfo     | $node/partinfo           | $node/prefaceinfo      | $node/refentryinfo |
-    $node/referenceinfo  | $node/refsect1info       | $node/refsect2info     | $node/refsect3info |
-    $node/refsectioninfo | $node/refsynopsisdivinfo | $node/sect1info        | $node/sect2info    |
-    $node/sect3infof     | $node/sect4info          | $node/sect5info        | $node/sectioninfo  |
-    $node/setindexinfo   | $node/db:info "/>
+  <xsl:param name="info" select="$node/&db_infos;"/>
   <xsl:variable name="subtitle" select="
     $node/subtitle | $node/db:subtitle | $info/subtitle | $info/db:subtitle"/>
   <xsl:choose>
diff --git a/xslt/docbook/html/db2html-css.xsl b/xslt/docbook/html/db2html-css.xsl
index 5354a1c..16b5333 100644
--- a/xslt/docbook/html/db2html-css.xsl
+++ b/xslt/docbook/html/db2html-css.xsl
@@ -112,6 +112,36 @@ a.footnote:hover, div.footnote > a.footnote:hover {
     <xsl:value-of select="$color.blue"/><xsl:text>;
 }
 
+<!-- == indexes == -->
+dt.ixprimary {
+  font-weight: bold;
+  color: </xsl:text><xsl:value-of select="$color.fg.dark"/><xsl:text>;
+}
+dt.ixprimary * { font-style: normal; }
+dt.ixprimary + dt.ixprimary { margin-top: 1em; }
+dd.ixsecondary {
+  color: </xsl:text><xsl:value-of select="$color.fg.gray"/><xsl:text>;
+}
+dt.ixsecondary, dt.ixtertiary { margin-top: 0.2em; }
+dd.ixlink, dd.ixsee, dd.ixseealso {
+  color: </xsl:text><xsl:value-of select="$color.fg.gray"/><xsl:text>;
+}
+dd.ixlink + dd, dd.ixsee + dd, dd.ixseealso + dd {
+  margin-top: 0.2em;
+}
+dt.ixsecondary:before, dt.ixtertiary:before {
+  content: "⏺";
+  color: </xsl:text><xsl:value-of select="$color.fg.gray"/><xsl:text>;
+}
+dd.ixlink:before {
+  content: "⏺";
+  color: </xsl:text><xsl:value-of select="$color.blue"/><xsl:text>;
+}
+dd.ixsee:before, dd.ixseealso:before {
+  content: "⏺";
+  color: </xsl:text><xsl:value-of select="$color.gray"/><xsl:text>;
+}
+
 <!-- == unsorted == -->
 dl.index dt { margin-top: 0; }
 dl.index dd { margin-top: 0; margin-bottom: 0; }
diff --git a/xslt/docbook/html/db2html-index.xsl b/xslt/docbook/html/db2html-index.xsl
index 48d3330..fa3f6f9 100644
--- a/xslt/docbook/html/db2html-index.xsl
+++ b/xslt/docbook/html/db2html-index.xsl
@@ -13,6 +13,28 @@ details.
 You should have received a copy of the GNU Lesser General Public License
 along with this program; see the file COPYING.LGPL.  If not, see <http://www.gnu.org/licenses/>.
 -->
+<!DOCTYPE xsl:stylesheet [
+<!ENTITY % selectors SYSTEM "../common/db-selectors.mod">
+%selectors;
+<!ENTITY primarykey "normalize-space(concat(
+  primary/@sortas | db:primary/@sortas, ' ',
+  primary | db:primary))">
+<!ENTITY secondarykey "normalize-space(concat(
+  primary/@sortas | db:primary/@sortas, ' ',
+  primary | db:primary, ' ',
+  secondary/@sortas | db:secondary/@sortas, ' ',
+  secondary | db:secondary))">
+<!ENTITY tertiarykey "normalize-space(concat(
+  primary/@sortas | db:primary/@sortas, ' ',
+  primary | db:primary, ' ',
+  secondary/@sortas | db:secondary/@sortas, ' ',
+  secondary | db:secondary, ' ',
+  tertiary/@sortas | db:tertiary/@sortas, ' ',
+  tertiary | db:tertiary))">
+<!ENTITY uppercase "'ABCDEFGHIJKLMNOPQRSTUVWXYZ'">
+<!ENTITY lowercase "'abcdefghijklmnopqrstuvwxyz'">
+]>
+<!-- FIXME: upper/lower for langs? -->
 
 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform";
                 xmlns:db="http://docbook.org/ns/docbook";
@@ -36,6 +58,22 @@ seealsoie
 indexterm (autoidx)
 -->
 
+<xsl:key name="db.index.all.key"
+         match="indexterm | db:indexterm"
+         use="''"/>
+
+<xsl:key name="db.index.primary.key"
+         match="indexterm | db:indexterm"
+         use="&primarykey;"/>
+
+<xsl:key name="db.index.secondary.key"
+         match="indexterm[secondary] | db:indexterm[db:secondary]"
+         use="&secondarykey;"/>
+
+<xsl:key name="db.index.tertiary.key"
+         match="indexterm[tertiary] | db:indexterm[db:tertiary]"
+         use="&tertiarykey;"/>
+
 <!-- == Matched Templates == -->
 
 <!-- = suppress = -->
@@ -47,7 +85,7 @@ indexterm (autoidx)
 <xsl:template match="indexentry | db:indexentry">
   <xsl:variable name="if"><xsl:call-template name="db.profile.test"/></xsl:variable>
   <xsl:if test="$if != ''">
-  <dt class="primaryie">
+  <dt class="ixprimary">
     <xsl:apply-templates select="primaryie/node() | db:primaryie/node()"/>
   </dt>
   <xsl:variable name="pri_see"
@@ -57,7 +95,7 @@ indexterm (autoidx)
                 select="seealsoie[not(preceding-sibling::secondaryie)] |
                         db:seealsoie[not(preceding-sibling::db:secondaryie)]"/>
   <xsl:if test="$pri_see">
-    <dd class="see">
+    <dd class="ixsee">
       <xsl:call-template name="l10n.gettext">
         <xsl:with-param name="msgid" select="'seeie.format'"/>
         <xsl:with-param name="node" select="$pri_see"/>
@@ -66,7 +104,7 @@ indexterm (autoidx)
     </dd>
   </xsl:if>
   <xsl:if test="$pri_seealso">
-    <dd class="seealso">
+    <dd class="ixseealso">
       <xsl:call-template name="l10n.gettext">
         <xsl:with-param name="msgid" select="'seealsoie.format'"/>
         <xsl:with-param name="node" select="$pri_seealso"/>
@@ -75,9 +113,9 @@ indexterm (autoidx)
     </dd>
   </xsl:if>
   <xsl:for-each select="secondaryie | db:secondaryie">
-    <dd class="secondary">
-      <dl class="secondary">
-        <dt class="secondaryie">
+    <dd class="ixsecondary">
+      <dl class="ixsecondary">
+        <dt class="ixsecondary">
           <xsl:apply-templates/>
         </dt>
         <xsl:variable name="sec_see"
@@ -96,7 +134,7 @@ indexterm (autoidx)
                               following-sibling::db:tertiaryie
                                 [set:has-same-node(preceding-sibling::db:secondaryie[1], current())]"/>
         <xsl:if test="$sec_see">
-          <dd class="see">
+          <dd class="ixsee">
             <xsl:call-template name="l10n.gettext">
               <xsl:with-param name="msgid" select="'seeie.format'"/>
               <xsl:with-param name="node" select="$sec_see"/>
@@ -105,7 +143,7 @@ indexterm (autoidx)
           </dd>
         </xsl:if>
         <xsl:if test="$sec_seealso">
-          <dd class="seealso">
+          <dd class="ixseealso">
             <xsl:call-template name="l10n.gettext">
               <xsl:with-param name="msgid" select="'seealsoie.format'"/>
               <xsl:with-param name="node" select="$sec_seealso"/>
@@ -216,4 +254,175 @@ indexterm (autoidx)
   </xsl:for-each>
 </xsl:template>
 
+<!-- = index % db2html.division.div.content.mode = -->
+<!-- Auto-generated indexes -->
+<xsl:template mode="db2html.division.div.content.mode"
+              match="index[count(indexentry | indexdiv) = 0] |
+                     db:index[count(db:indexentry | db:indexdiv) = 0]">
+  <xsl:param name="node" select="."/>
+  <xsl:param name="info" select="indexinfo | db:info"/>
+  <xsl:param name="depth_in_chunk">
+    <xsl:call-template name="db.chunk.depth-in-chunk">
+      <xsl:with-param name="node" select="$node"/>
+    </xsl:call-template>
+  </xsl:param>
+  <xsl:param name="depth_of_chunk">
+    <xsl:call-template name="db.chunk.depth-of-chunk">
+      <xsl:with-param name="node" select="$node"/>
+    </xsl:call-template>
+  </xsl:param>
+  <xsl:variable name="nots" select="title | db:title | titleabbrev | db:titleabbrev | subtitle | 
db:subtitle"/>
+  <xsl:apply-templates select="set:difference(*, $nots)">
+    <xsl:with-param name="depth_in_chunk" select="$depth_in_chunk + 1"/>
+    <xsl:with-param name="depth_of_chunk" select="$depth_of_chunk"/>
+  </xsl:apply-templates>
+
+  <xsl:variable name="allterms" select="key('db.index.all.key', '')"/>
+  <xsl:variable name="prifirstterms"
+                select="$allterms[count(. | key('db.index.primary.key', &primarykey;)[1]) = 1]"/>
+  <dl>
+    <xsl:for-each select="$prifirstterms">
+      <xsl:sort select="translate(&primarykey;, &uppercase;, &lowercase;)"/>
+      <xsl:variable name="term" select="."/>
+      <xsl:if test="true()">
+        <dt class="ixprimary">
+          <xsl:apply-templates select="primary/node() | db:primary/node()"/>
+        </dt>
+        <xsl:variable name="prikey" select="&primarykey;"/>
+        <xsl:variable name="priterms" select="key('db.index.primary.key', $prikey)"/>
+        <xsl:variable name="prilinks"
+                      select="$priterms[not(secondary | db:secondary | see | db:see)]"/>
+        <xsl:for-each select="$prilinks">
+          <dd class="ixlink">
+            <xsl:call-template name="db2html.xref">
+              <xsl:with-param name="target" select="."/>
+            </xsl:call-template>
+          </dd>
+        </xsl:for-each>
+        <xsl:variable name="prisee"
+                      select="$priterms[not(secondary)]/see | $priterms[not(db:secondary)]/db:see"/>
+        <xsl:for-each select="$prisee">
+          <dd class="ixsee">
+            <xsl:call-template name="l10n.gettext">
+              <xsl:with-param name="msgid" select="'seeie.format'"/>
+              <xsl:with-param name="node" select="."/>
+              <xsl:with-param name="format" select="true()"/>
+            </xsl:call-template>
+          </dd>
+        </xsl:for-each>
+        <xsl:variable name="priseealso"
+                      select="$priterms[not(secondary)]/seealso | $priterms[not(db:secondary)]/db:seealso"/>
+        <xsl:for-each select="$priseealso">
+          <dd class="ixseealso">
+            <xsl:call-template name="l10n.gettext">
+              <xsl:with-param name="msgid" select="'seealsoie.format'"/>
+              <xsl:with-param name="node" select="."/>
+              <xsl:with-param name="format" select="true()"/>
+            </xsl:call-template>
+          </dd>
+        </xsl:for-each>
+        <xsl:if test="$priterms/secondary or $priterms/db:secondary">
+          <dd class="ixsecondary">
+            <dl class="ixsecondary">
+              <xsl:variable name="secfirstterms"
+                            select="$priterms[count(. | key('db.index.secondary.key',
+                                                            &secondarykey;)[1]) = 1]"/>
+              <xsl:for-each select="$secfirstterms">
+                <xsl:sort select="translate(&secondarykey;, &uppercase;, &lowercase;)"/>
+                <xsl:if test="secondary | db:secondary">
+                  <dt class="ixsecondary">
+                    <xsl:value-of select="secondary | db:secondary"/>
+                  </dt>
+                  <xsl:variable name="seckey" select="&secondarykey;"/>
+                  <xsl:variable name="secterms" select="key('db.index.secondary.key', $seckey)"/>
+                  <xsl:variable name="seclinks"
+                                select="$secterms[not(tertiary | db:tertiary | see | db:see)]"/>
+                  <xsl:for-each select="$seclinks">
+                    <dd class="ixlink">
+                      <xsl:call-template name="db2html.xref">
+                        <xsl:with-param name="target" select="."/>
+                      </xsl:call-template>
+                    </dd>
+                  </xsl:for-each>
+                  <xsl:variable name="secsee"
+                                select="$secterms[not(tertiary)]/see | $secterms[not(db:tertiary)]/db:see"/>
+                  <xsl:for-each select="$secsee">
+                    <dd class="ixsee">
+                      <xsl:call-template name="l10n.gettext">
+                        <xsl:with-param name="msgid" select="'seeie.format'"/>
+                        <xsl:with-param name="node" select="."/>
+                        <xsl:with-param name="format" select="true()"/>
+                      </xsl:call-template>
+                    </dd>
+                  </xsl:for-each>
+                  <xsl:variable name="secseealso"
+                                select="$secterms[not(tertiary)]/seealso | 
$secterms[not(db:tertiary)]/db:seealso"/>
+                  <xsl:for-each select="$secseealso">
+                    <dd class="ixseealso">
+                      <xsl:call-template name="l10n.gettext">
+                        <xsl:with-param name="msgid" select="'seealsoie.format'"/>
+                        <xsl:with-param name="node" select="."/>
+                        <xsl:with-param name="format" select="true()"/>
+                      </xsl:call-template>
+                    </dd>
+                  </xsl:for-each>
+                  <xsl:if test="$secterms/tertiary or $secterms/db:tertiary">
+                    <dd class="ixtertiary">
+                      <dl class="ixtertiary">
+                        <xsl:variable name="terfirstterms"
+                            select="$secterms[count(. | key('db.index.tertiary.key',
+                                                            &tertiarykey;)[1]) = 1]"/>
+                        <xsl:for-each select="$terfirstterms">
+                          <xsl:sort select="translate(&tertiarykey;, &uppercase;, &lowercase;)"/>
+                          <xsl:if test="tertiary | db:tertiary">
+                            <dt class="ixtertiary">
+                              <xsl:value-of select="tertiary | db:tertiary"/>
+                            </dt>
+                            <xsl:variable name="terkey" select="&tertiarykey;"/>
+                            <xsl:variable name="terterms" select="key('db.index.tertiary.key', $terkey)"/>
+                            <xsl:variable name="terlinks" select="$terterms[not(see | db:see)]"/>
+                            <xsl:for-each select="$terlinks">
+                              <dd class="ixlink">
+                                <xsl:call-template name="db2html.xref">
+                                  <xsl:with-param name="target" select="."/>
+                                </xsl:call-template>
+                              </dd>
+                            </xsl:for-each>
+                            <xsl:variable name="tersee"
+                                          select="$terterms/see | $terterms/db:see"/>
+                            <xsl:for-each select="$tersee">
+                              <dd class="ixsee">
+                                <xsl:call-template name="l10n.gettext">
+                                  <xsl:with-param name="msgid" select="'seeie.format'"/>
+                                  <xsl:with-param name="node" select="."/>
+                                  <xsl:with-param name="format" select="true()"/>
+                                </xsl:call-template>
+                              </dd>
+                            </xsl:for-each>
+                            <xsl:variable name="terseealso"
+                                          select="$terterms/seealso | $terterms/db:seealso"/>
+                            <xsl:for-each select="$terseealso">
+                              <dd class="ixseealso">
+                                <xsl:call-template name="l10n.gettext">
+                                  <xsl:with-param name="msgid" select="'seealsoie.format'"/>
+                                  <xsl:with-param name="node" select="."/>
+                                  <xsl:with-param name="format" select="true()"/>
+                                </xsl:call-template>
+                              </dd>
+                            </xsl:for-each>
+                          </xsl:if>
+                        </xsl:for-each>
+                      </dl>
+                    </dd>
+                  </xsl:if>
+                </xsl:if>
+              </xsl:for-each>
+            </dl>
+          </dd>
+        </xsl:if>
+      </xsl:if>
+    </xsl:for-each>
+  </dl>
+</xsl:template>
+
 </xsl:stylesheet>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]