This is the mail archive of the
docbook@lists.oasis-open.org
mailing list for the DocBook project.
Re: [docbook] Automatically create index of commands
On Thu, Aug 28, 2003 at 11:53:41PM +0200, David N. Welton wrote:
> Bob Stayton <bobs@sco.com> writes:
>
> [stuff deleted]
>
> > If so, then you can do this with the HTML stylesheets out of the
> > box. The TOC mechanism has a lot of options, and I think it can
> > meet your needs.
>
> > Rewrite your entries from varlistentry to refentry as Bob
> > sugggested. That gives you the structure for name and purpose for
> > each entry. You can put a set of refentry elements in a sect1 or
> > other section level, without putting them into a reference
> > container. What's missing is a section table of contents, which you
> > need to turn on using this stylesheet parameter:
>
> The other thing that is missing is the aggregation of all the
> refentries on to one page. From what I can make out in chunk.xsl, it
> wants to make these individual pages - or am I mistaken? Since my
> commands don't have long descriptions, they don't warrant individual
> pages at the moment.
>
> > generate.section.toc.level=1 (if you use sect1)
>
> I actually use 'section'. Does that change things?
>
> > This turns on a table of contents for sect1 level elements. Of
> > course, it will turn on the toc for all sect1 level elements, which
> > you may not want. There are ways to work around that if you are
> > interested.
>
> Yes, I suppose I would.
I've included here a customization that should work for
your purposes. Changing the chunking behavior in
DocBook requires two stylesheet files because of the way
chunking is handled. The first one (base.xsl) handles
importing the stock docbook.xsl and adding any element
templates, and the second (norefchunk.xsl) imports base.xsl
and handles customizing the chunk behavior.
You process your document with norefchunk.xsl.
The trick was to remove refentry from all the chunking code,
and add a new refentry template that doesn't call process-chunk.
All that is in norefchunk.xsl.
The base.xsl template just handles turning on a section
toc if a section has <section role="reference">.
That lets you only have the toc for sections you designate
as reference using the role attribute.
-------------------------- base.xsl ----------------------
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform";
xmlns:exsl="http://exslt.org/common";
version="1.0"
exclude-result-prefixes="exsl">
<xsl:import href="../docbook-xsl-1.61.3/html/docbook.xsl"/>
<xsl:template match="section">
<xsl:variable name="depth" select="count(ancestor::section)+1"/>
<div class="{name(.)}">
<xsl:call-template name="language.attribute"/>
<xsl:call-template name="section.titlepage"/>
<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="@role = 'reference' or (contains($toc.params, 'toc')
and $depth <= $generate.section.toc.level)">
<xsl:call-template name="section.toc">
<xsl:with-param name="toc.title.p" select="contains($toc.params, 'title')"/>
</xsl:call-template>
<xsl:call-template name="section.toc.separator"/>
</xsl:if>
<xsl:apply-templates/>
<xsl:call-template name="process.chunk.footnotes"/>
</div>
</xsl:template>
</xsl:stylesheet>
-------------------------- end of base.xsl ----------------------
-------------------------- norefchunk.xsl ----------------------
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform";
xmlns:exsl="http://exslt.org/common";
version="1.0"
exclude-result-prefixes="exsl">
<xsl:import href="base2.xsl"/>
<xsl:import href="../docbook-xsl-1.61.3/html/chunk-common.xsl"/>
<xsl:include href="../docbook-xsl-1.61.3/html/manifest.xsl"/>
<!-- Why is chunk-code now xsl:included?
Suppose you want to customize *both* the chunking algorithm used *and* the
presentation of some elements that may be chunks. In order to do that, you
must get the order of imports "just right". The answer is to make your own
copy of this file, where you replace the initial import of "docbook.xsl"
with an import of your own base.xsl (that does its own import of docbook.xsl).
Put the templates for changing the presentation of elements in your base.xsl.
Put the templates that control chunking after the include of chunk-code.xsl.
Voila! (Man I hope we can do this better in XSLT 2.0)
-->
<xsl:include href="../docbook-xsl-1.61.3/html/chunk-code.xsl"/>
<xsl:template name="chunk">
<xsl:param name="node" select="."/>
<!-- returns 1 if $node is a chunk -->
<!-- ==================================================================== -->
<!-- What's a chunk?
The root element
appendix
article
bibliography in article or book
book
chapter
colophon
glossary in article or book
index in article or book
part
preface
refentry
reference
sect{1,2,3,4,5} if position()>1 && depth < chunk.section.depth
section if position()>1 && depth < chunk.section.depth
set
setindex
-->
<!-- ==================================================================== -->
<!--
<xsl:message>
<xsl:text>chunk: </xsl:text>
<xsl:value-of select="name($node)"/>
<xsl:text>(</xsl:text>
<xsl:value-of select="$node/@id"/>
<xsl:text>)</xsl:text>
<xsl:text> csd: </xsl:text>
<xsl:value-of select="$chunk.section.depth"/>
<xsl:text> cfs: </xsl:text>
<xsl:value-of select="$chunk.first.sections"/>
<xsl:text> ps: </xsl:text>
<xsl:value-of select="count($node/parent::section)"/>
<xsl:text> prs: </xsl:text>
<xsl:value-of select="count($node/preceding-sibling::section)"/>
</xsl:message>
-->
<xsl:choose>
<xsl:when test="not($node/parent::*)">1</xsl:when>
<xsl:when test="local-name($node) = 'sect1'
and $chunk.section.depth >= 1
and ($chunk.first.sections != 0
or count($node/preceding-sibling::sect1) > 0)">
<xsl:text>1</xsl:text>
</xsl:when>
<xsl:when test="local-name($node) = 'sect2'
and $chunk.section.depth >= 2
and ($chunk.first.sections != 0
or count($node/preceding-sibling::sect2) > 0)">
<xsl:call-template name="chunk">
<xsl:with-param name="node" select="$node/parent::*"/>
</xsl:call-template>
</xsl:when>
<xsl:when test="local-name($node) = 'sect3'
and $chunk.section.depth >= 3
and ($chunk.first.sections != 0
or count($node/preceding-sibling::sect3) > 0)">
<xsl:call-template name="chunk">
<xsl:with-param name="node" select="$node/parent::*"/>
</xsl:call-template>
</xsl:when>
<xsl:when test="local-name($node) = 'sect4'
and $chunk.section.depth >= 4
and ($chunk.first.sections != 0
or count($node/preceding-sibling::sect4) > 0)">
<xsl:call-template name="chunk">
<xsl:with-param name="node" select="$node/parent::*"/>
</xsl:call-template>
</xsl:when>
<xsl:when test="local-name($node) = 'sect5'
and $chunk.section.depth >= 5
and ($chunk.first.sections != 0
or count($node/preceding-sibling::sect5) > 0)">
<xsl:call-template name="chunk">
<xsl:with-param name="node" select="$node/parent::*"/>
</xsl:call-template>
</xsl:when>
<xsl:when test="local-name($node) = 'section'
and $chunk.section.depth >= count($node/ancestor::section)+1
and ($chunk.first.sections != 0
or count($node/preceding-sibling::section) > 0)">
<xsl:call-template name="chunk">
<xsl:with-param name="node" select="$node/parent::*"/>
</xsl:call-template>
</xsl:when>
<xsl:when test="name($node)='preface'">1</xsl:when>
<xsl:when test="name($node)='chapter'">1</xsl:when>
<xsl:when test="name($node)='appendix'">1</xsl:when>
<xsl:when test="name($node)='article'">1</xsl:when>
<xsl:when test="name($node)='part'">1</xsl:when>
<xsl:when test="name($node)='reference'">1</xsl:when>
<xsl:when test="name($node)='refentry'">0</xsl:when>
<xsl:when test="name($node)='index'
and (name($node/parent::*) = 'article'
or name($node/parent::*) = 'book')">1</xsl:when>
<xsl:when test="name($node)='bibliography'
and (name($node/parent::*) = 'article'
or name($node/parent::*) = 'book')">1</xsl:when>
<xsl:when test="name($node)='glossary'
and (name($node/parent::*) = 'article'
or name($node/parent::*) = 'book')">1</xsl:when>
<xsl:when test="name($node)='colophon'">1</xsl:when>
<xsl:when test="name($node)='book'">1</xsl:when>
<xsl:when test="name($node)='set'">1</xsl:when>
<xsl:when test="name($node)='setindex'">1</xsl:when>
<xsl:otherwise>0</xsl:otherwise>
</xsl:choose>
</xsl:template>
<xsl:template name="chunk-first-section-with-parent">
<xsl:param name="content">
<xsl:apply-imports/>
</xsl:param>
<!-- These xpath expressions are really hairy. The trick is to pick sections -->
<!-- that are not first children and are not the children of first children -->
<!-- Break these variables into pieces to work around
http://nagoya.apache.org/bugzilla/show_bug.cgi?id=6063 -->
<xsl:variable name="prev-v1"
select="(ancestor::sect1[$chunk.section.depth > 0
and preceding-sibling::sect1][1]
|ancestor::sect2[$chunk.section.depth > 1
and preceding-sibling::sect2
and parent::sect1[preceding-sibling::sect1]][1]
|ancestor::sect3[$chunk.section.depth > 2
and preceding-sibling::sect3
and parent::sect2[preceding-sibling::sect2]
and ancestor::sect1[preceding-sibling::sect1]][1]
|ancestor::sect4[$chunk.section.depth > 3
and preceding-sibling::sect4
and parent::sect3[preceding-sibling::sect2]
and ancestor::sect2[preceding-sibling::sect2]
and ancestor::sect1[preceding-sibling::sect1]][1]
|ancestor::sect5[$chunk.section.depth > 4
and preceding-sibling::sect5
and parent::sect4[preceding-sibling::sect4]
and ancestor::sect3[preceding-sibling::sect3]
and ancestor::sect2[preceding-sibling::sect2]
and ancestor::sect1[preceding-sibling::sect1]][1]
|ancestor::section[$chunk.section.depth > count(ancestor::section)
and not(ancestor::section[not(preceding-sibling::section)])][1])[last()]"/>
<xsl:variable name="prev-v2"
select="(preceding::sect1[$chunk.section.depth > 0
and preceding-sibling::sect1][1]
|preceding::sect2[$chunk.section.depth > 1
and preceding-sibling::sect2
and parent::sect1[preceding-sibling::sect1]][1]
|preceding::sect3[$chunk.section.depth > 2
and preceding-sibling::sect3
and parent::sect2[preceding-sibling::sect2]
and ancestor::sect1[preceding-sibling::sect1]][1]
|preceding::sect4[$chunk.section.depth > 3
and preceding-sibling::sect4
and parent::sect3[preceding-sibling::sect2]
and ancestor::sect2[preceding-sibling::sect2]
and ancestor::sect1[preceding-sibling::sect1]][1]
|preceding::sect5[$chunk.section.depth > 4
and preceding-sibling::sect5
and parent::sect4[preceding-sibling::sect4]
and ancestor::sect3[preceding-sibling::sect3]
and ancestor::sect2[preceding-sibling::sect2]
and ancestor::sect1[preceding-sibling::sect1]][1]
|preceding::section[$chunk.section.depth > count(ancestor::section)
and preceding-sibling::section
and not(ancestor::section[not(preceding-sibling::section)])][1])[last()]"/>
<xsl:variable name="prev"
select="(preceding::book[1]
|preceding::preface[1]
|preceding::chapter[1]
|preceding::appendix[1]
|preceding::part[1]
|preceding::reference[1]
|preceding::colophon[1]
|preceding::article[1]
|preceding::bibliography[1]
|preceding::glossary[1]
|preceding::index[1]
|preceding::setindex[1]
|ancestor::set
|ancestor::book[1]
|ancestor::preface[1]
|ancestor::chapter[1]
|ancestor::appendix[1]
|ancestor::part[1]
|ancestor::reference[1]
|ancestor::article[1]
|$prev-v1
|$prev-v2)[last()]"/>
<xsl:variable name="next-v1"
select="(following::sect1[$chunk.section.depth > 0
and preceding-sibling::sect1][1]
|following::sect2[$chunk.section.depth > 1
and preceding-sibling::sect2
and parent::sect1[preceding-sibling::sect1]][1]
|following::sect3[$chunk.section.depth > 2
and preceding-sibling::sect3
and parent::sect2[preceding-sibling::sect2]
and ancestor::sect1[preceding-sibling::sect1]][1]
|following::sect4[$chunk.section.depth > 3
and preceding-sibling::sect4
and parent::sect3[preceding-sibling::sect2]
and ancestor::sect2[preceding-sibling::sect2]
and ancestor::sect1[preceding-sibling::sect1]][1]
|following::sect5[$chunk.section.depth > 4
and preceding-sibling::sect5
and parent::sect4[preceding-sibling::sect4]
and ancestor::sect3[preceding-sibling::sect3]
and ancestor::sect2[preceding-sibling::sect2]
and ancestor::sect1[preceding-sibling::sect1]][1]
|following::section[$chunk.section.depth > count(ancestor::section)
and preceding-sibling::section
and not(ancestor::section[not(preceding-sibling::section)])][1])[1]"/>
<xsl:variable name="next-v2"
select="(descendant::sect1[$chunk.section.depth > 0
and preceding-sibling::sect1][1]
|descendant::sect2[$chunk.section.depth > 1
and preceding-sibling::sect2
and parent::sect1[preceding-sibling::sect1]][1]
|descendant::sect3[$chunk.section.depth > 2
and preceding-sibling::sect3
and parent::sect2[preceding-sibling::sect2]
and ancestor::sect1[preceding-sibling::sect1]][1]
|descendant::sect4[$chunk.section.depth > 3
and preceding-sibling::sect4
and parent::sect3[preceding-sibling::sect2]
and ancestor::sect2[preceding-sibling::sect2]
and ancestor::sect1[preceding-sibling::sect1]][1]
|descendant::sect5[$chunk.section.depth > 4
and preceding-sibling::sect5
and parent::sect4[preceding-sibling::sect4]
and ancestor::sect3[preceding-sibling::sect3]
and ancestor::sect2[preceding-sibling::sect2]
and ancestor::sect1[preceding-sibling::sect1]][1]
|descendant::section[$chunk.section.depth > count(ancestor::section)
and preceding-sibling::section
and not(ancestor::section[not(preceding-sibling::section)])])[1]"/>
<xsl:variable name="next"
select="(following::book[1]
|following::preface[1]
|following::chapter[1]
|following::appendix[1]
|following::part[1]
|following::reference[1]
|following::colophon[1]
|following::bibliography[1]
|following::glossary[1]
|following::index[1]
|following::article[1]
|following::setindex[1]
|descendant::book[1]
|descendant::preface[1]
|descendant::chapter[1]
|descendant::appendix[1]
|descendant::article[1]
|descendant::bibliography[1]
|descendant::glossary[1]
|descendant::index[1]
|descendant::colophon[1]
|descendant::setindex[1]
|descendant::part[1]
|descendant::reference[1]
|$next-v1
|$next-v2)[1]"/>
<xsl:call-template name="process-chunk">
<xsl:with-param name="prev" select="$prev"/>
<xsl:with-param name="next" select="$next"/>
<xsl:with-param name="content" select="$content"/>
</xsl:call-template>
</xsl:template>
<xsl:template name="chunk-all-sections">
<xsl:param name="content">
<xsl:apply-imports/>
</xsl:param>
<xsl:variable name="prev-v1"
select="(preceding::sect1[$chunk.section.depth > 0][1]
|preceding::sect2[$chunk.section.depth > 1][1]
|preceding::sect3[$chunk.section.depth > 2][1]
|preceding::sect4[$chunk.section.depth > 3][1]
|preceding::sect5[$chunk.section.depth > 4][1]
|preceding::section[$chunk.section.depth > count(ancestor::section)][1])[last()]"/>
<xsl:variable name="prev-v2"
select="(ancestor::sect1[$chunk.section.depth > 0][1]
|ancestor::sect2[$chunk.section.depth > 1][1]
|ancestor::sect3[$chunk.section.depth > 2][1]
|ancestor::sect4[$chunk.section.depth > 3][1]
|ancestor::sect5[$chunk.section.depth > 4][1]
|ancestor::section[$chunk.section.depth > count(ancestor::section)][1])[last()]"/>
<xsl:variable name="prev"
select="(preceding::book[1]
|preceding::preface[1]
|preceding::chapter[1]
|preceding::appendix[1]
|preceding::part[1]
|preceding::reference[1]
|preceding::colophon[1]
|preceding::article[1]
|preceding::bibliography[1]
|preceding::glossary[1]
|preceding::index[1]
|preceding::setindex[1]
|ancestor::set
|ancestor::book[1]
|ancestor::preface[1]
|ancestor::chapter[1]
|ancestor::appendix[1]
|ancestor::part[1]
|ancestor::reference[1]
|ancestor::article[1]
|$prev-v1
|$prev-v2)[last()]"/>
<xsl:variable name="next-v1"
select="(following::sect1[$chunk.section.depth > 0][1]
|following::sect2[$chunk.section.depth > 1][1]
|following::sect3[$chunk.section.depth > 2][1]
|following::sect4[$chunk.section.depth > 3][1]
|following::sect5[$chunk.section.depth > 4][1]
|following::section[$chunk.section.depth > count(ancestor::section)][1])[1]"/>
<xsl:variable name="next-v2"
select="(descendant::sect1[$chunk.section.depth > 0][1]
|descendant::sect2[$chunk.section.depth > 1][1]
|descendant::sect3[$chunk.section.depth > 2][1]
|descendant::sect4[$chunk.section.depth > 3][1]
|descendant::sect5[$chunk.section.depth > 4][1]
|descendant::section[$chunk.section.depth
> count(ancestor::section)][1])[1]"/>
<xsl:variable name="next"
select="(following::book[1]
|following::preface[1]
|following::chapter[1]
|following::appendix[1]
|following::part[1]
|following::reference[1]
|following::colophon[1]
|following::bibliography[1]
|following::glossary[1]
|following::index[1]
|following::article[1]
|following::setindex[1]
|descendant::book[1]
|descendant::preface[1]
|descendant::chapter[1]
|descendant::appendix[1]
|descendant::article[1]
|descendant::bibliography[1]
|descendant::glossary[1]
|descendant::index[1]
|descendant::colophon[1]
|descendant::setindex[1]
|descendant::part[1]
|descendant::reference[1]
|$next-v1
|$next-v2)[1]"/>
<xsl:call-template name="process-chunk">
<xsl:with-param name="prev" select="$prev"/>
<xsl:with-param name="next" select="$next"/>
<xsl:with-param name="content" select="$content"/>
</xsl:call-template>
</xsl:template>
<xsl:template match="refentry">
<xsl:apply-imports/>
</xsl:template>
<xsl:template match="set|book|part|preface|chapter|appendix
|article
|reference
|book/glossary|article/glossary|part/glossary
|book/bibliography|article/bibliography
|colophon">
<xsl:choose>
<xsl:when test="$onechunk != 0 and parent::*">
<xsl:apply-imports/>
</xsl:when>
<xsl:otherwise>
<xsl:call-template name="process-chunk-element"/>
</xsl:otherwise>
</xsl:choose>
</xsl:template>
</xsl:stylesheet>
-------------------------- end of norefchunk.xsl ----------------------
Bob Stayton 400 Encinal Street
Publications Architect Santa Cruz, CA 95060
Technical Publications voice: (831) 427-7796
The SCO Group fax: (831) 429-1887
email: bobs@sco.com
To unsubscribe from this list, send a post to docbook-unsubscribe@lists.oasis-open.org.