CDSDoc User Guide, Product Version 2.1

5

---

Searching Cadence Documents

CDSDoc uses the Verity Search tool to let you search books. This chapter describes:

• Searching All Cadence Documents

• Searching a Group of Documents

• Searching One Document

• Searching Different Cadence Hierarchies

• If Search Doesn't Find What You Want

• Narrowing Your Search

• Combining Operators

• Advanced Search Operators

• Searching for Special Characters

You can also view two videos about searching documents.

Searching All Cadence Documents

To search all the documents in this library:

1. Click the button at the top of any Cadence document, or click Search in the CDSDoc Library window.

   The Search window appears. By default, all product platforms, products, and manuals are selected.

2. Type the words you want to search for into the Search for field and click Go.

   

   • To search for part of a string, use wildcard characters to match the rest of the string: dbCreate*

   • You can use AND, OR, or NOT to perform Boolean searches: printer AND hp

   • To match an exact phrase, enclose it in quotes: "change layer colors"

   There are additional operators you can use to further refine your search. See Narrowing Your Search for more details.

3. Search displays a list of chapters that match your string. Click on a chapter title to open that chapter.

4. Inside the chapter, you can:

   • Click the Jump to the first match text at the top of the chapter to jump to the first matching word, and use the arrow buttons to jump to the next or previous matches.

   • Use the Edit - Find command in your web browser to find the matching string.

You can also view a video about searching documents.

Searching a Group of Documents

To select a group of documents to search, do the following:

1. Click the button at the top of any Cadence document, or click Search in the CDSDoc Library window.

   The Search window appears. By default, all product families, products, and manuals are selected.

2. Do any of the following:

   • Click on a Platform name to search all documents about products within that Cadence design platform.

     You can click on more than one Platform. On Windows, press Ctrl when clicking another platform name.

   • Click on a Product name to search only documents about that product.

     You can click on more than one Product. On Windows, press Ctrl when clicking another product name.

     

3. Type the words you want to search for into the Search for field and click Go.

   • To search for part of a string, use wildcard characters to match the rest of the string: dbCreate*

   • You can use AND, OR, or NOT to perform Boolean searches: printer AND hp

   • To match an exact phrase, enclose it in quotes: "change layer colors"

   There are additional operators you can use to further refine your search. See Narrowing Your Search for more details.

4. Search displays a list of chapters that match your string. Click on a chapter title to open that chapter.

5. Inside the chapter, you can:

   • Click the Jump to the first match text at the top of the chapter to jump to the first matching word, and use the arrow buttons to jump to next or previous matches.

   • Use the Edit - Find command in your web browser to find the matching string(s).

You can also view a video about searching documents.

Searching One Document

To select individual documents to search, do the following:

1. Click the button at the top of any Cadence document, or click Search in the CDSDoc Library window.

   The Search window appears. By default, all product families, products, and manuals are selected.

2. If you know the Platform name (for example, Incisive) containing this document, click on it to reduce the number of products listed.

3. Click on the name of the Product whose documents you want to search.

4. Select the title of the book(s) you want to search under Books.

   On Windows, press Ctrl when clicking on each additional book title.

   

   Note:  Double-clicking on the Books list does not open that book. This list is for selecting the books that you want to search. If you want to open the book, click on its title in the Library window as described in Opening a Document.

5. Type the words you want to search for into the Search for field and click Go.

   • To search for part of a string, use wildcard characters to match the rest of the string: dbCreate*

   • You can use AND, OR, or NOT to perform Boolean searches: printer AND hp

   • To match an exact phrase, enclose it in quotes: "change layer colors"

   There are additional operators you can use to further refine your search. See Narrowing Your Searchfor more details.

6. Search displays a list of chapters that match your string. Click on a chapter title to open that chapter.

7. Inside the chapter, you can:

   • Click the Jump to the first match text at the top of the chapter to jump to the first matching word, and use the arrow buttons to jump to next or previous matches.

   • Use the Edit - Find command in your web browser to find the matching string

You can also view a video about searching documents.

Searching Different Cadence Hierarchies

Cadence prepares a full-text Search index for each release it ships. When you choose Search, you search all the documents included in the release you are currently viewing.

If you have installed more than one Cadence release, you can choose to search the documents in a particular release. However, you cannot search two release hierarchies at the same time.

To change the release you are searching:

1. In the Library window, click on the Active Library pull-down.

   

2. Choose the directory of the release you want to Search.

   The list of documents in the Library window should change.

3. Open any of the documents in the Library.

4. Click the button at the top of any Cadence document, or click Search in the CDSDoc Library window.

5. Follow the steps in the previous sections to search all or selected documents.

If Search Doesn't Find What You Want

There are several possible reasons why a query may not find the matches you expect. The following are the most common problems users encounter. Further suggestions about search issues appear in Questions About Searching Documents.

Use wildcards when searching for commands or syntax

Search matches English words and their equivalents to the string you enter. It can complete a word like "print," to also find "printing, printed, printer."

However, Search does not automatically complete non-English strings. So if you look for a portion of a command name, you must include wildcard characters (* or ?) to indicate that there may be additional portions to this string.

