MathGroup Archive 2004

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

Search the Archive

RE: Help browser

  • To: mathgroup at smc.vnet.net
  • Subject: [mg45847] RE: [mg45808] Help browser
  • From: "David Park" <djmp at earthlink.net>
  • Date: Tue, 27 Jan 2004 04:50:42 -0500 (EST)
  • Sender: owner-wri-mathgroup at wolfram.com

Yes you can. I don't think it would be a good method to generally organize
all your Mathematica files. At least if you create as many notebooks as I
do. This is because you will have to keep updating a BrowserCategories.m
file and rebuilding you Help index every time you add a new notebook. And
many notebooks are just temporary one-time calculations. So just using your
ordinary folder structure to organize notebooks might be better. In Windows,
at least, I can put shortcuts on the desktop to particular folders so if I
am working intensely on a particular subject I can quickly get to the
notebooks on that subject.

But if you have a settled application with perfected notebooks that you want
to present to a wider audience then the Help browser format can be useful.
You have to find your local Applications folder. Then create the folder
structure

Applications
	Your Specific Application folder
	any packages you have written for your application
		Documentation
			English
				BrowserCategories.m
				Specific Notebooks

The following is an example of a BrowserCategories.m file. It is from the
ConicSections package at my web site. (You could download it and install it
to see how it looks in the Help Browser.) You could copy and modify this to
create your own Help Browser application.

BrowserCategory["ConicSections", None,
{Item["Introduction", "CSIntroduction.nb", CopyTag -> None],
 Item[Delimiter],
 BrowserCategory["Examples", None,
  {Item["Simple Problems","CSExample1.nb", CopyTag -> None]}],
 Item[Delimiter],
 BrowserCategory["Routines", None,
  {Item["SymbolicConic","CSSymbolicConic.nb", CopyTag -> None],
   Item["StandardConic","CSStandardConic.nb", CopyTag -> None],
   Item["SolveStandardEllipse","CSSolveStandardEllipse.nb", CopyTag ->
None],
   Item["SolveStandardHyperbola","CSSolveStandardHyperbola.nb", CopyTag ->
None],
   Item["GenerateCircleEquation","CSGenerateCircleEquation.nb", CopyTag ->
None],
   Item["GenerateConicEquation","CSGenerateConicEquation.nb", CopyTag ->
None],
   Item["ParseConic","CSParseConic.nb", CopyTag -> None],
   Item["TransformEllipseRules","CSTransformEllipseRules.nb", CopyTag ->
None],
   Item["TransformParabolaRules","CSTransformParabolaRules.nb", CopyTag ->
None],
   Item["TransformHyperbolaRules","CSTransformHyperbolaRules.nb", CopyTag ->
None],
   Item["CompleteTheSquare","CSCompleteTheSquare.nb", CopyTag -> None],
   Item["QuadraticEquationQ","CSQuadraticEquationQ.nb", CopyTag -> None],
   Item["ExtractQuadraticCoefficients","CSExtractQuadraticCoefficients.nb",
CopyTag -> None]}]}]

Of course, one must always rebuild the Help browser index when the
BrowserCategories.m file is changed.

So for presenting a finished piece of work to others this is a nice format,
but as a general method of organizing all your notebooks it's not so good.

David Park
djmp at earthlink.net
http://home.earthlink.net/~djmp/



From: mtmtk [mailto:mtmtk2003 at yahoo.com]
To: mathgroup at smc.vnet.net

I like the organization of the help browser. I was wondering if I can
organize my own Mathematica files into a browser like that? I know it
can be edited but can a new one be created? Thanks.



  • Prev by Date: Re: typesetting fractions
  • Next by Date: RE: Re: Unexpected behaviour of HoldRest
  • Previous by thread: Help browser
  • Next by thread: Re: Help browser