X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/58c77a01f79efaa5692fd30231695c6f8775a7d9..419de149a6b4c1cf598f33f0c96a2a21104528ec:/doc/plugins/po.mdwn diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn index ab7fcb725..ee6dbb097 100644 --- a/doc/plugins/po.mdwn +++ b/doc/plugins/po.mdwn @@ -13,7 +13,7 @@ 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, but PO. It does not have to 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. @@ -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 @@ -56,9 +56,8 @@ 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 translations files are anyway not considered as being -translatable, so you don't need to worry about excluding them -explicitly from this [[ikiwiki/PageSpec]]. +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 -------------- @@ -128,6 +127,9 @@ Usage Templates --------- +The `ISTRANSLATION` and `ISTRANSLATABLE` variables can be used to +display things only on translatable or translation pages. + ### Display page's versions in other languages The `OTHERLANGUAGES` loop provides ways to display other languages' @@ -163,49 +165,115 @@ The following variables are available inside the loop (for every page in): The `PERCENTTRANSLATED` variable is set to the translation completeness, expressed in percent, on "slave" pages. +One can use it this way: + + +
+ +
+ + Additional PageSpec tests ------------------------- This plugin enhances the regular [[ikiwiki/PageSpec]] syntax with some additional tests that are documented [[here|ikiwiki/pagespec/po]]. +Automatic PO file update +------------------------ + +Committing changes to a "master" page: + +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 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. + +Translating +----------- + +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 ==== -OTHERLANGUAGES dependencies ---------------------------- - -Pages using `OTHERLANGUAGES` must depend on any "master" and "slave" -pages whose status is being displayed. It will trigger dependency -loops; how to sort this out? +Security checks +--------------- + +- `refreshpofiles` uses `system()`, whose args have to be checked more + thoroughly to prevent any security issue (command injection, etc.). + > Always pass `system()` a list of parameters to avoid the shell. + > I've checked in a change fixing that. --[[Joey]] +- `refreshpofiles` and `refreshpot` create new files; this may need + some checks, e.g. using `IkiWiki::prep_writefile()` + > Yes, it would be ideal to call `prep_writefile` on each file + > that they write, beforehand. This way you'd avoid symlink attacks etc to the + > generated po/pot files. I haven't done it, but it seems pretty trivial. + > --[[Joey]] +- Can any sort of directives be put in po files that will + cause mischief (ie, include other files, run commands, crash gettext, + whatever). +- Any security issues on running po4a on untrusted content? + +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 +------------------ -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. +### page titles -Automatic PO files update -------------------------- +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]]. -Committing changes to a "master" page: +### websetup -1. updates the POT file and the PO files for the supported languages; - this is done in the `needsbuild` hook; **FIXME**: the updated PO - files must then be put under version control +Which configuration settings are safe enough for websetup, apart of +`po_master_language`, `po_slave_languages` and `po_translatable_pages` +that have been checked already? -2. triggers a refresh of the corresponding HTML slave pages: this is - achieved by making any "slave" page dependent on the corresponding - "master" page, in the `needsbuild` hook. +> `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]] -Also, when the plugin has just been enabled, or when a page -has just been declared as being translatable: +### backlinks -- all the needed POT and PO files are be created -- **FIXME** the PO files must be checked into version control +`po_link_to = negotiated`: 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. -**FIXME** `refreshpofiles` uses `system()`, whose args have to be -checked more thoroughly to prevent any security issue (command -injection, etc.). +`po_link_to = current`: seems to work nicely Translation quality assurance ----------------------------- @@ -218,41 +286,3 @@ A new `cansave` type of hook would be needed to implement this. Note: committing to the underlying repository is a way to bypass this check. - -Translating online ------------------- - -As PO is a wiki page type, we already have an online PO editor, that -is ikiwiki's CGI. - -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. - -Translating offline without VCS access --------------------------------------- - -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: - -- download the page's PO file -- use any PO editor to update the translation -- upload the updated PO file - -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. - -### Short-term workflow - -A possible workaround is: - -- 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