From: Mauritz Jeanson <mj@johanneberg.com>
Date: Sat, 28 Mar 2009 14:17:17 +0000 (+0000)
Subject: Added a new parameter, bookmarks.collapse, that controls the initial state
X-Git-Tag: release/1.79.1~6^2~1052
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=97b68bbdf72ca5dfffe2bc66bc01b62ddc0fd741;p=docbook-dsssl

Added a new parameter, bookmarks.collapse, that controls the initial state
of the bookmark tree. When the parameter has a non-zero value (the default),
only the top-level bookmarks are displayed initially. Otherwise, the whole
tree of bookmarks is displayed.

This is implemented for FOP 0.9X. Closes FR #1792326.
---

diff --git a/xsl/fo/fop1.xsl b/xsl/fo/fop1.xsl
index 566b0fb53..99d0663ed 100644
--- a/xsl/fo/fop1.xsl
+++ b/xsl/fo/fop1.xsl
@@ -15,6 +15,13 @@
 
 <!-- ==================================================================== -->
 
+<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>
@@ -40,6 +47,9 @@
     <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(translate($bookmark-label, $a-dia, $a-asc))"/>
         </fo:bookmark-title>
@@ -48,6 +58,9 @@
     </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(translate($bookmark-label, $a-dia, $a-asc))"/>
         </fo:bookmark-title>
diff --git a/xsl/fo/param.ent b/xsl/fo/param.ent
index efb729051..52879e605 100644
--- a/xsl/fo/param.ent
+++ b/xsl/fo/param.ent
@@ -338,3 +338,4 @@
 <!ENTITY glossdef.list.properties SYSTEM "../params/glossdef.list.properties.xml">
 <!ENTITY glossdef.block.properties SYSTEM "../params/glossdef.block.properties.xml">
 <!ENTITY glossentry.list.item.properties SYSTEM "../params/glossentry.list.item.properties.xml">
+<!ENTITY bookmarks.collapse SYSTEM "../params/bookmarks.collapse.xml">
diff --git a/xsl/fo/param.xweb b/xsl/fo/param.xweb
index 79a448e1a..3aaf75397 100644
--- a/xsl/fo/param.xweb
+++ b/xsl/fo/param.xweb
@@ -269,6 +269,7 @@ generate.section.toc.level;
 &section.container.element;
 &monospace.verbatim.font.width;
 &exsl.node.set.available;
+&bookmarks.collapse;
 </reference>
 <reference xml:id="graphics"><title>Graphics</title>
 &graphic.default.extension;
@@ -568,6 +569,7 @@ around all these parameters.</para>
 <src:fragref linkend="body.margin.top.frag"/>
 <src:fragref linkend="body.start.indent.frag"/>
 <src:fragref linkend="body.end.indent.frag"/>
+<src:fragref linkend="bookmarks.collapse.frag"/>
 <src:fragref linkend="bridgehead.in.toc.frag"/>
 <src:fragref linkend="callout.defaultcolumn.frag"/>
 <src:fragref linkend="callout.graphics.extension.frag"/>
diff --git a/xsl/params/bookmarks.collapse.xml b/xsl/params/bookmarks.collapse.xml
new file mode 100644
index 000000000..332005692
--- /dev/null
+++ b/xsl/params/bookmarks.collapse.xml
@@ -0,0 +1,31 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="bookmarks.collapse">
+<refmeta>
+<refentrytitle>bookmarks.collapse</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> 
+</refmeta>
+<refnamediv>
+<refname>bookmarks.collapse</refname>
+<refpurpose>Specifies the initial state of bookmarks</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="bookmarks.collapse.frag">
+<xsl:param name="bookmarks.collapse" select="1"></xsl:param>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+
+<para>If non-zero, the bookmark tree is collapsed so that only the 
+top-level bookmarks are displayed initially. Otherwise, the whole tree 
+of bookmarks is displayed.</para>
+
+<para>This parameter currently works with FOP 0.93 or later.</para>
+
+</refsection>
+</refentry>