Re: documentation program
- To: mathgroup at smc.vnet.net
- Subject: [mg110715] Re: documentation program
- From: David Reiss <dbreiss at gmail.com>
- Date: Sat, 3 Jul 2010 08:17:32 -0400 (EDT)
- References: <i0k2hj$jtb$1@smc.vnet.net>
And, or course, there is this: http://scientificarts.com/worklife with a screencast about it on http://scientificarts.com/worklife/screencasts/ Direct link: http://scientificarts.com/worklife/screencasts/documenting.mov --David On Jul 2, 2:55 am, "David Park" <djmp... at comcast.net> wrote: > If I understand you correctly you are asking if one can write application= s > in Mathematica that provide new resources to a user and then document the= se > so they are easy to use. > > The answer is definitely yes. > > As a first step you could write a notebook that contains the routines in = an > Initialization section of the notebook, and then write Sections that > textually describe and illustrate the use of the routines. > > Then, if you get the Wolfram Workbench program, you can write a complete > Application that has the routines in a package or packages, and has full > documentation that looks and behaves pretty much like the regular > Mathematica documentation. It is some work to learn how to do this, and s= ome > work to actually do it. For example, you would not only write a usage > message for each function you provide, but also a documentation page with > notes and examples. However, if you are doing serious work, and building = up > serious capabilities this is a very good way to organize and preserve you= r > work, and make it available to others. > > This all should, in principle, work on various computer platforms. But > Windows and Mac are probably the most robust. > > David Park > djmp... at comcast.nethttp://home.comcast.net/~djmpark/ > > From: Dirk Fehse [mailto:dirk.fe... at chemie.uni-halle.de] > > Hi, > I just want to ask here whether anyone know or use a good program for > document Mathematica software. I?d would like to use them for some > structure diagrams of the software kit. > One think will very nice too, when it runs under Winxp and Linux. > Cheers > Dirk