From: Bob Stayton <bobs@sagehill.net>
Date: Tue, 7 Jan 2014 21:36:28 +0000 (+0000)
Subject: Add support for standard XSL 1.1 bookmarks and parameter
X-Git-Tag: release/1.79.1~6^2~132
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=b71859041b231e05d70bd5ca6dd5afd86d22db56;p=docbook-dsssl

Add support for standard XSL 1.1 bookmarks and parameter
$xsl1.1.bookmarks to turn them on or off.
---

diff --git a/xsl/fo/autotoc.xsl b/xsl/fo/autotoc.xsl
index 543cc139e..97fc0acfd 100644
--- a/xsl/fo/autotoc.xsl
+++ b/xsl/fo/autotoc.xsl
@@ -35,7 +35,7 @@
   <xsl:if test="$nodes">
     <fo:block id="toc...{$id}"
               xsl:use-attribute-sets="toc.margin.properties">
-      <xsl:if test="$axf.extensions != 0">
+      <xsl:if test="$axf.extensions != 0 and $xsl1.1.bookmarks = 0">
         <xsl:attribute name="axf:outline-level">1</xsl:attribute>
         <xsl:attribute name="axf:outline-expand">false</xsl:attribute>
         <xsl:attribute name="axf:outline-title">
@@ -77,7 +77,7 @@
   <xsl:if test="$nodes">
     <fo:block id="toc...{$cid}"
               xsl:use-attribute-sets="toc.margin.properties">
-      <xsl:if test="$axf.extensions != 0">
+      <xsl:if test="$axf.extensions != 0 and $xsl1.1.bookmarks = 0">
         <xsl:attribute name="axf:outline-level">1</xsl:attribute>
         <xsl:attribute name="axf:outline-expand">false</xsl:attribute>
         <xsl:attribute name="axf:outline-title">
diff --git a/xsl/fo/component.xsl b/xsl/fo/component.xsl
index d68106073..10d132238 100644
--- a/xsl/fo/component.xsl
+++ b/xsl/fo/component.xsl
@@ -71,7 +71,7 @@
         <xsl:with-param name="key" select="'hyphenation-remain-character-count'"/>
       </xsl:call-template>
     </xsl:attribute>
-    <xsl:if test="$axf.extensions != 0">
+    <xsl:if test="$axf.extensions != 0 and $xsl1.1.bookmarks = 0">
       <xsl:attribute name="axf:outline-level">
         <xsl:value-of select="count($node/ancestor::*)"/>
       </xsl:attribute>
@@ -703,7 +703,7 @@
   </xsl:variable>
 
   <fo:block id='{$id}'>
-    <xsl:if test="$axf.extensions != 0">
+    <xsl:if test="$axf.extensions != 0 and $xsl1.1.bookmarks = 0">
       <xsl:attribute name="axf:outline-level">
         <xsl:value-of select="count(ancestor::*)+2"/>
       </xsl:attribute>
diff --git a/xsl/fo/division.xsl b/xsl/fo/division.xsl
index e74026338..9c479c3b7 100644
--- a/xsl/fo/division.xsl
+++ b/xsl/fo/division.xsl
@@ -31,7 +31,7 @@
 
   <fo:block keep-with-next.within-column="always"
             hyphenate="false">
-    <xsl:if test="$axf.extensions != 0">
+    <xsl:if test="$axf.extensions != 0 and $xsl1.1.bookmarks = 0">
       <xsl:attribute name="axf:outline-level">
         <xsl:choose>
           <xsl:when test="count($node/ancestor::*) > 0">
diff --git a/xsl/fo/docbook.xsl b/xsl/fo/docbook.xsl
index f2c396501..8ef5e8e9e 100644
--- a/xsl/fo/docbook.xsl
+++ b/xsl/fo/docbook.xsl
@@ -269,50 +269,147 @@
 
     <xsl:call-template name="setup.pagemasters"/>
 
