[Qgis-community-team] Updates on the new Documentation infrastructure

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
10 messages Options
Reply | Threaded
Open this post in threaded view
|

[Qgis-community-team] Updates on the new Documentation infrastructure

Paolo Corti
Hi

Today I have committed latest version of Sphinx Makefile.
At this point it should be easy to compile messages and build
documentation, you can find a basic workflow in the readme file [1].

Now I am in for installing the web application on the server.
After several considerations, I decided to keep going with Pootle [1],
as Weblate [2] didn't seem to me too much mature at this time, and has
several pitfalls.
As both Pootle and Weblate are using git as a data storage (for
Weblate this is native, for Pootle an option), it should be easy at
some point to switch to Weblate if we are not happy with Pootle.

I have seen that the User Guide has been split in several directory (I
guess one for each chapter): one important consideration to keep in
mind is that all the .rst files should have a different name, even if
they are in different chapters (directory).
So if two chapters have a file with the same name, we should rename them.
This is because all the .po messages are sent by the actual builder to
the translated/language directory: obviously in that directory all the
files must have a different name.

Obviously it is ok for having more introduction.rst files, one for
each documentation effort (at this time in the user_guide and readme
directory)

ciao
p

[1] http://translate.sourceforge.net/wiki/pootle/index?redirect=1
[2] http://weblate.org/

--
Paolo Corti
Geospatial software developer
web: http://www.paolocorti.net
twitter: @capooti
skype: capooti
_______________________________________________
Qgis-community-team mailing list
[hidden email]
http://lists.osgeo.org/mailman/listinfo/qgis-community-team
Reply | Threaded
Open this post in threaded view
|

Re: [Qgis-community-team] Updates on the new Documentation infrastructure

Alexander Bruy
Hi,

2012/4/18 Paolo Corti <[hidden email]>:
> Today I have committed latest version of Sphinx Makefile.
> At this point it should be easy to compile messages and build
> documentation, you can find a basic workflow in the readme file [1].
Readme file recommends use Virtaal for translation. AFAIK latest
versions of QtLinguist also can work with .po files. Does Virtaal has
any advantages in compare with QtLinguist?

Also, if I understand correctly now we can start to translate user
guide, right?

Thanks
--
Alexander Bruy
_______________________________________________
Qgis-community-team mailing list
[hidden email]
http://lists.osgeo.org/mailman/listinfo/qgis-community-team
Reply | Threaded
Open this post in threaded view
|

Re: [Qgis-community-team] Updates on the new Documentation infrastructure

Tim Sutton
Hi

On Wed, Apr 18, 2012 at 6:50 PM, Alexander Bruy
<[hidden email]> wrote:

> Hi,
>
> 2012/4/18 Paolo Corti <[hidden email]>:
>> Today I have committed latest version of Sphinx Makefile.
>> At this point it should be easy to compile messages and build
>> documentation, you can find a basic workflow in the readme file [1].
> Readme file recommends use Virtaal for translation. AFAIK latest
> versions of QtLinguist also can work with .po files. Does Virtaal has
> any advantages in compare with QtLinguist?
>

Yes we have used linguist here with .po files and it works quite
nicely. Also if you have multiple po/ts files open it cross references
between them for phrase hints etc which is very nice.

Paolo - we still need to get your login organised - contact me offlist
(or on IRC) to continue with that.

Regards

Tim

> Also, if I understand correctly now we can start to translate user
> guide, right?
>
> Thanks
> --
> Alexander Bruy
> _______________________________________________
> Qgis-community-team mailing list
> [hidden email]
> http://lists.osgeo.org/mailman/listinfo/qgis-community-team



--
Tim Sutton - QGIS Project Steering Committee Member (Release  Manager)
==============================================
Visit http://linfiniti.com to find out about:
 * QGIS programming services
 * Mapserver and PostGIS based hosting plans
 * FOSS Consulting Services
Skype: timlinux Irc: timlinux on #qgis at freenode.net
==============================================
_______________________________________________
Qgis-community-team mailing list
[hidden email]
http://lists.osgeo.org/mailman/listinfo/qgis-community-team
Reply | Threaded
Open this post in threaded view
|

Re: [Qgis-community-team] Updates on the new Documentation infrastructure

Paolo Corti
On Wed, Apr 18, 2012 at 9:41 PM, Tim Sutton <[hidden email]> wrote:

> Hi
>
> On Wed, Apr 18, 2012 at 6:50 PM, Alexander Bruy
> <[hidden email]> wrote:
>> Hi,
>>
>> 2012/4/18 Paolo Corti <[hidden email]>:
>>> Today I have committed latest version of Sphinx Makefile.
>>> At this point it should be easy to compile messages and build
>>> documentation, you can find a basic workflow in the readme file [1].
>> Readme file recommends use Virtaal for translation. AFAIK latest
>> versions of QtLinguist also can work with .po files. Does Virtaal has
>> any advantages in compare with QtLinguist?
>>
>
> Yes we have used linguist here with .po files and it works quite
> nicely. Also if you have multiple po/ts files open it cross references
> between them for phrase hints etc which is very nice.
>

