Tooltip and HTML5 Help

Tooltip

If you let the pointer hover over a button for a moment, a tooltip appears explaining what the button is for. Other useful tooltips appear at many different points in the application (e.g. text boxes).

The tooltips display for 10 seconds so that you have enough time to read the text if it is more complex.

You can disable the tooltip display in "File > Preferences > General".

If you need more information, press F1 on your keyboard to display the Online Help.

HTML5 Help 

You can display the Online Help with the Help menu command or the F1 key if an element in the user interface is selected. In many cases, Help displays details relating directly to the context currently shown in the user interface. The Help home page displays if there is no context-sensitive link. You can then find the information you want using the table of contents, the index or the full text search.

HTML5 Help is launched on a HEIDELBERG WEB server via a URL link and displays in an Internet browser window.

help_context.png

 

The window of HTML5 Help has the following structure:

The content pane (1) shows the Help content. The content can consist of text, tables, images or videos.

The buttons for toggling between the "Contents", "Index", "Glossary", "Content Filter" and "Full Text Search" functions are located on the left of the navigation bar (2).

The buttons for scrolling forwards and backwards in the content pages and the button for print­ing the current content page are located on the right of the navigation bar (3). You will find a box for a quick search in the caption bar. The quick search works in exactly the same way as the search function in the navigation bar (see Navigation bar - Section toggles). The Print function and Quick Search are available only in the Large desktop view.

The table of contents displays by default in the navigation pane (4). You can view a content by clicking the related line in the table of contents. You can expand lower levels in the content by clicking an icon in front of an item (circle with plus sign). Click again to close the expanded sec­tion. The currently selected content is highlighted in the table of contents by a gray flag in front of the content item.

You can scroll in the content pane if the Help content is longer than can be shown in the pane. You can go to the start of the current Help page fast with the "Go to start of page" button (5).

Blue underlined text (6) is a hyperlink. You can jump to the related page by clicking the hyper­link.

Display of the whole table of contents

When you invoke context-sensitive HTML5 Help, all of the contents generally do not display but only the section relating to the current content. This is also valid if you use Help as an app on a mobile device and a Help content page was already invoked on it.

To display all of the contents, click the small folder icon in front of the topmost item in the table of contents (not on the content text itself). Depending on which content level the invoked page is on, you may have to repeat this process once or several times to display the entire contents.

Online Help elements

Home icon

icon_up_level.png 

Click the Home icon in the caption bar to open the home page of Online Help.

Navigation bar - Section toggles

You use the section toggles to go between the "Contents", "Index", "Glossary", "Content Filter" and "Full Text Search" functions. The content of the navigation pane changes accordingly when you click one of these buttons.

icon_toc.png 

Contents: The table of contents displays. When you click an item, the related content page dis­plays. You can open lower levels by clicking the icon (circle with plus sign) in front of an item and close them by clicking the icon again.

icon_index.png 

Index: A list with keyword (index) items displays. When you click an item, the related Help content displays.

icon_glossary.png 

Glossary: A list with glossary items displays. When you click an item, the related definition of the term displays. Click again to close the defini­tion.

icon_filter.png 

Filter: You can toggle between filtered contents if the Help contents are filtered by content.

icon_search.png 

Search: A text box displays where you can enter a search item. When you hit the ENTER key, all Help pages containing the search item are listed in the navigation pane. When you click an item, the related content displays. The search item is high­lighted in color.

help_search.png 

The search window also displays at the top right in the caption bar in the Large view of the desktop Help (Windows, macOS).

Navigation bar - Navigate and print

You will find the buttons for navigation and printing on the right of the navigation bar.

icon_navigator.png

 

icon_back_foreward.png 

The arrow buttons let you move forwards and backwards from one content page to the next. This means that you can browse through the whole Online Help from page to page like a book.

icon_print.png 

You can use the "Print" button to print the current Help window to a con­nected system printer (only in the Large view in Windows and macOS). The printout can have several pages depending on the content of the Help win­dow.

Back/forward one step (only in Windows and macOS)

You can use the "Back one step" and "Forward one step" navigation buttons of the WEB browser (as is usual in Internet contents) to scroll through the Help pages you viewed so far.

Responsive Design

HTML5 Help is designed as "responsive Help". In other words, the structure of the Help window changes to fit the width of the set browser window. If the browser window is wide enough (Large view), the navigation pane on the left (with contents, index, etc. depending on what is selected) dis­plays permanently. The Print function is also available in this view. The navigation pane is hidden as of a certain threshold when you reduce the size of window width. The navigation bar with the buttons for toggling between contents, index, glossary, filter, search displays vertically on the left edge of the window. The content of the navigation pane displays or changes accordingly when you click one of these buttons. Click again to close the navigation pane. If you make the Browser window even nar­rower, the navigation bar is minimized at the lower edge of the window. The display automatically fits to the screen size of a mobile device if HTML 5 Help is installed as an IOS or Android app (if avail­able).

IconNote00004.png

Note: Elements in the Help window (e.g. graphics and videos) are matched dynamically to fit the size of the window.

Remember that some elements (e.g. Print function) are available only in the Large desktop view. The last window size set is retained after you close the window.

Context-Sensitive Design

Context-sensitive means that the Help contents are invoked for the part of the user interface currently in focus.

If an element, e.g. a check box, a text box or a list box, is marked in a window of the user interface and you then press the "F1" key, the Help window opens and generally shows information about the current view of the user interface.