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

Set params when using `@text/` (#2254) 

Signed-off-by: Martin <martin.grzeslowski@gmail.com>
pull/2222/head^2
Martin 2024-02-26 07:43:34 +01:00 committed by GitHub
parent 6774910167
commit b936d88c73
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
developers/utils/i18n.md
View File

@ -403,7 +403,7 @@ discovery.darksky.weather-and-forecast.api.local.label = Lokales Wetter und Wett
In addition to the default keys the developer can also specify custom keys inside the XML file.
But with this approach the XML file cannot longer contain the English texts.
So it is mandatory to define a language file for the English language.
The syntax for custom keys is `@text/<key>`.
The syntax for custom keys is `@text/<key> [params]`.
The keys are unique across the whole bundle, so a constant can reference any key in all files inside the `OH-INF/i18n` folder.
The following snippet shows a binding XML that uses custom keys:
@ -428,7 +428,7 @@ addon.acmeweather.description = Binding for ACME Weather
# thing status descriptions
offline.communication-error = The ACME Weather API is currently not available.
offline.communication-error = The ACME Weather API is currently not available. Error {0}
```
Language file (`acmeweather_de.properties`):
@ -441,13 +441,13 @@ addon.acmeweather.description = Binding für ACME Wetter
# thing status descriptions
offline.communication-error = Die ACME Wetter API ist zur Zeit nicht verfügbar.
offline.communication-error = Die ACME Wetter API ist zur Zeit nicht verfügbar. Fehler {0}
```
The custom keys are a very good practice to translate bundle dependent error messages.
```java
updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.OFFLINE.COMMUNICATION_ERROR, "@text/offline.communication-error");
updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.OFFLINE.COMMUNICATION_ERROR, "@text/offline.communication-error [\"EX-500\"]");
```
## Generating I18N properties file