Prev: Expression for manipulate controls
Next: A modified StyleSheet results in FontSize fluctuations
From: Dirk Fehse on 1 Jul 2010 08:27
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

From: David Park on 2 Jul 2010 02:55
If I understand you correctly you are asking if one can write applications
in Mathematica that provide new resources to a user and then document these
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 some
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 your
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
djmpark(a)comcast.net
http://home.comcast.net/~djmpark/



From: Dirk Fehse [mailto:dirk.fehse(a)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



From: José Luis Gómez Muñoz on 3 Jul 2010 08:17
Hi Dirk

Not exactly what you asked for, but next link might be useful for you. It
contains instructions to make a simple package (add-on) and create its
documentation inside the documentation center. Please notice that in
Mathematica 7, the add-ons documentation appears in the lower LEFT corner
instead of the lower RIGHT corner of Documentation Center's main page:

http://homepage.cem.itesm.mx/lgomez/createMathematica6AddOn/createMathematic
a6AddOn.html

Best regards from Mexico
Jose

-----Mensaje original-----
De: Dirk Fehse [mailto:dirk.fehse(a)chemie.uni-halle.de]
Enviado el: Jueves, 01 de Julio de 2010 07:27 a.m.
Para: mathgroup(a)smc.vnet.net
Asunto: documentation program

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




From: David Reiss on 3 Jul 2010 08:18
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...(a)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...(a)comcast.nethttp://home.comcast.net/~djmpark/
>
> From: Dirk Fehse [mailto:dirk.fe...(a)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


 | 
Pages: 1
Prev: Expression for manipulate controls
Next: A modified StyleSheet results in FontSize fluctuations