<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
</head>
<body bgcolor="#FFFFFF" text="#000000">
<font face="Calibri">Hi guys,<br>
<br>
we are now at the hackfest and we are starting to write the
documentation of all the processing (sextante) algorithms. If you
want to contribute the method is quite simple (you have to be just
a little bit practical with git):<br>
- fork the repository of Victor (<a
href="https://github.com/volaya/SEXTANTE-Help">https://github.com/volaya/SEXTANTE-Help</a>)<br>
- the repository is divided into folders of the algorithms
providers (qgis, grass, saga....)<br>
- choose a help file you want to write: you can either clone the
repository on your computer and use a text editor or you can
directly use the text editor of github (maybe the simpler method)<br>
- follow the 2 example files written by Victor (</font><a
class="moz-txt-link-freetext"
href="https://github.com/volaya/SEXTANTE-Help/blob/master/saga/gridcalculator.rst">https://github.com/volaya/SEXTANTE-Help/blob/master/saga/gridcalculator.rst</a>
and
<a class="moz-txt-link-freetext"
href="https://github.com/volaya/SEXTANTE-Help/blob/master/qgis/fieldcalculator.rst"><font
color="#000000"></font>https://github.com/volaya/SEXTANTE-Help/blob/master/qgis/fieldcalculator.rst
</a>) and the short how-to (<a class="moz-txt-link-freetext"
href="https://github.com/volaya/SEXTANTE-Help/blob/master/instructions.txt">https://github.com/volaya/SEXTANTE-Help/blob/master/instructions.txt</a>)<br>
- the files are restructuredtext (.rst), so be aware to the syntax
if you want to add some pictures or link or other stuff (just
compare the examples of Victor and those of the how-to). If you have
some question, just ask!<br>
- once done: commit the file, push it and make a pull request<br>
<br>
That's it!<br>
<br>
If you are not familiar with git (the first impact could be
devastating), just ask and MAYBE I can help you. Some suggestions
here <a
href="https://github.com/ghtmtt/QGIS-Documentation#howto-for-language-maintainers">https://github.com/ghtmtt/QGIS-Documentation#howto-for-language-maintainers<br>
</a><br>
BTW: all the grass algorithms have already a documentation, so we
don't need to improve this part. The qgis and otb algorithms are
already quite good explained in the manual, so you can just copy the
description and fill the fields of the rst file.<br>
PROBLEM: how can we avoid that two or more people works on the same
file? The idea is that everyone choose a category of a sextante
provider (example, Saga -> Shapes -> Points) and write an
email to the others. <br>
<br>
Feel free to make any suggestion and questions.<br>
<br>
<br>
One more thing. Especially for Saga, Victor needs help for proving
the validity of the algorithms. If you have time, this is the way to
do these "unit test".<br>
- open the python console in qgis (under the plugin menu)<br>
- write <b>import processing<br>
</b>-<b> </b>and <b>processing.loadTestData()</b><br>
- these 2 commands will load the sample dataset of sextante; unit
tests have to be done <b>only on these layers<br>
</b>- run the algorithm, <b>but you have to save the file as a REAL
FILE (not a temporary one)<br>
</b>- be<b> </b>sure that the algorithm runs correctly <br>
- go on <b>processing menu</b> and open the <b>history and log </b>window<br>
- under <b>algorithm</b> choose the algorithm you ran (watch the
time) <br>
- right click and open the <b>unit test dialog<br>
</b>- copy and paste the entire code in a text file (you can paste
different unit test in the same text file)<br>
- send the file to Victor (or to me)<br>
<br>
<br>
Thank you guys!<b> <br>
</b> <br>
<br>
Cheers,<br>
<br>
Matteo<br>
<br>
<a class="moz-txt-link-freetext"
href="https://github.com/volaya/SEXTANTE-Help/blob/master/qgis/fieldcalculator.rst"></a>
</body>
</html>