X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/1d767625178380c6b760b9ea4bb41a11a7c95d53..bd2dd8c60336ad7a03194d2a53f5409a620e484d:/doc/plugins/po.mdwn diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn index 2c46a80ed..f9cd0ff03 100644 --- a/doc/plugins/po.mdwn +++ b/doc/plugins/po.mdwn @@ -128,6 +128,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,6 +166,14 @@ 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 ------------------------- @@ -174,30 +185,36 @@ Automatic PO files update Committing changes to a "master" page: -1. updates the POT file and the PO files for the supported languages - (this is done in the `needsbuild` hook); the updated PO files are - then put under version control +1. updates the POT file, as well as the PO files for the "slave" + languages (this is done in the `needsbuild` hook); the updated PO + files are then put under version control; 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) + "master" page, in the `needsbuild` hook). 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. -TODO -==== +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. -OTHERLANGUAGES dependencies ---------------------------- +Translating +----------- -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? +One can edit the PO files using ikiwiki's CGI (a message-by-message +interface could also be implemented at some point). -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. +If [[tips/untrusted_git_push]] is setup, one can edit the PO files in +her preferred `$EDITOR`, without needing to be online. + +TODO +==== Security checks --------------- @@ -207,52 +224,52 @@ Security checks - `refreshpofiles` and `refreshpot` create new files; this may need some checks, e.g. using `IkiWiki::prep_writefile()` -Translation quality assurance ------------------------------ - -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 new `cansave` type of hook would be needed to implement this. +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 +------------------ -Note: committing to the underlying repository is a way to bypass -this check. +### page titles -Translating online ------------------- +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]]. -As PO is a wiki page type, we already have an online PO editor, that -is ikiwiki's CGI. +### 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. +Which configuration settings are safe enough for websetup? -Translating offline without VCS access --------------------------------------- +### backlinks -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: +`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. -- download the page's PO file -- use any PO editor to update the translation -- upload the updated PO file +`po_link_to = current`: seems to work nicely -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. +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.