po plugin: fix formatting in documentation

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

diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn
index f71a36739f18f3f56ad97648d45ba47270b41875..daee882add385d907ebecc89fab11ed46b4a72ac 100644 (file)
--- a/doc/plugins/po.mdwn
+++ b/doc/plugins/po.mdwn
@@ -49,12 +49,13 @@ languages, such as:
 Decide which pages are translatable
 -----------------------------------
 
 Decide which pages are translatable
 -----------------------------------
 

-The subset of "master" pages subject to translation is configurable:
+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.

 
 

-- 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.
+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
 --------------


@@ -66,12 +67,12 @@ 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:
 negotiated preferred language, *i.e.* `foo/page/`.
 
 (In)compatibility notes:


@@ -85,7 +86,7 @@ negotiated preferred language, *i.e.* `foo/page/`.
 ### Link to current language
 
 If `po_link_to` is set to `current` and the destination page is either
 ### 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
 page's language, *i.e.*:
 
 - `foo/page/index.LL.html` if `usedirs` is enabled


@@ -122,15 +123,6 @@ lighttpd unfortunately does not support content negotiation.
 TODO
 ====
 
 TODO
 ====
 

-Optimization
-------------
-
-Move `match_istranslation` and `match_istranslatable` code into helper
-functions, and pre-compute what can be early in the build process:
-
-- the list of translatable (master) pages
-- for every translatable page, the list of slave pages
-

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