po plugin: implemented po_link_to=negotiated

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

diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn
index 9e9ba1fd841631ce6204a834229ca908050d05cf..0d93aaddac1be32d4cbd0d26ea3418bada31a863 100644 (file)
--- a/doc/plugins/po.mdwn
+++ b/doc/plugins/po.mdwn
@@ -10,8 +10,12 @@ 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
@@ -73,28 +77,40 @@ lighttpd unfortunately does not support content negotiation.
 TODO
 ====
 
-Links
------
+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
 
-Choice between two behaviors must be possible in `ikiwiki.setup`;
-a `po_link_to_current_language` option must allow switching
-between them.
+If `po_link_to` is set to `negotiated`, `[[page]]` links to the
+negotiated preferred language, *i.e.* `foo/page/`.
 
-If `po_link_to_current_language` is disabled, `[[page]]` links to the
-negotiated preferred language, i.e.:
+(In)compatibility notes:
 
-- `usedirs` enabled: `bla/page/`
-- `usedirs` disabled: `bla/page`
+- `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
 
-This obviously does not work in case Content Negotiation is not
-supported by the web server, hence one can enable
-`po_link_to_current_language` to make `[[page]]` link to the current
-page's language, i.e.:
+### Link to current language
 
-- `usedirs` enabled: `bla/page/index.LL.html`
-- `usedirs` disabled: `bla/page.LL.html`
+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.*:
 
-**FIXME**: should `po_link_to_current_language` be enabled by default?
+- `foo/page/index.LL.html` if `usedirs` is enabled
+- `foo/page.LL.html` if `usedirs` is disabled
 
 Display available translations
 ------------------------------