write changelog, close bug

[git.ikiwiki.info.git] / doc / plugins / po.mdwn

diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn
index b701d3662e16e2ecb4f45f379169bf2cab2a2123..b7c1582ca4e1348cef265f06ddbf0579389772c4 100644 (file)
--- a/doc/plugins/po.mdwn
+++ b/doc/plugins/po.mdwn
@@ -49,15 +49,15 @@ Supported languages
 `po_master_language` is used to set the "master" language in
 `ikiwiki.setup`, such as:
 
-        po_master_language => 'en|English'
+        po_master_language: en|English
 
 `po_slave_languages` is used to set the list of supported "slave"
 languages, such as:
 
-        po_slave_languages => [ 'fr|Français',
-                                'es|Español',
-                                'de|Deutsch',
-        ]
+        po_slave_languages:
+         - fr|Français
+         - es|Español
+         - de|Deutsch
 
 Decide which pages are translatable
 -----------------------------------
@@ -229,6 +229,14 @@ are not rendered correctly on the slave pages:
   could be used to support it, but it would need a security audit
 * other markup languages have not been tested.
 
+Renaming a page
+---------------
+
+A translatable page may be renamed using the web interface and the
+[[rename plugin|plugins/rename]], or using the VCS directly; in
+the latter case, *both* the "master" page and every corresponding
+`.po` file must be renamed in the same commit.
+
 Security
 ========