tags 388775 pending
thanks
Hello Marc,
On Fri, Sep 22, 2006 at 03:35:45PM +0200, Marc Haber wrote:
>
> Please document the format of the e-mail messages that
> podebconf-update-po generates. For example, the manpage does not
> mention whether the new .po files is attached to the message or if one
> needs to tell the translators where to obtain the current PO files.
>
> The source code tells me that the .po file is attached, but this is
> not documented in the man page.
I've committed the attached patch to document the format of the emails and
templates.
Do you see other points to document?
Thanks in advance,
--
Nekral
Index: debian/changelog
===================================================================
RCS file: /cvsroot/po4a/po-debconf/debian/changelog,v
retrieving revision 1.161
diff -u -r1.161 changelog
--- debian/changelog 6 Oct 2006 19:12:04 -0000 1.161
+++ debian/changelog 6 Oct 2006 20:55:56 -0000
@@ -19,6 +19,8 @@
* podebconf-report-po: Invoke an editor, even with --template. The option
to avoid opening an editor is --default. Closes: #388762
+ * podebconf-report-po: Document the format of emails. Closes: #388775
+
-- Nicolas FRANCOIS (Nekral) <[EMAIL PROTECTED]> Wed, 4 Oct 2006 19:27:07
+0200
po-debconf (1.0.6) unstable; urgency=low
Index: doc/en/podebconf-report-po.1.pod
===================================================================
RCS file: /cvsroot/po4a/po-debconf/doc/en/podebconf-report-po.1.pod,v
retrieving revision 1.7
diff -u -r1.7 podebconf-report-po.1.pod
--- doc/en/podebconf-report-po.1.pod 6 Oct 2006 18:52:20 -0000 1.7
+++ doc/en/podebconf-report-po.1.pod 6 Oct 2006 20:55:56 -0000
@@ -13,9 +13,19 @@
or missing translations, launches an editor to allow modifications of
mail body and headers, asks confirmation to send mails, and sends them
to the last translator requesting for updates.
+The mail will contain the PO file which has to be updated.
B<podebconf-report-po> can be called either in the top-level directory,
or in F<debian> or F<debian/po> subdirectories.
+B<podebconf-report-po> can also be used to send call for translations to a
+mailing list. In that case, the POT file will be attached.
+
+Different template exist for translation update requests, request to send
+updated PO files to a bug report (B<--submit>) or for call for
+translations (B<--call>).
+The template can also be provided by the user.
+See the B<TEMPLATES> section for more information on the templates.
+
=head1 OPTIONS
Many options can be set in a configuration file.
@@ -70,6 +80,7 @@
=item B<--podir=I<DIR>>
Specify where are located the PO files.
+By default, B<podebconf-report-po> uses the F<debian/po> directory.
=item B<--smtp=I<SERVER>>
@@ -196,6 +207,47 @@
from = Me Myself <[EMAIL PROTECTED]>
utf8
+=head1 TEMPLATES
+
+The templates specified with the B<--template> option can contain the
+following tags:
+
+=over 4
+
+=item B<<from>>, B<<subject>>, B<<reply-to>>
+
+Replaced by the corresponding headers of the email(s).
+
+=item B<<filelist>>
+
+In the default mode, it is replaced by comments showing the list of
+translators with outdated translations.
+
+In the B<--submit> mode, it is replaced by the list of PO files with
+outdated translations.
+
+And in the B<--call> mode, it is replaced by the list of PO files found in
+the PO directory.
+
+=item B<<reply>>
+
+Replaced by a string that indicate how the translators have to reply
+(i.e. follow the I<Reply-To> tag or sending the PO to a given bug report).
+
+=item B<<deadline>>
+
+Replaced by a string indicating the deadline for the translation (see
+B<--deadline>).
+
+=item B<<package>>
+
+Replaced by the name of the package (if it was detected).
+
+=item B<<statistics>>
+
+Replaced by the statistics of the PO found in the PO directory (in the
+B<--call> mode only).
+
=head1 SEE ALSO
L<debconf-updatepo(1)>
