DokuWiki

It's better when it's simple

User Tools

Site Tools


localization

This is an old revision of the document!


Localizing DokuWiki (the engine)

DokuWiki's user interface can be configured to use any language by setting the appropriate option in the config.

A list of available interface translations is available at the DokuWiki Localization Hub.

To translate DokuWiki to your own language, visit http://translate.dokuwiki.org/, choose or add your language and use the web based translation editor to create a new or updated language pack.

Some easy to fix translation bugs are shown after running a few translation checks.

If you did a translation or improved an existing one, just send it to andi [at] splitbrain [dot] org and it will be included in the next release.

Translators should join the I18N Mailing List to be informed when new strings are added and need to be translated.

Localizing the plugins and templates

Most of the plugins and templates only provide localizations for English and one other language. If you would like to contribute missing localizations in any language, feel free to do it. It doesn't matter if you only would like translate a few sentences. Each tiny new strings will improve the plugin.

The following short How-to describes how you can create the needed files and where to save them.

  • Copy the content of lib/plugins/<pluginname>/lang/en/ to
    lib/plugins/<pluginname>/lang/<ISO-code>/ and translate the language in your wanted one. Similar for templates.
  • The are several ways to provide your translation files (sorted in favorite order)
    1. Push it via Github Pull Request to the Code Repository
      (not available for every plugin)
    2. Insert your translation content to the appropriate plugin page
      (create a section “Localization” if it's not there)
    3. Contact the plugin author via mail
      (Watch if there's any response. If not, please use another way to submit your translated content.)
    4. Send an e-mail to the i18n Mailinglist

For any further questions or general help you could send a mail to the I18N-Mailinglist or ask for help in the IRC-Channel.

Changing localized texts in your installation

Available since “Rincewind RC1” 2011-04-22

There are many localized texts in DokuWiki like emails that are sent on registration, password forgotten, the text above the edit form, …

You can change these texts by copying these files:

  • from inc/lang/<ISO-code>/<name>.txt
    to conf/lang/<ISO-code>/<name>.txt and editing the copied file.

This way your changes aren't overwritten on upgrades. You can do the same thing for plugins and templates(e.g. the help text for permissions in the ACL editor) by copying the files:

  • from lib/plugins/<plugin>/lang/<ISO-code>/<name>.txt
    to conf/plugin_lang/<plugin>/<ISO-code>/<name>.txt
  • from lib/tpl/<template>/lang/<ISO-code>/<name>.txt
    to conf/template_lang/<template>/<ISO-code>/<name>.txt

and changing them there.

:!: This method cannot be used for lang.php. If you need to change any text there you are recommended to add a “new” language folder and copy the files from language of your choice.

Translating DokuWiki.org (the documentation)

Translating the DokuWiki documentation here at dokuwiki.org is encouraged. Translated pages are to be named like their English counterparts and stored in a separate namespace based on their ISO code. To make this easier the translation plugin adds links to existing and missing translations in the upper right corner of every page.

Only languages manually configured by the administrator are shown in the selector. If you want to add translations for a language currently not shown, just manually create the pages in the appropriate language subnamespace and send a mail to the I18N mailing list asking for your language to be added.

Translation Guidelines

  • Feel free to create any missing translation
  • Only pages in the top namespace should be translated
  • Translated pages need to have the same (English) name as the original page
  • Translated pages have to be stored in a sub namespace of the root namespace named by the ISO language code
  • Please don't add stubs saying the page does not exist, yet.
  • Please refrain from cluttering translations with credit lines – if you want to be recognized as translator, log in first
  • A good starting point for translations is the manual
  • You may also want to translate the sidebar to your language

Disabling translation feature for certain pages

Where translation is not sensible the ~~NOTRANS~~ macro should be inserted into the page.

See also

localization.1376016084.txt.gz · Last modified: 2013-08-09 04:41 by ara

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki