Using InterSystems Documentation
Using the Search Engine
To perform a simple search in the InterSystems documentation, enter the subject of the search in the Search:
field near the top right of the page and then press Enter
For advanced search facilities, click on the Search:
label itself. The Key Word Search
page displays the following fields:
The contents field Enter search terms here.
button Click to search.
button Click to empty the contents field.
The Search the Web
button Click to use the terms specified in the contents field for a Google search of the Web.
You can read and navigate the online documentation if you have any level of database access, but in order to use the online documentation Search:
feature, the account into which you are logged in must have Write privileges in the DOCBOOK
database. Most accounts do have this access, but if you run into trouble with searches, you should adjust your privilege level, use a different account that does have the privilege, or contact the InterSystems Worldwide Response Center (WRC)
The following are the basic rules for searches:
A search can include one or more terms.
The search engine only returns paragraphs that include all terms. Such paragraphs can be titles, code fragments, and so on.
There is no OR
search that is, a search that includes either of two or more strings.
If the search string exactly matches the title of a section or an entry in a definition list, this hit appears at the beginning of the results and is tinted.
The order of search results depends on where the search terms appear. For example, a book title appears before a chapter title which appears before a paragraph of running text.
The search is not case-sensitive. For example, searches for SET
, and set
yield the same results.
Some search results begin with one or more highlighted links, which have been flagged as notable results for the search term. Exact search (described in the next section) disables this feature.
Exact and Free-Text Searches
By default, the search engine uses the Caché free-text search (sometimes called a stemmed search
). This kind of search is based on an extensive list of related forms of words. For any word appearing in the list, the search engine takes the stem of each word provided and finds all matches associated with that stem. For example, save
, and saved
all yield the same results. The order of the results is the same for all variants of a particular stem (for example, regardless of whether a search is for save
The search engine supports stemmed search for most words. Words with forms that have definitions relevant to InterSystems products may not support stemmed search. For example, include
return different sets of results, since include
is a reserved word with a specific meaning in some programming languages.
To search for an exact string, specify that string within quotation marks. This is known as an exact search
. Exact searches are also case-insensitive. Therefore, #SHOW
yield different results; however "#SHOW"
yield the same results. There is no search for strings that include quotation marks (
) or inch marks (").
Searches can include both exact and stemmed terms, such as a search for saving files
, which returns results that stem both saving
, versus a search for "saving" files
, which returns results that include the exact string saving
and any stemmed version of files
With the exceptions of $
, which have special meaning in Caché commands and keywords, the search engine treats all punctuation characters as white space. For example, searches for Sample.Person
, Sample Person
, and Person Sample
all yield the same results. This is also why searches for #INCLUDE
yield the same results.
The search engine indexes words that include é
as if they contained e
; it also indexes words that include ñ
as if they contained n
. Hence, to search for Caché
, simply enter Cache
for the search; to search for the word cache,
. Similarly, you can use Jalapeno
instead of Jalapeño
Interaction of Search Rules
The various search rules, taken together, offer a powerful means of locating information in InterSystems documentation. They can also sometimes cause unexpected search results. For example, the following are results for searches in Caché 2009.1 on Mr.
with various forms of punctuation and quoting:
In this case, there is no stemming, so Mr
return identical results. For Mr.
, the period is converted to white space, which is then not included in the search, making it the same as searching for Mr
(without a period at the end). For "Mr."
, however, the search is for exact case of the characters M, R, and a period, in that order, and there are only three of these in the Caché documentation set. The difference of five hits arises from references the MR
conversion code that appears in the MV Basic documentation.