GNOME.org

DocBook to HTML - Tables of Contents

This module provides templates to create tables of contents from any division-level elements.

Modes
db2html.autotoc.mode

Renders a TOC entry for an element and its children

Templates
db2html.autotoc

Creates a table of contents for a given element

db2html.autotoc.mode

db2html.autotoc.mode — Renders a TOC entry for an element and its children

Parameters

is_info

Whether this contents list is for the info page

selected

A currently-selected page

toc_depth

How deep to create entries in the table of contents

labels

Whether to generate labels

titleabbrev

Whether to use titleabbrev instead of title

Description

This mode outputs a single element in a table of contents. If the toc_depth parameter is non-zero, then templates implementing this mode should call db2html.autotoc in their context node, passing their division-level child elements and decrementing toc_depth by one.

For a description of the other parameters, see db2html.autotoc.

db2html.autotoc

db2html.autotoc — Creates a table of contents for a given element

Parameters

node

The element to create a table of contents for

show_info

Whether to include a link to the info page

is_info

Whether this contents list is for the info page

show_title

Whether to give the contents list a title

selected

A currently-selected page

divisions

The division-level child elements of node

toc_depth

How deep nested contents should be listed.

labels

Whether to generate labels

titleabbrev

Whether to use titleabbrev instead of title

Description

This template creates a table of contents for a given division-level element. The calling template should pass the division-level child elements in the divisions parameter. Nested divisions will be listed to the depth specified in the toc_depth parameter. If the selected parameter is set to an existing element, then this template will only output ancestors and siblings of ancestors of the selected element. This effectively creates a tree which is expanded sufficiently to show a particular element.

This template accepts a number of parameters that control the style of the table of contents. The show_info parameter specifies whether a link to the info page ("About This Document") should be shown. The is_info parameter specifies whether the info page should be treated as the selected page. If the info page is selected, it will not be displayed as a link.

The show_title specifies whether a title should be placed at the top of the table of contents. The labels parameter specifies whether to place section numbers as labels before each element in the list. Finally, the titleabbrev element specifies whether list elements should use the titleabbrev of each element for the link text, if available.

DocBook to XHTML DocBook to HTML - Bibliographies

About

Copyright

Copyright © 2004  Shaun McCance

Legal Notice

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License (GFDL), Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. You can find a copy of the GFDL at this link or in the file COPYING-DOCS distributed with this manual.

This manual is part of a collection of GNOME manuals distributed under the GFDL. If you want to distribute this manual separately from the collection, you can do so by adding a copy of the license to the manual, as described in section 6 of the license.

Many of the names used by companies to distinguish their products and services are claimed as trademarks. Where those names appear in any GNOME documentation, and the members of the GNOME Documentation Project are made aware of those trademarks, then the names are in capital letters or initial capital letters.

DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED UNDER THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE WITH THE FURTHER UNDERSTANDING THAT:

  1. DOCUMENT IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES THAT THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE OF THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT, YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER EXCEPT UNDER THIS DISCLAIMER; AND
  2. UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL THE AUTHOR, INITIAL WRITER, ANY CONTRIBUTOR, OR ANY DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE LIABLE TO ANY PERSON FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR LOSSES ARISING OUT OF OR RELATING TO USE OF THE DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT, EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF THE POSSIBILITY OF SUCH DAMAGES.