Mathematica 9 is now available
Services & Resources / Wolfram Forums / MathGroup Archive
-----

MathGroup Archive 2009

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

Search the Archive

Documentation Center tool screencast: Edited posting....

  • To: mathgroup at smc.vnet.net
  • Subject: [mg102321] Documentation Center tool screencast: Edited posting....
  • From: David Reiss <dbreiss at gmail.com>
  • Date: Wed, 5 Aug 2009 05:45:13 -0400 (EDT)

[Late at night my editorial skills are a bit weak.  This is an edited
version of my earlier post--it is hopefully more readable: my
apologies...]

I have added an informal screencast to

http://scientificarts.com/worklife/screencasts/

that shows how to use the tools in A WorkLife Framework (http://
scientificarts.com/worklife) that translate Notebooks into material
for the Mathematica Documentation Center. (The screencast in question
is not surprisingly called "Documenting:" it's number 8 in the list of
screencasts.)

Though Wolfram WorkBench has a procedure whereby you can create
Documentation Center material, the approach in A WorkLife FrameWork is
quite complementary to that since it takes place entirely within
Mathematica.

In a way this is consistent with the philosophy of A WorkLife
FrameWork in that one of its key goals is to allow you to stay within
Mathematica for as much of your general work as possible.

As some of you know, you can get an outline of how to create
Documentation Center material at

http://scientificarts.com/worklife/notebooks/

in the notebook titled "Documentation Center Notes."

I want to add that though that notebook describes much of the process
(that I learned through reverse engineering) it is missing a piece
that relates to how one indexes material so that the Documentation
Center search field can find it.  David Bailey  did similar
investigations on reverse engineering and, in particular, supplied my
missing indexing step.  You can read about it here on the web site of
David's consultancy:

http://www.dbaileyconsultancy.co.uk/m_documentation/m_documentation.html

I hope that all of this material is helpful to folks.

[A note for those of you who have A WorkLife FrameWork: the most
recent version (as of this past weekend) now contains the indexing
code as inspired by David Bailey's work. Thank you again David.]

--David Reiss


  • Prev by Date: Re: A Question about strings in lists
  • Next by Date: Re: error with Sum and Infinity
  • Previous by thread: Creating Documentation Center material: a screencast
  • Next by thread: FrameTicks or LogPlot bug?