X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/be30203459f6994f650ed56b9f7da88b8c98c137..34e8c78c1c9bf65564c1a3086584158e5c3cc415:/doc/plugins/po.mdwn?ds=sidebyside diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn index 8e87e2638..576d36ec1 100644 --- a/doc/plugins/po.mdwn +++ b/doc/plugins/po.mdwn @@ -114,7 +114,8 @@ Apache Using Apache `mod_negotiation` makes it really easy to have Apache serve any page in the client's preferred language, if available. -This is the default Debian Apache configuration. + +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. @@ -123,14 +124,17 @@ 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`. +For details, see [Apache's documentation](http://httpd.apache.org/docs/2.2/content-negotiation.html). + lighttpd -------- -lighttpd unfortunately does not support content negotiation. +Recent versions of lighttpd should be able to use +`$HTTP["language"]` to configure the translatted 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 ===== @@ -248,8 +252,7 @@ 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 thise additional features. - +and `meta` branches, and thus has this additional features. Language display order ---------------------- @@ -260,46 +263,63 @@ 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]] -po files in underlay --------------------- - -I think this plugin doesn't yet allow po files to be present in an -underlay to translate files also from the underlay. +Pagespecs +--------- -In `istranslatablefile`, it specifically checks that -the file is present in srcdir. +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]] -Problem with this is that it precludes using po to translate -the basewiki (work which is well under way for Danish BTW), -since the translated po files cannot really be used. +Edit links on untranslated pages +-------------------------------- -A further problem comes if one wants to use a non-English language as the -`po_master_language`. It would be good to get a translated -basewiki, taking po files from the underlay and using them as the primary -page sources, but this plugin doesn't yet support that. +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. -And, maybe it shouldn't? A user would not expect to see a po file when -editing the index page of their wiki, just because they're using a -different language. Instead, we might want to build localized .mdwn files -for the basewiki, and then ikiwiki would just use that translated underlay. -The when the user edits index, they get a nice mdwn file to start from. +That's really confusing, especially as clicking such a link +brings up an edit form to create a new, english page. -So, we seem to have two cases, in one po files from the underlay should be -used, in the other not. Hmm. Support both? +This is with po_link_to=current or negotiated. With default, it doesn't +happen.. -> Update -- I've written po2wiki, which can spit out translated underlays -> in markdown format, and made the po plugin enable use of such underlays -> when the master language is not `en`. +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]] -Duplicate %links ? ------------------- +Double commits of po files +-------------------------- -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]] +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" + +Same thing happens when a change to an existing page triggers a po file +update. --[[Joey]] + +Ugly messages with empty files +------------------------------ + +If there are empty .mdwn files, the po plugin displays some ugly messages. + +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 -------------