[SIP-devel] New SIP-dev released (HELP US)

[Ricardo F. <rf...@if...>]

Hi, all,

Download the new development version (20040320) at:
http://siptoolbox.sf.net/devel

In this version, all the files are already using new sections, such as
"Availability", and many more. We now use our own XSL and DTD files.
The problem of linking to external Scilab functions was solved by
requiring the HTML pages to be built in the user's machine,
which is the best solution I could find. Futurely, the binary version
will either require the user to have XSLTPROC command in his machine,
or else we will have to make some processing to the HTML files using
SED to replace the links to correct locations in the user's machine.

I have done most improvements to all XML files using some scripting
utilities (SED, etc). However, there is still important work to be
done which I couldn't automate. The only XML files that are complete
and finished are: drawline.xml, gray_imread.xml, imread.xml,
imshow.xml, mogrify.xml, and imwrite.xml

There still remains about 50 files to be revised. For this task, I
included the old ".man" files in the new devel distro so you can help
me match their content to the corresp XML files, if you have the time.

The most complex XML files are mogrify.xml and imwrite.xml, which you
should take as MODELS for editing the other XML files.  I ask that you
guys help me revise the rest of the XML files. I suggest the work be
assigned as bellow:

RICARDO
bwdist.xml
skel.xml
thin.xml
watershed.xml
minmax.xml

VITOR
angle.xml
bwborder.xml
bwlabel.xml
dilate.xml
edge.xml
edilate.xml
hello_sip.xml
hough.xml
ihough.xml
im2bw.xml
im2gray.xml
imconv.xml

JOCELYN
imcorrcoef.xml
unwrapl.xml
unwrapp.xml
imphase.xml
improfile.xml
imroi.xml
imvariance.xml
interferometry_gui.xml
pifilter.xml
poledetection.xml
sip_colormap.xml
mkfftfilter.xml

LINCHPIN
normal.xml
ntsc2rgb.xml
percol.xml
perim.xml
rgb2ntsc.xml
sip_fftshift.xml
curvature2d.xml
curvature.xml
unfollow.xml
xgetpixel.xml
xor.xml
erode.xml

Here's what we have to do (it's not much):

- take the files that I finished as a model on how to write good
  quality help pages.
- match the XMLs to corresp. .man's to see if everything is included
- Split the PARAMETERS section into INPUT/OUTPUT parameter sections,
  whenever both exist (see mogrify.xml for an example on this)
- in the description section, when we have something of the form:
<P>
 imwrite(Img, filename) creates an image filename in disk,  from
 Img matrix. For truecolor images, Img is a MxNx3  hypermatrix,
 so for example Img(:,:,1) stands for the red  channel. For binary
 images or intensity grayscale images,  Img is a MxNx1 matrix.
</P>
<P>
 imwrite(Index, Map, filename) does the same work, but from  Index
(MxN) and Map (Mx3) matrices. Grayscale and Paletted images are
written in this way.
</P>

That is, a commands folowed by their description, we should change to
this:

<DESCRIPTION_INDENT>
<DESCRIPTION_ITEM label="imwrite(Img, filename)">
 creates an image filename in disk,  from
 Img matrix. For truecolor images, Img is a MxNx3  hypermatrix,
 so for example Img(:,:,1) stands for the red  channel. For binary
 images or intensity grayscale images,  Img is a MxNx1 matrix.
</DESCRIPTION_ITEM>
<DESCRIPTION_ITEM label="imwrite(Index, Map, filename)">
 does the same work, but from  Index (MxN) and Map (Mx3)
 matrices. Grayscale and Paletted images are written in this way.
</DESCRIPTION_ITEM>
</DESCRIPTION_INDENT>

(if anybody can write a script to automate this, we'll be glad)

- function names, variables, and other programming elements should
be between <TT> </TT> tags.
- when you finish your review of the XML file, please send it to me.
- any doubts: email.

HINTS:
- type "make" to generate the HTML file from XML under Unix systems
- its faster to use an ordinary browser to view the resulting .htm
  file while you're writing it, without calling scilab.

If anybody can/wants to do it all, just tell us.
OTOH, no problem if you don't have the time to finish or even do any
of your part; just drop an email to this list so we can reassign the
task. Don't worry about the time, do what you can in your own pace.

I'll be working on other toolbox tasks after I finish my part.
thank you all,

PS: you can now reach me by ICQ: 208974212 almost all day long.
Ricardo.

--
  Ricardo Fabbri, Cybernetic Vision Research Group, USP, Brazil.
  WEB: cyvision.if.sc.usp.br/~rfabbri   ICQ: 208974212

  "With pain and suddeness is how Real Offsprings are born. But they
  must result from intense pleasure and a long period of development."