CGI::FormMagick::L10N - localization routines for FormMagick

SYNOPSIS

use CGI::FormMagick::L10N;

DESCRIPTION

L10N (Localisation) is the name given to the process of providing translations into another language. The previous step to this is I18N (internationalisation) which is the process of making an application ready to accept the translations.

We've done the work of I18N for you, so all you have to do is provide translations for your apps.

FormMagick uses the Locale::Maketext module for L10N. It stores its translations for each language in a hash like this:

%Lexicon = (
  "Hello"     => "Bonjour",
  "Click here"    => "Appuyez ici"
);

You can add your own entries to any language lexicon using the add_lexicon() method (see CGI::FormMagick for how to call that method).

Localisation preferences are picked up from the HTTP_ACCEPT_LANGUAGE environment variable passed by the user's browser. In Netscape, you set this by choosing "Edit, Preferences, Navigator, Languages" and then choosing your preferred language.

Localisation is performed on:

• Form titles

• Page titles and descriptions

• Field labels and descriptions

• Validation error messages

If you wish to localise other textual information such as your HTML Templates, you will have to explicitly call the l10n routines.

USER METHODS

add_lexicon($lang, $lexicon_hashref)

This method is deprecated and will be removed in CGI::FormMagick 0.60 in favour of an XML-based lexicon.

DEVELOPER METHODS

These routines are for internal use only, and are probably not of interest to anyone except FormMagick developers.

localise($string)

Translates a string into the end-user's preferred language by checking their HTTP_ACCEPT_LANG variable and pushing it through Locale::Maketext

WARNING WARNING WARNING: The internals of this routine will change significantly in version 0.60, when we remove Locale::Maketext from the equation. However, its output should still be the same. Just FYI.

check_l10n()

print out lexicons to check whether they're what you think they are this is mostly for debugging purposes. If you have DEBUG set to 1 in your call to the new() method, you'll see a link at the bottom of each page that says "Check L10N". This is the subroutine that's called when you follow that link.

SEE ALSO

The general documentation for FormMagick (perldoc CGI::FormMagick)

More information about FormMagick may be found at http://sourceforge.net/projects/formmagick/