I wouldn't mind that each translator would opt for her/his preferred
tool (there are several ones, also gTranslator seems to me very good),
but according to the Pottle documentation [1] (as someone - do not
rembember who - suggested at the HF), Virtal is the suggested tool.
I am quiet confident, anyway, that you could use any tool,
gTranslator, QtLinguist, vim, gedit or whatever, because as far as I
can see there are not particula advantages. So we could stay with
Tim's suggestion, and give QtLinguist a try.

> On Wed, Apr 18, 2012 at 6:50 PM, Alexander Bruy
> <[hidden email]> wrote:
> Also, if I understand correctly now we can start to translate user
> guide, right?

no, at least not until we commit to git the first master rst
documentations, with related .pot and .po files.
So you need still to bear a bit, as the the following email by Jean
Roc suggested. Or, maybe, contribute to the LaTeX to RST migration
consolidation effort?

cheers
p

[1] http://translate.sourceforge.net/wiki/pootle/offline_translation

--
Paolo Corti
Geospatial software developer
web: http://www.paolocorti.net
twitter: @capooti
skype: capooti
_______________________________________________
Qgis-community-team mailing list
[hidden email]
http://lists.osgeo.org/mailman/listinfo/qgis-community-team
Reply | Threaded
Open this post in threaded view
|

Re: [Qgis-community-team] Updates on the new Documentation infrastructure

Tim Sutton
Hi

On Wed, Apr 18, 2012 at 11:01 PM, Paolo Corti <[hidden email]> wrote:

>
> I wouldn't mind that each translator would opt for her/his preferred
> tool (there are several ones, also gTranslator seems to me very good),
> but according to the Pottle documentation [1] (as someone - do not
> rembember who - suggested at the HF), Virtal is the suggested tool.
> I am quiet confident, anyway, that you could use any tool,
> gTranslator, QtLinguist, vim, gedit or whatever, because as far as I
> can see there are not particula advantages. So we could stay with
> Tim's suggestion, and give QtLinguist a try.
>

Agreed - no need to force anything on anyone, let people use what they
prefer. Linguist is just a nice option for people who don't know what
to use and who might also be doing application translations since they
can learn one tool and do both jobs.

Regards

Tim



--
Tim Sutton - QGIS Project Steering Committee Member (Release  Manager)
==============================================
Visit http://linfiniti.com to find out about:
 * QGIS programming services
 * Mapserver and PostGIS based hosting plans
 * FOSS Consulting Services
Skype: timlinux Irc: timlinux on #qgis at freenode.net
==============================================
_______________________________________________
Qgis-community-team mailing list
[hidden email]
http://lists.osgeo.org/mailman/listinfo/qgis-community-team
Reply | Threaded
Open this post in threaded view
|

Re: [Qgis-community-team] Updates on the new Documentation infrastructure

Otto Dassau-3
Hi,

Am Wed, 18 Apr 2012 23:05:33 +0200
schrieb Tim Sutton <[hidden email]>:

> Hi
>
> On Wed, Apr 18, 2012 at 11:01 PM, Paolo Corti <[hidden email]> wrote:
> >
> > I wouldn't mind that each translator would opt for her/his preferred
> > tool (there are several ones, also gTranslator seems to me very good),
> > but according to the Pottle documentation [1] (as someone - do not
> > rembember who - suggested at the HF), Virtal is the suggested tool.
> > I am quiet confident, anyway, that you could use any tool,
> > gTranslator, QtLinguist, vim, gedit or whatever, because as far as I
> > can see there are not particula advantages. So we could stay with
> > Tim's suggestion, and give QtLinguist a try.
> >
> Agreed - no need to force anything on anyone, let people use what they
> prefer. Linguist is just a nice option for people who don't know what
> to use and who might also be doing application translations since they
> can learn one tool and do both jobs.

for the translation howto in the wiki it would be good to document all the
available tools a little bit and maybe focus on one tool that we prefere or
provides the easiest handling?

Could you please start and add some small notes (tool names) that we can
fill later in the wiki?

http://hub.qgis.org/wiki/quantum-gis/Manual_Translation

Regards
Otto
_______________________________________________
Qgis-community-team mailing list
[hidden email]
http://lists.osgeo.org/mailman/listinfo/qgis-community-team
Reply | Threaded
Open this post in threaded view
|

Re: [Qgis-community-team] Updates on the new Documentation infrastructure

Paolo Corti
2012/4/19 Otto Dassau <[hidden email]>:

