Help system features

Searching the topics

Enter text in the Search box, either in the main desktop view or in the Search flyout pane. The search engine accounts for misspellings and uses autocomplete technology to make suggestions as you type. The suggested terms include your recent search history. Click X next to a suggested term to delete it from the search history.

Press Enter, or click the search loupe, to search the help system. The Search flyout pane opens automatically if it is not already open.

While searching, the progress is displayed under the Search box. When the search is complete, the number of results displays. If no results are found, “No results found” displays.

If the search is progressing slowly or appears frozen at 0%, connection or bandwidth issues may be impeding the search progress. The Session pane of the Vectorworks preferences allows switching to the local version of the help in this type of situation.

SearchPane.png 

When entering search text:

       Use quotation marks to find a text string. For example, searching for the string “standard views” (in quotes) finds topics that contain the exact term standard views. The search is not case-sensitive.

       Prior to searching, click Include all words in search to find topics that contain all of the search terms. For example, searching for standard views finds topics that contain both standard and views, or variants of these words.

       Deselect Include all words in search, and enter the search terms to find topics that contain one or more of these terms. For example, searching for standard views finds topics that contain standard and/or views, or variants of these words.

The search results list the topics that contain the search text or string. Topics are listed in order of relevance. For context, each result displays the topic heading, an excerpt from the text, and the breadcrumbs.

Click on a search result to open the associated topic. To highlight your search terms within the topic contents, click Highlight Search Results before clicking on the desired search result. To remove the highlighting, deselect Highlight Search Results, and click on another search result.

Favorites

The Add to Favorites button allows you to bookmark frequently used topics for future reference. Navigate to the desired topic and click Add to Favorites. The plus sign changes to a check mark, indicating that the topic has been added to your favorites list.

UsingHelp00012.png 

The Favorites flyout pane opens, displaying a list of topics in the order in which they were bookmarked. Click a topic to view the contents. To remove a topic from your favorites list, click the Trash button next to the topic.

Favorites_List.png 

Printing topics

Printing from certain browsers with the Print button may crop the help contents. If this happens, try using a different browser.

Related topics

At the end of certain topics, a list of additional topics with information related to the current topic is displayed. Click one of the topics to view the additional information. To return to the original topic, use the browser’s Back button.

RelatedTopics.png 

Cross-references

Cross-references located within a topic are underlined and in gray. Click these links to navigate to more information about the underlined topic. To return to the original topic, click the browser’s Back button.

Crossrefs.png 

Browse navigation

The browse sequence buttons allow you to scroll through the help topics, in order. These special navigation buttons display at the top of the topic window (the buttons display at the bottom of the topic window for tablet or phone view). Click Previous and Next to navigate through the topics.

Browse_buttons.png 

Breadcrumb navigation

In desktop view, breadcrumb navigation displays the current topic path and facilitates navigation to other topics along the path. Click any part of the breadcrumb path to navigate to that topic.

Breadcrumbs.png 

 

Help feedback form

As you use the online help system to inform yourself about the commands and tools of the Vectorworks program, you may wish to make a suggestion or report a problem. A link displays at the end of every topic in the online help. Click the link to access an online help feedback page. Internet access is required to open the page.

Feedback_ex.png 

Movie links

The Vectorworks YouTube channel contains video technical tips with an audio/visual explanation of various concepts. If a topic in the help has a related video tip, a link in the help directs you to the associated Vectorworks YouTube movie. Internet access is required.

MovieLink.png 

Parameter tables

The parameters of every dialog box are described in tables. By default, these tables are hidden so that you can read the steps of a procedure easily first. To view or hide a parameter table, click the link, Click to show/hide the parameters. This link toggles the table display on and off.

When you open a topic from the search tab, the tables that contain search terms display automatically.

UsingHelp00015.png 

Commands and tools list

The Commands and Tools flyout pane provides a filterable, alphabetical list of all the commands and tools in the Vectorworks program. Click on a command or tool name to view the associated documentation. The command and tool names can be filtered by entering a term in Filter Keywords.

UsingHelp00018.png 

Glossary

The Glossary flyout pane displays an alphabetical listing of frequently encountered terms in the Vectorworks program. Scroll to the term of interest and click it to view its definition. The glossary definitions can be filtered by entering a term in Filter Terms.

UsingHelp00019.png 

 

Was this page helpful?