[scilab-Users] Add chapters to Scilab help system

[Eric Dubois]

Hi

There are indeed big differences between the 4.1.2 and the 5.2.0.

The greatest is that help files must now be written in the XML langage and
strictly comply with Scilab specifications.

When your help files comply with Scilab specifications that you have to run
xml2jar('avaHelp',helps_dirs,helps_titles)

And once it has been done, you must run:
add_help_chapter(your title','helps_dir',%f);

To understand how it works, you can for instance have a look at Torbjørn
Pettersen <top at tpett.com> toolbox guimaker
(1.2)<http://www.scilab.org/contrib/index_contrib.php?page=displayContribution&fileID=1200>(
http://www.scilab.org/contrib/index_contrib.php?page=listdyn&order=date).

If it can help, I have written a Scilab function html2xml.sci to translate
my help files. Altough it is only suited to my needs, I think it could be
adapted to your needs relatively easily. I join also a html file and its xml
version to help you understand how it works. If you need more examples, you
can download on my web site (http://dubois.ensae.net/grocer.html) the
version of my toolbox for Siclab-4.1.2 and the one for Scilab-5.> and
compare the html and xml files resulting from this translation.

Hope it will help.

Eric.



2009/12/24 José Luis Volta Grau <jlvolta at hipuu.com.py>

>  Hi,
> I've tried to add a help chapter for my functions to the Scilab-5.2.0 help
> system, as I did with version 4.1.2
> But Scilab rises an error when I try to access the global constant
> "%helps", and nothing happens when I use the "add_help_chapter" function (my
> help chapter doesn't appear).
> What's the difference between the 5.2.0 and 4.1.2 versions ?
>
> I would appreciate some help,
> J.L.V.
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.scilab.org/pipermail/users/attachments/20091225/89540c39/attachment.htm>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.scilab.org/pipermail/users/attachments/20091225/89540c39/attachment-0001.htm>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: html2xml.sci
Type: application/octet-stream
Size: 10514 bytes
Desc: not available
URL: <https://lists.scilab.org/pipermail/users/attachments/20091225/89540c39/attachment.obj>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: ols.xml
Type: text/xml
Size: 6649 bytes
Desc: not available
URL: <https://lists.scilab.org/pipermail/users/attachments/20091225/89540c39/attachment.xml>