--- loncom/localize/lonlocal.pm 2003/09/16 19:23:47 1.2 +++ loncom/localize/lonlocal.pm 2003/09/22 18:16:43 1.10 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Localization routines # -# $Id: lonlocal.pm,v 1.2 2003/09/16 19:23:47 www Exp $ +# $Id: lonlocal.pm,v 1.10 2003/09/22 18:16:43 bowersj2 Exp $ # # Copyright Michigan State University Board of Trustees # @@ -28,16 +28,154 @@ ###################################################################### ###################################################################### +=pod + +=head1 NAME + +Apache::lonlocal - provides localization services + +=head1 SYNOPSIS + +lonlocal provides localization services for LON-CAPA programmers based +on Locale::Maketext. See +C +for more information on Maketext. + +=head1 OVERVIEWX + +As of LON-CAPA 1.1, we've started to localize LON-CAPA using the +Locale::Maketext module. Internationalization is the bulk of the work +right now (pre-1.1); localizing can be done anytime, and involves +little or no programming. + +The internationalization process involves putting a wrapper around +on-screen user messages and menus and turning them into keys, +which the MaketextX library translates into the desired +language output using a look-up table ("lexicon").X + +As keys we are currently using the plain English messages, and +Maketext is configured to replace the message by its own key if no +translation is found. This makes it easy to phase in the +internationalization without disturbing the screen output. + +Internationalization is somewhat tedious and effectively impossible +for a non-fluent speaker to perform, but is fairly easy to create +translations, requiring no programming skill. As a result, this is one +area where you can really help LON-CAPA out, even if you aren't a +programmer, and we'd really appreciate it. + +=head1 How To Localize Handlers For Programmers + +Into the "use" section of a module, we need to insert + + use Apache::lonlocal; + +Note that there are B, we B to pollute our +namespace. + +Inside might be something like this + + sub message { + my $status=shift; + my $message='Status unknown'; + if ($status eq 'WON') { + $message='You have won.'; + } elsif ($status eq 'LOST') { + $message='You are a total looser.'; + } + return $message; + } + ... + $r->print('

Gamble your Homework Points

'); + ... + $r->print(<Rules: + No purchase necessary. Illegal where not allowed. + ENDMSG + +We have to now wrap the subroutine &mt()X ("maketext") around our +messages, but not around markup, etc. We also want minimal disturbance. +The first two examples are easy: + + sub message { + my $status=shift; + my $message='Status unknown'; + if ($status eq 'WON') { + $message='You have won.'; + } elsif ($status eq 'LOST') { + $message='You are a total looser.'; + } + return &mt($message); + } + ... + $r->print('

'.&mt('Gamble your Homework Points').'

'); + +The last one is a bummer, since you cannot call subroutines inside of +(< 'Rules', 'disclaimer' => + 'No purchase necessary. Illegal where not allowed.'); + $r->print(<$lt{'header'}: + $lt{'disclaimer'} + ENDMSG + +As a programmer, your job is done here. If everything worked, you +should see no changes on the screen. + +=head1 How To Localize LON-CAPA for Translators + +As a translator, you need to provide the lexicon for the keys, which in +this case is the plain text message. The lexicons sit in +loncom/localize/localize, with the language code as filename, for +example de.pm for the German translation. The file then simply looks +like this: + + 'You have won.' + => 'Sie haben gewonnen.', + + 'You are a total looser.' + => 'Sie sind der totale Verlierer.', + + 'Rules' + => 'Regeln', + + 'No purchase necessary. Illegal where not allowed.' + => 'Es ist erlaubt, einfach zu verlieren, und das ist Ihre Schuld.' + +The German translation lexicon is in pretty okay shape, but not +complete yet. Portuguese currently only covers the login screen. +Russian is purely experimental. Looks like UTF-8 is the way to encode +this, at least for latin/greek-based languages, but we still have to +learn a lot. + +Comments may be added with the # symbol, which outside of a string +(the things with the apostrophe surrounding them, which are the +keys and translations) will cause the translation routines to +ignore the rest of the line. + +This is a relatively easy task, and any help is appreciated. + +Maketext can do a whole lot more, see +C +but for most purposes, we do not have to mess with that. + +=cut + package Apache::lonlocal; use strict; use Apache::localize; +use Apache::File; require Exporter; our @ISA = qw (Exporter); our @EXPORT = qw(mt); +my $reroute; + # ========================================================= The language handle use vars qw($lh); @@ -45,13 +183,80 @@ use vars qw($lh); # ===================================================== The "MakeText" function sub mt (@) { - return $lh->maketext(@_); + unless ($ENV{'environment.translator'}) { + return $lh->maketext(@_); + } else { + my $trans=$lh->maketext(@_); + my $link='[['.$trans.']]'; + if ($ENV{'transreroute'}) { + $reroute.=$link; + return $trans; + } else { + return $link; + } + } +} + +# ============================================================== What language? + +sub current_language { + return $lh->language_tag(); +} + +# ============================================================== What encoding? + +sub current_encoding { + my $enc=$lh->maketext('char_encoding'); + return ($enc eq 'char_encoding'?'':$enc); +} + +# ============================================================== Translate hash + +sub texthash { + my %hash=@_; + foreach (keys %hash) { + $hash{$_}=&mt($hash{$_}); + } + return %hash; +} +# ======================================================== Re-route translation + +sub clearreroutetrans { + &reroutetrans(); + $reroute=''; +} + +# ======================================================== Re-route translation + +sub reroutetrans { + $ENV{'transreroute'}=1; +} + +# ==================================================== End re-route translation +sub endreroutetrans { + $ENV{'transreroute'}=0; + if ($ENV{'environment.translator'}) { + return $reroute; + } else { + return ''; + } } # ========= Get a handle (do not invoke in vain, leave this to access handlers) sub get_language_handle { + my $r=shift; $lh=Apache::localize->get_handle(&Apache::loncommon::preferred_languages); + $r->content_languages(["¤t_language()"]); + my $enc=¤t_encoding(); + if ($enc) { + + } } 1;