The DashBoard Help system is accessed by selecting Help > Help Contents from the main toolbar of DashBoard. The DashBoard Help displays the Contents pane and Search box in the toolbar by default.
The following Help Systems are currently available in DashBoard:
•DashBoard Help — This is the main Help system for the DashBoard Control System that is available by choosing Help > Help Contents from the main toolbar. DashBoard Help provides information on the various features and options available in DashBoard. Context-sensitive Help is also available by selecting an interface item, such as the Basic Tree View tab, and clicking F1 (when running Microsoft® Windows®).
•openGear Help — This feature provides information on individual openGear devices, such as frames and cards. You can access the openGear Help for your device by selecting the device in the Tree Views and clicking F1 (when running Microsoft® Windows®) or by choosing openGear from the Help dialog box. An option is provided for importing new help files for openGear devices.
•URM Help — This feature provides information on the DashBoard User Rights and Management option.
This section briefly summarizes how to configure the DashBoard Help display options and import new help files.
Configuring the DashBoard Help Display Options
This section summarizes how to configure the DashBoard Help display features:
•Open Window Context Help — This is the context-sensitive help that is displayed when you click F1 (when using Microsoft® Windows®) in the main DashBoard window.
•Dialog Context Help — This is the context-sensitive help in a dialog box.
To configure the Help display options for DashBoard:
1.Select Window > Preferences to display the Preferences dialog box.
2.Select Help to display the Help dialog box.
3.Specify the browser used to display the DashBoard Help search results by selecting one of the following options from the Open help search menu.
•In the dynamic help view — Select this option to display the DashBoard Help search results in a new pane of the DashBoard interface. This is the default setting.
•In a browser — Select this option to display the DashBoard Help search results in your default web browser.
4.Specify how to display help documents, such as user manuals in *.pdf format, by selecting one of the following options from the Open help view documents menu.
•In place — The help document is displayed in the same tab as the link to the document. This is the default setting.
•In the editor area — The help document is displayed in a new tab in DashBoard.
•In a browser — The help document is displayed in your default web browser.
5.Specify how to display the DashBoard Help contents by selecting one of the following options from the Open help contents menu.
•In the help browser — The DashBoard Help content is displayed in a new pane of the DashBoard interface. This is the default setting.
•In an external browser — The DashBoard Help content is displayed in your default web browser.
6.Specify how the openGear Help is displayed by selecting one of the following options from the Open window context help menu:
•In the dynamic help view — The selected Dialog Context Help is displayed in a new pane of the DashBoard interface. This is the default setting.
•In an infopop — The Help content is displayed as a persistent popup message.
7.Specify how to display the openGear Help by selecting one of the following options from the Open dialog context help menu.
•In a dialog tray — The DashBoard Help content is displayed in a new pane of the DashBoard interface. This is the default setting.
•In an infopop — The Help content is displayed as a persistent popup message.
8.Click Apply to save your changes. You can also click Restore Defaults to disregard any changes you have made.
DashBoard allows you to download and install additional help files provided by your openGear manufacturer, enabling you to display the most recent help files for your device. There are two methods for importing openGear Help:
•Importing openGear Help Files — This method enables you to import a file or directory from a location on your network to your DashBoard workstation. Use this method if you are running Apple® Mac® OS® or Linux® Fedora®.
•Installing a Ross Video openGear Help Pack — This method installs an additional DashBoard Help feature that provides a library of Ross Video openGear user manuals. If you are running Microsoft® Windows®, use the procedure provided in the section Installing DashBoard Add-on Programs. Otherwise, use the procedure for importing openGear Help Files.
The Include help content from a remote info-center option is not implemented.
This section briefly summarizes how to import openGear Help Files into DashBoard. If your openGear manufacturer has provided a Help Pack Add-on program and your computer is running Microsoft® Windows®, use the procedure Installing DashBoard Add-on Programs.
To import openGear Help Files:
1.Contact your openGear manufacturer to determine if additional help files are available for your device(s).
2.From the main toolbar, select File > New > Other... The Select Equipment or Service Type to Add dialog box opens.
3.Expand the openGear node.
4.Select Import openGear Help Files from the list.
5.Click Next >. The Import openGear Help File(s) dialog box opens.
6.From the Add Help From list, select the type of file to import:
•File — Select this option if the help file is a PDF, or is in a zip file. Proceed to step 7
•Directory — Select this option if the help file has been extracted to a directory. Proceed to step 7
•Download — Select this option if the help file is to be downloaded from the manufacturer website. Proceed to step 8
7.If you selected File or Directory:
•Click Browse... in the Selected Help area.
•Navigate to the file you wish to import.
•Click Open to return to the Import openGear Help File(s) dialog box. Note that the file location is now displayed in the Selected Help field.
•Click Finish to import the file into DashBoard.
•Enter the URL of the help file in the Selected Help field.
•Click Finish to import the file into DashBoard.
To view your new help file, choose Help > Help Contents from the main toolbar and select the file from the openGear node.