po plugin: updated doc/todo

[git.ikiwiki.info.git] / doc / plugins / po.mdwn

diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn
index 1a9144aee2ed4124a1353976c8e988b4718918a7..6aa63b429b1af2d8975424e3d10559e53a210fc1 100644 (file)
--- a/doc/plugins/po.mdwn
+++ b/doc/plugins/po.mdwn
@@ -185,30 +185,36 @@ Automatic PO files update
 
 Committing changes to a "master" page:
 
 
 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
 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.
 
 
 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` 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.
+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
 ---------------
 
 Security checks
 ---------------


@@ -227,45 +233,44 @@ gettext/po4a rough corners
   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`?
   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.
+- 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
 ------------------
 
 ### automatic POT/PO update
 
 
 Misc. improvements
 ------------------
 
 ### automatic POT/PO update
 

-Use the `change` hook instead of `needsbuild`?
+- Use the `change` hook instead of `needsbuild`?
+- Fix (apparently harmless) undefined values that pollute logs when
+  saving a master page in the CGI

 
 ### page titles
 
 
 ### page titles
 

-Use nice page titles from meta plugin in links, as inline already does.
+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]].

 
 ### websetup
 
 Which configuration settings are safe enough for websetup?
 
 
 ### websetup
 
 Which configuration settings are safe enough for websetup?
 

-### Discussion pages
-
-Decide something, probably that "slave" pages, being only translations, don't
-deserve a discussion page: the discussion should happen in the language in which
-the pages are written for real, which is the "master" one.
-

 ### parentlinks
 
 When the wiki home page is translatable, the parentlinks plugin sets
 ### parentlinks
 
 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.
+`./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.

 
 ### backlinks
 
 If a given translatable `sourcepage.mdwn` links to \[[destpage]],
 
 ### backlinks
 
 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.
+`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
 -----------------------------
 
 Translation quality assurance
 -----------------------------


@@ -278,43 +283,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.
 
 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.
-
-**FIXME** preview does not work for PO files.
-
-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