PIndexFormat

Specifies all the format settings for an index.

Command constructor

PIndexFormat(PMBool bHeadings, PMBool bEmpties, short cFormat, const char *
sFollow, const char * sBetPgeNmbrs, const char * sBetEntries, const char * sPageRange, char
* sBeforeXRef, const char * sEnd);

PMBool bHeadings;
true to include index section headings
PMBool bEmpties;
true to include empty index sections
short cFormat;
0 for nested format
1 for run in format
const char * sFollow;
Characters that separate index entry from first page number (maximum of seven characters; a typical value is two en spaces)
const char * sBetPgeNmbrs;
Characters that separate page number references (maximum of seven characters; a typical value is a comma and an en space)
const char * sBetEntries;
Characters that separate secondary entries in a run-in format (maximum of seven characters: a typical value is a semicolon and an en space)
const char * sPageRange;
Characters that separate start and end of a page range (maximum of seven characters; a typical value is an en dash)
const char * sBeforeXRef;
Characters before a cross-reference entry (maximum of seven characters; a typical value is a period and an en space)
const char * sEnd;
Characters at end of entry (to a maximum of seven characters; a typical value is no character)

Creating a new index. To start a new index, the PCreateIndex command must precede the PIndexFormat command.

Format application. If an index story is open, these format settings will apply to only that story. If no publication is open, the settings will become the default for all indexes until they are changed again.

Example. The following example results in the index-format example shown in the Index Format dialog box above.

PIndexFormat(true, false, 0, "^>^>", ",^>", ";^>", "^=", ".^>", "");

PIndexFormat

Command constructor

See also