$index-on-type

$index-on-role, $index-on-type

$index-on-type, $index-on-role — Make distinct indexes based on role and type?

Parameter:

{}index-on-type

{}index-on-role

Defined in:

param.xsl (2)

Used in:

param.xsl, modules/index.xsl

Used by:

t:generate-index

Synopsis

  |$index-on-type := 'true'

  |$index-on-role := 'true'

Description

DocBook supports the creation of different types of index. A book that documents an API might have a general index, for example, and also an index of functions, an index of variables, etc.

Typed indexes are created by specifying the index type in the type or role attribute. If $index-on-type is true, then separate indexes will be generated based on type values. If $index-on-role is true, then separate indexes will be generated based on role values.