X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/22d982243716bb04f56e4e78e573e3ec49077309..43a88daa5fc23fb70c22ab4472dd293e04b7236d:/doc/plugins/po.mdwn?ds=inline diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn index 0f1d66d32..0a764b694 100644 --- a/doc/plugins/po.mdwn +++ b/doc/plugins/po.mdwn @@ -36,7 +36,7 @@ rendered as `bla/page/index.fr.html`, else as `bla/page.fr.html` (In)Compatibility ================= -This plugin does not support the `indexpages` mode. If you don't know +This plugin does not support the `indexpages` mode (a.k.a. "use page/index.mdwn source files"). If you don't know what it is, you probably don't care. @@ -49,15 +49,15 @@ 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: - 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 ----------------------------------- @@ -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' @@ -225,6 +229,14 @@ are not rendered correctly on the slave pages: could be used to support it, but it would need a security audit * other markup languages have not been tested. +Renaming a page +--------------- + +A translatable page may be renamed using the web interface and the +[[rename plugin|plugins/rename]], or using the VCS directly; in +the latter case, *both* the "master" page and every corresponding +`.po` file must be renamed in the same commit. + Security ======== @@ -246,72 +258,3 @@ TODO [[!inline pages="todo/po:* and !todo/done and !link(todo/done) and !todo/*/*" feeds=no actions=no archive=yes show=0]] - -broken links to translatable basewiki pages that lack po files --------------------------------------------------------------- - -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]] - ->>> Seems not related to the page/string translation status: the 0% ->>> translated Spanish version has the correct link, just like the ->>> Dansk version => I'm changing the bug title accordingly. ->>> ->>> I tested forcing the sv html page to be rebuilt by translating a ->>> string in it, it did not fix the bug. I did the same for the ->>> Spanish page, it did not introduce the bug. So this is really ->>> weird. ->>> ->>> The smiley underlay seems to be the only place where the wrong ->>> thing happens: the basewiki underlay has similar examples ->>> that do not exhibit this bug. An underlay linking to another might ->>> be necessary to reproduce it. Going to dig deeper. --[[intrigeri]] - ->>>> After a few hours lost in the Perl debugger, I think I have found ->>>> the root cause of the problem: in l10n wiki's configured ->>>> `underlaydir`, the basewiki is present in every slave language ->>>> that is enabled for this wiki *but* Swedish. With such a ->>>> configuration, the `ikiwiki/wikilink` page indeed does not exist ->>>> in Swedish language: no `ikiwiki/wikilink.sv.po` can be found ->>>> where ikiwiki is looking. Have a look to ->>>> , the basewiki is not ->>>> available in Swedish language on this wiki. So this is not a po ->>>> bug, but a configuration or directories layout issue. This is ->>>> solved by adding the Swedish basewiki to the underlay dir, which ->>>> is I guess not a possibility in the l10n wiki context. I guess ->>>> this could be solved by adding `SRCDIR/basewiki` as an underlay ->>>> to your l10n wiki configuration, possibly using the ->>>> `add_underlays` configuration directive. --[[intrigeri]] - ->>>>> There is no complete Swedish underlay translation yet, so it is not ->>>>> shipped in ikiwiki. I don't think it's a misconfiguration to use ->>>>> a language that doesn't have translated underlays. --[[Joey]] - ->>>>>> Ok. The problem is triggered when using a language that doesn't ->>>>>> have translated underlays, *and* defining ->>>>>> `po_translatable_pages` in a way that renders the base wiki ->>>>>> pages translatable in po's view of things, which in turns makes ->>>>>> the po plugin act as if the translation pages did exist, ->>>>>> although they do not in this case. I still need to have a deep ->>>>>> look at the underlays-related code you added to `po.pm` a while ->>>>>> ago. Stay tuned. --[[intrigeri]]