-    <xsl:if test="$fop.extensions != 0">
-      <xsl:apply-templates select="$document.element" mode="fop.outline"/>
-    </xsl:if>
-
     <xsl:if test="$fop1.extensions != 0">
       <xsl:call-template name="fop1-document-information"/>
+      <xsl:apply-templates select="$document.element" mode="fop1.foxdest"/>
+    </xsl:if>
+
+    <!-- generate bookmark tree -->
+    <xsl:call-template name="generate.bookmarks"/>
+
+    <xsl:apply-templates select="$document.element"/>
+  </fo:root>
+</xsl:template>
+
+<xsl:template name="generate.bookmarks">
+  <xsl:choose>
+    <!-- use standard bookmark elements? -->
+    <xsl:when test="$xsl1.1.bookmarks != 0">
       <xsl:variable name="bookmarks">
         <xsl:apply-templates select="$document.element" 
-                             mode="fop1.outline"/>
+                             mode="bookmark"/>
       </xsl:variable>
       <xsl:if test="string($bookmarks) != ''">
         <fo:bookmark-tree>
           <xsl:copy-of select="$bookmarks"/>
         </fo:bookmark-tree>
       </xsl:if>
-      <xsl:apply-templates select="$document.element" 
-                           mode="fop1.foxdest"/>
-    </xsl:if>
+    </xsl:when>
+    <xsl:otherwise>
+      <xsl:choose>
+        <!-- pre FOP 1.0 -->
+        <xsl:when test="$fop.extensions != 0">
+          <xsl:apply-templates select="$document.element" mode="fop.outline"/>
+        </xsl:when>
+    
+        <!-- FOP 1.0 -->
+        <xsl:when test="$fop1.extensions != 0">
+          <xsl:variable name="bookmarks">
+            <xsl:apply-templates select="$document.element" 
+                                 mode="fop1.outline"/>
+          </xsl:variable>
+          <xsl:if test="string($bookmarks) != ''">
+            <fo:bookmark-tree>
+              <xsl:copy-of select="$bookmarks"/>
+            </fo:bookmark-tree>
+          </xsl:if>
+        </xsl:when>
+  
+        <!-- RenderX XEP 4.6 and earlier -->
+        <xsl:when test="$xep.extensions != 0">
+          <xsl:variable name="bookmarks">
+            <xsl:apply-templates select="$document.element" mode="xep.outline"/>
+          </xsl:variable>
+          <xsl:if test="string($bookmarks) != ''">
+            <rx:outline xmlns:rx="http://www.renderx.com/XSL/Extensions">
+              <xsl:copy-of select="$bookmarks"/>
+            </rx:outline>
+          </xsl:if>
+        </xsl:when>
+  
+        <!-- PTC Arbortext -->
+        <xsl:when test="$arbortext.extensions != 0">
+          <xsl:variable name="bookmarks">
+            <xsl:apply-templates select="$document.element"
+                                 mode="ati.xsl11.bookmarks"/>
+          </xsl:variable>
+          <xsl:if test="string($bookmarks) != ''">
+            <fo:bookmark-tree>
+              <xsl:copy-of select="$bookmarks"/>
+            </fo:bookmark-tree>
+          </xsl:if>
+        </xsl:when>
+      </xsl:choose>
+    </xsl:otherwise>
+  </xsl:choose>
+</xsl:template>
 
-    <xsl:if test="$xep.extensions != 0">
-      <xsl:variable name="bookmarks">
-        <xsl:apply-templates select="$document.element" mode="xep.outline"/>
-      </xsl:variable>
-      <xsl:if test="string($bookmarks) != ''">
-        <rx:outline xmlns:rx="http://www.renderx.com/XSL/Extensions">
-          <xsl:copy-of select="$bookmarks"/>
-        </rx:outline>
-      </xsl:if>
-    </xsl:if>
+<xsl:template match="*" mode="bookmark">
+  <xsl:apply-templates select="*" mode="bookmark"/>
+</xsl:template>
 
