About VirtualGL Developer Info
Library Related Projects |
Internationalizations
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 The rest of this page is devoted to the installation, configuration and usage of other language(s) support. If you are looking for tools and help to localize PmWiki in your language, or how you can improve the existing translations, start on pmwiki.org with the page Localization? - The Translation Portal. Loading Translation PagesPages for many other languages have already been created and maintained at the pmichaud.com site. You can download an archive of these translations from https://www.pmwiki.org/pub/pmwiki/i18n/. Simply download the appropriate language archive(s), and unpack the archive(s) into the directory containing your Once the translation pages are installed, you enable a language by adding a call to include_once("scripts/xlpage-utf-8.php"); # optional XLPage('fr','PmWikiFr.XLPage'); which says to load the translations for French ('fr') from the page PmWikiFr.XLPage?. The include_once line is recommended if you start a new wiki, and it should be placed before the XLPage line (for languages with alphabets other than the Latin, the It's possible to load multiple pages; so if you want to create your own local translations without changing the ones you got from an i18n archive, just create another page (see below) and load it first. Be sure that you load first the page with your local changes: 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 Wiki Groups as language selectors, you may want to place this code in local customizations files (see Group Customizations). 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 <?php if (!defined('PmWiki')) exit(); ##change to French language XLPage('fr','PmWikiFr.XLPage'); You may wish to create a page called An alternative to the above would be to add to $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. Another way (advanced) would be insert into $lang = substr($_SERVER['HTTP_ACCEPT_LANGUAGE'], 0, 2); switch ($lang){ case "es": XLPage('es','PmWikiEs.XLPage'); break; case "en": XLPage('en','PmWikiEn.XLPage'); break; default: XLPage('en','PmWikiEn.XLPage'); break; } See also Creating New TranslationsIf 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 'Search' => 'Rechercher',
converts " If you create new versions of PmWiki pages in other languages, please consider adding them to the main PmWiki site so that they can be made available to others in the i18n archives! (Be sure to check out The Localization Portal? for further information on effectively internationalizing PmWiki.) 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.
Enabling "Special" Characters in WikiLinksTo enable "special" characters like for example German umlauts in WikiLinks, it is necessary to configure the server locale to ensure that PmWiki uses the proper character set definition. If this is not possible due to limited access to the server configuration, PmWiki can be configured to use a specific locale by using the XLPage options (see XLPageTemplate?). For German umlauts, you'd need for example:
Note that the locale identifier depends on the operation system and perhaps on the specific installation. Notes If my wiki is internationalized by Use If my wiki is in English and I want just one page, or group, in Spanish do I say Yes, that is usually the best method. If you were doing this with many scattered pages, or with several languages, you might find it easier to maintain if you load the translations all in XLPage('es','PmWikiEs.XLPage'); XLPage('fr','PmWikiFr.XLPage'); XLPage('ru','PmWikiRu.XLPage'); $XLLangs = array('en'); Then in each group or page configuration file, you'd just use What does the first parameter of this function stand for? How can it be used? The XLPage mechanism allows multiple sets of translations to be loaded, and the first parameter is used to distinguish them. For example, suppose I want to have translations for both normal French and "Canadian" French. Rather than maintain two entirely separate sets of pages, I could do: XLPage('fr-ca', 'PmWikiFrCa.XLPage'); XLPage('fr', 'PmWikiFr.XLPage'); PmWikiFr.XLPage would contain all of the standard French translations, while PmWikiFrCA.XLPage would only need to contain "Canada-specific" translations -- i.e., those that are different from the ones in the French page. The first parameter distinguishes the two sets of translations.
In addition, a
and PmWiki will use only the 'fr' and 'en' translations (in that order), no matter how many translations have been loaded with XLPage(). How can I add a translation for an individual string in a PHP file? Use the XLSDV() function to provide a translation for a specific (English) string. For instance, with this in XLSDV('nl', array('my English expression'=>'mijn Nederlandse uitdrukking'));
any instance of the variable expression If you need to get a translation in a PHP file, use the $local_string = XL("my English expression");
But beware:
This page may have a more recent version on pmwiki.org: PmWiki:Internationalizations, and a talk page: PmWiki:Internationalizations-Talk. |
All content on this web site is licensed under the Creative Commons Attribution 2.5 License. Any works containing material derived from this web site must cite The VirtualGL Project as the source of the material and list the current URL for the VirtualGL web site. |