Please enable JavaScript to view this site.

 

Navigation: Help and Documentation > Windows Help

Windows Help Table of Contents

Scroll Prev Up Next More

At the top of the Table of Contents, is the TOC Toolbar.

 

The Back and Forward buttons at the top-left of the toolbar work the same way as in a web browser.

 

The left pane contains 4 tabs for navigation and search; Contents to navigate the topics hierarchy, Index to look up keywords, Search to search for specific words, and Favorites to keep handy topics to which you refer often.

 

Navigation

 

After you use it to select a topic, the Contents Navigator is still visible, so you always know where the current help topic fits in the overall structure of the help file.

 

As you jump from one topic to the other in the main help window (using hypertext links), the Navigator stays synchronized so that, again, you always know where the current help topic fits in the overall structure of the help file.

 

To access the Navigator, you do not usually need to do anything; any time you invoke the Q++Studio help, the Contents tab should also appear. However, if the left pane of Q++Studio Help was hidden, click on the Show button at the left of the Help file's Toolbar.

 

You can hide the Navigator, without closing down Q++Studio Help, by clicking on the Hide button on the toolbar.

 

Keyword Search

 

Keyword search in the Windows Help file is used to find all the topics related to some generic word or concept (such as "token" or "help"). This feature is accessible using the Index tab of the navigation panel to the left of the Q++Studio Help Window.

 

Keyword search will return a list of all the topics which have been marked as relating to the word you typed in, even if that word does not explicitly appear in the topic title (for example a keyword search for "workspace" will yield the topic "The Main Window", although the word workspace doesn't appear anywhere in that topic).

 

Note that topics are usually indexed under more than one entry. Also, if you are looking for a specific word or expression (such as "BLOB"), rather than a general topic, you should use Full Text Search instead.

 

Full-Text Search

 

Full text search is useful when you are looking for a specific word or expression (such as "BLOb"), rather than a general topic (such as "token", in which case you should use the Keyword Search).

 

To use full-text search 

 

Click the Search tab, and then type the word or phrase you want to find.

Click List Topics, select the topic you want, and then click Display.

If you are getting too many results (for example looking for "token"), or if you are not sure exactly how the word you are looking for appears (for example, is it "executing" or "execution"), you can use advanced full text search.

 

The basic rules for formulating queries

 

Searches are not case-sensitive, so you can type your search in uppercase or lowercase characters.

You may search for any combination of letters (a-z) and numbers (0-9).

Punctuation marks such as the period, colon, semicolon, comma, and hyphen are ignored during a search.

Group the elements of your search using double quotes or parentheses to set apart each element. You cannot search for quotation marks.

If you are searching for a file name with an extension, you should group the entire string in double quotes, ("filename.ext"). Otherwise, the period will break the file name into two separate terms. The default operation between terms is AND, so you will create the logical equivalent to "filename AND ext."

 

To highlight words in searched topics 

 

When searching for words in help topics, you can have each occurrence of the word or phrase highlighted in the topics that are found.

To highlight all instances of a search word or phrase, click Options on the toolbar, and then click Search Highlight On.

To turn off this option, click Options on the toolbar, and then click Search Highlight Off.

If you are viewing a long topic, only the first 500 instances of a search word or phrase will be highlighted.