]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/po.mdwn
po plugin: updated todo wrt. automatic POT/PO update/creation
[git.ikiwiki.info.git] / doc / plugins / po.mdwn
index d8cde9cb81b45565ce19c54bd8af0f87d91dc83a..9ae6d964a020b4f47b7b948ef3b724d2a6220de7 100644 (file)
@@ -171,23 +171,20 @@ loop would be needed.
 Automatic PO files update
 -------------------------
 
-Committing changes to a "master" page must:
+Committing changes to a "master" page:
 
-1. update the POT file and the PO files for the supported languages,
-   before putting them under version control
-2. trigger a refresh of the corresponding HTML slave pages
+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
 
-The former is to be done at a time when:
+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.
 
-- we know which "master" page was modified, and thus, which POT/PO
-  files have to be updated: the `needsbuild` hook is the first one to
-  run that provides us with the necessary information
-- we can modify the list of pages needing a refresh; this is
-  `needsbuild` hook's job
+**FIXME** Also, when the plugin has just been enabled:
 
-The latter can be implemented by making any "slave" page depend on the
-corresponding "master" page. The `add_depends` function can achieve
-this, if used in a **FIXME** hook.
+- all the needed POT and PO files have to be created
+- the PO files must be checked into version control
 
 UI consistency: rename "Edit" button on slave pages
 ---------------------------------------------------