DECdocument
Using Global Tags
Previous Contents Index

<XS>

Separates the main index entry from the first subentry, the first subentry from the second, and the second subentry from the third. Used within the argument to the <X> or <Y> tags. For a printed book, the <XS> tag creates a reference to the page on which the tag appears. For a book you create for Bookreader, the <XS> tag creates a hotspot on the index entry with no page reference. (The <XS> tag is identical to the <XSUBENTRY> tag.)

Format

<XS> (subentry-1[<XS>subentry-2[<XS>subentry-3]])

ARGUMENTS

subentry

Specifies up to three subentries you want to appear in the index. The capitalization you use is the capitalization that appears in the index.

related tags

restrictions

Valid only within the argument to an <X> or <Y> tag.

You can use a maximum of three subentries in the index.

DESCRIPTION

The <XS> tag separates the main index entry from the first subentry, the first subentry from the second, and the second subentry from the third. For example: 


<X>(main entry<XS>subentry-1<XS>subentry-2<XS>subentry-3)

For a printed book, the <XS> tag creates a reference to the page on which the tag appears. For a book you create for the Bookreader, the <XS> tag creates a hotspot on the index entry with no page reference.

An index entry for a book you create for Bookreader that contains more than one reference to another section displays all the index selections in a separate pop-up window. See Producing Online and Printed Documentation for a graphic example.

Examples

The following example shows how to use the <XS> tag.
#1 

<X>(Vehicles<XS>use of)

If the previous index tags appeared on page 3-1, they would create the following index entry under the heading "V": 


      Vehicles 
         use of, 3-1

The following example shows how to use the <XS> tag to create a "See also" entry.

#2 

<X>(File structure designators) 
<Y>(File structure designators<XS>See also Header blocks)

If the previous tags appeared on page 1-3, they would create the following index entry under the heading "F": 


      File stucture designators, 1-3 
         See also Header blocks

The following example shows how to code multiple subentries for a particular main entry.

#3 

<X>(Debugger<XS>features of) 
   .
   .
   .
<X>(Debugger<XS>exiting from) 
   .
   .
   .
<X>(Debugger<XS>invoking)

The previous tags produce the following entries under the heading "D": 


      Debugger 
         exiting from, 1-7 
         features of, 2-4 
         invoking, 3-9

The following example creates unnumbered index entries (because of the <Y> tag, which you use for unnumbered "See" and "See also" entries).

#4 

<Y>(CORP-AUTO report<XS>See Reports<XS>See also Cars)

Regardless of what page the previous tags appear on, they produce the following output under the heading "C": 


      CORP-AUTO report 
         See Reports 
           See also Cars

<XSUBENTRY>

Separates the main index entry from the first subentry, the first subentry from the second, and the second subentry from the third. Used within the argument to the <X> or <Y> tags. For a printed book, the <XSUBENTRY> tag creates a reference to the page on which the tag appears. For a book you create for Bookreader, the <XSUBENTRY> tag creates a hotspot on the index entry with no page reference. The <XSUBENTRY> tag is identical to the <XS> tag.

Format

<XSUBENTRY> (subentry-1[<XSUBENTRY>subentry-2
[<XSUBENTRY>subentry-3]])

ARGUMENTS

subentry

Specifies up to three subentries you want to appear in the index. The capitalization you use is the capitalization that appears in the index.

related tags

restrictions

Valid only within the argument to an <X> or <Y> tag.

You can use a maximum of three subentries in the index.

DESCRIPTION

The <XSUBENTRY> tag separates the main index entry from the first subentry, the first subentry from the second, and the second subentry from the third. For example: 


<X>(main entry<XSUBENTRY>subentry-1<XSUBENTRY>subentry-2<XSUBENTRY>subentry-3)

For a printed book, the <XSUBENTRY> tag creates a reference to the page on which the tag appears. For a book you create for Bookreader, the <XSUBENTRY> tag creates a hotspot on the index entry with no page reference.

An index entry for a book you create for Bookreader that contains more than one reference to another section displays all the index selections in a separate pop-up window. See Producing Online and Printed Documentation for a graphic example.

Examples

The following example shows how to use the <XSUBENTRY> tag.
#1 

<X>(Vehicles<XSUBENTRY>use of)

If the previous index tags appeared on page 3-1, they would create the following index entry under the heading "V": 


      Vehicles 
         use of, 3-1

The following example shows how to use the <XS> tag to create a "See also" entry.

