This plugin enhances the regular [[ikiwiki/PageSpec]] syntax with some
additional tests that are documented [[here|ikiwiki/pagespec/po]].
+Automatic PO files update
+-------------------------
+
+Committing changes to a "master" page:
+
+1. updates the POT file and the PO files for the supported languages
+ (this is done in the `needsbuild` hook); the updated PO files are
+ then put under version control
+2. triggers a refresh of the corresponding HTML slave pages (this is
+ achieved by making any "slave" page dependent on the corresponding
+ "master" page, in the `needsbuild` hook)
+
+Also, when the plugin has just been enabled, or when a page has just
+been declared as being translatable, the needed POT and PO files are
+created, and the PO files are checked into version control.
TODO
====
OTHERLANGUAGES dependencies
---------------------------
-Pages using `OTHERLANGUAGES` must depend on any "master" and "slave"
-pages whose status is being displayed. It will trigger dependency
-loops; how to sort this out?
+Pages using `OTHERLANGUAGES` depend on any "master" and "slave" pages
+whose status is being displayed. It is supposed to trigger dependency
+loops, but no practical bugs were noticed yet.
Should pages using the `OTHERLANGUAGES` template loop be declared as
linking to the same page in other versions? To be rigorous, they
should, but this may clutter the backlinks.
-Automatic PO files update
--------------------------
-
-Committing changes to a "master" page:
-
-1. updates the POT file and the PO files for the supported languages;
- this is done in the `needsbuild` hook; **FIXME**: the updated PO
- files must then be put under version control
-
-2. triggers a refresh of the corresponding HTML slave pages: this is
- achieved by making any "slave" page dependent on the corresponding
- "master" page, in the `needsbuild` hook.
+Security checks
+---------------
-Also, when the plugin has just been enabled, or when a page
-has just been declared as being translatable:
+- `refreshpofiles` uses `system()`, whose args have to be checked more
+ thoroughly to prevent any security issue (command injection, etc.).
+- `refreshpofiles` and `refreshpot` create new files; this may need
+ some checks, e.g. using `IkiWiki::prep_writefile()`
-- all the needed POT and PO files are be created
-- **FIXME** the PO files must be checked into version control
+gettext/po4a rough corners
+--------------------------
-**FIXME** `refreshpofiles` uses `system()`, whose args have to be
-checked more thoroughly to prevent any security issue (command
-injection, etc.).
+- fix the "duplicate message definition" error when updating a PO
+ file; do PO files need normalizing?
+- should `*.po~` backup files really be saved?
Translation quality assurance
-----------------------------