grandMA3 User Manual Publication

Navigate in the Help

grandMA3 User Manual » About the Help » Navigate in the Help
Version 2.4

Multiple elements in the help window help you navigate the manual.

Buttons in the Title Bar

To increase or decrease the size of the content displayed within the help window:

  • Tap (plus) or  (minus)
  • Tap and hold Zoom Factor and swipe left or right
  • Tap Zoom Factor and choose a percentage in the drop-down list

Tap (left arrow) to reverse through the history of previously viewed help topics.

Tap  (right arrow) to advance through the history of previously viewed help topics.


Scrolling in the Help

  • Two-finger tap and swipe to scroll through a help topic.
  • Use the screen encoder to scroll through a help topic. For more information on using the screen encoder see User Settings.

Topics Tab

The topics tab in the help window displays the available topics in a tree structure. Single topics are indicated by  next to them. Multiple topics of the same category are sorted within a folder ()  and are called subtopics. 

Tap > to the left of any topic to show or hide the related subtopics. Tap the name of any topic to display its content in the main area of the window. Subtopics are also displayed in a bullet list at the end of the topic.

If the help window is too small to display both the main area and the topics and search tabs, a burger menu () appears in the upper left corner. It contains the Topics and Search tabs. 

In addition to the grandMA3 User Manual, the root topics in the tree structure contain the Quick Manuals for the different products within the grandMA3 family. These main sections include:

Important:
The complete grandMA3 documentation consists of the grandMA3 User Manual and the respective grandMA3 Quick Manual with technical specifications, safety instructions, and declaration of conformity.

Search Tab

To find topics containing a specific search term, use the search function:

  1. Open the search tab in the help window.
  2. Tap the search field.
  3. Type a search term in the search field.
    To search for a specific product or search term, the brand name or the series name (for example grandMA3) is not necessary.
  4. Press Please. The search results are displayed.

To open a virtual keyboard in the software, tap the keyboard icon on the left of the search field.

The help window with a search result is shown
Help window - Search tab


Listed Subtopics

A list of subtopics that are related to the current topic is displayed at the bottom of the help page.

To open a related topic, tap it in the list.

Update this description text.
Listed subtopics

Breadcrumbs

Breadcrumbs are navigation elements that provide links to the related sections of the current topic and subtopics. Breadcrumbs are located at the top of each topic.

To go back to a more general topic in the hierarchy, tap the corresponding link in the breadcrumbs.

Breadcrumb to navigate in the help
Breadcrumbs to navigate in the help

Display of Content

The user manual offers graphical assistance to add context to the content.

  • Keys on the control surface of the hardware are displayed in a white font on a dark gray background, for example Please.
  • Buttons on the screen are displayed in a white font on a light gray background, for example  Dimmer.
  • Step-by-step instructions are displayed in a numeric list:
  1. This is the first step.
  2. This is the second step.
  • One-step instructions are displayed as bullet points.
  • Navigation to specific menus is displayed in bold, for example Menu – Settings – User Configuration.
  • Syntax descriptions are displayed in monospace font, underscored, and bolded, for example  Assign [Object] (At) [Object]. 

  • Links are displayed underscored and blue.
  • To display additional visualizations or information, tap 
    [-] Hide

    Here you can find additional content.

  • Pop-ups are displayed underscored, bolded, and green.

    Pop-ups display short descriptions for the selected words.

  • Command line input is displayed using command line formatting and icons, for example:
    User name[Fixture]>1 Thru 10 At Full
  • System response in the command line history is displayed on black background and in the colors used in the command line history, for example:
    OK : Command Line Feedback   
    OK : Second Line Feedback
The following symbols indicate possible danger, useful hints, or important information.

The warning icon indicates possible injury and hazards.
Restriction:
The restriction icon indicates known limitations of functions.
Important:
The important icon indicates essential information for using the software.
Hint:
The hint icon indicates useful tips for using the software.

Command Bot

Open elements, such as windows or settings, directly from the help window using the command bot.

You can use the bot wherever  Paste to Command Line is displayed in the manual.

To use the command bot:

  1. Tap  Paste to Command Line.
    The command to execute the action that is described in the manual is copied and inserted into the command line.
  2. Press Please.
    The command is executed.

Important:
If you change settings using the command bot, the changes are applied to all windows of the same type that are open at that time.

Hint:
To open a window using the command bot, there must be free space on your screen.