Re: Integrating package documentation with the documentation center
- To: mathgroup at smc.vnet.net
- Subject: [mg98132] Re: Integrating package documentation with the documentation center
- From: Bob F <deepyogurt at gmail.com>
- Date: Tue, 31 Mar 2009 04:17:10 -0500 (EST)
- References: <gqq5hq$8b8$1@smc.vnet.net>
On Mar 30, 4:05 am, David Bailey <d... at removedbailey.co.uk> wrote: > Although the documentation center (DC) came with version 6.0, there is > (to my knowledge) still no published method for fully integrating > package documentation with this system (at least not without using the > Wolfram Workbench). > > As part of work on my new DebugTrace package, I believe I have uncovered > the interface mechanism - using commands from the undocumented > DocumentationSearch` (!!) context. Using these commands, it is possible > to create documentation which pops up when F1 is pressed inside one of > your exported symbols, and which appears in searches done within the DC. > > I am not entirely sure if this information is publicly available > elsewhere, but if it is not, I am happy to write it up and make it > available to everyone. Please tell me if the knowledge is already availab= le. > > Needless to say, the information will be "at your own risk", and may > well not expose all available functionality. Since the relevant > functions are not within a private package, I assume WRI meant this to > be a public interface! > > David Baileyhttp://www.dbaileyconsultancy.co.uk Please do this -- would really enjoy reading how to do this. Thanks for the discovery and the work that it took to come up with what Wolfram neglected to. -Bob