]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/po.mdwn
Generic License grant.
[git.ikiwiki.info.git] / doc / plugins / po.mdwn
index 6690e5deaf15adeea14ff907ab167aac2c41f7ec..0c8110563ff72a32114da1d45c34983cbe0e10b0 100644 (file)
@@ -2,34 +2,51 @@
 [[!tag type/format]]
 
 This plugin adds support for multi-lingual wikis, translated with
-gettext, using [po4a|http://po4a.alioth.debian.org/].
+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
 ============
 
-A language is decided to be the "master" one, and any other supported
-language is a "slave" one. A page written in the "master" language is
-a "master" page, and is written in any supported format but PO.
+A language is chosen as the "master" one, and any other supported
+language is a "slave" one.
+
+A page written in the "master" language is a "master" page. It can be
+of any page type supported by ikiwiki, except `po`. It does not have to be
+named a special way: migration to this plugin does not imply any page
+renaming work.
 
 Example: `bla/page.mdwn` is a "master" Markdown page written in
 English; if `usedirs` is enabled, it is rendered as
-`bla/page/index.html`, else as `bla/page.html`.
+`bla/page/index.en.html`, else as `bla/page.en.html`.
 
-Translations of a "master" page into a "slave" language are called
-"slave" pages, and is a in gettext PO format. PO is thus promoted to
-the wiki page type status.
+Any translation of a "master" page into a "slave" language is called
+a "slave" page; it is written in the gettext PO format. `po` is now
+a page type supported by ikiwiki.
 
 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.html.fr`, else as `bla/page.html.fr`
+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
 =============
 
-`po_master_language` is used to set the master language in
+Supported languages
+-------------------
+
+`po_master_language` is used to set the "master" language in
 `ikiwiki.setup`, such as:
 
         po_master_language => { 'code' => 'en', 'name' => 'English' }
@@ -37,11 +54,57 @@ Configuration
 `po_slave_languages` is used to set the list of supported "slave"
 languages, such as:
 
-        po_slave_languages => { 'fr' => { 'name' => 'Français', },
-                                'es' => { 'name' => 'Castellano', },
-                                'de' => { 'name' => 'Deutsch', },
-        },
+        po_slave_languages => { 'fr' => 'Français',
+                                'es' => 'Español',
+                                'de' => 'Deutsch',
+        }
+
+Decide which pages are translatable
+-----------------------------------
+
+The `po_translatable_pages` setting configures what pages are
+translatable. It is a [[ikiwiki/PageSpec]], so you have lots of
+control over what kind of pages are translatable.
+
+The `.po` files are not considered as being translatable, so you don't need to
+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
+
+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
+
+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
+
+#### 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`
+  to `negotiated`; this option combination is neither implemented
+  nor allowed.
+* if the web server does not support Content Negotiation, setting
+  `po_link_to` to `negotiated` will produce a unusable website.
 
 Server support
 ==============
@@ -49,120 +112,185 @@ Server support
 Apache
 ------
 
-Using `mod_negotiation` makes it really easy to have Apache serve the
-page in the client's preferred language, if available. This is the
-default Debian Apache configuration.
+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.
 
 When `usedirs` is enabled, one has to set `DirectoryIndex index` for
 the wiki context.
 
-Setting `DefaultLanguage LL` for the wiki context can be needed, to
-ensure `bla/page/index.html` is served as `Content-Language: LL`
-(replace `LL` with your default MIME language).
+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`.
 
 lighttpd
 --------
 
 lighttpd unfortunately does not support content negotiation.
 
+**FIXME**: does `mod_magnet` provide the functionality needed to
+ emulate this?
 
-TODO
-====
 
-Display available translations
-------------------------------
+Usage
+=====
 
-The [[linguas|plugins/contrib/linguas]] plugin has some code that can
-be used as a basis to display the existing translations, and allow to
-navigate between them.
+Templates
+---------
 
-View translation status
------------------------
+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.
 
-One should be able to view some freshness information about the
-translation status, either for a given page or for the whole wiki.
+The `ISTRANSLATION` and `ISTRANSLATABLE` variables can be used to
+display things only on translatable or translation pages.
 
-This should not be too hard using gettext tools. If this is
-implemented as a
-[[HTML::Template|http://search.cpan.org/search?mode=dist&query=HTML%3A%3ATemplate]]
-loop, a page using it should depend on any "master" and "slave" pages
-whose status is being displayed.
+### Display page's versions in other languages
 
-Decide which pages are translatable
------------------------------------
+The `OTHERLANGUAGES` loop provides ways to display other languages'
+versions of the same page, and the translations' status.
+
+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
 
-The subset of ("master") pages supporting translation must be
-configurable:
+### Display the current translation status
 
-- a `[[!translatable ]]` directive, when put on a page, makes it
-  translatable
-- this [[ikiwiki/directive]] can be used with an optional `match=PageSpec`
-  argument, to render translatable a bunch of pages at once
+The `PERCENTTRANSLATED` variable is set to the translation
+completeness, expressed in percent, on "slave" pages. It is used by
+the default `templates/page.tmpl`.
 
-Automatic PO files update
+Additional PageSpec tests
 -------------------------
 
-Committing changes to a "master" page must:
+This plugin enhances the regular [[ikiwiki/PageSpec]] syntax with some
+additional tests that are documented [[here|ikiwiki/pagespec/po]].
 
-1. update the POT file, the PO files for the supported languages, and
-   put them under version control
-2. trigger a refresh of the corresponding HTML slave pages
+Automatic PO file update
+------------------------
 
-The former can be implemented as a `needsbuild` hook, which is the
-first type of hook to run after the list of files that need to be
-built is known: that is, at a time when we know which "master" page
-was modified, and thus, which POT/PO files have to be updated.
+Committing changes to a "master" page:
 
-The latter can be implemented by making any "slave" page depend on the
-corresponding "master" page. The `add_depends` function can achieved
-this, if used in a FIXME hook.
+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.
 
-UI consistency: rename "Edit" button on 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.
 
-It may be surprising to some, after having pressed *Edit* on a wiki
-page, to end up editing a strange PO file. The *Edit* button must then
-be be renamed to *Improve translation* on "slave" pages.
+Discussion pages and other sub-pages
+------------------------------------
 
-Translation quality assurance
------------------------------
+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.
 
-Modifying a PO file via the CGI must only be allowed if the new
-version is a valid PO file. As a bonus, check that it provides a more
-complete translation than the existing one.
+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.
 
-A new `cansave` type of hook would be needed to implement this.
+Translating
+-----------
 
-Note: committing to the underlying repository is a way to bypass
-this check.
+One can edit the PO files using ikiwiki's CGI (a message-by-message
+interface could also be implemented at some point).
 
-Translating online
-------------------
+If [[tips/untrusted_git_push]] is setup, one can edit the PO files in one's
+preferred `$EDITOR`, without needing to be online.
+
+Markup languages support
+------------------------
+
+[[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:
 
-As PO is a wiki page type, we already have an online PO editor, that
-is ikiwiki's CGI.
+* [[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.
 
-A message-by-message interface could be implemented later, providing
-a nice way to translate offline (without VCS access) is provided.
+Security
+========
 
-Translating offline without VCS access
---------------------------------------
+[[po/discussion]] contains a detailed security analysis of this plugin
+and its dependencies.
 
-The following workflow should be made possible for translators without
-VCS access who need to edit the PO files in another editor than a web
-browser:
+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.
 
-- download the PO file for the page
-- use any PO editor to update the translation
-- upload the updated PO file
+TODO
+====
 
-A generic mechanism to download and upload a page's source is needed.
-It's only an alternative way to do Edit/edit/Save.
+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 thise additional features.
+
+Self links
+----------
+
+If a page contains a WikiLink to itself, ikiwiki does not normally
+turn that into a hyperlink. However, if a translated page contains a
+WikiLink to itself, a hyperlink is inserted, at least with the default
+`po_link_to` the link points to the English version of the page. Is there a
+good reason for that to be done? --[[Joey]] 
+
+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]] 
+
+Duplicate %links ?
+------------------
+
+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]] 
+
+Bug when editing underlay file
+------------------------------
 
-### Short-term workflow
+While I've gotten translated underlays working, there is a bug
+if the wiki is currently using a page from the underlay, and the master
+language version is edited. This causes the edited page to be saved
+to srcdir.. and all the translations get set to 0% and their
+po files have the translated strings "emptied". What's really going on
+is that these are entirely new po files not based on the old ones
+in the basewiki, and thus lacking translations. --[[Joey]] 
 
-- pretend to edit the PO file online
-- copy the PO file content from the textarea
-- cancel the edit
-- paste the content into a local file.
+Documentation
+-------------
 
+Maybe write separate documentation depending on the people it targets:
+translators, wiki administrators, hackers. This plugin may be complex
+enough to deserve this.