Subject: After looking at the Mathematica documentation
From: Robert Dodier
Date: Tue, 18 Jan 2005 16:19:30 -0800 (PST)
Hello all,
It has been suggested that the Mathematica documentation
could be a model to follow. Indeed, after browsing
http://documents.wolfram.com/mathematica I see that
it has some interesting features.
Here are a few points that stand out to me. Maxima might or
might not follow suit. There are certainly other models to follow.
* Each function is on a separate page.
* Page title is the function name.
* Links at the top of the page show the place of
the item in a hierarchy of categories.
Clicking on a category name shows the items in the category.
* Related items mentioned in the text have web links.
This includes "See also" items.
* Color and font distinguish aspects of the description.
A synopsis stands out at the top. In examples, comments
and labels are colored differently from input & output.
Arguments are italicized (except for examples).
* Descriptions are bullet lists. There are links to
further discussions.
* Documents are enclosed in a box which fills
about 2/3 the screen width.
Here are some examples.
http://documents.wolfram.com/mathematica/functions/$Notebookshttp://documents.wolfram.com/mathematica/functions/Withhttp://documents.wolfram.com/mathematica/functions/Appendhttp://documents.wolfram.com/mathematica/functions/Integrate
It seems that the features mentioned above are largely things
that could be implemented via style sheets or automated
processing of some kind, if we think them important.
I might try to create a mock up using some of these ideas.
For what it's worth,
Robert Dodier
__________________________________
Do you Yahoo!?
Yahoo! Mail - You care about security. So do we.
http://promotions.yahoo.com/new_mail