-    <xsl:if test="$arbortext.extensions != 0 and $ati.xsl11.bookmarks != 0">
-      <xsl:variable name="bookmarks">
-        <xsl:apply-templates select="$document.element"
-                             mode="ati.xsl11.bookmarks"/>
+<xsl:template match="set|book|part|reference|
+                     preface|chapter|appendix|article|topic
+                     |glossary|bibliography|index|setindex
+                     |refentry
+                     |sect1|sect2|sect3|sect4|sect5|section"
+              mode="bookmark">
+
+  <xsl:variable name="id">
+    <xsl:call-template name="object.id"/>
+  </xsl:variable>
+  <xsl:variable name="bookmark-label">
+    <xsl:apply-templates select="." mode="object.title.markup"/>
+  </xsl:variable>
+
+  <!-- Put the root element bookmark at the same level as its children -->
+  <!-- If the object is a set or book, generate a bookmark for the toc -->
+
+  <xsl:choose>
+    <xsl:when test="self::index and $generate.index = 0"/>
+    <xsl:when test="parent::*">
+      <fo:bookmark internal-destination="{$id}">
+        <xsl:attribute name="starting-state">
+          <xsl:value-of select="$bookmarks.state"/>
+        </xsl:attribute>
+        <fo:bookmark-title>
+          <xsl:value-of select="normalize-space($bookmark-label)"/>
+        </fo:bookmark-title>
+        <xsl:apply-templates select="*" mode="bookmark"/>
+      </fo:bookmark>
+    </xsl:when>
+    <xsl:otherwise>
+      <fo:bookmark internal-destination="{$id}">
+        <xsl:attribute name="starting-state">
+          <xsl:value-of select="$bookmarks.state"/>
+        </xsl:attribute>
+        <fo:bookmark-title>
+          <xsl:value-of select="normalize-space($bookmark-label)"/>
+        </fo:bookmark-title>
+      </fo:bookmark>
+
+      <xsl:variable name="toc.params">
+        <xsl:call-template name="find.path.params">
+          <xsl:with-param name="table" select="normalize-space($generate.toc)"/>
+        </xsl:call-template>
       </xsl:variable>
-      <xsl:if test="string($bookmarks) != ''">
-        <fo:bookmark-tree>
-          <xsl:copy-of select="$bookmarks"/>
-        </fo:bookmark-tree>
-      </xsl:if>
-    </xsl:if>
 
-    <xsl:apply-templates select="$document.element"/>
-  </fo:root>
+      <xsl:if test="contains($toc.params, 'toc')
+                    and (book|part|reference|preface|chapter|appendix|article|topic
+                         |glossary|bibliography|index|setindex
+                         |refentry
+                         |sect1|sect2|sect3|sect4|sect5|section)">
+        <fo:bookmark internal-destination="toc...{$id}">
+          <fo:bookmark-title>
+            <xsl:call-template name="gentext">
+              <xsl:with-param name="key" select="'TableofContents'"/>
+            </xsl:call-template>
+          </fo:bookmark-title>
+        </fo:bookmark>
+      </xsl:if>
+      <xsl:apply-templates select="*" mode="bookmark"/>
+    </xsl:otherwise>
+  </xsl:choose>
 </xsl:template>
 
 <xsl:template name="root.messages">
diff --git a/xsl/fo/fop1.xsl b/xsl/fo/fop1.xsl
index 7daf16b8c..ee167e087 100644
--- a/xsl/fo/fop1.xsl
+++ b/xsl/fo/fop1.xsl
@@ -17,13 +17,6 @@
 
 <!-- ==================================================================== -->
 
-<xsl:variable name="bookmarks.state">
-  <xsl:choose>
-    <xsl:when test="$bookmarks.collapse != 0">hide</xsl:when>
-    <xsl:otherwise>show</xsl:otherwise>
-  </xsl:choose>
-</xsl:variable>
-
 <xsl:template match="*" mode="fop1.outline">
   <xsl:apply-templates select="*" mode="fop1.outline"/>
 </xsl:template>
