OpenHAB
/
openhab-docs
mirror of https://github.com/openhab/openhab-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update example for I18N custom keys (#2117) 

Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>
pull/2128/head
Jacob Laursen 2023-08-21 14:10:22 +02:00 committed by GitHub
parent 0d67c5c2ec
commit bdb37078aa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
developers/utils/i18n.md
View File

@ -408,29 +408,40 @@ The keys are unique across the whole bundle, so a constant can reference any key
The following snippet shows a binding XML that uses custom keys:
XML file (`binding.xml`):
XML file (`addon.xml`):
```xml
<binding:binding id="acmeweather">
<name>@text/bindingName</name>
<description>@text/bindingName</description>
</binding:binding>
<addon:addon id="acmeweather">
<type>binding</type>
<name>@text/addon.acmeweather.name</name>
<description>@text/addon.acmeweather.description</description>
</addon:addon>
```
Language file (`acmeweather_en.properties`):
```ini
bindingName = ACME Weather Binding
# add-on
offline.communication-error=The ACME Weather API is currently not available.
addon.acmeweather.name = ACME Weather Binding
addon.acmeweather.description = Binding for ACME Weather
# thing status descriptions
offline.communication-error = The ACME Weather API is currently not available.
```
Language file (`acmeweather_de.properties`):
```ini
bindingName = ACME Wetter Binding
# add-on
offline.communication-error=Die ACME Wetter API ist zur Zeit nicht verfügbar.
addon.acmeweather.name = ACME Wetter Binding
addon.acmeweather.description = Binding für ACME Wetter
# thing status descriptions
offline.communication-error = Die ACME Wetter API ist zur Zeit nicht verfügbar.
```
The custom keys are a very good practice to translate bundle dependent error messages.