JavaScript-Bibliothek common/i18n

Diese Bibliothek bietet Funktionen zum Übersetzen von Texten.

Verwendung

---

Binden Sie die Bibliothek stets am Anfang eines Skripts ein:

let i18n = require('common/i18n');

Funktionen

---

translate

Übersetzt einen Textschlüssel in die jeweilige Sprache des Benutzers.

i18n.translate('agorum.module.sample.Description')

Beispiel

let i18n = require('common/i18n');
let text = i18n.translate('agorum.module.sample.Description');

Rückgabewert

Sie erhalten einen String:

'Eine Beschreibung'

Für das Definieren von zu übersetzenden Textschlüsseln siehe Metadaten-Bezeichnungen im agorum core smart assistant übersetzen.

tryTranslate

Übersetzt einen String, sofern er einen Textschlüssel mit Präfix _ enthält und gibt ansonsten den String unverändert zurück.

i18n.tryTranslate('_agorum.module.sample.Description')

Beispiel

let i18n = require('common/i18n');

[
  i18n.tryTranslate('_agorum.module.sample.Description'),
  i18n.tryTranslate('no text key'),
];

Rückgabewert

Sie erhalten ein Array:

[ 'Eine Beschreibung', 'no text key' ]

Für das Definieren von zu übersetzenden Textschlüsseln siehe Metadaten-Bezeichnungen im agorum core smart assistant übersetzen.

loadPropertyFileContent

Liest das übergebene Objekt als Property-Content aus und decodiert den Text von ASCII in den Unicode-Zeichensatz.

• Verwenden Sie die Funktion, um den Inhalt einer Property-Datei zu lesen.
• Wenn Sie keine Property-Datei übergeben, erhalten Sie null.

Beispiel

let text = i18n.loadPropertyFile(object);

Rückgabewert

Sie erhalten den Text mit allen Sonderzeichen (menschenlesbar):

"agorum.comp.msg=Bitte wählen Sie.."

savePropertyFileContent

Speichert den Content einer Property-Datei im richtigen Zeichensatz ab und encodiert den Text von Unicode in den ASCII-Zeichensatz.

Verwenden Sie diese Funktion, um den Inhalt einer Property-Datei zu schreiben.

Beispiel

i18n.savePropertyFileContent(object, text);

Rückgabewert

Sie erhalten einen booleschen Wert je nach Erfolg:

true
false

isPropertyFile

Prüft, ob das übergebene Objekt eine Property-Datei ist.

Beispiel

let object = objects.find(9999);
i18n.isPropertyFile(object);

Rückgabewert

Sie erhalten einen String:

'Datei ist ein Property File';