resp
[ikiwiki.git] / doc / todo / language_definition_for_the_meta_plugin.mdwn
1 Here is a patch for the [[plugins/meta]] plugin. It adds the possibility to define the language 
2 used for a page, with
3     [[meta lang="ja"]]
4
5 It doesn't insert the langage information in the xhtml meta elements, but defines a LANG
6 variable to use in the templates, for example with
7
8     <html xmlns="http://www.w3.org/1999/xhtml"
9           lang="<TMPL_IF NAME="LANG"><TMPL_VAR LANG><TMPL_ELSE>fr</TMPL_IF>"
10           xml:lang="<TMPL_IF NAME="LANG"><TMPL_VAR LANG><TMPL_ELSE>fr</TMPL_IF>">
11
12 This way also allows to define a language for a subset of the final page, with custom
13 templates and inclusion. 
14
15 This may be useful for sites with a few pages in different languages, but no full i18n.
16
17 > Looks good, but the need to modify the template and include a default
18 > language in it is a bit problimatic, I think. --[[Joey]]
19
20 >> --lang=XX could be a setup option, with a default value, then the template would be 
21
22                 <html xmlns="http://www.w3.org/1999/xhtml" lang="<TMPL_VAR LANG>" xml:lang="<TMPL_VAR LANG>">
23
24 >>> Yes, that seems reasonable. I guess there's no problem with defaulting
25 >>> to en if it can be overridden in the setup. --[[Joey]]
26
27 <pre>
28 --- meta.orig.pm  2007-07-27 00:19:51.000000000 +0200
29 +++ meta.pm       2007-08-05 22:37:40.000000000 +0200
30 @@ -11,6 +11,7 @@
31  my %permalink;
32  my %author;
33  my %authorurl;
34 +my %lang;
35  
36  sub import { #{{{
37         hook(type => "preprocess", id => "meta", call => \&preprocess, scan => 1);
38 @@ -100,6 +101,11 @@
39                 $meta{$page}.='<link href="'.encode_entities($value).
40                         "\" rel=\"openid.delegate\" />\n";
41         }
42 +       elsif ($key eq 'lang') {
43 +           if ($value =~ /^[A-Za-z]{2}$/) {
44 +               $lang{$page}=$value;
45 +           }
46 +       }
47         else {
48                 $meta{$page}.=scrub("<meta name=\"".encode_entities($key).
49                         "\" content=\"".encode_entities($value)."\" />\n");
50 @@ -131,6 +137,8 @@
51                 if exists $author{$page} && $template->query(name => "author");
52         $template->param(authorurl => $authorurl{$page})
53                 if exists $authorurl{$page} && $template->query(name => "authorurl");
54 +       $template->param(lang => $lang{$page})
55 +               if exists $lang{$page} && $template->query(name => "lang");
56  
57  } # }}}
58 </pre>
59
60
61 [[tag wishlist patch plugin/meta translation]]