我有一堆DocBook XML文件,它们都被合并到一个DocBook文件中,以便转换为HTML。每个单独的文档都是一个参考页(用于函数或类似结构)。我使用分块HTML生成,这样每个引用页面就变成了自己的HTML页面。
问题是:我希望每页都有一个目录。但我不想要那个页面的目录。我想要整个参考手册的完整目录。
也就是说,从任何页面,我都希望能够通过使用TOC跳转到任何其他页面。我可以使用CSS样式将TOC粘贴在左侧(甚至可以隐藏它以供移动查看或其他什么)。
有一种明显的方法可以解决这个问题。我可以通过后处理脚本提取主TOC,并让脚本将其复制到每个输出HTML文档中。我正在寻找一种在DocBook XSL中工作的方法。
我希望结果看起来更像DocBookXSL的新网络帮助,但不太明显地涉及JavaScript。
截至2019-07-06,对于docbook-xsl-1.79.2,当前接受的答案不足以使每个目录都完整。
但是,下面的XSL模板确实如此。关键的见解是使用Oxygen XML编辑器的调试器,注意到虽然toc-context
被正确地设置为根元素,但nodes
变量仍然是本地子集。
我解开了toc-context
的零钱。相反,我创建了一个选择/
的新变量root-nodes
,并编辑了make.toc
模板以使用root-nodes
而不是nodes.
把它放在我的定制层中,现在每个目录都是一个完整的目录。
<xsl:template name="make.toc">
<xsl:param name="toc-context" select="."/>
<xsl:param name="toc.title.p" select="true()"/>
<xsl:param name="nodes" select="/NOT-AN-ELEMENT"/>
<xsl:variable name="root-nodes" select="/"/>
<xsl:variable name="nodes.plus" select="$root-nodes | d:qandaset"/>
<xsl:variable name="toc.title">
<xsl:if test="$toc.title.p">
<xsl:choose>
<xsl:when test="$make.clean.html != 0">
<div class="toc-title">
<xsl:call-template name="gentext">
<xsl:with-param name="key">TableofContents</xsl:with-param>
</xsl:call-template>
</div>
</xsl:when>
<xsl:otherwise>
<p>
<strong>
<xsl:call-template name="gentext">
<xsl:with-param name="key">TableofContents</xsl:with-param>
</xsl:call-template>
</strong>
</p>
</xsl:otherwise>
</xsl:choose>
</xsl:if>
</xsl:variable>
<xsl:choose>
<xsl:when test="$manual.toc != ''">
<xsl:variable name="id">
<xsl:call-template name="object.id"/>
</xsl:variable>
<xsl:variable name="toc" select="document($manual.toc, .)"/>
<xsl:variable name="tocentry" select="$toc//d:tocentry[@linkend=$id]"/>
<xsl:if test="$tocentry and $tocentry/*">
<div class="toc">
<xsl:copy-of select="$toc.title"/>
<xsl:element name="{$toc.list.type}" namespace="http://www.w3.org/1999/xhtml">
<xsl:call-template name="toc.list.attributes">
<xsl:with-param name="toc-context" select="$toc-context"/>
<xsl:with-param name="toc.title.p" select="$toc.title.p"/>
<xsl:with-param name="nodes" select="$root-nodes"/>
</xsl:call-template>
<xsl:call-template name="manual-toc">
<xsl:with-param name="tocentry" select="$tocentry/*[1]"/>
</xsl:call-template>
</xsl:element>
</div>
</xsl:if>
</xsl:when>
<xsl:otherwise>
<xsl:choose>
<xsl:when test="$qanda.in.toc != 0">
<xsl:if test="$nodes.plus">
<div class="toc">
<xsl:copy-of select="$toc.title"/>
<xsl:element name="{$toc.list.type}" namespace="http://www.w3.org/1999/xhtml">
<xsl:call-template name="toc.list.attributes">
<xsl:with-param name="toc-context" select="$toc-context"/>
<xsl:with-param name="toc.title.p" select="$toc.title.p"/>
<xsl:with-param name="nodes" select="$root-nodes"/>
</xsl:call-template>
<xsl:apply-templates select="$nodes.plus" mode="toc">
<xsl:with-param name="toc-context" select="$toc-context"/>
</xsl:apply-templates>
</xsl:element>
</div>
</xsl:if>
</xsl:when>
<xsl:otherwise>
<xsl:if test="$root-nodes">
<div class="toc">
<xsl:copy-of select="$toc.title"/>
<xsl:element name="{$toc.list.type}" namespace="http://www.w3.org/1999/xhtml">
<xsl:call-template name="toc.list.attributes">
<xsl:with-param name="toc-context" select="$toc-context"/>
<xsl:with-param name="toc.title.p" select="$toc.title.p"/>
<xsl:with-param name="nodes" select="$root-nodes"/>
</xsl:call-template>
<xsl:apply-templates select="$root-nodes" mode="toc">
<xsl:with-param name="toc-context" select="$toc-context"/>
</xsl:apply-templates>
</xsl:element>
</div>
</xsl:if>
</xsl:otherwise>
</xsl:choose>
</xsl:otherwise>
</xsl:choose>
</xsl:template>
注意:还有一个问题,不是每个分块的页面都有自己的ToC,但这与特定的ToC无关。如果我对它进行排序,我会添加一条关于我是如何做到这一点的评论
有一种相对简单的方法可以实现这一点,尽管我敢肯定,如果不创建DocBook XSL自定义层或直接修改已安装的(系统)样式表,就无法实现。
不管怎样,我认为您需要修改或覆盖的实际docbookxsl模板名为make.toc
,位于文件html/autotoc.xsl
中的样式表分布中。
这是一个很大的模板——将近一百行——但你只需要对它做一行更改:
--- /usr/share/xml/docbook/stylesheet/docbook-xsl/html/autotoc.xsl 2012-12-16 11:35:12.000000000 +0900
+++ /opt/workspace/autotoc.xsl 2015-12-26 09:19:36.000000000 +0900
@@ -28,7 +28,7 @@
</xsl:variable>
<xsl:template name="make.toc">
- <xsl:param name="toc-context" select="."/>
+ <xsl:param name="toc-context" select="/"/>
<xsl:param name="toc.title.p" select="true()"/>
<xsl:param name="nodes" select="/NOT-AN-ELEMENT"/>
也就是说,您需要调用toc-context
参数设置为"/
"(而不是".
")的模板。
默认的".
"值告诉模板,当为块创建TOC时,它应该只查看当前正在处理的任何元素的(子)内容(即特定块的根);例如,如果它正在处理一个section
,它只查看该section
的子级。
但是,如果将该值改为"/
",则意味着模板每次都要(重新)查看源文档的整个内容。因此,如果你的文档是book
,它每次都会给你整本书的整个TOC,或者如果你的文件是article
,整篇文章,等等。
所以我认为这应该给你想要的。
如果您决定只修改已安装的样式表,并且已经从您使用的任何特定于操作系统的包管理器中安装了它们,那么您需要找到html/autotoc.xsl
文件的安装位置。
在我的Debian Linux系统上,html/autotoc.xsl
文件在这里:
/usr/share/xml/docbook/stylesheet/docbook-xsl/html/autotoc.xsl
在我的OS X系统上,从自制软件包安装,它在这里:
/usr/local/opt/docbook-xsl/docbook-xsl/html/autotoc.xsl
如果您决定创建一个自定义层,则需要将整个make.toc
模板复制到您的自定义层中(但toc-context
参数更改为"/
")。