locale.module 7.65 KB
Newer Older
Dries's avatar
   
Dries committed
1
<?php
Dries's avatar
 
Dries committed
2

Dries's avatar
   
Dries committed
3
function locale_help() {
Dries's avatar
   
Dries committed
4
5
 ?>
  <P>Normally programs are written and documented in English, and use English to interact with users.  This is true for a great deal of websites.  However, most people are less comfortable with English than with their own native language, and would prefer to use their mother tongue as much as possible.  Many people love see their website showing a lot less of English, and far more of their own language.</P>
Dries's avatar
CHANGES    
Dries committed
6
  <P>Therefore drupal provides a framework to setup a multi-lingual website, or to overwrite the default texts in English.  We explored the various alternatives to support internationalization and decided to design the framework in such a way that the impact of internationalization on drupal's sources is minimized, modular and that it doesn't require a HTML or PHP wizard to maintain translations.  Maintaining translations had to be simple so it became as easy as filling out forms on the administration page.  A side effect is that translation support adds significant overhead to the dynamic generation of your website.  If you don't need translation support, consider to turning it off from the "conf" section.</P>
Dries's avatar
   
Dries committed
7

Dries's avatar
   
Dries committed
8
9
10
11
12
13
14
15
16
17
18
  <H3>How to translate texts</H3>

  <P>The actual translation starts at the "overview" of the locale page of the administration pages.  To allow a user to maintain the translations, he obviously needs access to the locale module.  See the account documentation for more information on roles and permissions.</P>
  <P>At the locale page, users with the proper access rights will see the various texts that need translation on the left column of the table.</P>
  <P>Below the text you can see an URI where this text shows up one your site.  Changes are most of these texts will be used and displayed on more than one page, though only one example URI is presented.</P>
  <P>The second column displays the supported languages as defined in the configuration file.  See below for more information on how to support new languages.  If the symbol for a language is seen like <strike>this</strike>, it means that this entry still needs to be translated into that language.  If not, it has been translated already.</P>
  <P>To add or change a translation click the "edit locale" link in the third column, the "operations" column.  You'll be presented the original text and fields for translation in the supported languages.  Enter the translations and confirm by clicking the "Save translations" button.  The translations need not be accurate; they are for your site so you can choose what to show to your users.</P>
  <P>To delete a translation, click the "delete locale" link at the overview page and the translation will be immediately deleted without confirmation.  Deleting translations is convenient for removing texts that belonged to an obsolete module.</P>
  <P>In some texts special strings such as "%a" and "%b" show up.  Those get replaced by some string at run-time when Drupal dynamically generate pages.  You can find out which string this is by looking at the page where the text appears.  This is where the above mentioned URI can come in handy.</P>

  <H3>How to add new languages</H3>
Dries's avatar
   
Dries committed
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

  <P>Adding a new language requires you to edit your configuration file and to edit your SQL database.  Assuming you want to support Dutch (ISO 639 code: "nl") and French (ISO 639 code: "fr"), you add the following line to your configuration file's <CODE>$languages</CODE>-variable:</P>
  <PRE>
    $languages = array("nl" => "Dutch / Nederlands", "fr" => "French / Francais");
  </PRE>
  <P>Note that the default language must come first and that if you want to overwrite the default text you can add an entry for English (ISO 639 code: "en"):</P>
  <PRE>
    $languages = array("en" => "English", "nl" => "Dutch / Nederlands", "fr" => "French / Francais");
  </PRE>
  <P>After having edited your configuration file, make sure your SQL table "locales" has the required database fields setup to host your new translations.  You can add the required rows to your "locales" table from the MySQL prompt:</P>
  <PRE>
    mysql> ALTER TABLE locales ADD en TEXT DEFAULT '' NOT NULL;
    mysql> ALTER TABLE locales ADD nl TEXT DEFAULT '' NOT NULL;
    mysql> ALTER TABLE locales ADD fr TEXT DEFAULT '' NOT NULL;
  </PRE>
Dries's avatar
   
Dries committed
34
 <?php
Dries's avatar
   
Dries committed
35
36
}

Dries's avatar
   
Dries committed
37
38
39
40
function locale_perm() {
  return array("add and edit locales");
}

Dries's avatar
CHANGES    
Dries committed
41
function locale_conf_options() {
Dries's avatar
   
Dries committed
42
  return form_select(t("Locale support"), "locale", variable_get("locale", 0), array("Disabled", "Enabled"), t("Disable locale support if your site does not require translation or internationalization support."));
Dries's avatar
CHANGES    
Dries committed
43
44
}

Dries's avatar
   
