Opened 6 years ago
Last modified 6 years ago
#2654 assigned enhancement
Add subcommand documentation from bundles to doc index
| Reported by: | Tom Goddard | Owned by: | Greg Couch |
|---|---|---|---|
| Priority: | moderate | Milestone: | |
| Component: | Documentation | Version: | |
| Keywords: | Cc: | Conrad Huang, Elaine Meng | |
| Blocked By: | Blocking: | ||
| Notify when closed: | Platform: | all | |
| Project: | ChimeraX |
Description
Currently command documentation in toolshed bundles is merged into the main ChimeraX command index, but only for top level commands. If a bundle adds a subcommand it does not get merged into any index. For instance, the RealSpace bundle adds the "device realspace" command. If the docs are put in the RealSpace bundle, they will not be seen if "help device" is used.
I don't have a clear an idea of how documentation for subcommands from bundles can be integrated. One idea is that all builtin commands have javascript to generate a subcommand index at the top of the main command page.
A related thought is that current documentation organization that puts all subcommands in one html page maybe should be changed to have subcommands each use a separate html page. Commands like volume and color with many subcommands have exceedingly long manual pages currently.