Nik Clayton > SVN-Web-0.53 > SVN::Web::I18N

Download:
SVN-Web-0.53.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  5
Open  6
View/Report Bugs
Module Version: 0.53   Source   Latest Release: SVN-Web-0.63

NAME ^

SVN::Web::I18N - SVN::Web internationalisation class

SYNOPSIS ^

  use SVN::Web::I18N;                    # Nothing exported

  # Add a directory that contains .po and/or .mo files
  SVN::Web::I18N::add_directory('/path/to/directory');

  # Specify the current language
  SVN::Web::I18N::loc_lang('en');

  # Get a translated string
  my $xlated = SVN::Web::I18N::loc('(a string to translate)');

DESCRIPTION ^

SVN::Web::I18N provides the interface through which SVN::Web is internationalised, and how different localisations are implemented.

SUBROUTINES ^

SVN::Web::I18N::add_directory($path)

Adds a new directory to the list of directories in which localisations will be found. Any *.po and *.mo files in this directory will automatically be scanned for localisations, and added to the language key given by the file's basename.

In case where two different directories both contain a localisation file that defines the same localisation key for the same language, the localisation key from the most recently added directory will be used.

SVN::Web::I18N::loc_lang($lang)

Selects the language to use for subsequent calls to loc(). The $lang parameter should be a valid language name -- i.e., there must exist at least one $lang.po file in one of the directories used in a call to SVN::Web::I18N::add_directory().

SVN::Web::I18N::loc($text)

and

SVN::Web::I18N::loc($text, $param1, ...)

Returns the localised form of $text according to the localisation selected by the most recent call to loc_lang().

If the localisation expects parameters to fill in the localisation result they should be passed as the second and subsequent arguments.

If $text does not have a defined localised form it is returned with the parameters interpolated in to it.

SEE ALSO ^

Locale::Maketext, Locale::Maketext::Lexicon, SVN::Web

AUTHORS ^

Nik Clayton <nik@FreeBSD.org>

COPYRIGHT ^

Copyright 2006-2007 by Nik Clayton <nik@FreeBSD.org>.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See http://www.perl.com/perl/misc/Artistic.html

syntax highlighting: