Return to lonlocal.pm CVS log

Up to [LON-CAPA] / loncom / localize

Minoru had a better idea on how to show translators where material appears
on the screen.

    1: # The LearningOnline Network with CAPA
    2: # Localization routines
    3: #
    4: # $Id: lonlocal.pm,v 1.26 2003/11/07 23:22:22 www Exp $
    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: ######################################################################
   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
  160: 
  161: package Apache::lonlocal;
  162: 
  163: use strict;
  164: use Apache::localize;
  165: use Apache::File;
  166: use locale;
  167: use POSIX qw(locale_h);
  168: 
  169: require Exporter;
  170: 
  171: our @ISA = qw (Exporter);
  172: our @EXPORT = qw(mt mtn ns);
  173: 
  174: # ========================================================= The language handle
  175: 
  176: use vars qw($lh);
  177: 
  178: # ===================================================== The "MakeText" function
  179: 
  180: sub mt (@) {
  181: #    my $fh=Apache::File->new('>>/home/www/loncapa/loncom/localize/localize/newphrases.txt');
  182: #    print $fh @_[0]."\n";
  183: #    $fh->close();
  184:     if ($lh) {
  185: 	return $lh->maketext(@_);
  186:     } else {
  187: 	return @_;
  188:     }
  189: }
  190: 
  191: # ============================================================== What language?
  192: 
  193: sub current_language {
  194:     if ($lh) {
  195: 	my $lang=$lh->maketext('language_code');
  196: 	return ($lang eq 'language_code'?'en':$lang);
  197:     }
  198:     return 'en';
  199: }
  200: 
  201: # ============================================================== What encoding?
  202: 
  203: sub current_encoding {
  204:     if ($lh) {
  205: 	my $enc=$lh->maketext('char_encoding');
  206: 	return ($enc eq 'char_encoding'?'':$enc);
  207:     } else {
  208: 	return undef;
  209:     }
  210: }
  211: 
  212: # =============================================================== Which locale?
  213: # Refer to locale -a
  214: #
  215: sub current_locale {
  216:     if ($lh) {
  217: 	my $enc=$lh->maketext('lang_locale');
  218: 	return ($enc eq 'lang_locale'?'':$enc);
  219:     } else {
  220: 	return undef;
  221:     }
  222: }
  223: 
  224: # ============================================================== Translate hash
  225: 
  226: sub texthash {
  227:     my %hash=@_;
  228:     foreach (keys %hash) {
  229: 	$hash{$_}=&mt($hash{$_});
  230:     }
  231:     return %hash;
  232: }
  233: 
  234: # ========= Get a handle (do not invoke in vain, leave this to access handlers)
  235: 
  236: sub get_language_handle {
  237:     my $r=shift;
  238:     $lh=Apache::localize->get_handle(&Apache::loncommon::preferred_languages);
  239:     if (&Apache::lonnet::mod_perl_version == 1) {
  240: 	$r->content_languages([&current_language()]);
  241:     }
  242: ###    setlocale(LC_ALL,&current_locale);
  243: }
  244: 
  245: # ========================================================== Localize localtime
  246: 
  247: sub locallocaltime {
  248:     my $thistime=shift;
  249:     if ((&current_language=~/^en/) || (!$lh)) {
  250: 	return ''.localtime($thistime);
  251:     } else {
  252: 	my $format=$lh->maketext('date_locale');
  253: 	if ($format eq 'date_locale') {
  254: 	    return ''.localtime($thistime);
  255: 	}
  256: 	my ($seconds,$minutes,$twentyfour,$day,$mon,$year,$wday,$yday,$isdst)=
  257: 	    localtime($thistime);
  258: 	my $month=(split(/\,/,$lh->maketext('date_months')))[$mon];
  259: 	my $weekday=(split(/\,/,$lh->maketext('date_days')))[$wday];
  260: 	if ($seconds<10) {
  261: 	    $seconds='0'.$seconds;
  262: 	}
  263: 	if ($minutes<10) {
  264: 	    $minutes='0'.$minutes;
  265: 	}
  266: 	$year+=1900;
  267: 	my $twelve=$twentyfour;
  268: 	my $ampm;
  269: 	if ($twelve>12) {
  270: 	    $twelve-=12;
  271: 	    $ampm=$lh->maketext('date_pm');
  272: 	} else {
  273: 	    $ampm=$lh->maketext('date_am');
  274: 	}
  275: 	foreach 
  276: 	('seconds','minutes','twentyfour','twelve','day','year',
  277: 	 'month','weekday','ampm') {
  278: 	    $format=~s/\$$_/eval('$'.$_)/gse;
  279: 	}
  280: 	return $format;
  281:     }
  282: }
  283: 
  284: # ==================== Normalize string (reduce fragility in the lexicon files)
  285: 
  286: # This normalizes a string to reduce fragility in the lexicon files of
  287: # huge messages (such as are used by the helper), and allow useful
  288: # formatting: reduce all consecutive whitespace to a single space,
  289: # and remove all HTML
  290: sub normalize_string {
  291:     my $s = shift;
  292:     $s =~ s/\s+/ /g;
  293:     $s =~ s/<[^>]+>//g;
  294:     # Pop off beginning or ending spaces, which aren't good
  295:     $s =~ s/^\s+//;
  296:     $s =~ s/\s+$//;
  297:     return $s;
  298: }
  299: 
  300: # alias for normalize_string; recommend using it only in the lexicon
  301: sub ns {
  302:     return normalize_string(@_);
  303: }
  304: 
  305: # mtn: call the mt function and the normalization function easily.
  306: # Returns original non-normalized string if there was no translation
  307: sub mtn (@) {
  308:     my @args = @_; # don't want to modify caller's string; if we
  309: 		   # didn't care about that we could set $_[0]
  310: 		   # directly
  311:     $args[0] = normalize_string($args[0]);
  312:     my $translation = &mt(@args);
  313:     if ($translation ne $args[0]) {
  314: 	return $translation;
  315:     } else {
  316: 	return $_[0];
  317:     }
  318: }
  319: 
  320: 1;
  321: 
  322: __END__