git.oblomov.eu Git - ikiwiki/blob - doc/plugins/contrib/po.mdwn

   1 I've been working on a plugin called "po", that adds support for multi-lingual wikis,
   2 translated with gettext, using [po4a](http://po4a.alioth.debian.org/).
   3
   4 More information:
   5
   6 * It can be found in [my "po" branch](http://repo.or.cz/w/ikiwiki/intrigeri.git?a=shortlog;h=refs/heads/po): `git clone git://repo.or.cz/ikiwiki/intrigeri.git`
   7 * It involves adding three hooks to ikiwiki core.
   8 * It is documented (including TODO and plans for next work steps) in `doc/plugins/po.mdwn`, which can be found in the same branch.
   9 * No public demo site is available so far, I'm working on this.
  10
  11 My plan is to get this plugin clean enough to be included in ikiwiki.
  12
  13 The current version is a proof-of-concept, mature enough for me to dare submitting it here,
  14 but I'm prepared to hear various helpful remarks, and to rewrite parts of it as needed.
  15
  16 Any thoughts on this?
  17
  18 > Well, I think it's pretty stunning what you've done here. Seems very
  19 > complete and well thought out. I have not read the code in great detail
  20 > yet.
  21 >
  22 > Just using po files is an approach I've never seen tried with a wiki. I
  23 > suspect it will work better for some wikis than others. For wikis that
  24 > just want translations that match the master language as closely as
  25 > possible and don't wander off and diverge, it seems perfect. (But what happens
  26 > if someone edits the Discussion page of a translated page?)
  27 >
  28 > Please keep me posted, when you get closer to having all issues solved
  29 > and ready for merging I can do a review and hopefully help with the
  30 > security items you listed. --[[Joey]]
  31
  32 >> Thanks a lot for your quick review, it's reassuring to hear such nice words
  33 >> from you. I did not want to design and write a full translation system, when
  34 >> tools such as gettext/po4a already have all the needed functionality, for cases
  35 >> where the master/slave languages paradigm fits.
  36 >> Integrating these tools into ikiwiki plugin system was a pleasure.
  37 >>
  38 >> I'll tell you when I'm ready for merging, but in the meantime,
  39 >> I'd like you to review the changes I did to the core (3 added hooks).
  40 >> Can you please do this? If not, I'll go on and hope I'm not going to far in
  41 >> the wrong direction.
  42 >>
  43 >>> Sure.. I'm not completly happy with any of the hooks since they're very
  44 >>> special purpose, and also since `run_hooks` is not the best interface
  45 >>> for a hook that modifies a variable, where only the last hook run will
  46 >>> actually do anything. It might be better to just wrap
  47 >>> `targetpage`, `bestlink`, and `beautify_urlpath`. But, I noticed
  48 >>> the other day that such wrappers around exported functions are only visible by
  49 >>> plugins loaded after the plugin that defines them.
  50 >>>
  51 >>> Update: Take a look at the new "Function overriding" section of
  52 >>> [[plugins/write]]. I think you can just inject wrappers about a few ikiwiki
  53 >>> functions, rather than adding hooks. The `inject` function is pretty
  54 >>> insane^Wlow level, but seems to work great. --[[Joey]]
  55 >>>
  56 >>>> Thanks a lot, it seems to be a nice interface for what I was trying to achieve.
  57 >>>> I may be forced to wait two long weeks before I have a chance to confirm
  58 >>>> this. Stay tuned. --[[intrigeri]]
  59 >>>>
  60 >>>>> I've updated the plugin to use `inject`. It is now fully self-contained,
  61 >>>>> and does not modify the core anymore. --[[intrigeri]]
  62 >>
  63 >> The Discussion pages issue is something I am not sure about yet. But I will
  64 >> probably decide that "slave" pages, being only translations, don't deserve
  65 >> a discussion page: the discussion should happen in the language in which the
  66 >> pages are written for real, which is the "master" one. --[[intrigeri]]
  67 >>
  68 >> I think that's a good decision, you don't want to translate discussion,
  69 >> and if the discussion page turns out multilingual, well, se la vi. ;-)
  70 >>
  71 >> Relatedly, what happens if a translated page has a broken link, and you
  72 >> click on it to edit it? Seems you'd first have to create a master page
  73 >> and could only then translate it, right? I wonder if this will be clear
  74 >> though to the user.
  75 >>
  76 >> And also, is there any way to start a translation of a page into a new
  77 >> lanauge using the web interface?
  78 >>
  79 >> FWIW, I'm tracking your po branch in ikiwiki master git in the po
  80 >> branch. One thing I'd like to try in there is setting up a translated
  81 >> basewiki, which seems like it should be pretty easy to do, and would be
  82 >> a great demo! --[[Joey]]