Opened 8 years ago
Closed 7 years ago
#783 closed defect (fixed)
Integrate bundle help files with core help
| Reported by: | Greg Couch | Owned by: | Greg Couch |
|---|---|---|---|
| Priority: | blocker | Milestone: | 0.7 |
| Component: | Documentation | Version: | |
| Keywords: | Cc: | Elaine Meng, Conrad Huang | |
| Blocked By: | Blocking: | ||
| Notify when closed: | Platform: | all | |
| Project: | ChimeraX |
Description
Start by modifying help URLs to work with help in bundles: help:user/commands/cmd_name.html would look in the bundle for cmd_name.html. Likewise for help:user/tool/tool_name.html. Others? help:user/format/format_name.html?
Autogenerate list of all commands? Combined search index? Could have combined list when downloading list of all bundles, and go to ChimeraX Toolshed website for uninstalled tools.
Change History (6)
comment:1 by , 8 years ago
| Cc: | added |
|---|---|
| Component: | Unassigned → Documentation |
| Owner: | set to |
| Status: | new → assigned |
comment:2 by , 8 years ago
| Milestone: | Beta Release → 0.5 |
|---|
comment:3 by , 8 years ago
| Milestone: | 0.5 → 0.6 |
|---|
comment:4 by , 8 years ago
| Milestone: | 0.6 → 0.7 |
|---|
comment:5 by , 7 years ago
Done. User manual index is automatically augmented with additional tools and commands. Bundles, whose documentation is independent of the core, should have a docs/tools/tool_name.html file and/or a docs/user/commands/command.html file included in the bundle (see the tut_gui and tut_cmd examples).
comment:6 by , 7 years ago
| Blocked By: | 782 |
|---|---|
| Resolution: | → fixed |
| Status: | assigned → closed |
Milestone renamed