X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/fe350e8b895be69471fad094fcdcf0b4c7d3beb3..cab8a795682bcac2e937461d9a7d2c683cdc5ed0:/doc/plugins/po.mdwn diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn index 38b6b12cd..5088677c1 100644 --- 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 => { 'fr' => 'Français', - 'es' => 'Español', - 'de' => 'Deutsch', - } + 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 @@ -262,6 +263,66 @@ 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]] +> Done in my po branch, preserving backward compatibility. Please +> review :) --[[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]] + +>>> I have added a sanity check for the even array problem. This was +>>> the easy part. +>>> +>>> About the hash-like vs. dump and websetup issue, +>>> I can think of a few solutions: +>>> +>>> - keep the current hash-like pairs and unmark this setting as safe +>>> for websetup: this does not solve the dump setup issue, though; +>>> - replace the array of pairs with an array of +>>> "LANGUAGECODE|LANGUAGENAME" elements, using a pipe or whatever +>>> separator seems adequate; +>>> - add support for ordered hashes to `$config`, websetup and +>>> dumpsetup, using Tie-IxHash or any similar module; +>>> - replace the array of hash-like pairs with an array of real +>>> pairs, such as `[ ['de', 'Deutsch'], ['fr', 'Français'] ]`; this +>>> brings once again the need for `$config` to support arrays of +>>> arrays, which I have already implemented in my mirrorlist branch +>>> (see [[todo/mirrorlist_with_per-mirror_usedirs_settings]] for +>>> details). +>>> +>>> Joey, which of these solutions do you prefer? Or another one? +>>> I tend to prefer the last one. --[[intrigeri]] + +>>>> I prefer the pipe separator, I think. I'm concerned that there is +>>>> no way to really sanely represent complex data structures in web +>>>> setup. --[[Joey]] + +>>>>> Implemented using the pipe separator, fixed the po.t test suite +>>>>> accordingly. Please have a look. --[[intrigeri]] + +>>>>>> Merged. I wonder if "ll: Lang" would be better than pipe? + +>>>>>>> I've no clear opinion on this one. --[[intrigeri]] + +>>>>>> Also, the compatability code for HASH is not really needed, +>>>>>> ikiwiki has not been released using a hash for it. --[[Joey]] + +>>>>>>> The compatibility code is there to support the +>>>>>>> `po_slave_languages => {fr => 'Français'}` format that has +>>>>>>> been supported for ages. It's not there to support the +>>>>>>> intermediate array of hash-like pairs I proposed in the +>>>>>>> meantime. +>>>>>>> +>>>>>>> By the way, could you please have a look to the rest of my po +>>>>>>> branch? (bb22e8c4a..d98296d1db0) --[[intrigeri]] + +>>>>>>>> Thought I'd already merged everything; I've got those in now. +>>>>>>>> --[[Joey]] + Pagespecs --------- @@ -289,6 +350,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]] +> Any simple testcase to reproduce it, please? I've never seen this +> happen yet. --[[intrigeri]] + +>> Sure, go here +>> (Currently 0% translateed) and see the 'WikiLink' link at the bottom, +>> which goes to +>> Compare with eg, the 100% translated Dansk version, where +>> the WikiLink link links to the English WikiLink page. --[[Joey]] + Double commits of po files -------------------------- @@ -303,11 +373,28 @@ 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 has been fixed. +> * The ENCODING\n part is due to an inconsistency in po4a, which +> I've just send a patch for. --[[intrigeri]] + +New pages not translatable +-------------------------- + +Today I added a new English page to l10n.ikiwiki.info. When I saved, +the page did not have the translation links at the top. I waited until +the po plugin had, in the background, created the po files, and refreshed; +still did not see the translation links. Only when I touched the page +source and refreshed did it finally add the translation links. +I can reproduce this bug in a test site. --[[Joey]] + 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,27 +404,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. -2 test suite failures --------------------- - -t/po is currently failing tests 57 and 59 (and I would like to release -soon..) --[[Joey]] - -> They are failing because of commit cdc3576c8d1e (po: do not inject -> custom bestlink function when `po_link_to` eq `default`). The test -> suite changes `$config{po_link_to}`, but the `checkconfig` hook is -> not re-run. I could manually run it when needed in the test-suite, -> but this would lead to this function being injected several times, -> and then `$origsubs{'bestlink'}` to be sometimes set to a wrong -> value, which would break other parts of the test-suite. The best -> solution I can think of (apart of reverting this commit or disabling -> these two tests) is to split the test-suite into 3 parts, depending -> on the `$config{po_link_to}` setting, either in 3 different `.t` -> files, or inside the existing one and completely reset the IkiWiki -> environment at the start of these parts... which I did not manage to -> achieve in the last 2 hours :/ --[[intrigeri]] - ->> I've reverted it. --[[Joey]] +(We also will need this in order to use translated templates, when they are +available.) Documentation -------------