index

An index.

Name	Refer to By
index sections	by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID
topics	by numeric index, as a range of elements, before/after another element, satisfying a test

Property	Type	Access	Description
all topics	list of topics	read	A ﬂattened list of all the child topics.
class	integer	read	The class descriptor type.
id	integer	read	A unique number identifying the object.
index	integer	read	Index of the object within its parent object.
label	string	r/w	A label that can be set to any string.
name	string	r/w	The name of the object.
object reference	object	read	An object reference for this object.
parent	object	read	The parent of the object.
properties	record	r/w	Property that allows setting of several properties at the same time.

Method	Returns	Description
capitalize	Nothing	Applies capitalization options to the index entries.
extract label	string	Gets the content of the label associated with the specified key (name).
generate	list of stories	Generate a new index story.
import topics	Nothing	Imports a list of topics.
insert label	Nothing	Sets the content of the label associated with the specified key (name), creating the label if it does not already exist.
remove unused topics	Nothing	Removes all unused index entries.
update	Nothing	Update the page numbers in the index.