Manual (Help)
The option 'Manual' in the Help-menu of the menu bar opens the integrated manual of Lobster Data Platform / Orchestration in a view on page one.
The permission Administration/Masterdata/Online help/View default help defines, whether this menu item is available. Without this permission context help (see following section) does not consider entries from the manual while Online help entries appear, if applicable.
Space permitting, the view shows the document structure in a side bar as a dynamic tree view featuring links to the individual pages:
Getting context help from the manual
A context sensitive approach to the manual is available in Lobster Data Platform / Orchestration by one of the following methods:
The title bar if views generally includes a '?' symbol at the right side, that can be clicked to search for 'context help'. If there is exactly one resource linked to the context of the view either in the manual or by a qualified reference configured via Online help it is opened immediately. If there are multiple resources to choose from a context menu appears for selection by the user.
►NOTE◄ If one of the special keys Ctrl or Shift is held while clicking the '?' symbol, the manual entry is not presented in a view within Lobster Data Platform / Orchestration but in a new browser window or tab.Various graphical editors feature 'Help' (with a
symbol) as an item in context menus for certain elements:
Search function
At the top right in a manual view of Lobster Data Platform / Orchestration a looking glass symbol can be clicked to start a search for specific content, which present potential 'search hits' while the search terms are being entered.
Instead of a direct 'jump' to one of the search results presented in the dropdown, search results can be listed in a view, e. g. by hitting the 'enter' key after typing in search terms.
Manual pages listed in a results view can be inspected one by one. The results page remains available in the history of the help session and can be returned to by clicking the '<' symbol in the sidebar. As the example illustrates, the search is not limited to page titles, but searches the content of each page.