Package: po4a Version: 0.42-1 Severity: minor Tags: patch While translating the po4a documentation (man pages) to German I noticed some typos, omissions and unclear wordings. Please carefully review the attached patch and apply only those parts which are actually correct, especially in the wording domain. However, even if you don't apply my version consider improving that part, as I did not (fully) understood it (and this might happen to other people as well).
Do not hesitate to contact me in case of any questions regarding this
patch.
This patch was made against the SVN version as of 2013-05-31.
Index: po4a
===================================================================
--- po4a (Revision 2722)
+++ po4a (Arbeitskopie)
@@ -468,7 +468,7 @@
=item B<--msgmerge-opt> I<options>
-Extra options for B<msgmerge>.
+Extra options for B<msgmerge>(1).
Note: B<$lang> will be extended to the current language.
Index: po4a-updatepo
===================================================================
--- po4a-updatepo (Revision 2722)
+++ po4a-updatepo (Arbeitskopie)
@@ -81,7 +81,7 @@
=item B<--msgmerge-opt> I<options>
-Extra options for B<msgmerge>.
+Extra options for B<msgmerge>(1).
=item B<-h>, B<--help>
Index: doc/po4a-build.conf.5.pod
===================================================================
--- doc/po4a-build.conf.5.pod (Revision 2722)
+++ doc/po4a-build.conf.5.pod (Arbeitskopie)
@@ -34,7 +34,7 @@
Typically used for manpages for shell scripts or other interpreters that
do not have their own documentation format like POD. Suitable XML can
-be generated directly from an existing manpage using C<doclifter> and
+be generated directly from an existing manpage using C<doclifter>(1) and
C<po4a-build> will then generate a POT file with no extra workload. The
POT file can then be offered for translation and the PO files added to
the relevant F<po/> directory. C<po4a-build> will then prepare not only
@@ -142,6 +142,9 @@
name. Generated content will then appear in subdirectories of
F<BASEDIR/BINARIES>:
+=for comment
+No localization here?
+
_build/po4a/man/man1/foo.1
If the package builds more than one binary package (i.e. one source
Index: doc/po4a-build.conf.5.pod
===================================================================
--- doc/po4a-build.conf.5.pod (Revision 2722)
+++ doc/po4a-build.conf.5.pod (Arbeitskopie)
@@ -34,7 +34,7 @@
Typically used for manpages for shell scripts or other interpreters that
do not have their own documentation format like POD. Suitable XML can
-be generated directly from an existing manpage using C<doclifter> and
+be generated directly from an existing manpage using C<doclifter>(1) and
C<po4a-build> will then generate a POT file with no extra workload. The
POT file can then be offered for translation and the PO files added to
the relevant F<po/> directory. C<po4a-build> will then prepare not only
@@ -142,6 +142,9 @@
name. Generated content will then appear in subdirectories of
F<BASEDIR/BINARIES>:
+=for comment
+No localization here?
+
_build/po4a/man/man1/foo.1
If the package builds more than one binary package (i.e. one source
Index: doc/po4a.7.pod
===================================================================
--- doc/po4a.7.pod (Revision 2722)
+++ doc/po4a.7.pod (Arbeitskopie)
@@ -100,7 +100,7 @@
But the situation is rather different when it comes to documentation. Too
often, the translated documentation is not visible enough (not distributed
as a part of the program), only partial, or not up to date. This last
-situation is by far the worst possible one. Outdated translation can reveal
+situation is by far the worst possible one. Outdated translation can turn out
to be
worse than no translation at all to the users by describing old program
behavior which are not in use anymore.
@@ -478,7 +478,7 @@
be a typo in the tag name.
Likewise, two paragraphs may get merged together in POD when the separating
-line contains some spaces, or when there is no empty line before the =item
+line contains some spaces, or when there is no empty line between the =item
line and the content of the item.
=item -
@@ -505,8 +505,8 @@
So, when the same paragraph appears twice in the original but both are not
translated in the exact same way each time, you will get the feeling that a
paragraph of the original disappeared. Just kill the new translation. If you
-prefer to kill the first translation instead when it was actually better,
-remove the second one from where it is and put it in place of the first one.
+prefer to kill the first translation instead when the second one was actually
better,
+remove the second one from where it is and put the first one in the place of
the second one.
In the contrary, if two similar but different paragraphs were translated in the
exact same way, you will get the feeling that a paragraph of the translation
@@ -960,7 +960,7 @@
sentences by aggregating parts of sentences working for all existing
languages (or even for the 5 of the 10 most spoken ones, or even less).
-=head2 Why not put the original as comment along with translation (or other
way around)?
+=head2 Why not put the original as comment along with translation (or the
other way around)?
At the first glance, gettext doesn't seem to be adapted to all kind of
translations. For example, it didn't seemed adapted to debconf, the
Index: doc/po4a-runtime.7.pod
===================================================================
--- doc/po4a-runtime.7.pod (Revision 2722)
+++ doc/po4a-runtime.7.pod (Arbeitskopie)
@@ -41,7 +41,7 @@
extension only needs to exist during the time that F<po/POTFILES.in>
is being processed.
-The --keywords option can also be useful - see the xgettext
+The --keywords option can also be useful - see the B<xgettext>(1)
documentation.
=head1 Populating po/
@@ -55,7 +55,7 @@
Must exist, even if empty. Consists of a list of translations -
each line not starting with a '#' must match an existing PO file.
-e.g. if F<LINGUAS> contains a single line, 'fr', an F<fr.po> file
+E.g. if F<LINGUAS> contains a single line, 'fr', an F<fr.po> file
must exist alongside the F<LINGUAS> file.
$ cat po/LINGUAS
Index: lib/Locale/Po4a/Chooser.pm
===================================================================
--- lib/Locale/Po4a/Chooser.pm (Revision 2722)
+++ lib/Locale/Po4a/Chooser.pm (Arbeitskopie)
@@ -96,12 +96,15 @@
Locale::Po4a::Chooser is a module to manage po4a modules. Previously, all po4a
binaries used to know all po4a modules (pod, man, sgml, etc). This made the
-addition of a new module boring, to make sure the documentation is synchronized
+addition of a new module boring, because you had to make sure that the
documentation is synchronized
in all modules, and that each of them can access the new module.
Now, you just have to call the Locale::Po4a::Chooser::new() function,
passing the name of module as argument.
+=for comment
+Next paragraph is unclear
+
You also have the Locale::Po4a::Chooser::list() function which lists the
available formats and exits on the value passed as argument.
Index: lib/Locale/Po4a/Po.pm
===================================================================
--- lib/Locale/Po4a/Po.pm (Revision 2722)
+++ lib/Locale/Po4a/Po.pm (Arbeitskopie)
@@ -39,7 +39,7 @@
of a string.
For a more complete description of message catalogs in the PO format and
-their use, please refer to the documentation of the gettext program.
+their use, please refer to the info documentation of the gettext program (node
"`PO Files"').
This module is part of the po4a project, which objective is to use PO files
(designed at origin to ease the translation of program messages) to
@@ -129,7 +129,7 @@
'encoding' => 0,
'filter' => 0);
-=head1 Functions about whole message catalogs
+=head1 Functions concerning entire message catalogs
=over 4
Index: lib/Locale/Po4a/Sgml.pm
===================================================================
--- lib/Locale/Po4a/Sgml.pm (Revision 2722)
+++ lib/Locale/Po4a/Sgml.pm (Arbeitskopie)
@@ -44,7 +44,7 @@
Locale::Po4a::Sgml is a module to help the translation of documentation in
the SGML format into other [human] languages.
-This module uses B<nsgmls> to parse the SGML files. Make sure it is
+This module uses B<nsgmls>(1) to parse the SGML files. Make sure it is
installed.
Also make sure that the DTD of the SGML files are installed in the system.
@@ -147,7 +147,7 @@
document. To prevent that, I rewrite them to C<{PO4A-beg-foo}> and
C<{PO4A-end}>.
-The problem with this is that the C<{PO4A-end}> and such I add are valid in
+The problem with this is that the C<{PO4A-end}> and such I add are invalid in
the document (not in a E<lt>pE<gt> tag or so).
Everything works well with nsgmls's output redirected that way, but it will
Index: lib/Locale/Po4a/TeX.pm
===================================================================
--- lib/Locale/Po4a/TeX.pm (Revision 2722)
+++ lib/Locale/Po4a/TeX.pm (Arbeitskopie)
@@ -243,7 +243,7 @@
This information is latter used to check the number of arguments of the
\begin command, and permit to specify which one must be translated.
The syntax of the I<parameters> argument is the same as described for the
-commands.
+??? commands.
The first parameter of the \begin command is the name of the environment.
This parameter must not be specified in the list of parameters. Here are
some examples:
Index: lib/Locale/Po4a/Xml.pm
===================================================================
--- lib/Locale/Po4a/Xml.pm (Revision 2722)
+++ lib/Locale/Po4a/Xml.pm (Arbeitskopie)
@@ -353,9 +353,9 @@
Space-separated list of tag's attributes you want to translate. You can
specify the attributes by their name (for example, "lang"), but you can
prefix it with a tag hierarchy, to specify that this attribute will only be
-translated when it's into the specified tag. For example:
E<lt>bbbE<gt>E<lt>aaaE<gt>lang
-specifies that the lang attribute will only be translated if it's into an
-E<lt>aaaE<gt> tag, and it's into a E<lt>bbbE<gt> tag.
+translated when it's in the specified tag. For example:
E<lt>bbbE<gt>E<lt>aaaE<gt>lang
+specifies that the lang attribute will only be translated if it's in an
+E<lt>aaaE<gt> tag, and it's in a E<lt>bbbE<gt> tag.
=item B<foldattributes>
@@ -377,7 +377,7 @@
The tags must be in the form <aaa>, but you can join some
(<bbb><aaa>), if a tag (<aaa>) should only be considered
-when it's into another tag (<bbb>).
+when it's within another tag (<bbb>).
=item B<inline>
@@ -386,7 +386,7 @@
The tags must be in the form <aaa>, but you can join some
(<bbb><aaa>), if a tag (<aaa>) should only be considered
-when it's into another tag (<bbb>).
+when it's within another tag (<bbb>).
=item B<placeholder>
@@ -401,7 +401,7 @@
The tags must be in the form <aaa>, but you can join some
(<bbb><aaa>), if a tag (<aaa>) should only be considered
-when it's into another tag (<bbb>).
+when it's within another tag (<bbb>).
=item B<nodefault>
@@ -426,7 +426,7 @@
The tags must be in the form <aaa>, but you can join some
(<bbb><aaa>), if a tag (<aaa>) should only be considered
-when it's into another tag (<bbb>).
+when it's within another tag (<bbb>).
You can also specify some tag options by putting some characters in front of
the tag hierarchy. For example, you can put 'w' (wrap) or 'W' (don't wrap)
@@ -440,7 +440,7 @@
The tags must be in the form <aaa>, but you can join some
(<bbb><aaa>), if a tag (<aaa>) should only be considered
-when it's into another tag (<bbb>).
+when it's within another tag (<bbb>).
=item B<defaulttranslateoption>
@@ -661,7 +661,7 @@
=head2 MODIFYING TAG TYPES (TODO)
This is a more complex one, but it enables a (almost) total customization.
-It's based in a list of hashes, each one defining a tag type's behavior. The
+It's based on a list of hashes, each one defining a tag type's behavior. The
list should be sorted so that the most general tags are after the most
concrete ones (sorted first by the beginning and then by the end keys). To
define a tag type you'll have to make a hash with the following keys:
--
Dr. Helge Kreutzmann deb...@helgefjell.de
Dipl.-Phys. http://www.helgefjell.de/debian.php
64bit GNU powered gpg signed mail preferred
Help keep free software "libre": http://www.ffii.de/
signature.asc
Description: Digital signature