For example, searching for dbCreate looks for only the string "dbCreate."

Typing dbCreate* finds dbCreateLabel, dbCreatePath, dbCreateLib, etc.

Use a slash to "protect" special characters

The backslash (\) is used to tell Search not to interpret special characters. See Searching for Special Characters for a list of all the special characters. If Search does not find an exact match, it may be that one of the characters you are looking for is interpreted specially by Search.

For example, if you want to look for reference to a SKILL function and its syntax, you only want to find instances of the full function syntax, which includes open and close parentheses, not mentions of the function title elsewhere in documentation. To search for parentheses, you must place a backslash in front of them. So if you want to look for a function that you know ends in Create(), typing *Create\(* finds commands like aelEnvCreate(), syMenuAlignCreate(), cmxfAxisCreate(), etc.

Use Booleans between words, not spaces

Search looks for phrases by default. If you enter: layer color, Search looks for "layer color," "layer colors," in the same phrase.

If you want to look for the two words, layer and color, together, use the Boolean AND between them. Typing layer AND color finds both words anywhere in a chapter.

You can also use special operators to find words in the same paragraph (layer <PARAGRAPH> color) or near each other (layer <NEAR> color). See Narrowing Your Search for a complete list of Search operators.

Use all one case to find text in both upper- and lowercase

By default, if you search for a mixed-case string, using both upper- and lowercase letters, Search is case-sensitive and finds the string exactly as you typed it. Searching for Print finds only Print, not print.

If you enter your search string in all lowercase (or in all uppercase) letters, Search is case-insensitive. For example, searching for axl finds both axl, AXL, and Axl. If you don't care whether the string you find is uppercase or lowercase, enter your string in all one case.

To force searching for all uppercase or all lowercase letters, use the <CASE> operator.

Make sure you are searching the correct hierarchy

Search only searches one Cadence installation hierarchy at a time. Make sure your CDSDoc Library window shows the path to the hierarchy you want to Search before choosing Search. If it does not, change the hierarchy as described in Searching Different Cadence Hierarchies, and then click Search again.

Narrowing Your Search

There are many ways you can refine your search. The following table gives an overview of the commonly used methods to narrow your search.

You can also view a video about controlling search to see examples of using wildcard characters or Boolean operators.

.

Table 5-1 Refining a Search

To find this:	Type this:	Example:
Variations of a word	myword	place Finds place, placing, places, placed. Does not find place_and_route (use a wildcard character to find partial strings as described in this table)
A phrase	all words in phrase	layer colors Finds the phrase layer colors. Does not find layer and colors separately (use AND as described in this table)
An exact word or phrase	"myword"	"place" Finds only place
Substitute for a character	? for a single character * for multiple characters	??Create* Finds syCreatePin, hiCreateForm, leCreateCell, and other functions that begin with two characters followed by "Create" and another string See also Operators to Restrict or Expand Word Searches
Two specific strings	word AND word	printer AND CalComp Finds only documents with both printer and CalComp
One string or another	word OR word	printer OR plotter Finds either the words printer or plotter
One string but not another	word NOT word	plotter NOT CalComp Finds all documents with the word plotter that do not have the word CalComp
A string near another string	word <NEAR> word	place <NEAR> route Finds place, placing, places near route, routing, routes See also Operators to Find Words Near Other Words
Case-sensitive strings	<CASE> word	<CASE> SUBMIT Finds SUBMIT but not submit Note: By default, Search is case sensitive if you enter words that are mixed case (upper and lowercase) but case insensitive if you enter words that are all upper or all lowercase.
Strings including "and," "or," or "not"	word "and" word	place "and" route Finds the phrase place and route
A document containing several strings	word, word, word	command, block Finds documents with command and block, ranking those with both words higher than others

Combining Operators

You can combine two or more of the operators above in a query as shown in the following examples:

• "place" AND "route" AND "floorplan"

  Finds documents containing all three words: place, route, floorplan

• "place and route" AND "floorplan"

  Finds documents with both the phrase place and route, and the word floorplan

By default, Search evaluates an AND before an OR:

• "place" AND "route" OR "floorplan"

  Finds documents with both place and route, or documents that contain floorplan.

To have Search evaluate some segments of a query before others, enclose some portions in parentheses. Search evaluates the most nested parenthetical statement first, and works outward, as shown in the following examples:

• ("printer" OR "plotter") AND CalComp

  Finds documents containing either printer or plotter, and CalComp

• ((layer colors <NEAR> "design") AND set) NOT Virtuoso)

  Finds documents containing the phrase layer colors near the word design, and the word set or variations (e.g. setting, sets), excluding any documents with the string Virtuoso.

Advanced Search Operators

In addition to the operators listed above, there are other operators you can include in a Search. Operators let you:

• Expand the search to include additional words by how they are spelled or by their meaning (Operators to Restrict or Expand Word Searches table).

• Search for words near other words (Operators to Find Words Near Other Words table).

• Search for strings in the book's title, chapter title, product name, or Cadence product platform name (Operators to Find Words in Books by Title or Product table).

