Localization

This article explains how to customize the localization of the wiki article pages.

Overview

By default the article pages are localized in English^[1]

The localization concerns texts which are automatically generated by the tool, such as in the menus for example. Of course the content of the articles can be in any language

. However it is possible to change the localization in the configuration file.

There are two ways to specify the localization:

• By specifying a built-in language name for the "localization" property
• By specifying the path to a property file which will contain the texts localization

Supported built-in language names

The built-in supported language names are:

• "en": English
• "fr": French
• "de": German
• "es": Spanish
• "it": Italian
• "ru": Russian

To specify a built-in language, just set the language name for the property in the configuration file. For example:

   localization=de

Custom localization

To specify a custom localization, set the path for a properties File containing the texts localizations^[2]

This property file will be relative to the configuration property file

. For example:

   localization=localization.properties

Custom localization properties

The names of the properties in the custom localization properties file are the identifiers for the texts used in the tool. These tags are:

• "home": The name for accessing the Home page
• "dictionnary" : The name for accessing the Dictionary page
• "categories": The name for accessing the Categories page
• "glossary": The name for accessing the Glossary page
• "category": The name for each Category
• "fallback": The title for fallback articles
• "about": The name for the "The article is about" text (the article meta)
• "for": The "For" text for the For ..., see text in the articles header
• "see": The "see" text for the For ..., see text in the articles header
• "linksFrom": The What links here text for the menu which presents for each article the articles which link to this article
• "mainArticle": The "Main Article" text for the moreInfo element
• "notes": The name for the Notes chapter
• "seealso": The name for the See Also chapter
• "disambText": The name for the presentation of Disambiguation articles, used in the Dictionary and Categories
• "disambCat": The name of the disambiguation category
• "disambPres": The text for a disambiguation article presentation
• "searchResults": The text for the full text search results
• "containing": The prompt text for the full text search results
• "from": The prompt text for the "from" field for TODOs
• "reason": The prompt text for the "reason" field for TODOs

Specific PDF generation localization properties

• "introduction": The title of the introduction chapter. This chapter will only contain the Home page content
• "notes": The title of the notes chapter. This chapter will contain the notes and citations
• "toc": The title of the Table of contents chapter
• "miscellanous": The title of the chapter containing articles which fit in none other chapters

Usage for properties

The "locale" and "language" properties allow to get the locale and the language used by the wiki.