====== UI Language Plugin ======

---- plugin ----
description: Changes the user interface language to match the language of the current page
author     : Viktor Söderqvist
email      : viktor@zuiderkwast.se
type       : Action
lastupdate : 2017-11-23
compatible : Rincewind
depends    : 
conflicts  : 
similar    : translation
tags       : language

downloadurl: https://github.com/zuiderkwast/dokuwiki-plugin-uilanguage/zipball/master
bugtracker : https://github.com/zuiderkwast/dokuwiki-plugin-uilanguage/issues
sourcerepo : https://github.com/zuiderkwast/dokuwiki-plugin-uilanguage/
donationurl: 

screenshot_img : 
----

This plugin changes the wiki's user-interface language to match the language of the current page.

The following methods are used to find out which language to use:

  - Metadata ''language'', if set.
  - The namespace, if it is a valid language code.
  - The browser's prefered language.

The plugin handles the case when the language has been changed to a RTL language. In this case, RTL CSS is loaded instead of the "normal" (non-RTL) CSS.

If you are using the [[plugin:translate|translate plugin]], this plugin is useful.

If you are using the [[plugin:translation|translation plugin]] (another plugin with a similar name) you don't need this plugin. That plugin has this behaviour built-in (except it doesn't use metadata for language).

===== Installation =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

===== Examples/Usage =====

If you have pages in multiple languages, there are two ways you can make the user-interface appear in the correct language:

  * You can use a language code as a namespace and use pagenames such as ''de:hallo''.
  * You can use set the ''language'' metadata on the page. Metadata can be set using the [[plugin:meta|meta plugin]].

If you use the [[plugin:translate|translate]] plugin, it sets the ''language'' metadata, so in this case you don't have to do anything.

If the language cannot be detected, the browser's prefered language will be used.

===== Development =====

=== Change Log ===

{{rss>https://github.com/zuiderkwast/dokuwiki-plugin-uilanguage/commits/master.atom date author}}

This plugin has been used in production since 2009-08-16.

=== Known Bugs and Issues ===

None.

=== ToDo/Wish List ===

  * Add a configuration setting to turn on/off setting the language by browser language.
  * Verify compatibility with the latest version of DokuWiki.
  * Ability to have different 'Navigation', 'Tool' and 'Site_notice' pages for each detecting language. 
===== Discussion =====