Legacy Document

Inside Macintosh: Apple Guide Complete / Part 4 - Scripting Guide Files

Chapter 10 - Guide Script Command Reference / Guide Script Command Descriptions

/ Defining Index Terms

<Sorting>

You can use the <Sorting> command to specify the method Apple Guide should use when sorting index terms in your guide file.

<Sorting> method 

indexTerm

A constant, either SCRIPTSORT or USASCIISORT, indicating the sorting method. If you specify SCRIPTSORT, Apple Guide sorts index terms according to the international sorting method for the script specified by the <World Script> command. If you specify USASCIISORT, Apple Guide sorts index terms using a fast, case-insensitive ASCII comparison routine.

DESCRIPTION

Apple Guide sorts index terms before displaying them. Apple Guide sorts these terms according to the sorting method specified by the <Sorting> command.

SPECIAL CONSIDERATIONS

The <Sorting> command is optional. If you omit it, Apple Guide uses SCRIPTSORT as the default. Apple Guide retrieves information much more quickly from your guide file if you specify the USASCIISORT sorting method, especially for non-Roman script systems. However, if you specify USASCIISORT you should provide hidden keys for your index terms to obtain best results. You may also need to customize the sliding letter bar that appears above the list of index terms.

EXAMPLES

#sort index terms according to the sorting method of the
# script specified by the World Script command
<Sorting> SCRIPTSORT
#sort index terms using the fast, case-insensitive
# sorting method
<Sorting> USASCIISORT

SEE ALSO

You can also specify the order in which index terms appear in the displayed list of index terms by using the <Index Sorting> command, described next.