po: check validity of po_slave_languages array.

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

diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn
index 1d343e0f81b642783af498fbadcdecf73025a5a2..57f04a476094739efe23d9d04d6ef791699dfc1b 100644 (file)
--- a/doc/plugins/po.mdwn
+++ b/doc/plugins/po.mdwn
@@ -54,10 +54,10 @@ Supported languages
 `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' => 'Français',
+        po_slave_languages => [ 'fr' => 'Français',

                                 'es' => 'Español',
                                 'de' => 'Deutsch',
                                 'es' => 'Español',
                                 'de' => 'Deutsch',

-        }
+        ]

 
 Decide which pages are translatable
 -----------------------------------
 
 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
 --------
 

-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
 =====
 
 Usage
 =====


@@ -212,16 +213,16 @@ preferred `$EDITOR`, without needing to be online.
 Markup languages support
 ------------------------
 
 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
 
 * [[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
 * other markup languages have not been tested.
 
 Security


@@ -253,22 +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.
 
 An integration branch, called `meta-po`, merges [[intrigeri]]'s `po`
 and `meta` branches, and thus has this additional features.
 

-Self links
-----------
-
-If a page contains a WikiLink to itself, ikiwiki does not normally
-turn that into a hyperlink. However, if a translated page contains a
-WikiLink to itself, a hyperlink is inserted, at least with the default
-`po_link_to` the link points to the English version of the page. Is there a
-good reason for that to be done? --[[Joey]]
-
-> The commit 0113c69d4fb in my po branch might fix this. --[[intrigeri]]
-
->> It may fix it in passing, but shouldn't it also be fixed for the other
->> `po_link_to` styles? (Also, if `mybestlink` is going to always 
->> just return `bestlink` in this case, there seems no reason to inject
->> it.) --[[Joey]]
-

 Language display order
 ----------------------
 
 Language display order
 ----------------------
 


@@ -278,50 +263,16 @@ 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]] 
 
 to an array to support this. (If twere done, twere best done quickly.)
 --[[Joey]] 
 

-Duplicate %links ?
-------------------
-
-I notice code in the scan hook that seems to assume
-that %links will accumulate duplicate links for a page.
-That used to be so, but the bug was fixed. Does this mean
-that po might be replacing the only link on a page, in error? 
---[[Joey]] 
-
-> It would replace it. The only problematic case is when another
-> plugin has its own reasons, in its `scan` hook, to add a page
-> that is already there to `$links{$page}`. This other plugin's
-> effect might then be changed by po's `scan` hook... which could
-> be either good (better overall l10n) or bad (break the other
-> plugin's goal). --[[intrigeri]]
-
->> Right.. well, the cases where links are added is very small.
->> Grepping for `add_link`, it's just done by link, camelcase, meta, and
->> tag. All of these are supposed to work just link regular links
->> so I'd think that is ok. We could probably remove the currently scary
->> comment about only wanting to change the first link. --[[Joey]] 
-
->>> Commit 3c2bffe21b91684 in my po branch does this. --[[intrigeri]]
+> Done in my po branch, preserving backward compatibility. Please
+> review :) --[[intrigeri]]

 
 

-Name of toplevel index page
----------------------------
-
-Normally at the top index page of a wiki, you see the wiki name at
-the top. However, at the top *translated* index page, you see something
-like "index.da". --[[Joey]]
-
-> I suggest changing `Render.pm`, line 115, to replace the `$page eq 'index'`
-> test with a predicate call such as isindexpage($page). Such a predicate
-> function could then be overriden by the po plugin. --[[intrigeri]]
-
->> Could do that, but if you have such a function it's natural to want to
->> use it elsewhere. Not clear to me it would make sense for po to override
->> such a function if it were used in some of the other places that compare
->> to index.
->> 
->> The other option would be for po to override the template setting.
->> --[[Joey]] 
-
->>> Great idea. Commit 6c0f9c691c3df3a in my po branch does it. --[[intrigeri]]
+>> Right, well my immediate concern is that using an array to hold
+>> hash-like pairs is not very clear to the user. It will be displayed
+>> in a confusing way by websetup; dumping a setup file will probably
+>> also cause it to be formatted in a confusing way. And the code
+>> seems to assume that the array length is even, and probably blows
+>> up if it is not.. and the value is marked safe so websetup can be
+>> used to modify it and break that way too. --[[Joey]] 

 
 Pagespecs
 ---------
 
 Pagespecs
 ---------


@@ -350,6 +301,15 @@ 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]] 
 
 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]]
+
+>> Sure, go here <http://l10n.ikiwiki.info/smiley/smileys/index.sv.html>
+>> (Currently 0% translateed) and see the 'WikiLink' link at the bottom,
+>> which goes to <http://l10n.ikiwiki.info/ikiwiki.cgi?page=ikiwiki/wikilink&from=smiley/smileys&do=create>
+>> Compare with eg, the 100% translated Dansk version, where
+>> the WikiLink link links to the English WikiLink page. --[[Joey]] 
+

 Double commits of po files
 --------------------------
 
 Double commits of po files
 --------------------------
 


@@ -364,11 +324,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]] 
 
 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.
 
 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
 -------------------------
 
 Translation of directives
 -------------------------
 


@@ -378,6 +345,9 @@ 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.
 
 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.
 

+(We also will need this in order to use translated templates, when they are
+available.)
+

 Documentation
 -------------
 
 Documentation
 -------------