Skip to main content

Userhelp

Accessing Userhelp within the client​

Userhelp can be found in the following places within the application:

  • Application help: it can be accessed through the navigation bar and serves as a global hub for all help topics. navbar.png apphelp.png

  • Filter help: it can be accessed through the buttonstrip of a filter view. filterhelp.png

  • Edit help: it can be accessed via the question mark button in the edit view. edithelp.png

  • Main help: it can be accessed via the floating action bar button or the help icon a register tab header. fab.png registertab.png

Customizing / Deyploing Userhelp​

Context Properties (mainHelp, filterHelp, editHelp)​

Userhelp documents can directly be deployed from the designer. helpproperties.png

Preferences → Navigation Bar → helpLocation​

Specifies the URL of the help link in the navigation bar (either relative or absolute). For absolute URLs the protocol must be specified, e.g. https://www.adito.de/ If set to null, the help link will be hidden. Default = "/client/USERHELP/overview"

preferences.png

If a custom help location is specified, only the help location in the navigation bar will be overwritten. Other help locations will be left untouched (e.g. mainHelp, filterHelp, editHelp).