[Scilab-Dev] Update of the online documentation

[Sylvestre Ledru]

Hi,

We did some improvements:
* There is now a "top" link which leads to the "upper" page (the
category usually)
http://www.scilab.org/team/sylvestre.ledru/scidoc/datatipsRemoveAll.html
I am not 100% happy about the look and feel of this section... patches
are welcome.

* Following David & Michael comments, I started to sort some functions
into subchapters. For example, Discrete mathematics, Floating point,
Integer representation or Trigonometry on this page:
http://www.scilab.org/team/sylvestre.ledru/scidoc/section_2cbe47bdd9625e1742e4aa00d40a68e2.html
Please open new bug reports for other relevant sections.
Other examples, the Scilab keyword section:
http://www.scilab.org/team/sylvestre.ledru/scidoc/section_791d3d7b404e3abd5a433fa232cfe678.html
Note that these commits are still under review in gerrit:
http://codereview.scilab.org/

* The left bar contains the full path:
http://www.scilab.org/team/sylvestre.ledru/scidoc/factor.html
ie: Discrete mathematics => Elementary Functions => Scilab manual

Sylvestre


Le mardi 19 octobre 2010 à 18:14 +0200, Sylvestre Ledru a écrit :
> Hello guys,
> 
> Calixte (on the technical side) and I (on the complain side) have been
> working on a rebuild of the documentation system of Scilab.
> 
> First, Calixte decreased the build time from 30 minutes (even 60 on some
> configurations) to about 25 seconds. Even if it is not really important
> to the normal user, this will help us in improving the documentation (it
> was very frustrating to have to wait some long).
> 
> We took the time to redesign the online guide.
> Here is a draft:
> http://www.scilab.org/team/sylvestre.ledru/scidoc/index.html
> 
> Some examples:
> http://www.scilab.org/team/sylvestre.ledru/scidoc/zeros.html
> http://www.scilab.org/team/sylvestre.ledru/scidoc/datatipRemove.html
> 
> We would like your feedback on this.
> 
> Please note some elements:
> * we will add a component to switch between the various localization
> (lang) of the same page.
> * we will the possibility for a user to comment
> * we will probably add a link "report a bug" from a page to encourage
> user to contribute by reporting bugs
> 
> * we will to make available various Scilab versions documentations.
> 
> The embedded Scilab document has been also improved in the same way
> (with some minor differences due to interface):
> * In the embedded page in Scilab, we will have a "path" element which
> will display:
> Scilab :: Graphics Library :: datatips :: datatipRemove with a link on
> each elements .
> 
> 
> Thanks, 
> Calixte & Sylvestre
> 
> PS: The inspiration of this development comes from the excellent PHP
> documentation.
> Example: http://fr2.php.net/str_replace
>