:i1. and :i2. (Index)

Place topics into the index.

Syntax

┌───────────────┬───────────────┬───────────────┬───────────────┐
│Tag            │Element        │Attributes     │End            │
├───────────────┼───────────────┼───────────────┼───────────────┤
│:i1.           │Primary entry  │id=            │               │
├───────────────┼───────────────┼───────────────┼───────────────┤
│               │               │global         │               │
├───────────────┼───────────────┼───────────────┼───────────────┤
│               │               │roots=' '      │               │
├───────────────┼───────────────┼───────────────┼───────────────┤
│               │               │sortkey=' '    │               │
├───────────────┼───────────────┼───────────────┼───────────────┤
│:i2.           │Secondary entry│refid=         │               │
├───────────────┼───────────────┼───────────────┼───────────────┤
│               │               │global         │               │
├───────────────┼───────────────┼───────────────┼───────────────┤
│               │               │sortkey=' '    │               │
└───────────────┴───────────────┴───────────────┴───────────────┘

Attributes

id=

Provides a cross-reference identifier for the secondary index tag (:i2.). This attribute is optional and only valid when used with the primary index tag (:i1.).
global
Specifies that the index entry can appear in any MIndex Object depending on where you install the file and how each MIndex Object is set up. Entries also appear in the component index. This attribute is only used in Help windows. Online document cannot use this attribute.
roots='root words'
Specifies a list of root words that act as index entries to specified topics. These root words are associated with words defined with the index-synonym tag (:isyn.). Root words can contain alphabetic and numeric characters, which can be entered in uppercase or lowercase. When entering a string of words, insert a blank space between each word, and enclose the string within apostrophes.

Root words do not appear in the index, so are not viewed by the user, and need not be translated. They are used to create a link between the primary index tag and the index-synonym tag. To enable the user to search for an index entry, use the index-synonym tag to map the root words associated with the entry to synonyms.

sortkey='sortkey-text'.index-text
Specifies a character string that is used for sorting the entry in the index, and another character string that is displayed for the index entry.

The sortkey-text character string determines where this entry is placed in the index. The index-text character string is displayed for the index entry.

refid=
Provides a reference to the text associated with the primary index tag.

Description

You use the primary and secondary index tags to provide index entries to the information. The attributes associated with each index tag enable you to define related information. Index entries can be used throughout the file, but cannot be placed within a footnote.

The text of the index entry must be on the same line as the tag, and cannot contain other tags. The entry for each primary index entry within the window must be unique. That is, you cannot provide duplicate index entries within the same window. Secondary index entries must refer to an identifier specified for a primary index entry.

When the user selects Help index from the Help menu, an Index window is displayed for the help interface. When the user selects Index from the Options menu, an Index window is displayed for the online information interface. If the user enters a synonym that matches a root word, the index topics listed for the root word are displayed. When the user selects the Master Help Index object from the Desktop, it opens to display an alphabetic list of entries within a spiral bound notebook. For more information, see Master Help Index and Glossary

Conditions

• Index entries cannot appear in a footnote. 
  When referencing the :i1. tag, use the global attribute on both the :i1. and :i2. tag.

  Example 1

  This example shows how to tag your file to include primary and secondary index entries.

  :i1 id=del.delete:i2 refid=del.directories
  :i2 refid=del.files
  

  Output

  The index will include the following entry: delete
  directories
  files
  

  Example 2

  This example shows a file with the index-synonym tag (:isyn.) and the roots= attribute.

  :h1 id=copy03.Help for Copying
  :isyn root=copy.copy copying duplicate duplicating
  :isyn root=book.book manual draft manuscript
  :isyn root=folder.folder folders document documents
  :i1 roots='copy folder'.Copying a document
  :i1 roots='book folder'.Test procedures
  :p.When copying a file from the current directory to a new
  directory, specify the following:
  :ul.
  :li.The file name
  :li.The target directory
  :li.The new file name and extension.
  :eul.
  

  Output

  The index-synonym tag creates the following synonym table:

  Root word

  Synonym words
  copy
  copy copying duplicate duplicating
  book
  book manual draft manuscript
  folder
  folder folders document documents

  The roots= attribute points to the root words, "copy" and "folder," and the list of associated synonyms. For example, if the user searches for "copy" or "folder," the "Copying a document" entry appears because "copy" and "folder," identified by the index roots= attribute, match the entries listed for the index synonym root= attribute.

  A search for the synonym "duplicate" lists "Copying a document" as one of the index choices. A search for the synonym "manual" lists "Test procedures" as an index choice, and a search for "document" lists both "Copying a document" and "Test procedures."

  Example 3

  This example shows how to specify a sort key to change the location of the entry in the index.

  :i1 sortkey='point sizes'.changing fonts:i1.program header
  :i1.parameter list
  :i1.preface
  

  Output

  The index will include the entry "changing fonts" at the location where the term "point sizes" would appear in the sorting sequence of the index, as follows: parameter list
  changing fonts
  preface
  program header
  

  Example 4

  This example is for a simple Master Help Index object entry for conceptual information about batch files.

  • i1 global.batch files, creating
  When referring to an :i1. tag, use the global attribute in both the :i1. and :i2. tags. For example:

  
  
  : i1   id = copy   global . copying
  : i2   refid = copy   global . help   topics
  
  : i2   refid = copy   global . document   topics
  
  

  When the IPF compiler encounters global attributes, it creates an alphabetic list, which can then be accessed by selecting Master Help Index object from the Desktop.

  ---

  [Back: :hp1. through :hp9. (Highlighted Phrase)]
  [Next: :icmd. (Index Command)]