Commit b042b35a authored by mrodzis's avatar mrodzis 🐸
Browse files

Add English docs for multilanguage module

parent 353d8811
# Mehrsprachigkeit
# Multilingual
Dieses Modul ermöglicht mehrsprachige Inhalte. Standardmäßig ist Deutsch als Default- und Englisch als Alternativsprache eingestellt.
This module enables multilingual content. By default, German is set as the default/main language and English as an alternative.
## Konfiguration des Moduls
Die Konfiguration für dieses Modul befindet sich in der `config.xml`.
Dort muss unter dem Modul `multilanguage` im Parameter `lang.enabled` "true" stehen und im Parameter `lang.default` eine Defaultsprache (bzw. das entsprechende Sprachenkürzel) angegeben werden. Unter dem Parameter `lang.alt` können beliebig viele weitere Sprachen hinzugefügt werden. Diese müssen mit einem Semikolon getrennt werden. Im folgenden Beispiel sind die Sprachen Deutsch, Englisch und Französisch konfiguriert:
The module works with the GET parameter "lang" which is automatically attached to internal links. This module is compatible with the module "Confluence Wiki". To display language-specific content in Confluence, please use Confluence's own macros (e.g. German, English, ...).
## Configuration
Open `config.xml` to change configuration.
There, check out the module `multilanguage`.
The parameter `lang.enabled` must be set to 'true' to enable this module.
If enabled, the parameter `lang.default` must contain a default language (or the corresponding language abbreviation).
An unlimited number of additional languages can be added to `lang.alt`; These languages must be separated by a semicolon.
The following example configures the languages German (default), English and French (alternatives):
```xml
<module key="multilanguage">
......@@ -13,8 +19,9 @@ Dort muss unter dem Modul `multilanguage` im Parameter `lang.enabled` "true" ste
<param key="lang.alt" description="a semicolon seperated list of alternative languages">en;fr</param>
</module>
```
If you want to use the built-in HTML Language Switcher, you have to configure language names for each language code:
Für jede Sprache muss in der `lang.xml` unter dem key="Language" das Sprachenkürzel und der Sprachenname in der entsprechenden Sprache vorhanden sein. Per Default sind folgende Sprachen schon eingetragen:
Open `lang.xml` and go to key="Language". The default configuration looks like this:
```xml
<word key="Language">
......@@ -24,25 +31,29 @@ Für jede Sprache muss in der `lang.xml` unter dem key="Language" das Sprachenk
</word>
```
## Benutzung
In der Navigationsleiste `navigation.xml` muss für jede zusätzlich zu der Defaultsprache konfigurierten Sprache ein Label erstellt werden. Beispiel für Deutsch als Defaultsprache und Englisch als Zweitsprache:
## Usage
If you want to use the built-in navigation bar, you have to open `navigation.xml` and configure one label for each language.
The following example applies to German as the default language and English as the alternative language:
```xml
<submenu label="Weiterführende Links" label-en="Further Links">
<submenu label="Projektbeschreibung" label-en="project description">
```
Um einzelne Wörter, wie Überschriften, auf HTML-Seiten sprachenspezifisch anzeigen zu lassen, benutzen Sie `div`- oder `span`-Elemente mit dem Parameter `data-template="lang:translate"` und einem selbstgewählten `data-template-content`-Parameter. Beispiel:
To display individual words, such as headings, in different languages use `div` or `span` elements, set
the parameter `data-template="lang:translate"` and choose a new `data-template-content` parameter. Example:
```html
<span data-template="lang:translate" data-template-content="Publications"/>
<span data-template="lang:translate" data-template-content="Search"/>
```
Dieser `data-template-content` Parameter muss einzigartig sein und zusätzlich in der `lang.xml` erstellt werden.
Folgendes Beispiel zeigt die Übersetzungen für das Wort "Publications" in Deutsch, Englisch und Französisch:
This `data-template-content` parameter must be unique and added to file `lang.xml`.
The following example shows the translations for the word "Search" in German, English and French:
```xml
<word key="Publications">
<lang key="de">Publikationen</lang>
<lang key="en">Publications</lang>
<lang key="fr">Publications</lang>
<word key="Search">
<lang key="de">Suche</lang>
<lang key="en">Search</lang>
<lang key="fr">Recherche</lang>
</word>
```
## Funktionsweise
Das Modul funktioniert mit dem GET-Parameter "lang". Dieser wird an interne Links automatisch angehängt. Dieses Modul ist kompatibel mit dem Modul Confluence Wiki. Um sprachenspezifische Inhalte aus dem Wiki darzustellen, nutzen Sie bitte die Confluence eigenen Makros (z.B. German, English, ...).
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment