Opened 6 years ago
Closed 4 years ago
#2076 closed enhancement (fixed)
Clear instructions for preparing bundle help files
| Reported by: | Tristan Croll | Owned by: | Eric Pettersen |
|---|---|---|---|
| Priority: | moderate | Milestone: | |
| Component: | Documentation | Version: | |
| Keywords: | Cc: | Elaine Meng | |
| Blocked By: | Blocking: | ||
| Notify when closed: | Platform: | all | |
| Project: | ChimeraX |
Description
I may have just missed it, but the instructions on how to make a bundle play nicely with ChimeraX's help viewer (i.e. bring up the right help file when a user right-clicks on the tool widget and clicks "Help) don't appear to be in the "Building and distributing bundles" instructions. I worked it out in the end by tracing through code and now I know how I see it's absurdly easy - just put it in a directory called "docs" in the bundle path (I had it in "doc"). I think it would be a good idea to add a paragraph or two on this to the online developer instructions.
Change History (3)
comment:1 by , 5 years ago
| Owner: | changed from to |
|---|
comment:2 by , 4 years ago
comment:3 by , 4 years ago
| Resolution: | → fixed |
|---|---|
| Status: | assigned → closed |
Note:
See TracTickets
for help on using tickets.
This is in fact covered in the tutorial. I'll put in some kind of cross reference.