Setting up online help - kwantu/platformconfiguration GitHub Wiki
Setting up online help
This page outlines the process to take to configure online help for apps. There is an additional page created to build help files for the application. Once you create help file via this tool, default help file with all the sections as per the application will be created. Editing the help file via the tool is still not available, although you can go to CouchDB/kwantu_configs bucket locate the help file and edit it.
https://kwantu.support/exist/rest/db/kwantu-resource/api/rest/buildHelp.xq
There are two levels of help implemented as of now. User and Application. The third level of adoption is not implemented as of now and can come later.
User level help
help:user
help:xxxx_applicationIdxxx
User section help will cover 7 pages. You can configure more than one help sections for a single page.
- Favourite
- Notifications
- Inbox
- Network Settings
- User Settings
- Logout
- Global Search
Application level help
Application help will cover areas depending on application config and the contexts available. For example below are from CA outcome harvesting application
| ID | Level | Page |
|---|---|---|
| profile:details | Profile | Details page |
| profile:forms | Profile | Workflow page |
| profile:data | Profile | Data page |
| profile:default | Profile | Whichever page is set as the default |
| profile:roles | Profile | Roles page |
| profile:settings | Profile | Not used |
| profile:profileExternal | Profile | Not used |
| profile:subprofilenodes | Profile | Not used |
| profile:profileDashboard | Profile | Not used |
| profile:subprocess:processName | Profile | A specific sub process workflow page |
| application:instances | Application | Profile listing page |
| application:pending | Application | Not used |
| application:appLevel | Application | Not used |
| application:adoption | Application | Adoption workflow page |
| application:appRoles | Application | Roles page |
| profile:profileDashboard | Application | Not used |
| subprofile:profileRegistration:categoryName | Sub profile | Sub profile category listing page |
| subprofile:profileRegistration:list | Sub profile | Not used |
| subprofile:profileRegistration:node | Sub profile | Default page |
| subprofile:profileRegistration:nodeForms | Sub profile | Workflow page |
| subprofile:profileRegistration:subprofileDashboard | Sub profile | Not used |
| subprofile:profileRegistration:nodeRoles | Sub profile | Roles page |