NAME

MKDoc::Language - Language class for the MKDoc framework

SUMMARY

The list of languages supported by MKDoc is defined in two config files.

These two config files are loaded from (by order of preference):

$ENV{SITE_DIR}/Language/

$ENV{MKDOC_DIR}/Language/

@INC/Language/languages/

The two file are the following:

languages.conf - All the languages to support, including those from right to left

languages_rtl.conf - Just the languages which are written from right to left

Methods / API

$class->new ($iso_code);

Instantiates a new MKDoc::Language object for $iso_code.

Returns undef if $iso_code is not defined in the languages.conf file.

$self->code();

Returns the iso code of a given language object, e.g:

  my $lang = new MKDoc::Language ('en');
  print $lang->code(); # should print 'en'

$self->label();

Returns the label associated with a given language object, e.g:

  my $lang = new MKDoc::Language ('en');
  print $lang->label(); # should print 'English'

$thing->code_list()

Returns a list of ISO codes of all languages, sorted by the Unicode value of their associated label.

$self->align();

In order to do proper multilingual HTML formatting, you need to have a sensible value for the XHTML align="left|right" attribute.

If the language is written left to right, this method returns 'left'.

If the language is written right to left, this method returns 'right'.

$self->align_opposite();

In order to do proper multilingual HTML formatting, you need to have a sensible value for the XHTML align="left|right" attribute.

This method does the exact opposite as $self->align(), i.e.

If the language is written left to right, this method returns 'right'.

If the language is written right to left, this method returns 'left'.

$self->dir()

In order to do proper multilingual HTML formatting, you need to have a sensible value for the XHTML dir="ltr|rtl" attribute.

If the language is written left to right, this method returns 'ltr'.

If the language is written right to left, this method returns 'rtl'.

AUTHOR

Copyright 2003 - MKDoc Holdings Ltd.

Author: Jean-Michel Hiver <jhiver@mkdoc.com>

This module is free software and is distributed under the same license as Perl itself. Use it at your own risk.

SEE ALSO

  Petal: http://search.cpan.org/author/JHIVER/Petal/
  MKDoc: http://www.mkdoc.com/

Help us open-source MKDoc. Join the mkdoc-modules mailing list:

  mkdoc-modules@lists.webarch.co.uk

cpanm MKDoc

perl -MCPAN -e shell
install MKDoc