[SIP-devel] help needed with SIP documentation

[Ricardo F. <ric...@us...>]

Hi, all,

Scilab has had support for images in the help pages a while now. SIP
would hugely benefit from having an illustrated documentation, as this
makes a huge difference for computer vision algorithms. I would like
to call your attention to
a presently ongoing effort to illustrate SIP documentation with
images. I have done it for the function 'skel' and the results are
exciting. The generated help files in HTML format can then be put on
the web for the benefit of the community.

To add images into a Scilab help file is very simple. You can look at
skel.xml for an example of how I did it.

Is anyone out there willing to collaborate on this effort? It would be
painstakingly inefficient to do it alone, as SIP has over 80
functions.

Basically, you change the XML file and then, inside "siptoolbox/help",
you type "make", and the HTML shold be created. You can examine the
HTML with any web browser. Watch out for XML to HTML translation
errors during "make". That's all. You can then commit the changes in
Git or just email me the file.

The images to be included are basically just any illustration you want,
but mainly the images that result from running the examples.

PS:  SIP now has OpenCV support. If it finds OpenCV in your system,
you should have additional functions available that make use of
OpenCV.

Best regards,
Ricardo Fabbri
--
Linux registered user #175401
www.lems.brown.edu/~rfabbri
pt.wikipedia.org/wiki/IPRJ
labmacambira.sf.net