diff --git a/xsl/fo/param.ent b/xsl/fo/param.ent
index c8eb6b699..fa2311156 100644
--- a/xsl/fo/param.ent
+++ b/xsl/fo/param.ent
@@ -363,3 +363,4 @@
 <!ENTITY activate.external.olinks SYSTEM "../params/activate.external.olinks.xml">
 <!ENTITY force.blank.pages SYSTEM "../params/force.blank.pages.xml">
 <!ENTITY mark.optional.procedure.steps SYSTEM "../params/mark.optional.procedure.steps.xml">
+<!ENTITY xsl1.1.bookmarks SYSTEM "../params/xsl1.1.bookmarks.xml">
diff --git a/xsl/fo/param.xweb b/xsl/fo/param.xweb
index 8bdd9ce9b..d114f34f5 100644
--- a/xsl/fo/param.xweb
+++ b/xsl/fo/param.xweb
@@ -282,6 +282,7 @@ generate.section.toc.level;
 &monospace.verbatim.font.width;
 &exsl.node.set.available;
 &bookmarks.collapse;
+&xsl1.1.bookmarks;
 &generate.consistent.ids;
 &base.dir;
 &chunk.quietly;
@@ -932,6 +933,7 @@ around all these parameters.</para>
 <src:fragref linkend="region.outer.properties.frag"/>
 <src:fragref linkend="para.properties.frag"/>
 <src:fragref linkend="mark.optional.procedure.steps.frag"/>
+<src:fragref linkend="xsl1.1.bookmarks.frag"/>
 
 </xsl:stylesheet>
 </src:fragment>
diff --git a/xsl/fo/refentry.xsl b/xsl/fo/refentry.xsl
index 004080925..f969d681c 100644
--- a/xsl/fo/refentry.xsl
+++ b/xsl/fo/refentry.xsl
@@ -637,7 +637,7 @@
       </xsl:choose>
     </xsl:variable>
 
-    <xsl:if test="$axf.extensions != 0">
+    <xsl:if test="$axf.extensions != 0 and $xsl1.1.bookmarks = 0">
       <xsl:attribute name="axf:outline-level">
         <xsl:value-of select="count(ancestor::*)-1 + $offset"/>
       </xsl:attribute>
diff --git a/xsl/fo/sections.xsl b/xsl/fo/sections.xsl
index 691c7308e..6b242067d 100644
--- a/xsl/fo/sections.xsl
+++ b/xsl/fo/sections.xsl
@@ -294,7 +294,7 @@
       </xsl:apply-templates>
     </xsl:variable>
 
-    <xsl:if test="$axf.extensions != 0">
+    <xsl:if test="$axf.extensions != 0 and $xsl1.1.bookmarks = 0">
       <xsl:attribute name="axf:outline-level">
         <xsl:value-of select="count(ancestor::*)-1"/>
       </xsl:attribute>
diff --git a/xsl/fo/xep.xsl b/xsl/fo/xep.xsl
index 782ab378e..8af1a30ae 100644
--- a/xsl/fo/xep.xsl
+++ b/xsl/fo/xep.xsl
@@ -130,6 +130,9 @@
     <xsl:when test="self::index and $generate.index = 0"/>	
     <xsl:when test="parent::*">
       <rx:bookmark internal-destination="{$id}">
+        <xsl:attribute name="starting-state">
+          <xsl:value-of select="$bookmarks.state"/>
+        </xsl:attribute>
         <rx:bookmark-label>
           <xsl:value-of select="normalize-space($bookmark-label)"/>
         </rx:bookmark-label>
@@ -139,6 +142,9 @@
     <xsl:otherwise>
       <xsl:if test="$bookmark-label != ''">
         <rx:bookmark internal-destination="{$id}">
+          <xsl:attribute name="starting-state">
+            <xsl:value-of select="$bookmarks.state"/>
+          </xsl:attribute>
           <rx:bookmark-label>
             <xsl:value-of select="normalize-space($bookmark-label)"/>
           </rx:bookmark-label>