Annotation of loncom/localize/lonlocal.pm, revision 1.22
1.1 www 1: # The LearningOnline Network with CAPA
2: # Localization routines
3: #
1.22 ! bowersj2 4: # $Id: lonlocal.pm,v 1.16 2003/09/29 13:24:49 www Exp $
1.1 www 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28: ######################################################################
29: ######################################################################
1.10 bowersj2 30:
31: =pod
32:
33: =head1 NAME
34:
35: Apache::lonlocal - provides localization services
36:
37: =head1 SYNOPSIS
38:
39: lonlocal provides localization services for LON-CAPA programmers based
40: on Locale::Maketext. See
41: C<http://search.cpan.org/dist/Locale-Maketext/lib/Locale/Maketext.pod>
42: for more information on Maketext.
43:
44: =head1 OVERVIEWX<internationalization>
45:
46: As of LON-CAPA 1.1, we've started to localize LON-CAPA using the
47: Locale::Maketext module. Internationalization is the bulk of the work
48: right now (pre-1.1); localizing can be done anytime, and involves
49: little or no programming.
50:
51: The internationalization process involves putting a wrapper around
52: on-screen user messages and menus and turning them into keys,
53: which the MaketextX<Maketext> library translates into the desired
54: language output using a look-up table ("lexicon").X<lexicon>
55:
56: As keys we are currently using the plain English messages, and
57: Maketext is configured to replace the message by its own key if no
58: translation is found. This makes it easy to phase in the
59: internationalization without disturbing the screen output.
60:
61: Internationalization is somewhat tedious and effectively impossible
62: for a non-fluent speaker to perform, but is fairly easy to create
63: translations, requiring no programming skill. As a result, this is one
64: area where you can really help LON-CAPA out, even if you aren't a
65: programmer, and we'd really appreciate it.
66:
67: =head1 How To Localize Handlers For Programmers
68:
69: Into the "use" section of a module, we need to insert
70:
71: use Apache::lonlocal;
72:
73: Note that there are B<no parentheses>, we B<want> to pollute our
74: namespace.
75:
76: Inside might be something like this
77:
78: sub message {
79: my $status=shift;
80: my $message='Status unknown';
81: if ($status eq 'WON') {
82: $message='You have won.';
83: } elsif ($status eq 'LOST') {
84: $message='You are a total looser.';
85: }
86: return $message;
87: }
88: ...
89: $r->print('<h3>Gamble your Homework Points</h3>');
90: ...
91: $r->print(<<ENDMSG);
92: <font size="1">Rules:</font>
93: <font size="0">No purchase necessary. Illegal where not allowed.</font>
94: ENDMSG
95:
96: We have to now wrap the subroutine &mt()X<mt> ("maketext") around our
97: messages, but not around markup, etc. We also want minimal disturbance.
98: The first two examples are easy:
99:
100: sub message {
101: my $status=shift;
102: my $message='Status unknown';
103: if ($status eq 'WON') {
104: $message='You have won.';
105: } elsif ($status eq 'LOST') {
106: $message='You are a total looser.';
107: }
108: return &mt($message);
109: }
110: ...
111: $r->print('<h3>'.&mt('Gamble your Homework Points').'</h3>');
112:
113: The last one is a bummer, since you cannot call subroutines inside of
114: (<<MARKER). I have written a little subroutine to generate a translated
115: hash for that purpose:
116:
117: my %lt=&Apache::lonlocal::texthash('header' => 'Rules', 'disclaimer' =>
118: 'No purchase necessary. Illegal where not allowed.');
119: $r->print(<<ENDMSG);
120: <font size="1">$lt{'header'}:</font>
121: <font size="0">$lt{'disclaimer'}</font>
122: ENDMSG
123:
124: As a programmer, your job is done here. If everything worked, you
125: should see no changes on the screen.
126:
127: =head1 How To Localize LON-CAPA for Translators
128:
129: As a translator, you need to provide the lexicon for the keys, which in
130: this case is the plain text message. The lexicons sit in
131: loncom/localize/localize, with the language code as filename, for
132: example de.pm for the German translation. The file then simply looks
133: like this:
134:
135: 'You have won.'
136: => 'Sie haben gewonnen.',
137:
138: 'You are a total looser.'
139: => 'Sie sind der totale Verlierer.',
140:
141: 'Rules'
142: => 'Regeln',
143:
144: 'No purchase necessary. Illegal where not allowed.'
145: => 'Es ist erlaubt, einfach zu verlieren, und das ist Ihre Schuld.'
146:
147:
148: Comments may be added with the # symbol, which outside of a string
149: (the things with the apostrophe surrounding them, which are the
150: keys and translations) will cause the translation routines to
151: ignore the rest of the line.
152:
153: This is a relatively easy task, and any help is appreciated.
154:
155: Maketext can do a whole lot more, see
156: C<http://search.cpan.org/dist/Locale-Maketext/lib/Locale/Maketext.pod>
157: but for most purposes, we do not have to mess with that.
158:
159: =cut
1.1 www 160:
161: package Apache::lonlocal;
162:
163: use strict;
164: use Apache::localize;
1.3 www 165: use Apache::File;
1.14 www 166: use locale;
167: use POSIX qw(locale_h);
1.1 www 168:
169: require Exporter;
170:
171: our @ISA = qw (Exporter);
1.22 ! bowersj2 172: our @EXPORT = qw(mt mtn ns);
1.1 www 173:
1.4 www 174: my $reroute;
175:
1.1 www 176: # ========================================================= The language handle
177:
178: use vars qw($lh);
179:
180: # ===================================================== The "MakeText" function
181:
182: sub mt (@) {
1.3 www 183: unless ($ENV{'environment.translator'}) {
1.12 albertel 184: if ($lh) {
185: return $lh->maketext(@_);
186: } else {
187: return @_;
188: }
1.3 www 189: } else {
1.12 albertel 190: if ($lh) {
191: my $trans=$lh->maketext(@_);
192: my $link='<a target="trans" href="/cgi-bin/translator.pl?arg1='.
193: &Apache::lonnet::escape($_[0]).'&arg2='.
194: &Apache::lonnet::escape($_[1]).'&arg3='.
195: &Apache::lonnet::escape($_[2]).'&lang='.
196: $ENV{'environment.translator'}.
197: '">[['.$trans.']]</a>';
198: if ($ENV{'transreroute'}) {
199: $reroute.=$link;
200: return $trans;
201: } else {
202: return $link;
203: }
1.4 www 204: } else {
1.12 albertel 205: return @_;
1.4 www 206: }
207: }
208: }
209:
1.6 www 210: # ============================================================== What language?
211:
212: sub current_language {
1.20 albertel 213: if ($lh) {
214: my $lang=$lh->maketext('language_code');
215: return ($lang eq 'language_code'?'en':$lang);
216: }
1.21 www 217: return 'en';
1.6 www 218: }
219:
1.8 www 220: # ============================================================== What encoding?
221:
222: sub current_encoding {
1.12 albertel 223: if ($lh) {
224: my $enc=$lh->maketext('char_encoding');
225: return ($enc eq 'char_encoding'?'':$enc);
226: } else {
227: return undef;
228: }
1.8 www 229: }
230:
1.15 www 231: # =============================================================== Which locale?
232: # Refer to locale -a
233: #
234: sub current_locale {
235: if ($lh) {
236: my $enc=$lh->maketext('lang_locale');
237: return ($enc eq 'lang_locale'?'':$enc);
238: } else {
239: return undef;
240: }
241: }
242:
1.4 www 243: # ============================================================== Translate hash
244:
245: sub texthash {
246: my %hash=@_;
247: foreach (keys %hash) {
248: $hash{$_}=&mt($hash{$_});
249: }
250: return %hash;
251: }
1.5 www 252: # ======================================================== Re-route translation
253:
254: sub clearreroutetrans {
255: &reroutetrans();
256: $reroute='';
257: }
1.4 www 258:
259: # ======================================================== Re-route translation
260:
261: sub reroutetrans {
262: $ENV{'transreroute'}=1;
263: }
1.5 www 264:
1.4 www 265: # ==================================================== End re-route translation
266: sub endreroutetrans {
267: $ENV{'transreroute'}=0;
268: if ($ENV{'environment.translator'}) {
269: return $reroute;
270: } else {
271: return '';
1.3 www 272: }
1.1 www 273: }
274:
275: # ========= Get a handle (do not invoke in vain, leave this to access handlers)
276:
277: sub get_language_handle {
1.9 www 278: my $r=shift;
1.2 www 279: $lh=Apache::localize->get_handle(&Apache::loncommon::preferred_languages);
1.12 albertel 280: if (&Apache::lonnet::mod_perl_version == 1) {
281: $r->content_languages([¤t_language()]);
1.8 www 282: }
1.16 www 283: ### setlocale(LC_ALL,¤t_locale);
1.18 www 284: }
285:
286: # ========================================================== Localize localtime
287:
288: sub locallocaltime {
289: my $thistime=shift;
290: if ((¤t_language=~/^en/) || (!$lh)) {
291: return ''.localtime($thistime);
292: } else {
293: my $format=$lh->maketext('date_locale');
294: if ($format eq 'date_locale') {
295: return ''.localtime($thistime);
296: }
297: my ($seconds,$minutes,$twentyfour,$day,$mon,$year,$wday,$yday,$isdst)=
298: localtime($thistime);
299: my $month=(split(/\,/,$lh->maketext('date_months')))[$mon];
300: my $weekday=(split(/\,/,$lh->maketext('date_days')))[$wday];
301: if ($seconds<10) {
302: $seconds='0'.$seconds;
303: }
304: if ($minutes<10) {
305: $minutes='0'.$minutes;
306: }
307: $year+=1900;
308: my $twelve=$twentyfour;
1.19 www 309: my $ampm;
1.18 www 310: if ($twelve>12) {
311: $twelve-=12;
1.19 www 312: $ampm=$lh->maketext('date_pm');
1.18 www 313: } else {
1.19 www 314: $ampm=$lh->maketext('date_am');
1.18 www 315: }
316: foreach
317: ('seconds','minutes','twentyfour','twelve','day','year',
1.19 www 318: 'month','weekday','ampm') {
1.18 www 319: $format=~s/\$$_/eval('$'.$_)/gse;
320: }
321: return $format;
322: }
1.1 www 323: }
324:
1.17 bowersj2 325: # ==================== Normalize string (reduce fragility in the lexicon files)
326:
327: # This normalizes a string to reduce fragility in the lexicon files of
328: # huge messages (such as are used by the helper), and allow useful
329: # formatting: reduce all consecutive whitespace to a single space,
330: # and remove all HTML
331: sub normalize_string {
332: my $s = shift;
333: $s =~ s/\s+/ /g;
334: $s =~ s/<[^>]+>//g;
1.22 ! bowersj2 335: # Pop off beginning or ending spaces, which aren't good
! 336: $s =~ s/^\s+//;
! 337: $s =~ s/\s+$//;
1.17 bowersj2 338: return $s;
339: }
1.22 ! bowersj2 340:
! 341: # alias for normalize_string; recommend using it only in the lexicon
! 342: sub ns {
! 343: return normalize_string(@_);
! 344: }
! 345:
! 346: # mtn: call the mt function and the normalization function easily.
! 347: # Returns original non-normalized string if there was no translation
! 348: sub mtn (@) {
! 349: my @args = @_; # don't want to modify caller's string; if we
! 350: # didn't care about that we could set $_[0]
! 351: # directly
! 352: $args[0] = normalize_string($args[0]);
! 353: my $translation = &mt(@args);
! 354: if ($translation ne $args[0]) {
! 355: return $translation;
! 356: } else {
! 357: return $_[0];
! 358: }
! 359: }
! 360:
1.1 www 361: 1;
362:
363: __END__
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonlocal.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / localize