[Scilab-Dev] Update of the online documentation

[Calixte Denizet]

Le mercredi 20 octobre 2010 à 09:54 +0200, Clément David a écrit :
> Hello,

Hello Clement,

> 
> Thanks for these improvements, It will ease the documentation
> improvement.
> 
> First the user comment should be managed with care to avoid
> documentation vandalism. Just sending a formatted mail should be
> sufficient.
> 
> Then, there is some rendering problems on:
> 
>  * http://www.scilab.org/team/sylvestre.ledru/scidoc/INTEGRAL_m.html
>     passing the mouse over "Dialog box" or any text underline it !
> 
>  * http://www.scilab.org/team/sylvestre.ledru/scidoc/MATEIG.html
>     Passing the mouse over the first line of the example underline it !
> 

I fixed the bug on the forge:
http://forge.scilab.org/index.php/p/scidoc/source/commit/cb432547a66e60f1fd96561ac121e5e957e85c81/

And I fixed a bug in MATEIG.xml (link instead of xref) :
http://codereview.scilab.org/#change,2319

Calixte

>  *
> http://www.scilab.org/team/sylvestre.ledru/scidoc/section_10261ac2c63340e6a753699961fb03f4.html
>     The content height is smaller then the left menu one. This lead to a
> mixed text footer (should be a CSS problem only).
> 
> > 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
> > 
>