• Search for books by their version number (Operators to Find Books by Version Number table)

Table 5-2 Operators to Restrict or Expand Word Searches

To do this:	Use this:	Example:
Search for specific words (not variations on them)	<WORD> word	<WORD> place Finds place but not placing or places
Search for words and their variations	<STEM> word	<STEM> place Finds place, placing, places. The STEM operator is assumed by default to be part of the query, unless you quote a word ("word") or use the WORD operator
Search for words and their synonyms	<THESAURUS> word	<THESAURUS> stop Finds stop and words similar in meaning such as halt, cancel.
Find words spelled similarly to the one you type	<TYPO> word <TYPO/N> word where N is the number of letters changed (added, deleted, or transposed); the default is 2	<TYPO> equivulence Finds equivalence <TYPO/3> sweeping Finds sweeping and swimming
Search for a word including a "wildcard" string	Wildcard characters * or ? <WILDCARD> with any of the following: '[character set]' '[^excludepattern]' '[set-set]' '{pattern, pattern}'	??Create* Finds syCreate, leCreateCell <WILDCARD> 'c[auo]t' Finds cat, cut, and cot. Note the entire expression must be enclosed in backquotes (') <WILDCARD> 'st[^o]ck' Finds stick, stack, stuck, but not stock <WILDCARD> 'c[a-o]t' Finds cat, cbt, cct, through cot <WILDCARD> 'plott{er,ing}' Finds plotter and plotting

Table 5-3 Operators to Find Words Near Other Words

To do this:	Use this:	Example:
Search for strings near each other	word <NEAR> word word <NEAR/N> word where N is the number of words distance between the words	place <NEAR/2> route Finds place and route (or their variations) within two words of each other
Search for strings in the same phrase	word <PHRASE> word The <PHRASE> operator is used by default in any search of two words separated by a space.	layer <PHRASE> color Finds the phrase layer color or layer colors.
Search for strings in the same sentence	word <SENTENCE> word	print <SENTENCE> stop Finds print, printer, printing near stop, stopped, stopping
Search for strings in the same paragraph	word <PARAGRAPH> word	"Create command" PARAGRAPH "blocks" Finds Create command in the same paragraph with blocks

The next table lists operators that can be used to find strings inside specific parts of Cadence documents. In the following table, Part can be:

• DocTitle to find text within the book's title.

• Title to find text within the book or the chapter title.

• Product to find text in the product name for a book or books.

Table 5-4 Operators to Find Words in Books by Title or Product

To do this:	Use this:	Example:
Search for strings anywhere in a book's title or product name	Part <SUBSTRING> string	Product <SUBSTRING> Wave Finds chapters of books whose product name includes the string Wave
Search for words anywhere in a book's title or product name	Part <CONTAINS> word	Title <CONTAINS> Checker Finds all chapters of books with the string Checker in the book or the chapter title
Search for strings at the beginning of a book's title or product name	Part <STARTS> word	Product <STARTS> NC Finds all chapters of books whose product name begins with NC
Search for strings at the end of a book's title or product name	Part <ENDS> word	DocTitle <ENDS> Guide Finds all chapters of books whose title ends with Guide
Search for an exact book title or product name	Part <MATCHES> word word	Product <MATCHES> CDSDoc Finds all chapters in books with the Product CDSDoc.

You can also search for chapters of books by the book's version number, as shown in Table 5-5.

Table 5-5 Operators to Find Books by Version Number

To do this:	Use this:	Example:
Search for books by the version number	Version = value Version > value Version >= value Version < value Version <= value	Version = 2.0 Finds books whose version string is exactly 2.0 Version >= 2.0 Finds books whose version string is equal to 2.0 or higher Version > 2.0 Finds books whose version string is greater than 2.0

Note:  You can use the operators in Table 5-4 to search by Version as well, but generally Version numbers do not include text strings so the above operators are more useful.

Searching for Special Characters

Some characters are used internally by the Search engine; to search for them, you must precede them with a backslash (\):

Special characters that must be preceded by \

,	comma
"	double quote
(	left parenthesis
)	right parenthesis
[	left square bracket
]	right square bracket
=	equals
>	right angle bracket
<	left angle bracket
!	exclamation point
?	question mark
@	"at" symbol
'	apostrophe
-	hyphen
_	underscore
/	forward slash
{	left curly brace

To search for a backslash (\), which is used to help search for other special characters, or to search for a backtick (') or accent grave, you must use the following special syntax:

<WORD>"\\" 

or

<WORD>"\'"

So, for example, to search for the text \abc, you would enter the following in the Search form:

<WORD>"\\abc"

To search for a command such as 'switch, you would enter:

<WORD>"\'switch"

Note:  If you search for a string that contains more than one special character, you may not get a result even if you "escape" the character with a backslash. If you have trouble searching for special characters, reduce the string so that it contains only one special character.

For support, see http://www.cadence.com/support or try Cadence's SourceLink service.

Copyright © 2003, Cadence Design Systems, Inc.
All rights reserved.
Legal notices and trademark attributions