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
--------------------------
+Security checks
+---------------
-Committing changes to a "master" page:
+- `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()`
-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
+gettext/po4a rough corners
+--------------------------
-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.
+- fix the duplicated PO header mysterious bug
+- fix the "duplicate message definition" error when updating a PO
+ file; do PO files need normalizing? (may be a side effect of
+ previous bug)
+- fix infinite loop when synchronizing two ikiwiki (when checkouts
+ live in different directories): say bla.fr.po has been updated in
+ repo2; pulling repo2 from repo1 seems to trigger a PO update, that
+ changes bla.fr.po in repo1; then pushing repo1 to repo2 triggers
+ a PO update, that changes bla.fr.po in repo2; etc.; fixed in
+ `629968fc89bced6727981c0a1138072631751fee` ?
-Also, when the plugin has just been enabled, or when a page
-has just been declared as being translatable:
+Misc. bugs
+----------
-- all the needed POT and PO files are be created
-- **FIXME** the PO files must be checked into version control
-Security checks:
-- `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()`
+Misc. improvements
+------------------
+
+### page titles
+
+Use nice page titles from meta plugin in links, as inline already does.
+
Translation quality assurance
-----------------------------
As PO is a wiki page type, we already have an online PO editor, that
is ikiwiki's CGI.
+**FIXME** preview does not work for PO files.
+
A message-by-message interface could also be implemented at some
point; a nice way to do offline translation work (without VCS access)
still has to be offered, though.