COLLATEINDEX

Section: DocBook DSSSL (1)
Updated: 2002-02-23
Index
Return to Main Contents

NAME

collateindex.pl - generate DocBook index files

collateindex.pl [-p] [-g] [-s name] [-t name] [-P file]
[-i id] [-o file] [-S scope] [-I scope]
[-x] [-f] [-N] [-q] [file

collateindex.pl is a Perl script that creates index data for DocBook XML or SGML files.

-p: Link to points in the document. The default is to link to the closest containing section.
-g: Group terms with IndexDiv based on the first letter of the term (or its sortas attribute). (This probably doesn't handle i10n particularly well.)
-s: Name the IndexDiv that contains symbols. The default is 'Symbols'. Meaningless if -g is not used.
-t name: Title for the index.
-P file: Read a preamble from file. The contents of file will be inserted before the <index> tag.
-i id: The ID to use for the <index> tag.
-o file: Output to file. Defaults to stdout.
-S scope: Scope of the index, must be "all", "local", or "global". If unspecified, "all" is assumed.
-I scope: The implied scope, must be "all", "local", or "global". IndexTerms which do not specify a scope will have the implied scope. If unspecified, "all" is assumed.
-x: Make a SetIndex.
-f: Force the output file to be written, even if it appears to have been edited by hand.
-N: New index (generates an empty index file).
-q: Run quietly.
-V: Print version number and exit.
file: The file containing index data generated by Jade with the DocBook HTML Stylesheet.

collateindex.pl -o index.sgml HTML.index

Norm Walsh <ndw@nwalsh.com>.

Minor updates by Adam Di Carlo <adam@onshore.com>.

This document was created by man2html, using the manual pages.
Time: 00:33:46 GMT, April 18, 2024