PmWiki supports internationalization (internationalisation) of web pages, allowing accented characters to appear in page names and almost complete customization of PmWiki's prompts.  Most customization is provided via the `XLPage() function in PmWiki, which loads a set of translation variables from a wiki page (typically named `XLPage, but it can be named anything you wish).


!!Loading Translation Pages

Pages for many languages such as French, German, Dutch, and Spanish have already been created and maintained at the pmichaud.com site.  You can download an archive of these translations from http://www.pmichaud.com/pub/pmwiki/i18n.tgz.  Simply unpack the archive into the directory containing your ''pmwiki.php'' installation.  The archive contains a number of page files that are placed in your wikilib.d/ directory, and some special scripts for translations that use a character set other than iso-8859-1 (PmWiki's default).

Once the translation pages are installed, you enable a language by adding a call to `XLPage() in your ''config.php'' file.  For example, to select French language prompts, one would specify

->[@XLPage('fr','PmWikiFr.XLPage');@]

which says to load the translations for French ('fr') from the page `PmWikiFr.XLPage.  It's perfectly okay to load multiple pages; so if you want to create your own local translations without changing the ones you got from ''i18n.tgz'', just create another page (see below) and load it on top. Be sure that you load first the page with your local chances:

-> [@
XLPage('fr','PmWikiFr.XLPageLocal');  # my local translations
XLPage('fr','PmWikiFr.XLPage');       # from i18n.tgz
@]

If your intention is to offer multiple languages on your site, and use [[WikiGroup]]s as language selectors, you may want to place this code in local customizations files (see [[PerGroupCustomizations]]). For example, if your site is published in French and English, and the French pages are in a group called Fr, you could create a file named Fr.php in the local/ directory which contains:

-> [@
<?php if (!defined('PmWiki')) exit();
##change to French language
XLPage('fr','PmWikiFr.XLPage');
@]

You may wish to create a page called `PmwikiFr.php with the same content to access the French documentation in the `PmwikiFr group.
En.php is not necessary in this case since English is the default language.

An alternative to the above would be to add to config.php the following, which tests if there is an `XLPage in a group, and if it finds one it gets loaded:

-> [@    
$xlpage = FmtPageName('$Group.XLPage', $pagename);
if (PageExists($xlpage)) XLPage($xlpage, $xlpage);
@]

With this method you would need to copy any relevant `XLPage into any group which needs the different language support.


!!Creating New Translations

If language pages don't exist for your desired language, it's easy to create one!  An `XLPage translation file simply contains lines of the form

->[@'phrase' => 'translated phrase',@]

where "phrase" is an internationalized phrase (denoted by @@$[...]@@) in PmWiki's $...Fmt variables, and "translated phrase" is what should be printed in your particular language.  For example, the line (in [@PmWikiFr.XLPage@])

->[@'SearchWiki' => 'Rechercher',@]

converts "`SearchWiki" to "Rechercher" on output.  The file PmWiki:XLPageTemplate is a good starting point for creating a new `XLPage and has most of PmWiki's key phrases already listed in it.  Note that the translation mechanism only converts phrases that have been listed as translatable in $...Fmt strings--it won't translate things that appear in wiki markup.

If you create new versions of PmWiki pages in other languages, please consider adding them to the [[PmWiki:PmWiki | main PmWiki site]] so that they can be made available to others in the ''i18n.tgz'' archive!

->%note% The term "i18n" is commonly used as an abbreviation for the English word "internationalization".  The abbreviation is derived from the fact that there are 18 letters between the "i" and the final "n" and few people want to type them all out.


!!Tools for PmWiki Localization

You can help to localize PmWiki in your language in the original site:

* [[PmWiki:Localization]]

%trail% <<|[[DocumentationIndex]]|>>

>>faq<< [[#faq]]

Q: If my wiki is internationalized by [@config.php@], how do I revert a specific group to English?

A: Use [@$XLLangs = array('en');@] in the [@group.php@] configuration file.