runoff.save.index Command/Runoff: Commands

runoff.save.index

Command runoff.save.index Command/Runoff: Commands
Applicable release versions: AP, R83
Category Runoff: Commands (93)
Description saves entries defined in previous ".index" commands in the specified "file.reference", using the item-id of the current Runoff item.

The "file.reference" of the index must be different than the current "file.reference" to avoid destroying data.

This command causes chapter and page number information of indexed data in a text to be saved in a separate file.

Each index entry is stored as an individual item using the index entry as the item-Id, the chapter (where that index entry is referenced) as the first attribute and the page number as the second attribute.

Multiple values are stored in these attributes as multiple references to the same index entry. The resulting file may then be operated on by the Access processor to generate listings for the chapter and page number information of all indexed data in a text.

The "file.reference" is the name of the file in which the chapter and page information is to be stored.

The ".save index" command is placed in the text item itself and must precede the ".index" commands.

In short, only that indexed data which has been preceded by the ".save index" command is saved in the specified file.
Syntax .save index file.reference
Options
Example
Purpose
Related runoff.commands
runoff.index