X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/968106cc80c4f24ae02a3e54877939cd00e33258..23dccccdf22e09f1f9f0b8142a16983b93eaed5f:/doc/plugins/po.mdwn?ds=sidebyside

diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn
index fddfe5c41..69fce52ef 100644
--- a/doc/plugins/po.mdwn
+++ b/doc/plugins/po.mdwn
@@ -10,12 +10,16 @@ Introduction
 ============
 
 A language is chosen as the "master" one, and any other supported
-language is a "slave" one. A page written in the "master" language is
-a "master" page, and is written in any supported format but PO.
+language is a "slave" one.
+
+A page written in the "master" language is a "master" page, and is
+written in any supported format but PO. It does not have to be named
+a special way: migration from/to this plugin does not imply heavy
+renaming work.
 
 Example: `bla/page.mdwn` is a "master" Markdown page written in
 English; if `usedirs` is enabled, it is rendered as
-`bla/page/index.html.en`, else as `bla/page.html.en`.
+`bla/page/index.en.html`, else as `bla/page.en.html`.
 
 Any translation of a "master" page into a "slave" language is called
 a "slave" page; it is written in the gettext PO format. PO is now
@@ -23,7 +27,7 @@ a page type supported by ikiwiki.
 
 Example: `bla/page.fr.po` is the PO "message catalog" used to
 translate `bla/page.mdwn` into French; if `usedirs` is enabled, it is
-rendered as `bla/page/index.html.fr`, else as `bla/page.html.fr`
+rendered as `bla/page/index.fr.html`, else as `bla/page.fr.html`
 
 
 Configuration
@@ -42,6 +46,51 @@ languages, such as:
                                 'de' => { 'name' => 'Deutsch', }
         }
 
+Decide which pages are translatable
+-----------------------------------
+
+The subset of "master" pages subject to translation is 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.
+
+Internal links
+--------------
+
+One can use the `po_link_to_` option in `ikiwiki.setup` to choose how
+internal links should be generated, depending on web server features
+and site-specific preferences.
+
+### 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
+language's page.
+
+### Link to negotiated language
+
+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`
+  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
+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
+
 
 Server support
 ==============
@@ -58,8 +107,8 @@ 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.html.en` is served as `Content-Language: LL`.
-**FIXME**: is it still needed with the new `.html.en` naming convention?
+`bla/page/index.en.html` is served as `Content-Language: LL`.
+**FIXME**: is it still needed with the new `.en.html` naming convention?
 
 lighttpd
 --------
@@ -92,17 +141,6 @@ implemented as a
 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
 -------------------------
 
@@ -138,12 +176,10 @@ Pages selection depending on language
 To improve user navigation in a multi-lingual wiki, site developers
 must be enabled to write:
 
-        \[[!map pages="dev/* and preferredlang()" feeds="no"]]
+        \[[!map pages="dev/* and lang(LL)" feeds="no"]]
 
         \[[!map pages="dev/* and currentlang()" feeds="no"]]
 
-Some new [[ikiwiki/pagespec]] functions have to be written.
-
 Translation quality assurance
 -----------------------------