]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/po.mdwn
me too
[git.ikiwiki.info.git] / doc / plugins / po.mdwn
index ac2df2d184a943d36a8535bfe9e5d69847ed1394..0a764b6947a1f1e307522df46d86d6d6df361ca1 100644 (file)
@@ -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,59 +258,3 @@ TODO
 
 [[!inline pages="todo/po:* and !todo/done and !link(todo/done) and !todo/*/*"
 feeds=no actions=no archive=yes show=0]]
-
-l10n wiki misconfiguration
---------------------------
-
-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 <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]] 
-
->>> 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
->>>> <http://l10n.ikiwiki.info/ikiwiki/>, 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]]