...
Help App provides an application and a status element in the title bar.
- The Help application (part of the menu) offers an entry point to all help pages.
- All available ux applications need to provide a help content page.
- The helpserver bundle provides the web service for ux help.
- The status bar help button uses a specific path, containing the appId as reference to the app related Help context.
- The helpserver bundle provides the web service for ux help
Implementation
A json file describes the dependency between specific app and related help content.
The path sdnr/nodes/appId identifies the app.
Path example for "Fault App" with Id: "faultApp": sdnr/nodes/faultApp
Example of meta.json that is part of helpserver
...
| language | java |
|---|
...
- If clicked, the corresponding help page is opened. The dependency information is provided by the help server by meta.json. See HelpServer.
The status bar element
If the help button is grayed out, no help page is available.
Help App displaying all available help pages grouped together
