Merge remote branch 'upstream/master' into prv/po
[ikiwiki.git] / doc / plugins / po.mdwn
index 031188a674cc3e52e3265e3eb2da386d2c33861e..30bac7068e5436b177ee9915f65783fcbd72b175 100644 (file)
@@ -54,10 +54,10 @@ Supported languages
 `po_slave_languages` is used to set the list of supported "slave"
 languages, such as:
 
-        po_slave_languages => { 'fr' => 'Français',
+        po_slave_languages => [ 'fr' => 'Français',
                                 'es' => 'Español',
                                 'de' => 'Deutsch',
-        }
+        ]
 
 Decide which pages are translatable
 -----------------------------------
@@ -129,11 +129,12 @@ For details, see [Apache's documentation](http://httpd.apache.org/docs/2.2/conte
 lighttpd
 --------
 
-lighttpd unfortunately does not support content negotiation.
+Recent versions of lighttpd should be able to use
+`$HTTP["language"]` to configure the translated pages to be served.
 
-**FIXME**: does `mod_magnet` provide the functionality needed to
- emulate this?
+See [Lighttpd Issue](http://redmine.lighttpd.net/issues/show/1119)
 
+TODO: Example
 
 Usage
 =====
@@ -212,16 +213,16 @@ preferred `$EDITOR`, without needing to be online.
 Markup languages support
 ------------------------
 
-[[Markdown|mdwn]] is well supported. Some other markup languages supported
-by ikiwiki mostly work, but some pieces of syntax are not rendered
-correctly on the slave pages:
+[[Markdown|mdwn]] and [[html]] are well supported. Some other markup
+languages supported by ikiwiki mostly work, but some pieces of syntax
+are not rendered correctly on the slave pages:
 
 * [[reStructuredText|rst]]: anonymous hyperlinks and internal
   cross-references
 * [[wikitext]]: conversion of newlines to paragraphs
 * [[creole]]: verbatim text is wrapped, tables are broken
-* [[html]] and LaTeX: not supported yet; the dedicated po4a modules
-  could be used to support them, but they would need a security audit
+* LaTeX: not supported yet; the dedicated po4a module
+  could be used to support it, but it would need a security audit
 * other markup languages have not been tested.
 
 Security
@@ -253,15 +254,6 @@ once [[intrigeri]]'s `meta` branch is merged.
 An integration branch, called `meta-po`, merges [[intrigeri]]'s `po`
 and `meta` branches, and thus has this additional features.
 
-Language display order
-----------------------
-
-Jonas pointed out that one might want to control the order that links to
-other languages are listed, for various reasons. Currently, there is no
-order, as `po_slave_languages` is a hash. It would need to be converted
-to an array to support this. (If twere done, twere best done quickly.)
---[[Joey]] 
-
 Pagespecs
 ---------
 
@@ -289,6 +281,9 @@ Also, this may only happen if the page being linked to is coming from an
 underlay, and the underlays lack translation to a given language.
 --[[Joey]] 
 
+> Any simple testcase to reproduce it, please? I've never seen this
+> happen yet. --[[intrigeri]]
+
 Double commits of po files
 --------------------------
 
@@ -303,11 +298,18 @@ and then committed again. The second commit makes this change:
 Same thing happens when a change to an existing page triggers a po file
 update. --[[Joey]] 
 
+> * The s/utf-8/UTF-8 part is fixed in my po branch.
+> * The ENCODING\n part is due to an inconsistency in po4a, which
+>   I've just send a patch for. --[[intrigeri]]
+
 Ugly messages with empty files
 ------------------------------
 
 If there are empty .mdwn files, the po plugin displays some ugly messages.
 
+> This is due to a bug in po4a (not checking definedness of a
+> variable). One-liner patch sent. --[[intrigeri]]
+
 Translation of directives
 -------------------------
 
@@ -317,40 +319,8 @@ text, or text in whatever single language ikiwiki is configured to "speak".
 Maybe there could be a way to switch ikiwiki to speaking another language
 when building a non-english page? Then the directives would get translated.
 
-Created page type
------------------
-
-The interdiction to create pages of type po was broken by the new
-`page_types` code. This is fixed in my po branch by
-commit 1914ae2fd24e1e802.
-
-While I was there, I also added some code to set a new default value
-to the type select field in case it was previously set to "po".
-This code favors the type of the linking page's masterpage on page
-creation (when `from=page.LL`). This is commit c9301d2c296f682.
---[[intrigeri]]
-
-> Both cherry picked. --[[Joey]] 
-
-inline's post form's rootpage
------------------------------
-
-When a translatable page (say it is called "bugs") contains an
-[[inline directive|ikiwiki/directive/inline]] with `postform` enabled,
-the rootpage is l10n'd on translations pages (e.g. "bugs.fr" gets
-a `rootpage` value of `bugs.fr`). This is usually not what's expected,
-as translation pages are not supposed to have subpages. My po branch
-has code (e671e72053e81fa, which depends on 72ac9821e56637) that fixes
-this. --[[intrigeri]]
-
-link() pagespec on translation pages
-------------------------------------
-
-The `link()` pagespec, on translation pages, currently tests whether
-a given page links to the *current translation page*, rather than
-whether it links to its master page. I believe the later is generally
-expected. Commit 646c9a4c95a480 in my po branch fixes this.
---[[intrigeri]]
+(We also will need this in order to use translated templates, when they are
+available.)
 
 Documentation
 -------------