X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/7e95723dadfe2a11fcd2463f2e8adf579fdc64db..8cfba729702e52ba2b3716d7a2d2daaff61a1604:/doc/plugins/po.mdwn diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn index 7ac1b3f0f..57459c1ef 100644 --- a/doc/plugins/po.mdwn +++ b/doc/plugins/po.mdwn @@ -5,6 +5,10 @@ This plugin adds support for multi-lingual wikis, translated with gettext, using [po4a](http://po4a.alioth.debian.org/). It depends on the Perl `Locale::Po4a::Po` library (`apt-get install po4a`). +As detailed bellow in the security section, `po4a` is subject to +denial-of-service attacks before version 0.35. + +[[!toc levels=2]] Introduction ============ @@ -29,6 +33,12 @@ Example: `bla/page.fr.po` is the PO "message catalog" used to translate `bla/page.mdwn` into French; if `usedirs` is enabled, it is 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 +what it is, you probably don't care. + Configuration ============= @@ -45,7 +55,7 @@ Supported languages languages, such as: po_slave_languages => { 'fr' => 'Français', - 'es' => 'Castellano', + 'es' => 'Español', 'de' => 'Deutsch', } @@ -62,39 +72,40 @@ worry about excluding them explicitly from this [[ikiwiki/PageSpec]]. Internal links -------------- +### Links targets + The `po_link_to` option in `ikiwiki.setup` is used to decide how internal links should be generated, depending on web server features and site-specific preferences. -### Default linking behavior +#### Default linking behavior If `po_link_to` is unset, or set to `default`, ikiwiki's default linking behavior is preserved: `\[[destpage]]` links to the master language's page. -### Link to current language +#### Link to current language If `po_link_to` is set to `current`, `\[[destpage]]` links to the `destpage`'s version written in the current page's language, if available, *i.e.*: -- `foo/destpage/index.LL.html` if `usedirs` is enabled -- `foo/destpage.LL.html` if `usedirs` is disabled +* `foo/destpage/index.LL.html` if `usedirs` is enabled +* `foo/destpage.LL.html` if `usedirs` is disabled -### Link to negotiated language +#### Link to negotiated language If `po_link_to` is set to `negotiated`, `\[[page]]` links to the negotiated preferred language, *i.e.* `foo/page/`. (In)compatibility notes: -- if `usedirs` is disabled, it does not make sense to set `po_link_to` +* if `usedirs` is disabled, it does not make sense to set `po_link_to` to `negotiated`; this option combination is neither implemented nor allowed. -- if the web server does not support Content Negotiation, setting +* if the web server does not support Content Negotiation, setting `po_link_to` to `negotiated` will produce a unusable website. - Server support ============== @@ -103,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. @@ -112,6 +124,8 @@ 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 -------- @@ -127,6 +141,10 @@ Usage Templates --------- +When `po_link_to` is not set to `negotiated`, one should replace some +occurrences of `BASEURL` with `HOMEPAGEURL` to get correct links to +the wiki homepage. + The `ISTRANSLATION` and `ISTRANSLATABLE` variables can be used to display things only on translatable or translation pages. @@ -135,43 +153,21 @@ display things only on translatable or translation pages. The `OTHERLANGUAGES` loop provides ways to display other languages' versions of the same page, and the translations' status. -One typically adds the following code to `templates/page.tmpl`: - - -
- -
- - -The following variables are available inside the loop (for every page in): - -- `URL` - url to the page -- `CODE` - two-letters language code -- `LANGUAGE` - language name (as defined in `po_slave_languages`) -- `MASTER` - is true (1) if, and only if the page is a "master" page -- `PERCENT` - for "slave" pages, is set to the translation completeness, in percents +An example of its use can be found in the default +`templates/page.tmpl`. In case you want to customize it, the following +variables are available inside the loop (for every page in): + +* `URL` - url to the page +* `CODE` - two-letters language code +* `LANGUAGE` - language name (as defined in `po_slave_languages`) +* `MASTER` - is true (1) if, and only if the page is a "master" page +* `PERCENT` - for "slave" pages, is set to the translation completeness, in percents ### Display the current translation status The `PERCENTTRANSLATED` variable is set to the translation -completeness, expressed in percent, on "slave" pages. - -One can use it this way: - - -
- -
- +completeness, expressed in percent, on "slave" pages. It is used by +the default `templates/page.tmpl`. Additional PageSpec tests ------------------------- @@ -184,118 +180,146 @@ Automatic PO file update Committing changes to a "master" page: -1. updates the POT file and the PO files for the supported languages; - the updated PO files are then put under version control -2. triggers a refresh of the corresponding HTML slave pages +1. updates the POT file and the PO files for the "slave" languages; + the updated PO files are then put under version control; +2. triggers a refresh of the corresponding HTML slave pages. Also, when the plugin has just been enabled, or when a page has just been declared as being translatable, the needed POT and PO files are created, and the PO files are checked into version control. -Discussion pages ----------------- +Discussion pages and other sub-pages +------------------------------------ + +Discussion should happen in the language in which the pages are +written for real, *i.e.* the "master" one. If discussion pages are +enabled, "slave" pages therefore link to the "master" page's +discussion page. -Discussion should happen in the language in which the pages are written for -real, *i.e.* the "master" one. If discussion pages are 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 +the master page's sub-pages. Translating ----------- -One can edit the PO files using ikiwiki's CGI (a message-by-message interface -could also be implemented at some point). +One can edit the PO files using ikiwiki's CGI (a message-by-message +interface could also be implemented at some point). If [[tips/untrusted_git_push]] is setup, one can edit the PO files in one's preferred `$EDITOR`, without needing to be online. -TODO -==== +Markup languages support +------------------------ -OTHERLANGUAGES dependencies ---------------------------- +[[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: -Pages using `OTHERLANGUAGES` depend on any "master" and "slave" pages -whose status is being displayed. It is supposed to trigger dependency -loops, but no practical bugs were noticed yet. +* [[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 +* other markup languages have not been tested. -Should pages using the `OTHERLANGUAGES` template loop be declared as -linking to the same page in other versions? To be rigorous, they -should, but this may clutter the backlinks. +Security +======== -Security checks ---------------- +[[po/discussion]] contains a detailed security analysis of this plugin +and its dependencies. -- `refreshpofiles` uses `system()`, whose args have to be checked more - thoroughly to prevent any security issue (command injection, etc.). -- `refreshpofiles` and `refreshpot` create new files; this may need - some checks, e.g. using `IkiWiki::prep_writefile()` +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. -gettext/po4a rough corners --------------------------- +TODO +==== + +Better links +------------ -- fix infinite loop when synchronizing two ikiwiki (when checkouts - live in different directories): say bla.fr.po has been updated in - repo2; pulling repo2 from repo1 seems to trigger a PO update, that - changes bla.fr.po in repo1; then pushing repo1 to repo2 triggers - a PO update, that changes bla.fr.po in repo2; etc.; fixed in - `629968fc89bced6727981c0a1138072631751fee`? -- new translations created in the web interface must get proper charset/encoding - gettext metadata, else the next automatic PO update removes any non-ascii - chars; possible solution: put such metadata into the Pot file, and let it - propagate; should be fixed in `773de05a7a1ee68d2bed173367cf5e716884945a`, time - will tell. +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. -Misc. improvements ------------------- +An integration branch, called `meta-po`, merges [[intrigeri]]'s `po` +and `meta` branches, and thus has this additional features. -### preview +Language display order +---------------------- -preview does not work for PO files. +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]] -### automatic POT/PO update +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 +-------------------------------- -Use the `change` hook instead of `needsbuild`? +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. -### page titles +That's really confusing, especially as clicking such a link +brings up an edit form to create a new, english page. -Use nice page titles from meta plugin in links, as inline already does. This is -actually a duplicate for -[[bugs/pagetitle_function_does_not_respect_meta_titles]], which might be fixed -by something like [[todo/using_meta_titles_for_parentlinks]]. +This is with po_link_to=current or negotiated. With default, it doesn't +happen.. -### websetup +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]] -Which configuration settings are safe enough for websetup? +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: -> I see no problems with `po_master_language` and `po_slave_languages` -> (assuming websetup handles the hashes correctly). Would not hurt to check -> that the values of these are legal language codes, in `checkconfig`. -> `po_translatable_pages` seems entirely safe. `po_link_to` w/o usedirs -> causes ikiwiki to error out. If it were changed to fall back to a safe -> setting in this case rather than error, it would be safe. -> --[[Joey]] + -"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" -### parentlinks +Same thing happens when a change to an existing page triggers a po file +update. --[[Joey]] -When the wiki home page is translatable, the parentlinks plugin sets -`./index.html` as its translations' single parent link. Ideally, the home page's -translations should get no parent link at all, just like the version written in -the master language. +Ugly messages with empty files +------------------------------ -### backlinks +If there are empty .mdwn files, the po plugin displays some ugly messages. -If a given translatable `sourcepage.mdwn` links to \[[destpage]], -`sourcepage.LL.po` also link to \[[destpage]], and the latter has the master -page *and* all its translations listed in the backlinks. +Translation of directives +------------------------- -Translation quality assurance ------------------------------ +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". -Modifying a PO file via the CGI must be forbidden if the new version -is not a valid PO file. As a bonus, check that it provides a more -complete translation than the existing one. +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. -A new `cansave` type of hook would be needed to implement this. +Documentation +------------- -Note: committing to the underlying repository is a way to bypass -this check. +Maybe write separate documentation depending on the people it targets: +translators, wiki administrators, hackers. This plugin may be complex +enough to deserve this.