Legacy Document

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

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

/ Specifying "Look For" Help

<Ignore>

You can use the <Ignore> command to specify a word or phrase that Apple Guide should ignore when parsing a search phrase entered by the user when Look For is active.

<Ignore> ignoreWord

ignoreWord

A text string that specifies a word or phrase to ignore when parsing the phrase entered by the user in the search phrase entry box.

DESCRIPTION

When a user enters a phrase in the search phrase entry box and then clicks Search, Apple Guide parses the entered phrase, removing any words specified by <Ignore> commands. (Then it stems common word variations to a root word; see the <Exception> command, described next, for more details.) Apple Guide also searches the list of synonyms and finally the list of index terms for an index term matching the parsed phrase. For example, if the user enters "How do I view files" and "How", "do", and "I" are on the ignore list (specified by <Ignore> commands), Apple Guide parses these words from the entered text, resulting in a search phrase "view files". Apple Guide then stems words (except for words in the exception list) in the phrase (resulting in "view file"), and looks for this phrase in the synonym list. If Apple Guide doesn't find the phrase in the synonym list, it continues the search process, as described earlier.

Apple Guide automatically ignores (removes from the search phrase) numerals and punctuation marks. Using the previous example, Apple Guide parses the similar phrase "How, do I view 3 files?" to "view file".

EXAMPLES

#specify words to ignore when parsing the phrase entered
# by the user in the search phrase entry box
<Ignore> "a"
<Ignore> "how"
<Ignore> "do"
<Ignore> "I"
<Ignore> "am"
<Ignore> "an"
<Ignore> "are"
<Ignore> "aren't"
<Ignore> "aren't"
<Ignore> "at"
<Ignore> "be"
<Ignore> "can"
<Ignore> "cannot"
<Ignore> "can't"
<Ignore> "can't"
<Ignore> "did"
<Ignore> "for"
<Ignore> "in"
<Ignore> "it"
<Ignore> "its"
<Ignore> "it's"
<Ignore> "it's"
<Ignore> "like"
<Ignore> "of"
<Ignore> "on"
<Ignore> "or"
<Ignore> "not"
<Ignore> "real"
<Ignore> "really"
<Ignore> "that"
<Ignore> "the"
<Ignore> "this"
<Ignore> "to"
<Ignore> "what"
<Ignore> "why"