po plugin: po_slave_languages is a hash, rather than a hash of hashes

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

diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn
index d2f572706eaf3d5c268ba4e445a683b017961f5e..28b69e04bcb657ae675669e03512672c96b86193 100644 (file)
--- a/doc/plugins/po.mdwn
+++ b/doc/plugins/po.mdwn
@@ -41,41 +41,21 @@ Configuration
 `po_slave_languages` is used to set the list of supported "slave"
 languages, such as:
 
 `po_slave_languages` is used to set the list of supported "slave"
 languages, such as:
 

-        po_slave_languages => { 'fr' => { 'name' => 'Français', },
-                                'es' => { 'name' => 'Castellano', },
-                                'de' => { 'name' => 'Deutsch', }
+        po_slave_languages => { 'fr' => 'Français',
+                                'es' => 'Castellano',
+                                'de' => 'Deutsch',

         }
 
         }
 

+Decide which pages are translatable
+-----------------------------------

 
 

-Server support
-==============
-
-Apache
-------
-
-Using `mod_negotiation` makes it really easy to have Apache serve the
-page in the client's preferred language, if available. This is the
-default Debian Apache configuration.
-
-When `usedirs` is enabled, one has to set `DirectoryIndex index` for
-the wiki context.
-
-Setting `DefaultLanguage LL` (replace `LL` with your default MIME
-language) for the wiki context can be needed, to ensure
-`bla/page/index.en.html` is served as `Content-Language: LL`.
-**FIXME**: is it still needed with the new `.en.html` naming convention?
-
-lighttpd
---------
-
-lighttpd unfortunately does not support content negotiation.
-
-**FIXME**: does `mod_magnet` provide the functionality needed to
- emulate this?
-
+The `po_translatable_pages` setting configures what pages are
+translatable. It is a [[ikiwiki/PageSpec]], so you have lots of
+control over what kind of pages are translatable.

 
 

-TODO
-====
+The `*.LL.po` translations files are anyway not considered as being
+translatable, so you don't need to worry about excluding them manually
+from this [[ikiwiki/PageSpec]].

 
 Internal links
 --------------
 
 Internal links
 --------------


@@ -87,30 +67,62 @@ and site-specific preferences.
 ### Default linking behavior
 
 If `po_link_to` is unset, or set to `default`, ikiwiki's default
 ### Default linking behavior
 
 If `po_link_to` is unset, or set to `default`, ikiwiki's default

-linking behavior is preserved: `[[page]]` links to the master
+linking behavior is preserved: `\[[page]]` links to the master

 language's page.
 
 ### Link to negotiated language
 
 language's page.
 
 ### Link to negotiated language
 

-If `po_link_to` is set to `negotiated`, `[[page]]` links to the
+If `po_link_to` is set to `negotiated`, `\[[page]]` links to the

 negotiated preferred language, *i.e.* `foo/page/`.
 
 (In)compatibility notes:
 
 - `po_link_to => negotiated` provides no useful behavior if `usedirs`
 negotiated preferred language, *i.e.* `foo/page/`.
 
 (In)compatibility notes:
 
 - `po_link_to => negotiated` provides no useful behavior if `usedirs`

-  is disabled: 
+  is disabled; this option combination is neither implemented nor
+  allowed

 - `po_link_to => negotiated` provides no useful behavior if the web
   server does not support Content Negotiation
 
 ### Link to current language
 
 If `po_link_to` is set to `current` and the destination page is either
 - `po_link_to => negotiated` provides no useful behavior if the web
   server does not support Content Negotiation
 
 ### Link to current language
 
 If `po_link_to` is set to `current` and the destination page is either

-a translatable page or a translation, `[[page]]` links to the current
+a translatable page or a translation, `\[[page]]` links to the current

 page's language, *i.e.*:
 
 - `foo/page/index.LL.html` if `usedirs` is enabled
 - `foo/page.LL.html` if `usedirs` is disabled
 
 page's language, *i.e.*:
 
 - `foo/page/index.LL.html` if `usedirs` is enabled
 - `foo/page.LL.html` if `usedirs` is disabled
 

+
+Server support
+==============
+
+Apache
+------
+
+Using `mod_negotiation` makes it really easy to have Apache serve the
+page in the client's preferred language, if available. This is the
+default Debian Apache configuration.
+
+When `usedirs` is enabled, one has to set `DirectoryIndex index` for
+the wiki context.
+
+Setting `DefaultLanguage LL` (replace `LL` with your default MIME
+language) for the wiki context can be needed, to ensure
+`bla/page/index.en.html` is served as `Content-Language: LL`.
+**FIXME**: is it still needed with the new `.en.html` naming convention?
+
+lighttpd
+--------
+
+lighttpd unfortunately does not support content negotiation.
+
+**FIXME**: does `mod_magnet` provide the functionality needed to
+ emulate this?
+
+
+TODO
+====
+

 Display available translations
 ------------------------------
 
 Display available translations
 ------------------------------
 


@@ -130,17 +142,6 @@ implemented as a
 loop, a page using it should depend on any "master" and "slave" pages
 whose status is being displayed.
 
 loop, a page using it should depend on any "master" and "slave" pages
 whose status is being displayed.
 

-Decide which pages are translatable
------------------------------------
-
-The subset of "master" pages subject to translation must be
-configurable:
-
-- a `[[!translatable ]]` directive, when put on a page, makes it
-  translatable
-- to set at once a bunch of pages as being translatable, use this
-  [[ikiwiki/directive]] with the `match=PageSpec` argument.
-

 Automatic PO files update
 -------------------------
 
 Automatic PO files update
 -------------------------