Dries committed
45
46
47
48
49
50
51
52
53
54
55
function locale_delete($id) {
  db_query("DELETE FROM locales WHERE id = '$id'");
}

function locale_save($id, $edit) {
  foreach ($edit as $key=>$value) {
    db_query("UPDATE locales SET $key = '". check_input($value) ."' WHERE id = '$id'");
  }
}

function locale_edit($id) {
Dries's avatar
   
Dries committed
56
57
  global $languages, $REQUEST_URI;

Dries's avatar
   
Dries committed
58
59
  $result = db_query("SELECT * FROM locales WHERE id = '$id'");
  if ($translation = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
60
61
62
63
64
65
    $form .= form_item(t("Original text"), "<PRE>". wordwrap(check_output($translation->string)) ."</PRE>");
    foreach ($languages as $code=>$language) $form .= (strlen($translation->string) > 30) ? form_textarea($language, $code, $translation->$code, 50, 10) : form_textfield($language, $code, $translation->$code, 50, 128);
    $form .= form_hidden("id", $id);
    $form .= form_submit("Save translations");

    return form($REQUEST_URI, $form);
Dries's avatar
   
Dries committed
66
67
68
69
  }
}

function locale_languages($translation) {
70
71
72
73
74
75
  global $languages, $na;
  if (count($languages)) {
    foreach ($languages as $key=>$value) {
      $output .= ($translation->$key) ? "$key " : "<STRIKE>$key</STRIKE> ";
    }
    return $output;
Dries's avatar
   
Dries committed
76
  }
77
  return $na;
Dries's avatar
   
Dries committed
78
79
}

Dries's avatar
   
Dries committed
80
function locale_overview() {
81
82
  if (variable_get("locale", 0)) {
    $result = db_query("SELECT * FROM locales ORDER BY string");
Dries's avatar
   
Dries committed
83

84
85
86
87
    $output .= "<TABLE BORDER=\"1\" CELLPADDING=\"2\" CELLSPACING=\"2\">\n";
    $output .= " <TR><TH>string</TH><TH>languages</TH><TH COLSPAN=\"2\">operations</TH><TR>\n";
    while ($locale = db_fetch_object($result)) {
      $languages = locale_languages($locale);
Dries's avatar
   
Dries committed
88
      $output .= " <TR><TD>". check_output($locale->string) ."<BR><SMALL><I>$locale->location</I></SMALL></TD><TD ALIGN=\"center\">$languages</TD><TD NOWRAP><A HREF=\"admin.php?mod=locale&op=edit&id=$locale->id\">edit locale</A></TD><TD NOWRAP><A HREF=\"admin.php?mod=locale&op=delete&id=$locale->id\">delete locale</A></TD></TR>";
89
90
    }
    $output .= "</TABLE>\n";
Dries's avatar
   
Dries committed
91

92
    return $output;
Dries's avatar
 
Dries committed
93
  }
Dries's avatar
   
Dries committed
94
95
96
  else {
    return status("locale disabled.");
  }
Dries's avatar
 
Dries committed
97
98
}

Dries's avatar
   
Dries committed
99
function locale_admin() {
Dries's avatar
   
Dries committed
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
  global $user, $id, $edit, $op;

  if (user_access($user, "add and edit locales")) {
    print "<SMALL><A HREF=\"admin.php?mod=locale\">overview</A> | <A HREF=\"admin.php?mod=locale&op=help\">help</A></SMALL><HR>\n";

    switch ($op) {
      case "delete":
        print status(locale_delete(check_input($id)));
        print locale_overview();
        break;
      case "help":
        print locale_help();
        break;
      case "edit":
        print locale_edit(check_input($id));
        break;
      case "Save translations":
        print locale_save(check_input($id), $edit);
        // fall through
      default:
        print locale_overview();
    }
  }
  else {
    print message_access();
Dries's avatar
   
Dries committed
125
126
127
128
129
  }
}

function locale($string) {
  global $locale;
Dries's avatar
   
Dries committed
130
  if (variable_get("locale", 0)) {
Dries's avatar
Dries committed
131
132
133
134
    $result = db_query("SELECT id, $locale FROM locales WHERE STRCMP(string, '". addslashes($string) ."') = 0");
    if ($translation = db_fetch_object($result)) $string = ($translation->$locale) ? check_output($translation->$locale) : $string;
    else db_query("INSERT INTO locales (string, location) VALUES ('". addslashes($string) ."', '". check_input(getenv("REQUEST_URI")) ."')");
  }
Dries's avatar
   
Dries committed
135
136
137
  return $string;
}

Dries's avatar
   
Dries committed
138
?>