Macro Language Reference > Macros > Text (Frame Level) > index
  
index
Description
Inserts an index reference point at the text cursor position.
 
Example 283. Examples of index references
The example below, taken from a Body style tag, demonstrates some index reference examples:
<?"This text",4>...Standard reference, do not show text...
<?"This text",4,0,1>...Standard reference, group 1...
<?"This text",4,11"See also this text">...&emsp;&emsp;
See also reference
Syntax
index group:n? index entry:s? ( num format:n? ( see str:s? ) )
index
[no parameter]
Invoke the Index Reference dialog box.
group
Group(s) in which index appears 1-5 (optional)
index entry
A string containing the index entry, with each index level separated by a | (vertical bar) character.
Special characters required in an index are entered as a &#nnn; sequence, e.g. &#94; would give a real ^ which would not be treated as a sort key.
Any entry that needs to be sorted differently should have the sort key separated from the reference by a ^ character, e.g. three^PTC ALD.
 
The sort key is not displayed when the index is generated.
num format
0..9
Numbering codes used when the index is created to show how a page number, for example, should be formatted for any particular reference. For index references in the main body of a manual can use a different num_format to any references in the appendix, to ensure page numbers do not conflict when the index is compiled using the control stream keyword nformat.
10
Numbering code used to create a free-format reference
11
Numbering code used to create a see/see also reference.
see str
Actual text of the reference.
* 
This parameter should only be present when num_format codes of 10 or 11 have been specified.