Subject: After looking at the Mathematica documentation
From: Vadim V. Zhytnikov
Date: Thu, 20 Jan 2005 12:08:48 +0300
Robert Dodier writes:
>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.
>
>
>
Do you mean HTML documentation or printed book?
Each function on separate page may be good for HTML
but it is paper waste for printed material.
> * Page title is the function name.
>
>
>
Good idea. It can be helpful in printed material as well - just
like it usually done in dictionaries.
> * 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.
>
>
>
Do we have any notion of hierarchy for Maxima objects?
I haven't seen anything like this.
> * 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).
>
>
>
I can implement different font attributes in update_examples
script. At least one thing can be done immediately - user input
in bold face to make it differ from program output
(like in Mathematica book). I'm not sure about color though.
> * 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/$Notebooks
>http://documents.wolfram.com/mathematica/functions/With
>http://documents.wolfram.com/mathematica/functions/Append
>http://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
>
>
>
>
--
Vadim V. Zhytnikov