Vector License Client » Tips for Using the Help

Tips for Using the Help

Navigation Within the Help

ClosedTable of Contents

The table of contents on the left margin lists only the main topics with the overview pages. You navigate to further subpages via the hyperlinks on the help pages.

Not all helps have a table of contents.

ClosedSearch

Troubleshooting

  • If you can't find any or very little content when searching in the help, deleting the browser cache may solve the problem.

  • Some characters (such as colon :, pointed clamps < >, percent %, or slash /) are not interpreted correctly or are passed on incorrectly by the search in the help, so the search text will not produce any results. Instead of these characters, use the wildcard *, which stands for any character.

Basic Rules

  • The search is not case-sensitive.
  • The search contains a substring search starting with three related characters.

Search for Multiple Words / Usage of Search Operators

Search for multiple words:

Entry

Search Result: All help pages are listed, that ...

Trace-Window

... contain the word trace, trace-window or window.

Trace Window

... contain the word trace, window or both.

"Trace Window"

... contain the phrase trace window.

Search with the search operators AND, OR, NEAR, NOT:

Entry

Search Result: All help pages are listed, that ...

Trace AND Window

... contain the words trace AND window.

Trace OR Window

... contain the word trace OR window.

Trace NEAR Window

... contain the word trace AND within eight words also the word window.

Trace NOT Window

... contain the word trace but NOT the word window.

Combinations of the above two cases:

Entry

Search Result: All help pages are listed, that ...

Lookup AND "CAPL Function"

... contain the word Lookup and the phrase CAPL Function.
Note: Each CAPL function help page contains the function name as index entry and the phrase CAPL Function as bracket addition.

(Event AND CAPL) NOT message

... contain the words event AND CAPL but NOT the word message.

English US and Synonyms

The help texts are written in English US. Accordingly, you must enter the search texts with English US spelling.

For certain search words synonyms are stored, which are searched parallel to the search word and generate additional hits in the search result list. For example, if you enter the search word deinstall, the word uninstall is also searched for and corresponding search results are displayed and vice versa. To prevent such synonym coupling, enclose the search word in quotation marks, e.g. "uninstall".

Search Filters

To the right of the search input box you can select search filters, to reduce the search to the corresponding range.

The Search without Topic Filter command removes the filters for the search.

Not all helps have search filters.

Page Search

With the key combination <Ctrl>+<F> you open the search input box for the current page in the browser. This way you can search the content of a single page.

Collapsed texts are not taken into account in page search.

Text areas that can be expanded via a but are currently collapsed are not included in this page search.

Closedcollapsed

Recommendation: Expand these areas before the page search via the beside toolbar button, so that the complete text content is visible and can be searched.

ClosedToolbar

Icon

Description

Opens the help page Tips for Using the Help, you are reading here.

If there are several elements with on the current page, you can expand them all at once using this button. (Recommendation: expand all elements before searching with <Ctrl>+<F>).

Closedcollapsed

If there are several elements with minus signs on the current page, you can collapse them all at once using this button.

Closedcollapsed

After you have started a search using the Search Input Box and called up a page from the search results, the searched text is highlighted in color. To remove this color highlighting, you can use this button.

ClosedTopic Path

The help pages are structured thematically and hierarchically. The lower the page is in the hierarchy, the longer the topic path becomes. You can use the hyperlinks of the topic path to navigate to the overview pages of the next higher levels.

ClosedNavigation Path

If elements of the graphical user interface of the tool are explained on the help page, the navigation path indicates how you can open the element in the tool. In the example of the screenshot above, the navigation path indicates that you can open the General page in the configuration dialog of the Trace Window by using the context menu command Configuration and then clicking on the General page. The hyperlinks in the navigation path lead you to the help page of the respective element.

ClosedPage Navigation

On the help page you will find hyperlinks that lead to further subpages or to text parts on the page.

Browser / Links Between Tool and Help

ClosedNotes for Browsers

The help opens in your default browser.

If you have changed the default browser in the operating system, this change will take effect with respect to the context-sensitive help of the Vector tool only after a restart of the Vector tool.

The following browsers are supported:

  • Google Chrome (recommended, since no problems are known here).
  • Mozialla Firefox (when opening links to PDFs, CFGs and other files a security dialog may appear).
  • Microsoft Internet Explorer (blocked content must be allowed with every help call, because of ActiveX elements).
  • Microsoft Edge:
  • When opening links to PDFs, CFGs and other files, a security dialog may appear..
  • When searching for words with umlauts (ä, ö, ü), the second search query may not produce a result.
    In this case, click on the Refresh button or press the <F5> key.

ClosedTool Opens Help

You can open the help from the graphical user interface of the tool. According to the currently selected element, the appropriate help page is displayed context-sensitively:

Element of the GUI or Key

Description

? button

  • opens the help page for the element in which the cursor is currently positioned

<F1> key

  • opens the help page for the element in which the cursor is currently positioned
  • in CAPL Browser:
    opens the help page for the selected CAPL function

Help button, e.g. in a dialog.

  • opens the help page for the dialog

Help button in Help panel of a CFG sample configuration

  • opens the help page for the sample configuration

ClosedHelp Opens Elements of the Tool Setup

You can use the blue launcher links in the help to open items that are part of the tool setup:

  • PDFs
  • CFG sample configurations
  • folders in Windows Explorer
  • tools
  • helps

Typographic Conventions

Here we present the typographic and symbolic elements of our Help system together with their meanings.

Used Symbols

Note

Note

Additional information.

  • Notes and tips that facilitate your work.

Notice!

Notice!

Possibly damaging situation!

  • Failure to observe can result in damage to the product or the surroundings!

Caution!

Caution!

Possibly dangerous situation!

  • Failure to observe can result in light or minor injuries to persons!
  • Failure to observe can result in damage to the product or the surroundings!

Warning!

Warning!

Dangerous situation!

  • Failure to observe can result in death or extremely severe injuries to persons!

Danger!

Danger!

Immediate hazard!

  • Failure to observe will result in death or extremely severe injuries to persons!

Introduction

Introduction into a specific topic.

Basic Knowledge

Basic Knowlegde

Text areas containing basic knowledge.

Expert Knowledge

Expert Knowlegde

Text areas containing expert knowledge.

Example

Example

Examples

Step by Step Procedure

Procedure

Step-by-step instructions.

FAQ

FAQ

Frequently asked questions.

Obsolete Function

Deprecated Function

Deprecated function.

Edit

Editing Allowed

Text areas where changes of the currently described file are allowed or necessary.

Do not edit manually!

Editing Prohibited

Files you must not change.

Multimedia Link

Multimedia files e.g. video clips.

Changes

Changes

Something has changed.

Cross Reference

Cross Reference

More detailed information.

Further Typographic Elements

Element

Short Description

Expand / Close

This symbols flags (expandable/closeable) drop-down sections.

Typography

Links to a help page or a help pop up window.

»CAPL

Links to a glossary entry.

Vector KnowledgeBase

Links to an external page/application.

Concept Link

This symbol flags cross references/conceptual links; a window will pop up.

[OK]

Notation for buttons in dialogs.

<F5>

Notation for keys on the computer keyboard.

<Ctrl>+<z>

Notation for keys on the computer keyboard that should be pressed simultaneously.

Add…

File|Save file…

Notation for commands, menu names, dialog names and screen/dialog elements.Here Save file… refers to a command within the File menu.

on message <msg id>

Notation for syntax (CAPL, MS-DOS, XML, C#…).

on message 0x100

Notation for sample code (CAPL, MS-DOS, XML, C#…).