MathGroup Archive 2009

[Date Index] [Thread Index] [Author Index]

Search the Archive

Re: Integrating package documentation with the documentation center

  • To: mathgroup at smc.vnet.net
  • Subject: [mg98157] Re: Integrating package documentation with the documentation center
  • From: John Jowett <John.M.Jowett at gmail.com>
  • Date: Wed, 1 Apr 2009 05:54:10 -0500 (EST)
  • References: <gqq5hq$8b8$1@smc.vnet.net>

Yes, this would be very useful if you would be kind enough to do it.
I have made some progress using Workbench for this but more
information would certainly be welcome,

John Jowett


On Mar 30, 12:05 pm, 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



  • Prev by Date: Re: DeleteCases
  • Next by Date: Re: pdf export problem
  • Previous by thread: Re: Using manipulate in two cells in one note book crashes my computer.
  • Next by thread: Re: Integrating package documentation with the documentation center