X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/862fc7c1ab1f7d709561bcb02fc8ede57b90a51b..3186fcb985e854143c9ef85df8e02e50e19efb1a:/doc/plugins/po.mdwn diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn index c36414c8e..b701d3662 100644 --- a/doc/plugins/po.mdwn +++ b/doc/plugins/po.mdwn @@ -49,7 +49,7 @@ Supported languages `po_master_language` is used to set the "master" language in `ikiwiki.setup`, such as: - po_master_language => { 'code' => 'en', 'name' => 'English' } + po_master_language => 'en|English' `po_slave_languages` is used to set the list of supported "slave" languages, such as: @@ -117,12 +117,13 @@ serve any page in the client's preferred language, if available. Add 'Options MultiViews' to the wiki directory's configuration in Apache. -When `usedirs` is enabled, one has to set `DirectoryIndex index` for -the wiki context. +When `usedirs` is enabled, you should also set `DirectoryIndex index`. -Setting `DefaultLanguage LL` (replace `LL` with your default MIME -language code) for the wiki context can help to ensure -`bla/page/index.en.html` is served as `Content-Language: LL`. +These settings are also recommended, in order to avoid serving up rss files +as index pages: + + AddType application/rss+xml;qs=0.8 .rss + AddType application/atom+xml;qs=0.8 .atom For details, see [Apache's documentation](http://httpd.apache.org/docs/2.2/content-negotiation.html). @@ -149,6 +150,9 @@ the wiki homepage. The `ISTRANSLATION` and `ISTRANSLATABLE` variables can be used to display things only on translatable or translation pages. +The `LANG_CODE` and `LANG_NAME` variables can respectively be used to +display the current page's language code and pretty name. + ### Display page's versions in other languages The `OTHERLANGUAGES` loop provides ways to display other languages' @@ -198,7 +202,7 @@ enabled, "slave" pages therefore link to the "master" page's discussion page. Likewise, "slave" pages are not supposed to have sub-pages; -[[WikiLinks|wikilink]] that appear on a "slave" page therefore link to +[[WikiLinks|ikiwiki/wikilink]] that appear on a "slave" page therefore link to the master page's sub-pages. Translating @@ -235,159 +239,14 @@ When using po4a older than 0.35, it is recommended to uninstall `Text::WrapI18N` (Debian package `libtext-wrapi18n-perl`), in order to avoid a potential denial of service. -TODO +BUGS ==== -Better links ------------- - -Once the fix to -[[bugs/pagetitle_function_does_not_respect_meta_titles]] from -[[intrigeri]]'s `meta` branch is merged into ikiwiki upstream, the -generated links' text will be optionally based on the page titles set -with the [[meta|plugins/meta]] plugin, and will thus be translatable. -It will also allow displaying the translation status in links to slave -pages. Both were implemented, and reverted in commit -ea753782b222bf4ba2fb4683b6363afdd9055b64, which should be reverted -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]] - -> 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]] - -Pagespecs ---------- - -I was suprised that, when using the map directive, a pagespec of "*" -listed all the translated pages as well as regular pages. That can -make a big difference to an existing wiki when po is turned on, -and seems generally not wanted. -(OTOH, you do want to match translated pages by -default when locking pages.) --[[Joey]] - -Edit links on untranslated pages --------------------------------- - -If a page is not translated yet, the "translated" version of it -displays wikilinks to other, existing (but not yet translated?) -pages as edit links, as if those pages do not exist. - -That's really confusing, especially as clicking such a link -brings up an edit form to create a new, english page. - -This is with po_link_to=current or negotiated. With default, it doesn't -happen.. - -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 --------------------------- - -When adding a new english page, the po files are created, committed, -and then committed again. The second commit makes this change: - - -"Content-Type: text/plain; charset=utf-8\n" - -"Content-Transfer-Encoding: ENCODING" - +"Content-Type: text/plain; charset=UTF-8\n" - +"Content-Transfer-Encoding: ENCODING\n" +[[!inline pages="bugs/po:* and !bugs/done and !link(bugs/done) and !bugs/*/*" +feeds=no actions=no archive=yes show=0]] -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]] - -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 -------------------------- - -If a translated page contains a directive, it may expand to some english -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. - -(We also will need this in order to use translated templates, when they are -available.) - -Documentation -------------- +TODO +==== -Maybe write separate documentation depending on the people it targets: -translators, wiki administrators, hackers. This plugin may be complex -enough to deserve this. +[[!inline pages="todo/po:* and !todo/done and !link(todo/done) and !todo/*/*" +feeds=no actions=no archive=yes show=0]]