-
Notifications
You must be signed in to change notification settings - Fork 38
improve access to help in viewer admin
Currently the component help is held in one file: help.html, this file is hard to maintain (as it is not side-by-side with the component code and is a monolithic structure) and does not provide help for custom (3rd party) components
- The component help in the viewer-admin will come from an external site and will be up-to-date. Alternatively, if the deployment prevents internet access, helpfiles may be packaged and deployed on the Flamingo server as a webdirectory.
- Help will be available for 3rd-party components and extensions
The changes needed for the completion of this functionality are described here.
Improve access to component helpfiles by:
- splitting out the current helpfile into a file per component
- hosting the helpfiles in github, either the wiki or the code repository
- adding a property + some code to the base config object to make the url available in the viewer-admin
- modify current help popup to load the component help file or load help in an external browser window
We foresee no incompatibility issues with older versions. All the old configurations will be kept and remain functional.
implementation started in PR #675
The following naming convention should be used for pages: package_class.md dots in the package name should be replaced with underscores.
For example the GoogleNavigation tool (viewer.components.tools.GoogleNavigation) will have a help page at: <wiki-url>/viewer_components_tools_GoogleNavigation_Help (file viewer_components_tools_GoogleNavigation_Help.md in the wiki )