[Qgis-community-team] Documentation guidelines

[Diethard Jansen]

Hi Paolo,

I see what you mean. Now there is in documentation guidelines underneath
inline tags the following example:

* Icon with popup text belonging to Icon

  ::

     |icon| :sup:`popup_text`

In the chapter Substitions you can find all icons that are used in the
manual but the example of the inline tags could use some additional
examples (like the ones used in "conventions used in this manual" and
a reference to the substitutions.

Regards,

Diethard.



2015-02-25 13:27 GMT+01:00 Paolo Cavallini <cavallini at faunalia.it>:

> Il 25/02/2015 13:09, Yves Jacolin ha scritto:
>
> > For me both are a little bit different. conventions is read by the user
> to
> > understand the text (so it should be in the documentation),
> > documentation_guidelins aims to be read by documentors, ie which tags
> should
> > be used for writing the documentation (so it should be located in the
> source,
> > not in the final documentation).
>
> Got it, thanks.
> However, I do not find in the Documentation guidelines some useful info,
> e.g. how to add a checkbox, radiobutton etc.
> Am I wrong?
> All the best.
>
> --
> Paolo Cavallini - www.faunalia.eu
> QGIS & PostGIS courses: http://www.faunalia.eu/training.html
> _______________________________________________
> Qgis-community-team mailing list for organizing community resources such
> as documentation, translation etc..
> Qgis-community-team at lists.osgeo.org
> http://lists.osgeo.org/mailman/listinfo/qgis-community-team
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-community-team/attachments/20150225/d50f6520/attachment.html>