doc/plugins/contrib/linguas.mdwn

   1 [[!template id=plugin name=linguas author="Jordà Polo"]]
   2
   3 Linguas
   4 =======
   5
   6 Linguas is a plugin for [ikiwiki](http://ikiwiki.info/) that
   7 allows translations of wiki pages.
   8
   9 Download: [linguas.pm](http://ettin.org/pub/ikiwiki/linguas.pm) (2006-08-21).
  10
  11 Note that even though it is still available for download, this plugin is no
  12 longer actively maintained. If you are interested in multilingual wiki pages, you
  13 can also take a look at other approaches such as [[todo/l10n]] or Lars Wirzenius's
  14 [Static website, with translations, using IkiWiki](http://liw.iki.fi/liw/log/2007-05.html#20070528b).
  15
  16 Usage
  17 -----
  18
  19 Translatable pages and translations must have the following format:
  20 `pagename.$LANG`, where `$LANG` is a ISO639-1 (two-letter) language code.
  21 To enable linguas, add the following line in the source code of the page:
  22
  23         \[[!linguas ]]
  24
  25 Note that linguas is only required in one of the pages (the original,
  26 for instance); the rest of translations will be automatically
  27 updated. Additionally, it is also possible to specify the title of
  28 the translation:
  29
  30         \[[!linguas title="Translated title"]]
  31
  32
  33 Template
  34 --------
  35
  36 This is the template code that should be added to `templates/page.tmpl`:
  37
  38         <TMPL_IF NAME="LINGUAS">
  39         <div id="linguas">
  40         <p class="otherlinguas"><TMPL_VAR NAME="OTHERLINGUAS"></p>
  41         <ul>
  42         <TMPL_LOOP NAME="LINGUAS">
  43         <li><TMPL_VAR NAME=LINK></li>
  44         </TMPL_LOOP>
  45         </ul>
  46         </div>
  47         </TMPL_IF>
  48
  49
  50 TODO/Known Problems
  51 -------------------
  52
  53 * The current language list only contains 4 languages (ca, de, en,
  54 es), and is "hardcoded" in linguas.pm. Would be interesting to define
  55 it in ikiwiki.setup, though some problems were found while trying to do
  56 so. (Actually, defining hash-like arguments from the command like works
  57 fine, but it fails from ikiwiki.setup.)
  58
  59   > My guess about this is that it's because of the way Setup/Standard.pm
  60   > untaints the config items from the file. It has code to handle arrays,
  61   > but not hashes or more complex data structures. --[[Joey]]
  62
  63   >  > Right. With this simple
  64   >  > [patch](http://ettin.org/pub/ikiwiki/hash_setup.patch) it seems to
  65   >  > work. However, note that 1) it only allows simple hashes, hashes of
  66   >  > hashes will not work (I don't think getops can handle complex hashes
  67   >  > anyway); 2) I don't really know when/why you call
  68   >  > `possibly_foolish_untaint()`; and 3) I'm no perl guru ;). --Jordà
  69
  70   >  >  > It's good. Applied..
  71
  72 * Wiki links to other translated pages require the full page name
  73 including the `.$LANG`. It should be possible to link automatically
  74 to pages with the same `.$LANG`, but that would probably require some
  75 changes in IkiWiki. (I'm not sure though, I still haven't looked at
  76 it... any hints?)
  77
  78   > Have you considered using the form ll/page? This would let more usual
  79   > linking rules  apply amoung pages without needing to specify the
  80   > language. I'm not sure if you're supporting browser content
  81   > negotiation, or whether that other layout would be harder to support it
  82   > though. --[[Joey]]
  83
  84   >  > Actually, I'm happy with the way it works now (and yeah, it is very
  85   >  > easy to take advantage of content negotiation). I just wanted
  86   >  > something simple to translatte a single page (or a few pages), not
  87   >  > the entire wiki. I'm not even sure it is a good idea to have fully
  88   >  > multilingual wikis, in most cases I would go for a different wiki
  89   >  > for each language. That said, I think it is an interesting idea, so
  90   >  > I'll take a look when I have the time. Thanks for your comments.
  91   >  > --Jordà
  92
  93 * The changes to htmllink in ikiwiki 1.44 broke this plugin.
  94 The following fixes it:
  95
  96         --- linguas.pm.orig     2006-08-23 19:07:04.000000000 +0200
  97         +++ linguas.pm  2007-03-24 01:53:18.000000000 +0100
  98         @@ -100,7 +100,7 @@
  99                         if (exists $linguas{$2} && defined $linguas{$2}) {
 100                                 $link = $linguas{$2}{'name'};
 101                         }
 102         -               push @links, IkiWiki::htmllink($page, $destpage, $trans, 0, 0, $link);
 103         +               push @links, IkiWiki::htmllink($page, $destpage, $trans, noimageinline => 0, forcesubpage => 0, linktext => $link);
 104                 }
 105
 106                 my $otherlinguas = 'Translations:';