]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/plugins/po.mdwn
todo++ (?)
[ikiwiki.git] / doc / plugins / po.mdwn
index fc7d1d50277b90726f2863e20d99cdd79bb63560..6377a11bef259730203b738e27a6ac0ecdd529a1 100644 (file)
@@ -54,10 +54,10 @@ Supported languages
 `po_slave_languages` is used to set the list of supported "slave"
 languages, such as:
 
-        po_slave_languages => { 'fr' => 'Français',
-                                'es' => 'Español',
-                                'de' => 'Deutsch',
-        }
+        po_slave_languages => [ 'fr|Français',
+                                'es|Español',
+                                'de|Deutsch',
+        ]
 
 Decide which pages are translatable
 -----------------------------------
@@ -254,56 +254,6 @@ once [[intrigeri]]'s `meta` branch is merged.
 An integration branch, called `meta-po`, merges [[intrigeri]]'s `po`
 and `meta` branches, and thus has this additional features.
 
-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]] 
-
-> Done in my po branch, preserving backward compatibility. Please
-> review :) --[[intrigeri]]
-
->> Right, well my immediate concern is that using an array to hold
->> hash-like pairs is not very clear to the user. It will be displayed
->> in a confusing way by websetup; dumping a setup file will probably
->> also cause it to be formatted in a confusing way. And the code
->> seems to assume that the array length is even, and probably blows
->> up if it is not.. and the value is marked safe so websetup can be
->> used to modify it and break that way too. --[[Joey]] 
-
->>> I have added a sanity check for the even array problem. This was
->>> the easy part.
->>>
->>> About the hash-like vs. dump and websetup issue,
->>> I can think of a few solutions:
->>>
->>> - keep the current hash-like pairs and unmark this setting as safe
->>>   for websetup: this does not solve the dump setup issue, though;
->>> - replace the array of pairs with an array of
->>>   "LANGUAGECODE|LANGUAGENAME" elements, using a pipe or whatever
->>>   separator seems adequate;
->>> - add support for ordered hashes to `$config`, websetup and
->>>   dumpsetup, using Tie-IxHash or any similar module;
->>> - replace the array of hash-like pairs with an array of real
->>>   pairs, such as `[ ['de', 'Deutsch'], ['fr', 'Français'] ]`; this
->>>   brings once again the need for `$config` to support arrays of
->>>   arrays, which I have already implemented in my mirrorlist branch
->>>   (see [[todo/mirrorlist_with_per-mirror_usedirs_settings]] for
->>>   details).
->>>
->>> Joey, which of these solutions do you prefer? Or another one?
->>> I tend to prefer the last one. --[[intrigeri]]
-
->>>> I prefer the pipe separator, I think. I'm concerned that there is 
->>>> no way to really sanely represent complex data structures in web
->>>> setup. --[[Joey]]
-
->>>>> Implemented using the pipe separator, fixed the po.t test suite
->>>>> accordingly. Please have a look. --[[intrigeri]]
-
 Pagespecs
 ---------
 
@@ -314,8 +264,13 @@ and seems generally not wanted.
 (OTOH, you do want to match translated pages by
 default when locking pages.) --[[Joey]]
 
-Edit links on untranslated pages
---------------------------------
+> Seems hard to me to sort apart the pagespec whose matching pages
+> list must be restricted to pages in the master (or current?)
+> language, and the ones that should not. The only solution I can see
+> to this surprising behaviour is: documentation. --[[intrigeri]]
+
+Edit links on some slave pages
+------------------------------
 
 If a page is not translated yet, the "translated" version of it
 displays wikilinks to other, existing (but not yet translated?)
@@ -340,6 +295,20 @@ underlay, and the underlays lack translation to a given language.
 >> Compare with eg, the 100% translated Dansk version, where
 >> the WikiLink link links to the English WikiLink page. --[[Joey]] 
 
+>>> Seems not related to the page/string translation status: the 0%
+>>> translated Spanish version has the correct link, just like the
+>>> Dansk version => I'm changing the bug title accordingly.
+>>>
+>>> I tested forcing the sv html page to be rebuilt by translating a
+>>> string in it, it did not fix the bug. I did the same for the
+>>> Spanish page, it did not introduce the bug. So this is really
+>>> weird.
+>>>
+>>> The smiley underlay seems to be the only place where the wrong
+>>> thing happens: the basewiki underlay has similar examples
+>>> that do not exhibit this bug. An underlay linking to another might
+>>> be necessary to reproduce it. Going to dig deeper. --[[intrigeri]]
+
 Double commits of po files
 --------------------------
 
@@ -368,6 +337,10 @@ still did not see the translation links. Only when I touched the page
 source and refreshed did it finally add the translation links. 
 I can reproduce this bug in a test site. --[[Joey]]
 
+> I could reproduce this bug at some point during the merge of a buggy
+> version of my ordered slave languages patch, but I cannot anymore.
+> Could you please try again? --[[intrigeri]]
+
 Ugly messages with empty files
 ------------------------------
 
@@ -376,6 +349,12 @@ If there are empty .mdwn files, the po plugin displays some ugly messages.
 > This is due to a bug in po4a (not checking definedness of a
 > variable). One-liner patch sent. --[[intrigeri]]
 
+Remove po/pot files when disabling the po plugin?
+-------------------------------------------------
+
+ikiwiki now has a `disable` hook. Should the po plugin remove the po
+files from the source repository when it has been disabled?
+
 Translation of directives
 -------------------------