[Qgis-community-team] more rst conventions questions

[Paolo Corti]

Hi Emmanuel

> I have been editing several rst docs in the EN userguide the past
> week.  A couple of questions before continuing:
>
> 1. Updating screenshots - many of the screenshots needs to be updated
> since there are GUI changes made.
>  - What should be default OS for screenshots? Depending on the OS,
> some GUI appear different (especially with OSX).
>     I'm thinking we use Xubuntu/OSGeo Live DVD as the base OS for
> creating screenshots, this way, we have consistent
>     look of the screenshots within the user guide.
>

It seems to me a very good idea ;)

> 2. File location of icons and image screenshots - Each chapter has its
> own img directory for screenshots and icons,
>    however, the conf.py [0] contains global image aliases for some
> icons located in the user_guide/img directory.
>    - Is it possible to include all the commonly used icons in
> conf.py's rst_epilog so that these are available in all the chapters.
>      I am only using the English version of QGIS so, I'm not sure
> whether icons are different with the other languages.
>

Regarding the structure for images, the way we are proceeding now
seems to me the optimal one: for each chapter an img directory, with a
directory for each language (en, es, fr, it...) with 'en' being the
master.

If we need to have a different version for the rst_epilog, this could
be easily done by overriding the rst_epilog value in conf.py at build
time.
Need to check if it is possible, but we could have a different
rst_epilog for each language in conf.py (ie rst_epilog_en,
rst_epilot_es, ...) and then pass it with the -Drst_epilog option when
building. Will try this in the next days.

> 3. Compiled rst available - do we have a regular build of the rst
> documentation available already? I do compile my own, but it would be
> good
>    if we have a daily build available in the qgis.org so that we can
> start linking QGIS questions to sections of the manual.  Even as a
> working draft.

I was considering to do the same: we can simply add a task in crontab
for building the latest source at every hour or so (the task need to
update the local git clone adn run the make script [1]).
Otto if you need help let me know

cheers
p

[1] https://github.com/qgis/QGIS-Documentation/blob/master/Makefile

-- 
Paolo Corti
Geospatial software developer
web: http://www.paolocorti.net
twitter: @capooti
skype: capooti