[Po4a-commits] "po4a changelog,1.543,1.544 po4a,1.93,1.94"

Fri Jan 15 21:12:24 UTC 2010

Update of /cvsroot/po4a/po4a
In directory alioth:/tmp/cvs-serv14219

Modified Files:
	changelog po4a 
Log Message:
	* po4a: Add table of content.
	* po4a: Stress that po4a(1) is meant to ease the use of the po4a-*
	commands.
	* po4a: Fix the location of the explanation when --force is not
	specified.
	* po4a: Added notes in the [po4a_langs] and [po4a_paths] sections
	to indicate that [po_directory] is recommended.
	* po4a: Split long example lines.


Index: po4a
===================================================================
RCS file: /cvsroot/po4a/po4a/po4a,v
retrieving revision 1.93
retrieving revision 1.94
diff -u -d -r1.93 -r1.94

--- po4a	15 Jan 2010 19:27:24 -0000	1.93
+++ po4a	15 Jan 2010 21:12:21 -0000	1.94
@@ -26,7 +26,50 @@
 interestingly, the maintenance of translations) using gettext tools on
 areas where they were not expected like documentation.
 
-The C<po4a> program is in charge of updating both the po files (to sync
+The B<po4a> program is useful if you want to avoid calling
+L<po4a-gettextize(1)>, L<po4a-updatepo(1)>, and L<po4a-translate(1)> in
+complex Makefiles when you have multiple files to translate, different
+format, or need to specify different options for different documents.
+
+=head1 Table of content
+
+This document is organized as follow:
+
+=head2 DESCRIPTION
+
+=head2 INTRODUCTION
+
+=head2 CONFIGURATION FILE SYNTAX
+
+=head3 Specifying the template languages
+
+=head3 Specifying the paths to translator inputs
+
+=head3 Autodetection of the paths and languages
+
+=head3 Specifying the documents to translate
+
+=head3 Specifying options for the modules
+
+=head3 Specifying aliases
+
+=head3 Split mode
+
+=head2 OPTIONS
+
+=head2 SHORTCOMINGS
+
+=head2 SEE ALSO
+
+=head2 AUTHORS
+
+=head2 COPYRIGHT AND LICENSE
+
+=head3
+
+=head1 INTRODUCTION
+
+The B<po4a> program is in charge of updating both the po files (to sync
 them to the original documents) and the translated documents (to sync
 them to the po files). The main point is to make the use of po4a easier
 without having to remember of the command line options.
@@ -63,6 +106,10 @@
 
 =head2 Specifying the template languages
 
+B<Note:> It is recommended to use [po_directory] rather than [po4a_langs]
+and [po4a_paths].
+See section B<Autodetection of the paths and languages> below.
+
 This is an optional command that can simplify the whole config file, and will
 make it more scalable. You have to specify a list of the languages in which
 you want to translate the documents. This is as simple as:
@@ -74,10 +121,15 @@
 
 =head2 Specifying the paths to translator inputs
 
+B<Note:> It is recommended to use [po_directory] rather than [po4a_langs]
+and [po4a_paths].
+See section B<Autodetection of the paths and languages> below.
+
 First, you have to specify where the translator input files (ie, the files
 used by translators to do their job) are located. It can be done by such a line:
 
- [po4a_paths] doc/l10n/project.doc.pot fr:doc/l10n/fr.po de:doc/l10n/de.po
+ [po4a_paths] doc/l10n/project.doc.pot \
+              fr:doc/l10n/fr.po de:doc/l10n/de.po
 
 The command is thus 'po4a_paths'. The first argument is the path to the pot
 file to use. All subsequent arguments are of the self-explanatory form:
@@ -110,6 +162,9 @@
 This command should not be used together with the po4a_langs or po4a_paths
 commands.
 
+When using this command, you have to create an empty POT file on the first
+invocation of po4a to let it know the name of the POT file.
+
  [po_directory] po4a/po/
 
 =head2 Specifying the documents to translate
@@ -128,7 +183,8 @@
 
 More formally, the format is:
 
- [type: <format>] <master_doc> <lang>:<localized_doc>* add_<lang>:<addendum>*
+ [type: <format>] <master_doc> <lang>:<localized_doc>* \
+                  add_<lang>:<addendum>*
 
 If you've defined the template languages, you can rewrite the line above this
 way:
@@ -248,6 +304,12 @@
 
 Output some debugging information.
 
+=item -o, --option
+
+Extra option(s) to pass to the format plugin. Specify each option in the
+'name=value' format. See the documentation of each plugin for more
+information about the valid options and their meanings.
+
 =item -f, --force
 
 Always generate the POT and PO files, even if po4a considers it is
@@ -255,12 +317,6 @@
 
 The default behavior (when --force is not specified) is the following:
 
-=item -o, --option
-
-Extra option(s) to pass to the format plugin. Specify each option in the
-'name=value' format. See the documentation of each plugin for more
-information about the valid options and their meanings.
-
 =over
 
 If the POT file already exists, it is regenerated if a master document
@@ -285,7 +341,7 @@
 =item --stamp
 
 Tells po4a to create stamp files when a translation is not generated
-because it it does not reach the threshold. These stamp files are named
+because it does not reach the threshold. These stamp files are named
 according to the expected translated document, with the I<.po4a-stamp>
 extension.
 

Index: changelog
===================================================================
RCS file: /cvsroot/po4a/po4a/changelog,v
retrieving revision 1.543
retrieving revision 1.544
diff -u -d -r1.543 -r1.544
--- changelog	15 Jan 2010 19:27:24 -0000	1.543
+++ changelog	15 Jan 2010 21:12:20 -0000	1.544
@@ -1,5 +1,16 @@
 2010-01-15  Nicolas FranÃ§ois  <nicolas.francois at centraliens.net>
 
+	* po4a: Add table of content.
+	* po4a: Stress that po4a(1) is meant to ease the use of the po4a-*
+	commands.
+	* po4a: Fix the location of the explanation when --force is not
+	specified.
+	* po4a: Added notes in the [po4a_langs] and [po4a_paths] sections
+	to indicate that [po_directory] is recommended.
+	* po4a: Split long example lines.
+
+2010-01-15  Nicolas FranÃ§ois  <nicolas.francois at centraliens.net>
+
 	* po4a, lib/Locale/Po4a/TeX.pm, lib/Locale/Po4a/Text.pm: Fixed
 	typos.
 


