You are here: Scripting Techniques > Common Script Operations > Changing automatic index keywords in a script

Changing automatic index keywords in a script

For reference material, the topic title often serves as a convenient index. Typically, you index reference topics by enabling automatic index keywords for an active paragraph style. For specific instructions, see Creating Index Keywords Automatically Using Styles.

When a script assigned to a paragraph style executes at compile time, the following expression returns the name of the automatic index keyword generated by Doc-To-Help:


However, you can change the default behavior by setting the Key property to a different value. For instance, you can convert the keyword to lower case with the following statement, which uses the intrinsic VBScript function LCase:

ActiveTopic.Key = LCase(ActiveTopic.Key)

To prevent an index keyword from being generated, set the Key property to an empty string:

ActiveTopic.Key = ""