>
> for the translation howto in the wiki it would be good to document all the
> available tools a little bit and maybe focus on one tool that we prefere or
> provides the easiest handling?
>
> Could you please start and add some small notes (tool names) that we can
> fill later in the wiki?
>
> http://hub.qgis.org/wiki/quantum-gis/Manual_Translation
>

Hi Otto
the wiki refer to the actual translation effort workflow (without
using rst and gettext): should I still add it there the tools for
editing the files generated by gettext?

As far as I can see, these are the most commont I have found so far
(but I guess there are more ones, that you may know):

Desktop tools
--------------------
* Qt Linguist: http://qt-project.org/doc/qt-4.8/linguist-manual.html
* Gtranslator: http://projects.gnome.org/gtranslator/
* Virtaal: http://translate.sourceforge.net/wiki/virtaal/index?redirect=1

Web tools
--------------
* Pootle: http://translate.sourceforge.net/wiki/pootle/index?redirect=1
* Weblate: http://weblate.org/

Please note that the Pootle offline editing documentation page [1]
gives nice hints related to the offline editing process.

cheers
p

[1] http://translate.sourceforge.net/wiki/pootle/offline_translation

--
Paolo Corti
Geospatial software developer
web: http://www.paolocorti.net
twitter: @capooti
skype: capooti
_______________________________________________
Qgis-community-team mailing list
[hidden email]
http://lists.osgeo.org/mailman/listinfo/qgis-community-team
Reply | Threaded
Open this post in threaded view
|

Re: [Qgis-community-team] Updates on the new Documentation infrastructure

Otto Dassau-3
Hi Paolo,

Am Thu, 19 Apr 2012 10:40:58 +0200
schrieb Paolo Corti <[hidden email]>:

> 2012/4/19 Otto Dassau <[hidden email]>:
> >
> > for the translation howto in the wiki it would be good to document all
> > the available tools a little bit and maybe focus on one tool that we
> > prefere or provides the easiest handling?
> >
> > Could you please start and add some small notes (tool names) that we can
> > fill later in the wiki?
> >
> > http://hub.qgis.org/wiki/quantum-gis/Manual_Translation
> >
>
> Hi Otto
> the wiki refer to the actual translation effort workflow (without
> using rst and gettext): should I still add it there the tools for
> editing the files generated by gettext?
>
> As far as I can see, these are the most commont I have found so far
> (but I guess there are more ones, that you may know):
>
> Desktop tools
> --------------------
> * Qt Linguist: http://qt-project.org/doc/qt-4.8/linguist-manual.html
> * Gtranslator: http://projects.gnome.org/gtranslator/
> * Virtaal: http://translate.sourceforge.net/wiki/virtaal/index?redirect=1
>
> Web tools
> --------------
> * Pootle: http://translate.sourceforge.net/wiki/pootle/index?redirect=1
> * Weblate: http://weblate.org/
>
> Please note that the Pootle offline editing documentation page [1]
> gives nice hints related to the offline editing process.
>
> cheers
> p
>
> [1] http://translate.sourceforge.net/wiki/pootle/offline_translation

yes, just add it, maybe in a new subsection "for the new rst / gettext
translation". We will rewrite the wiki pages soon.

Regards
Otto
_______________________________________________
Qgis-community-team mailing list
[hidden email]
http://lists.osgeo.org/mailman/listinfo/qgis-community-team
Reply | Threaded
Open this post in threaded view
|

Re: [Qgis-community-team] Updates on the new Documentation infrastructure

Paolo Corti
2012/4/19 Otto Dassau <[hidden email]>:
>
> yes, just add it, maybe in a new subsection "for the new rst / gettext
> translation". We will rewrite the wiki pages soon.
>

did it.
I have also added a very schematic representation of the translation workflow.
p

--
Paolo Corti
Geospatial software developer
web: http://www.paolocorti.net
twitter: @capooti
skype: capooti
_______________________________________________
Qgis-community-team mailing list
[hidden email]
http://lists.osgeo.org/mailman/listinfo/qgis-community-team
Reply | Threaded
Open this post in threaded view
|

Re: [Qgis-community-team] Updates on the new Documentation infrastructure

pcav
In reply to this post by Otto Dassau-3
Il 19/04/2012 10:00, Otto Dassau ha scritto:
> for the translation howto in the wiki it would be good to document all
> the available tools a little bit and maybe focus on one tool that we
> prefere or provides the easiest handling? Could you please start and
> add some small notes (tool names) that we can fill later in the wiki?
> http://hub.qgis.org/wiki/quantum-gis/Manual_Translation
and please do a good cleanup of the obsolete pages, otherwise people
will get wrong quite esily.
thanks a lot.

--
Paolo Cavallini
See: http://www.faunalia.it/pc

_______________________________________________
Qgis-community-team mailing list
[hidden email]
http://lists.osgeo.org/mailman/listinfo/qgis-community-team