#2 

<X>(File structure designators) 
<Y>(File structure designators<XSUBENTRY>See also Header blocks)

If the previous tags appeared on page 1-3, they would create the following index entry under the heading "F": 


      File stucture designators, 1-3 
         See also Header blocks

The following example shows how to code multiple subentries for a particular main entry.

#3 

<X>(Debugger<XSUBENTRY>features of) 
   .
   .
   .
<X>(Debugger<XSUBENTRY>exiting from) 
   .
   .
   .
<X>(Debugger<XSUBENTRY>invoking)

The previous tags produce the following entries under the heading "D": 


      Debugger 
         exiting from, 1-7 
         features of, 2-4 
         invoking, 3-9

The following example creates unnumbered index entries (because of the <Y> tag, which you use for unnumbered "See" and "See also" entries).

#4 

<Y>(CORP-AUTO report<XSUBENTRY>See Reports<XSUBENTRY>See also Cars)

Regardless of what page the previous tags appear on, they produce the following output under the heading "C": 


      CORP-AUTO report 
         See Reports 
           See also Cars

<Y>

Used with the <XSUBENTRY> tag to create a main index entry and a subentry that has no page reference for a printed book and no hotspot for a book you create for Bookreader. Use the <Y> and <XSUBENTRY> tags for cross-references ("See" or "See also" entries) to other index entries.

Format

<Y> (index entry[\attribute])

ARGUMENTS

index entry

Specifies the main entry and subentries that appear in the index. The capitalization you use is the capitalization that appears in the index.

attribute

This is an optional argument. It specifies the attributes that control the sorting of the index entry. You can specify a maximum of two attribute arguments. Each attribute must be a separate argument. The possible attributes follow:
Attribute Function
BOTH Specifies an index entry that you want to appear in both a single-document and a master index. BOTH has no effect for Bookreader output.
MASTER Specifies that an index entry appear only in a master index. A master index is an index generated by specifying /MASTER on the DOCUMENT command line. By default, the entries appear only in a single-document index. Using /MASTER allows you to specify different entries for a single book's index and for the master index of the document set. MASTER has no effect for Bookreader output.
NOMASTER Specifies that an index entry appear only in a single-document index and not in a master index. NOMASTER has no effect for Bookreader output.
<XSORT>(string) Uses the specified string as the sort key when placing this entry in the index, forcing the entry to sort in a place different from where it would by default.

related tags

restrictions

Invalid in informal code examples. Using this tag in a code example interferes with the formatting of the example.

DESCRIPTION

Use the <Y> tag with the <XSUBENTRY> tag to create a main index entry and a subentry that has no page reference for a printed book and no hotspot for a book you create for Bookreader. Use the <Y> and <XSUBENTRY> tags for cross-references ("See" or "See also" entries) to other index entries. You specify the subentries by using the <XSUBENTRY> tag within the argument to the <Y> tag. See the <XSUBENTRY> tag description for more information.

The <Y> tag subentries sort alphabetically at the top of the subentry list, before the <X> tag subentries; that is, cross-references to a topic are listed before its subtopics.

For information on how to use the MASTER, NOMASTER, BOTH, and <XSORT> attributes, see the <X> tag description.

Examples

The following example shows how to use the <Y> tag.
#1 

<X>(File structure designators) 
<Y>(File structure designators<XSUBENTRY>See also Header blocks)

If the previous index tags appeared on page 1-3, they would create the following index entry under the heading "F": 


      File stucture designators, 1-3 
         See also Header blocks

The following example shows how to use the <Y> tag to create an unnumbered index entry.

#2 

<Y>(File structure designators<XSUBENTRY>See also Header blocks)

The previous tags create the following output under the "F" entry: 


      File stucture designators 
         See also Header blocks

The following example shows how to code multiple "See also" references for a particular main entry.

#3 

<Y>(Debugger<XS>See also Debugger commands; Debugging; /DEBUG 
qualifier)

The previous tags produce the following output under the heading "D": 


      Debugger 
         See also Debugger commands; Debugging; /DEBUG qualifier

The following example shows how to use the <Y> tag to sort the entry "Cat".

#4 

<Y>(Cat<XSUBENTRY>See also Feline\<XSORT>(Animals))

The previous tags produce the following output, where "Cat" is placed with the "A" entries after "Animals" rather than with the "C" entries: 


      Cat 
         See also Feline

Appendix A
User Notes

You can use these pages for notes.

Index Contents