<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html lang="en">
<head><meta http-equiv="Content-Type" content="text/html;">
<title>Scalix message content</title>
<style type="text/css">
<!--
.Normal { text-align: left; text-indent:0pt; margin-top:0pt; margin-bottom:0pt; font-family: Arial; font-size: 12pt; }
.Default_Paragraph_Font {font-family: Arial; color: Black; background-color: white ; font-size: 12pt; font-weight: normal; font-style: normal; font-variant: normal; vertical-align: normal; text-decoration: none;}
div.ltTOCtitle { font-family: Verdana; font-size: 8pt; font-weight: bold; text-align: center;}
div.ltTOCl1 { font-family: Verdana; font-size: 8pt; font-weight: bold; margin-left:32pt; text-indent:-32pt;}
div.ltTOCl2 { font-family: Verdana; font-size: 8pt; font-weight: bold; margin-left:40pt; text-indent:-32pt;}
div.ltTOCl3 { font-family: Verdana; font-size: 8pt; font-weight: bold; margin-left:48pt; text-indent:-32pt;}
div.ltTOCl4 { font-family: Verdana; font-size: 8pt; font-weight: bold; margin-left:56pt; text-indent:-32pt;}
div.ltTOCl5 { font-family: Verdana; font-size: 8pt; font-weight: bold; margin-left:64pt; text-indent:-32pt;}
div.ltTOCl6 { font-family: Verdana; font-size: 8pt; font-weight: bold; margin-left:72pt; text-indent:-32pt;}
-->
</style>
</head>
<body>
<div class="Normal"><span style='font-size: 10pt; '>Martin</span></div>
<br>
<div class="Normal"><span style='font-size: 10pt; '>Your cookbook looks very
fine. We also should discuss to publish more complex issues like the
communiation between maptools and other tools p.e. </span></div>
<br>
<div class="Normal"><span style='font-size: 10pt; '>+1!</span></div>
<br>
<div class="Normal"><span style='font-size: 10pt; '>Horst</span></div>
<br>
<div class="Normal"><span style='font-size: 10pt; '>------------------------------------------------</span></div>
<br>
<div class="Normal"><span style='font-size: 10pt; '>Dr. Horst
Düster</span><br><span style='font-size: 10pt; '>Stv. Amtschef / kantonaler
GIS-Koordinator </span></div>
<br>
<div class="Normal"><span style='font-size: 10pt; '>Kanton
Solothurn</span><br><span style='font-size: 10pt; '>Bau- und
Justizdepartement</span><br><span style='font-size: 10pt; '>Amt für
Geoinformation</span><br><span style='font-size: 10pt; '>SO!GIS
Koordination</span><br><span style='font-size: 10pt; '>Rötistrasse
4</span><br><span style='font-size: 10pt; '>CH-4501 Solothurn</span></div>
<br>
<div class="Normal"><span style='font-size: 10pt; '>Telefon ++41(0)32 627 25
32</span><br><span style='font-size: 10pt; '>Mobil ++41(0)79 511 54
12</span><br><span style='font-size: 10pt; '>Telefax ++41(0)32 627 22
14</span></div>
<br>
<div class="Normal"><span style='font-size: 10pt; '>mailto:horst.duester@bd.so.ch</span><br><span style='font-size: 10pt; '>http://www.agi.so.ch</span></div>
<br>
<div class="Normal"><span style='font-size: 10pt; '>-----Ursprüngliche
Nachricht-----</span><br><span style='font-size: 10pt; '>Von: Martin Dobias
[mailto:wonder.sk@gmail.com]</span><br><span style='font-size: 10pt; '>Gesendet
am: Mittwoch, 5. Mai 2010 13:49</span><br><span style='font-size: 10pt; '>An:
qgis-dev</span><br><span style='font-size: 10pt; '>Betreff: [Qgis-developer]
PyQGIS cookbook</span></div>
<br>
<div class="Normal"><span style='font-size: 10pt; '>Hi all</span></div>
<br>
<div class="Normal"><span style='font-size: 10pt; '>I think we are still lacking
a comprehensive resource for
developers</span><br><span style='font-size: 10pt; '>using Python bindings to
develop plugins and/or custom
applications.</span><br><span style='font-size: 10pt; '>There are some resources
in form of of blog posts and wiki pages,
but</span><br><span style='font-size: 10pt; '>they are not well organized and
sometimes outdated. Finally,
existing</span><br><span style='font-size: 10pt; '>plugins contain a lot of
useful (reusable) code, but going through
a</span><br><span style='font-size: 10pt; '>plenty of source code of plugins is
not a particularly good way to</span><br><span style='font-size: 10pt; '>learn
QGIS API.</span></div>
<br>
<div class="Normal"><span style='font-size: 10pt; '>I've decided to start a
PyQGIS cookbook that would introduce
various</span><br><span style='font-size: 10pt; '>aspects of QGIS API in form of
working code snippets. The
cookbook</span><br><span style='font-size: 10pt; '>shouldn't replace the
generated Doxygen documentation. Instead
of</span><br><span style='font-size: 10pt; '>telling what a class can do, it
should be task-oriented,
i.e.</span><br><span style='font-size: 10pt; '>answering the questions "how do
I?". Ideally, the cookbook should
be</span><br><span style='font-size: 10pt; '>both a way how to learn QGIS API
and a source of code for
those</span><br><span style='font-size: 10pt; '>familiar with it, though not
remembering the exact syntax/usage.</span></div>
<br>
<div class="Normal"><span style='font-size: 10pt; '>After reviewing possible
documentation systems, sphinx [1] looked
like</span><br><span style='font-size: 10pt; '>a suitable candidate (currently
generator for Python
documentation</span><br><span style='font-size: 10pt; '>[2]). It has plenty of
features and supports various output
formats.</span><br><span style='font-size: 10pt; '>It uses reStructured text
syntax, which is quite similar to
wiki</span><br><span style='font-size: 10pt; '>syntax.</span></div>
<br>
<div class="Normal"><span style='font-size: 10pt; '>As a start, I've combined
Python_Bindings
and</span><br><span style='font-size: 10pt; '>Developing_Python_Plugins wiki
pages and added some new material,
the</span><br><span style='font-size: 10pt; '>working draft is available
here:</span><br><span style='font-size: 10pt; '>http://mapserver.sk/~wonder/qgis/html/</span></div>
<br>
<div class="Normal"><span style='font-size: 10pt; '>It is in early stages and
covers only some parts of the API. If
the</span><br><span style='font-size: 10pt; '>cookbook will get positive
feedback, I'd like to move it to
official</span><br><span style='font-size: 10pt; '>QGIS documentation page [3].
The source code for the cookbook could
be</span><br><span style='font-size: 10pt; '>put into QGIS svn - either within
the source tree or as a
separate</span><br><span style='font-size: 10pt; '>branch in svn and the online
docs could be regenerated daily as is
the</span><br><span style='font-size: 10pt; '>case of Doxygen
documentation.</span></div>
<br>
<div class="Normal"><span style='font-size: 10pt; '>I'd like to ask you for some
feedback on the cookbook:</span><br><span style='font-size: 10pt; '>- do you
like the idea?</span><br><span style='font-size: 10pt; '>- what parts of API
should be documented - what is
missing?</span><br><span style='font-size: 10pt; '>- do you know about any
resources / useful code snippets that could
be</span><br><span style='font-size: 10pt; '>integrated into the
cookbook?</span></div>
<br>
<div class="Normal"><span style='font-size: 10pt; '>Any contributions to the
cookbook would be highly welcome. I
believe</span><br><span style='font-size: 10pt; '>after some time this could end
up as a complete guide for all
common</span><br><span style='font-size: 10pt; '>needs.</span></div>
<br>
<div class="Normal"><span style='font-size: 10pt; '>Regards</span><br><span style='font-size: 10pt; '>Martin</span></div>
<br>
<div class="Normal"><span style='font-size: 10pt; '>[1]
http://sphinx.pocoo.org/</span><br><span style='font-size: 10pt; '>[2]
http://docs.python.org/</span><br><span style='font-size: 10pt; '>[3]
http://doc.qgis.org/</span><br><span style='font-size: 10pt; '>_______________________________________________</span><br><span style='font-size: 10pt; '>Qgis-developer
mailing
list</span><br><span style='font-size: 10pt; '>Qgis-developer@lists.osgeo.org</span><br><span style='font-size: 10pt; '>http://lists.osgeo.org/mailman/listinfo/qgis-developer</span></div>
</body>
</html>