specifically something to block certain bad words

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

diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn
index ca1775f6e4ec49bbb7c889a1a424f85a1e322dae..0a764b6947a1f1e307522df46d86d6d6df361ca1 100644 (file)
--- a/doc/plugins/po.mdwn
+++ b/doc/plugins/po.mdwn
@@ -36,7 +36,7 @@ rendered as `bla/page/index.fr.html`, else as `bla/page.fr.html`
 (In)Compatibility
 =================
 
-This plugin does not support the `indexpages` mode. If you don't know
+This plugin does not support the `indexpages` mode (a.k.a. "use page/index.mdwn source files"). If you don't know
 what it is, you probably don't care.
 
 
@@ -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
 -----------------------------------
@@ -117,8 +117,13 @@ serve any page in the client's preferred language, if available.
 
 Add 'Options MultiViews' to the wiki directory's configuration in Apache.
 
-When `usedirs` is enabled, one has to set `DirectoryIndex index` for
-the wiki context.
+When `usedirs` is enabled, you should also set `DirectoryIndex index`.
+
+These settings are also recommended, in order to avoid serving up rss files
+as index pages:
+
+       AddType application/rss+xml;qs=0.8 .rss
+       AddType application/atom+xml;qs=0.8 .atom
 
 For details, see [Apache's documentation](http://httpd.apache.org/docs/2.2/content-negotiation.html).
 
@@ -145,6 +150,9 @@ the wiki homepage.
 The `ISTRANSLATION` and `ISTRANSLATABLE` variables can be used to
 display things only on translatable or translation pages.
 
+The `LANG_CODE` and `LANG_NAME` variables can respectively be used to
+display the current page's language code and pretty name.
+
 ### Display page's versions in other languages
 
 The `OTHERLANGUAGES` loop provides ways to display other languages'
@@ -221,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
 ========