[buildd-tools-devel] Bug#588962: schroot: Please include po4a material for translated documentation

[David Prévot]

tag 588962 patch
thanks

Hi Roger, Thomas,

Le 19/07/2010 13:24, David Prévot a écrit :
> Le 13/07/2010 18:23, Roger Leigh a écrit :
>> On Tue, Jul 13, 2010 at 10:00:03PM +0200, Thomas Blein wrote:

>>> [...] I saw that the documentation of the schroot package is not translated
>>> in any language. I would like to translate it French. For this, there is a 
>>> need to change the source organisation so the documentation use po4a to
>>> allow us to translate it. 
>>>
>>> I would like to know if such changes could be me made.
> 
>> I'd be happy to make this sort of change, or accept patches to do this.

Please find attached a patch against the current git repository in order
to provide POT files to translators, and build translated documentation.

1. You first want to run "po4a man/po4a/po4a.cfg" in order to populate
the POT file (man/po4a/po/schroot-man.pot here, the name is arbitrary).

2. The POT file should then be proposed to translators. Once you
received one (fr.po for example), you just have to put it in
man/po4a/po/. If you receive an addendum (fr.add for example), just put
it a the new sub-directory man/po4a/add_fr/.

3. If there are some translations, run "po4a man/po4a/po4a.cfg" in order
to update PO and POT files and build the translated documentation (for
example, French translation of man/schroot.1.in will be build in
man/translated/fr/schroot.1.in).

4. You also probably want to add a clean rule in order to delete the
directory man/translated (which will contain, in subdirectories, the
translated documentation build by "po4a man/po4a/po4a.cfg"): it doesn't
need to be saved in your VCS, just keep the PO and POT files.

I'm not sure of how you want to configure stuff with Autotools, but:
point 1: just need to be done once you've applied the patch.
point 2: just need to be done once you receive a translation.
point 3: it should be done before creating the tarball, thus the
 	proposed rule added in the dist-hook target.
point 4: you should add a clean rule somewhere.

You also off course need to actually build and install the translated
manual pages (from man/translated/$lang/manpages.#.in), but it can wait
until you actually receive some translation. translated pdf and ps can
also be provided.

>> Currently the documentation is all in manual page format with some
>> GNU troff extensions; can po4a cope with this?
> 
> Actually, a tiny problem in the Locale::Po4a::Man module don't permit it
> for the moment, but a patch is already on it's way.

po4a 0.40 released yesterday is now OK with GNU troff extensions used in
your manual pages.

> Anyway, in order to make translators life easier, Denis Barbier [...]
> proposed another version of schroot.1.in [2], fully
> compatible with the actual one (as far as I tried the manual pages and
> pdf generation, it provides exactly the same result). I fully agree with
> him : PO files are much more understandable this way (and sources too I
> think), so I ask you to consider similar changes into other manual pages.
> 
> [2]http://lists.alioth.debian.org/pipermail/po4a-devel/attachments/20100719/8962358d/attachment-0001.obj

The patch includes Denis' proposition, it's updated against the current
version (in git) of schroot.1.in.

Cheers

David

-------------- next part --------------
A non-text attachment was scrubbed...
Name: add-translation.patch
Type: text/x-diff
Size: 21166 bytes
Desc: not available
URL: <http://lists.alioth.debian.org/pipermail/buildd-tools-devel/attachments/20100728/1152f638/attachment-0001.patch>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 198 bytes
Desc: OpenPGP digital signature
URL: <http://lists.alioth.debian.org/pipermail/buildd-tools-devel/attachments/20100728/1152f638/attachment-0001.pgp>