Description
The position of the index in the document's back matter.
The metadata in the root BDML file of the document contains information on front and back matter pages. The order of the back matter metadata elements determines the order of the back matter in the document. In order to specify where the index is placed within the back matter, the <index-page> element is used.
The <index-page> element does not have any attributes or child elements.
If the <index-page> element is not present in the root BDML file of the document, no index is generated.
Attributes
No attributes are defined for the <index-page> element.
Immediate descendants
No element descendants are defined for the <index-page> element.
Immediate ancestors
| Element name | Relation |
|---|---|
| <metadata> | The enclosing metadata element. |
Example
<document xmlns="http://boradoc.org/1.0"> <metadata> <-- back matter --> <back-matter url="../single-page/glossary-pdf.bdml" /> <index-page /> <back-matter url="../single-page/back-notes.bdml" /> </metadata> <-- Main document contents follows. --> </document>