MathGroup Archive 2002

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

Search the Archive

Re: package documentation

  • To: mathgroup at smc.vnet.net
  • Subject: [mg34347] Re: [mg34166] package documentation
  • From: Omega Consulting <omega_consulting at yahoo.com>
  • Date: Thu, 16 May 2002 05:08:30 -0400 (EDT)
  • Sender: owner-wri-mathgroup at wolfram.com

At 02:54 AM 5/7/2002, Selwyn Hollis wrote:
>When creating an application package, how does one get package
>documentation to show up in the Help Browser?

To include documentation with your package, add a directory to your package 
called Documentation. Inside that directory is an English directory. Inside 
that goes the documentation (in nb form) plus a BrowserCategories.m that 
details how the documentation is organized.

So it looks something like:

MyPackageDir/
    MyPackages.m
    Documentation/
       English/
          MyDocs.nb
          BrowserCategories.m

BrowserCategories.m has it's own strange syntax, but you can look at some 
of the ones included in Mathematica to get the general idea.

--------------------------------------------------------------
Omega Consulting
"The final answer to your Mathematica needs"

Spend less time searching and more time finding.
http://www.wz.com/internet/Mathematica.html



  • Prev by Date: Simplify and Booleans
  • Next by Date: Re: ValueQ
  • Previous by thread: package documentation
  • Next by thread: Exporting Graphics