[Qgis-community-team] convention for label/reference

[Larissa Junek]

Am Thu, 26 Apr 2012 23:10:38 +0200
schrieb Paolo Corti <pcorti at gmail.com>:

> 2012/4/26 Larissa Junek <junek at gbd-consult.de>:
> > Hello Paolo,
> > thanks for your suggestion. If we proceed like this the references
> > can't be read fluently. I made a suggestion in the index.rst:
> >
> > Now we test our project WMS, add the WMS with the URL
> > 'http://localhost/cgi-bin/project/qgis_mapserv.fcgi' as described in
> > section `Creating a WMS from a QGIS project`_ to QGIS and load the
> > WMS, see figure `fig_wmsproject`_
> >
> > The first reference now can be read easily the second is written
> > after the conventions we made so far.
> > Maybe there's another possibility for references in rst like for
> > example in HTML?
> >
> 
> Hi Larissa
> it was just an idea inherited from the Python documentation style
> guide. I would be more comfortable with schematic and short cross
> link labels (ex mychapt-mysect) that with descriptive long ones.
> But that's just my idea ;)
> p
> 
Hi Paolo,
i thought about the conventions again and my idea would be that we link
labels the following way (ex from the plugins_raster_terrain.rst):
 
See Figure `plugins/plugins_raster_terrain/RasterTerrainDialog`_

so the label would be:

.. _`plugins/plugins_raster_terrain/RasterTerrainDialog`:

In my opinion this way people could easily refer to other chapters
also in printed versions of the user guide where the links dont work.
If thats o.k. I will add it to the README.rst.

Kind regards,
Larissa


-- 
Geoinformatik Büro Dassau - http://www.gbd-consult.de
FOSSGIS consulting , training , support  and analysis
Davenstedter Str. 60  ,  D - 30453 Hannover , Germany
Phone:  +49-(0)511-2615322 ,  Fax: +49-(0)511-2615323