]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/plugins/po.mdwn
po plugin: make any slave page dependent on the corresponding master page
[ikiwiki.git] / doc / plugins / po.mdwn
index d8cde9cb81b45565ce19c54bd8af0f87d91dc83a..06ecedc246dfdc9af0973646e9ec7768f76b88e3 100644 (file)
@@ -173,21 +173,16 @@ Automatic PO files update
 
 Committing changes to a "master" page must:
 
-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. update the POT file and the PO files for the supported languages;
+   this is done in the `needsbuild` hook; the updated PO files must
+   then be put under version control
 
-The former is to be done at a time when:
+2. trigger 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
-
-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.
+Also, when the plugin has just been enabled, all the needed POT and PO
+files have to be created.
 
 UI consistency: rename "Edit" button on slave pages
 ---------------------------------------------------