X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/cc4736d9eef4fba7ec39afe1aa6782142befc3d0..7e95723dadfe2a11fcd2463f2e8adf579fdc64db:/doc/plugins/po.mdwn
diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn
index fd8a50e0b..7ac1b3f0f 100644
--- a/doc/plugins/po.mdwn
+++ b/doc/plugins/po.mdwn
@@ -12,9 +12,9 @@ Introduction
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, and is
-written in any supported format but PO. It does not have to be named
-a special way: migration from/to this plugin does not imply heavy
+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
@@ -22,7 +22,7 @@ English; if `usedirs` is enabled, it is rendered as
`bla/page/index.en.html`, else as `bla/page.en.html`.
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 "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
@@ -33,7 +33,10 @@ rendered as `bla/page/index.fr.html`, else as `bla/page.fr.html`
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' }
@@ -41,11 +44,56 @@ 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' => 'Castellano',
+ '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
+--------------
+
+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
==============
@@ -53,17 +101,16 @@ 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` (replace `LL` with your default MIME
-language) for the wiki context can be needed, to ensure
+language code) for the wiki context can help to ensure
`bla/page/index.en.html` is served as `Content-Language: LL`.
-**FIXME**: is it still needed with the new `.en.html` naming convention?
lighttpd
--------
@@ -74,147 +121,181 @@ lighttpd unfortunately does not support content negotiation.
emulate this?
-TODO
-====
+Usage
+=====
-Links
------
+Templates
+---------
-Choice between two behaviors must be possible in `ikiwiki.setup`;
-a `po_link_to_current_language` option must allow switching
-between them.
+The `ISTRANSLATION` and `ISTRANSLATABLE` variables can be used to
+display things only on translatable or translation pages.
-If `po_link_to_current_language` is disabled, `[[page]]` links to the
-negotiated preferred language, i.e.:
+### Display page's versions in other languages
-- `usedirs` enabled: `bla/page/`
-- `usedirs` disabled: `bla/page`
+The `OTHERLANGUAGES` loop provides ways to display other languages'
+versions of the same page, and the translations' status.
-This obviously does not work in case Content Negotiation is not
-supported by the web server, hence one can enable
-`po_link_to_current_language` to make `[[page]]` link to the current
-page's language, i.e.:
+One typically adds the following code to `templates/page.tmpl`:
-- `usedirs` enabled: `bla/page/index.LL.html`
-- `usedirs` disabled: `bla/page.LL.html`
+
+
+
+
+ -
+ ">
+
+ ( %)
+
+
+
+
+
+
+
+
-Decide which pages are translatable
------------------------------------
+Additional PageSpec tests
+-------------------------
-The subset of "master" pages subject to translation must be
-configurable:
+This plugin enhances the regular [[ikiwiki/PageSpec]] syntax with some
+additional tests that are documented [[here|ikiwiki/pagespec/po]].
-- a `[[!translatable ]]` directive, when put on a page, makes it
- translatable
-- to set at once a bunch of pages as being translatable, use this
- [[ikiwiki/directive]] with the `match=PageSpec` argument.
+Automatic PO file update
+------------------------
-Automatic PO files update
--------------------------
+Committing changes to a "master" page:
-Committing changes to a "master" page must:
+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. update the POT file and the PO files for the supported languages,
- before putting them under version control
-2. trigger 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.
-The former is to be done at a time when:
+Discussion pages
+----------------
-- we know which "master" page was modified, and thus, which POT/PO
- files have to be updated: the `needsbuild` hook is the first one to
- run that provides us with the necessary information
-- we can modify the list of pages needing a refresh; this is
- `needsbuild` hook's job
+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.
-The latter can be implemented by making any "slave" page depend on the
-corresponding "master" page. The `add_depends` function can achieve
-this, if used in a **FIXME** hook.
+Translating
+-----------
-UI consistency: rename "Edit" button on slave pages
----------------------------------------------------
+One can edit the PO files using ikiwiki's CGI (a message-by-message interface
+could also be implemented at some point).
-It may be surprising to some, after having pressed *Edit* on a wiki
-page, to end up editing a strange looking PO file. The *Edit* button
-displayed on "slave" pages must therefore be renamed *Improve
-translation* .
+If [[tips/untrusted_git_push]] is setup, one can edit the PO files in one's
+preferred `$EDITOR`, without needing to be online.
-Pages selection depending on language
--------------------------------------
+TODO
+====
-To improve user navigation in a multi-lingual wiki, site developers
-must be enabled to write:
+OTHERLANGUAGES dependencies
+---------------------------
+
+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.
+
+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 checks
+---------------
+
+- `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()`
+
+gettext/po4a rough corners
+--------------------------
+
+- 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.
+
+Misc. improvements
+------------------
- \[[!map pages="dev/* and lang(LL)" feeds="no"]]
+### preview
- \[[!map pages="dev/* and currentlang()" feeds="no"]]
+preview does not work for PO files.
-Translation quality assurance
------------------------------
+### automatic POT/PO update
-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.
+Use the `change` hook instead of `needsbuild`?
-A new `cansave` type of hook would be needed to implement this.
+### page titles
-Note: committing to the underlying repository is a way to bypass
-this check.
+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]].
-Translating online
-------------------
+### websetup
-As PO is a wiki page type, we already have an online PO editor, that
-is ikiwiki's CGI.
+Which configuration settings are safe enough for websetup?
-A message-by-message interface could also be implemented at some
-point; a nice way to do offline translation work (without VCS access)
-still has to be offered, though.
+> 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]]
-Translating offline without VCS access
---------------------------------------
+### parentlinks
-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 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.
-- download the page's PO file
-- use any PO editor to update the translation
-- upload the updated PO file
+### backlinks
-Implementation note: a generic mechanism to upload a page's source is
-needed: it's only an alternative way to allow saving a the modified
-page's source with the CGI.
+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 quality assurance
+-----------------------------
-### Short-term workflow
+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.
-A possible workaround is:
+A new `cansave` type of hook would be needed to implement this.
-- 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.
-- edit the local file in any PO editor
-- pretend to edit the PO file online
-- paste the modified local file's content into the edit textarea
-- save
+Note: committing to the underlying repository is a way to bypass
+this check.