Help menu
- Last UpdatedSep 04, 2024
- 2 minute read
The Help menu contains options for Help and About.
|
Menu item |
Description |
|---|---|
|
Help Documents |
Opens the XR Studio Help. Lists available Help documents, including AVEVA XR Framework and installed add-on help documents. Also, the list of available PDF files are listed below the web help documents. |
|
About |
Opens the About form, which displays the software version, and other information. |
Help documents
Help Documents shows the list of available documents. You can select the relevant document for help by hovering the mouse over Help Documents. The list of document becomes visible.
The list shows the web help documents as well as the PDF documents below.
Help shortcut and contextual use
XR Studio supports the use of F1 key as a shortcut to open the Help documentation.
Additionally, XR studio supports contextual, automatic documentation search, displaying the most appropriate content in several situations, such as:
-
When a node is selected in Graphic Context Node Editor.
-
When a node is selected in XML Script Editor.
-
When a node is selected in Object Explorer.
-
When text is selected in XML Script Editor.
|
Shortcut key |
Description |
|---|---|
|
F1 |
Searches in the default XR Studio document. |
|
Shift+F1 |
Displays the Contextual Help dialog with a list of available add-on XR documents. for contextual search other than default help document. |
Open Default Help in Context mode
When you select a node or some text and press F1 , the default XR Studio help document opens to the relevant page for the selected node or text information.
Open Add-on Help file in Context mode
When you select a node or some text and press Shift+F1, the Contextual Help dialog displays.
-
You can choose a document from list of additional documents.
-
After selecting the document from the dialog, XR will contextually search on that particular document and open to the relevant page of the selected help document.
