chrome.i18n

Beschreibung

Mit der chrome.i18n-Infrastruktur können Sie die Internationalisierung in Ihrer gesamten App oder Erweiterung implementieren.

Alle für Nutzer sichtbaren Strings müssen in einer Datei mit dem Namen messages.json enthalten sein. Jedes Mal, wenn Sie ein neues Gebietsschema hinzufügen, fügen Sie eine Datei mit Nachrichten in einem Verzeichnis mit dem Namen _locales/_localeCode_ hinzu. Dabei ist localeCode ein Code wie en für Englisch.

Hier ist die Dateihierarchie für eine internationalisierte Erweiterung, die Englisch (en), Spanisch (es) und Koreanisch (ko) unterstützt:

Im Erweiterungsverzeichnis: manifest.json, *.html, *.js, _locales-Verzeichnis. Im Verzeichnis „_locales“: die Verzeichnisse „en“, „es“ und „ko“, jeweils mit einer Datei „messages.json“.

Mehrere Sprachen unterstützen

Angenommen, Sie haben eine Erweiterung mit den in der folgenden Abbildung gezeigten Dateien:

Eine manifest.json-Datei und eine Datei mit JavaScript. Die JSON-Datei enthält

Um diese Erweiterung zu internationalisieren, benennen Sie jeden für Nutzer sichtbaren String und fügen ihn in eine Datei mit Nachrichten ein. Im Manifest, in den CSS-Dateien und im JavaScript-Code der Erweiterung wird der Name der einzelnen Strings verwendet, um die lokalisierte Version abzurufen.

So sieht die Erweiterung aus, wenn sie internationalisiert wird (beachten Sie, dass sie weiterhin nur englische Strings enthält):

<img "__msg_extname__",="" "default_locale"="" "en".="" "extname"."="" "hello="" _locales="" a="" alt="In the manifest.json file, " and="" been="" changed="" chrome.i18n.getmessage("extname").="" defines="" en="" file="" file,="" has="" hello="" in="" item="" javascript="" messages.json="" named="" new="" src="/static/images/i18n-after-1.gif" the="" to="" value="" world"="" />

Einige Hinweise zur Internationalisierung:

  • Sie können alle unterstützten Gebietsschemas verwenden. Wenn Sie ein nicht unterstütztes Gebietsschema verwenden, wird es von Google Chrome ignoriert.
  • In manifest.json- und CSS-Dateien verweisen Sie so auf einen String namens messagename:

    __MSG_messagename__
    
  • Verweisen Sie im JavaScript-Code Ihrer Erweiterung oder App so auf einen String namens messagename:

    chrome.i18n.getMessage("messagename")
    
  • Bei jedem Aufruf von getMessage() können Sie bis zu neun Strings angeben, die in die Nachricht aufgenommen werden sollen. Weitere Informationen finden Sie unter Beispiele: getMessage.

  • Einige Meldungen, z. B. @@bidi_dir und @@ui_locale, werden vom Internationalisierungssystem bereitgestellt. Eine vollständige Liste der Namen vordefinierter Nachrichten finden Sie im Abschnitt Vordefinierte Nachrichten.

  • In messages.json hat jeder für Nutzer sichtbare String einen Namen, ein „message“-Element und ein optionales „description“-Element. Der Name ist ein Schlüssel wie „extName“ oder „search_string“, der den String identifiziert. Mit „message“ wird der Wert des Strings in dieser Sprache angegeben. Die optionale „description“ (Beschreibung) kann Übersetzern helfen, die möglicherweise nicht sehen können, wie der String in Ihrer Erweiterung verwendet wird. Beispiel:

    {
      "search_string": {
        "message": "hello%20world",
        "description": "The string we search for. Put %20 between words that go together."
      },
      ...
    }
    

    Weitere Informationen finden Sie unter Formate: Länderspezifische Nachrichten.

Nachdem eine Erweiterung oder App internationalisiert wurde, ist die Übersetzung ganz einfach. Sie kopieren messages.json, übersetzen die Kopie und legen sie in einem neuen Verzeichnis unter _locales ab. Wenn Sie beispielsweise Spanisch unterstützen möchten, legen Sie einfach eine übersetzte Kopie von messages.json unter _locales/es ab. Die folgende Abbildung zeigt die bisherige Erweiterung mit einer neuen spanischen Übersetzung.

Das sieht genauso aus wie im vorherigen Bild, aber mit einer neuen Datei unter _locales/es/messages.json, die eine spanische Übersetzung der Nachrichten enthält.

Vordefinierte Nachrichten

Das Internationalisierungssystem bietet einige vordefinierte Meldungen, die Ihnen bei der Lokalisierung helfen. Dazu gehört @@ui_locale, mit dem Sie das aktuelle UI-Gebietsschema erkennen können, sowie einige @@bidi_...-Nachrichten, mit denen Sie die Textrichtung erkennen können. Letztere haben ähnliche Namen wie Konstanten in der Gadgets BIDI (bi-directional) API.

Die spezielle Nachricht @@extension_id kann in den CSS- und JavaScript-Dateien verwendet werden, unabhängig davon, ob die Erweiterung oder App lokalisiert ist. Diese Nachricht funktioniert nicht in Manifestdateien.

In der folgenden Tabelle werden die einzelnen vordefinierten Nachrichten beschrieben.

Name der NachrichtBeschreibung
@@extension_idDie ID der Erweiterung oder App. Mit diesem String können Sie URLs für Ressourcen innerhalb der Erweiterung erstellen. Auch nicht lokalisierte Erweiterungen können diese Nachricht verwenden.
Hinweis:Sie können diese Nachricht nicht in einer Manifestdatei verwenden.
@@ui_localeDas aktuelle Gebietsschema. Sie können diesen String verwenden, um gebietsschemaspezifische URLs zu erstellen.
@@bidi_dirDie Textrichtung für das aktuelle Gebietsschema, entweder „ltr“ für linksläufige Sprachen wie Englisch oder „rtl“ für rechtsläufige Sprachen wie Japanisch.
@@bidi_reversed_dirWenn @@bidi_dir „ltr“ ist, ist dies „rtl“, andernfalls „ltr“.
@@bidi_start_edgeWenn @@bidi_dir „ltr“ ist, ist dies „left“ (links), andernfalls „right“ (rechts).
@@bidi_end_edgeWenn @@bidi_dir „ltr“ ist, ist dies „right“ (rechts), andernfalls „left“ (links).

Hier sehen Sie ein Beispiel für die Verwendung von @@extension_id in einer CSS-Datei zum Erstellen einer URL:

body {
  background-image:url('chrome-extension://__MSG_@@extension_id__/background.png');
}

Wenn die Erweiterungs-ID abcdefghijklmnopqrstuvwxyzabcdef ist, wird die fett formatierte Zeile im vorherigen Code-Snippet so geändert:

  background-image:url('chrome-extension://abcdefghijklmnopqrstuvwxyzabcdef/background.png');

Hier sehen Sie ein Beispiel für die Verwendung von @@bidi_*-Nachrichten in einer CSS-Datei:

body {
  direction: __MSG_@@bidi_dir__;
}

div#header {
  margin-bottom: 1.05em;
  overflow: hidden;
  padding-bottom: 1.5em;
  padding-__MSG_@@bidi_start_edge__: 0;
  padding-__MSG_@@bidi_end_edge__: 1.5em;
  position: relative;
}

Bei links-nach-rechts-Sprachen wie Deutsch werden die fett gedruckten Zeilen so dargestellt:

  dir: ltr;
  padding-left: 0;
  padding-right: 1.5em;

Sprachen

Sie können aus vielen Gebietsschemas auswählen, darunter einige (z. B. en), mit denen eine einzelne Übersetzung mehrere Varianten einer Sprache (z. B. en_GB und en_US) unterstützen kann.

Unterstützte Gebietsschemen

Sie können jede Sprache verwenden, die vom Chrome Web Store unterstützt wird.

Suchen von Nachrichten

Sie müssen nicht jeden String für jede unterstützte Sprache definieren. Solange die messages.json-Datei des Standardsprachengebiets einen Wert für jeden String enthält, wird Ihre Erweiterung oder App unabhängig davon ausgeführt, wie spärlich eine Übersetzung ist. So sucht das Erweiterungssystem nach einer Nachricht:

  1. Suchen Sie in der Datei mit Nachrichten (falls vorhanden) nach der bevorzugten Sprache des Nutzers. Wenn die Sprache von Google Chrome beispielsweise auf Britisches Englisch (en_GB) eingestellt ist, sucht das System zuerst nach der Meldung in _locales/en_GB/messages.json. Wenn diese Datei vorhanden ist und die Nachricht darin enthalten ist, wird nicht weiter gesucht.
  2. Wenn der bevorzugte Sprachcode des Nutzers eine Region enthält (d. h. der Sprachcode hat einen Unterstrich: _), suchen Sie nach dem Sprachcode ohne diese Region. Wenn beispielsweise die Datei en_GB nicht vorhanden ist oder die Nachricht nicht enthält, sucht das System in der Datei en. Wenn diese Datei vorhanden ist und die Meldung angezeigt wird, wird nicht weiter gesucht.
  3. Suchen Sie in der Datei mit den Nachrichten nach dem Standardsprache. Wenn beispielsweise „default_locale“ der Erweiterung auf „es“ festgelegt ist und weder _locales/en_GB/messages.json noch _locales/en/messages.json die Nachricht enthält, wird die Nachricht aus _locales/es/messages.json verwendet.

In der folgenden Abbildung ist die Nachricht mit dem Namen „colores“ in allen drei von der Erweiterung unterstützten Sprachen enthalten, „extName“ jedoch nur in zwei. Wenn ein Nutzer, der Google Chrome auf US-Englisch verwendet, das Label „Colors“ sieht, wird einem Nutzer, der Google Chrome auf Britisch-Englisch verwendet, „Colours“ angezeigt. Sowohl Nutzer, die US-Englisch als Sprache eingestellt haben, als auch Nutzer, die Britisches Englisch als Sprache eingestellt haben, sehen den Namen der Erweiterung „Hello World“. Da die Standardsprache Spanisch ist, sehen Nutzer, die Google Chrome in einer anderen Sprache als Englisch verwenden, das Label „Colores“ und den Namen der Erweiterung „Hola mundo“.

Vier Dateien: manifest.json und drei messages.json-Dateien (für es, en und en_GB).  Die Dateien „es“ und „en“ enthalten Einträge für Nachrichten mit dem Namen

Sprache des Browsers festlegen

Wenn Sie Übersetzungen testen möchten, können Sie die Sprache Ihres Browsers festlegen. In diesem Abschnitt erfahren Sie, wie Sie das Gebietsschema in Windows, Mac OS X, Linux und ChromeOS festlegen.

Windows

Sie können das Gebietsschema entweder über eine gebietsschemaspezifische Tastenkombination oder über die Google Chrome-Benutzeroberfläche ändern. Die Verknüpfungsmethode ist schneller, sobald Sie sie eingerichtet haben, und ermöglicht es Ihnen, mehrere Sprachen gleichzeitig zu verwenden.

Länderspezifische Tastenkombination verwenden

So erstellen und verwenden Sie eine Verknüpfung, mit der Google Chrome mit einem bestimmten Gebietsschema gestartet wird:

  1. Erstellen Sie eine Kopie der Google Chrome-Verknüpfung, die sich bereits auf Ihrem Desktop befindet.
  2. Benennen Sie die neue Verknüpfung entsprechend dem neuen Gebietsschema um.
  3. Ändern Sie die Eigenschaften der Verknüpfung so, dass im Feld „Ziel“ die Flags --lang und --user-data-dir angegeben sind. Das Ziel sollte in etwa so aussehen:

    path_to_chrome.exe --lang=locale --user-data-dir=c:\locale_profile_dir
    
  4. Starten Sie Google Chrome, indem Sie auf die Verknüpfung doppelklicken.

Wenn Sie beispielsweise eine Verknüpfung erstellen möchten, mit der Google Chrome auf Spanisch (es) gestartet wird, können Sie eine Verknüpfung mit dem Namen chrome-es erstellen, die das folgende Ziel hat:

path_to_chrome.exe --lang=es --user-data-dir=c:\chrome-profile-es

Sie können beliebig viele Verknüpfungen erstellen, um das Testen in mehreren Sprachen zu vereinfachen. Beispiel:

path_to_chrome.exe --lang=en --user-data-dir=c:\chrome-profile-en
path_to_chrome.exe --lang=en_GB --user-data-dir=c:\chrome-profile-en_GB
path_to_chrome.exe --lang=ko --user-data-dir=c:\chrome-profile-ko
Benutzeroberfläche verwenden

So ändern Sie das Gebietsschema über die Benutzeroberfläche in Google Chrome für Windows:

  1. App-Symbol > Optionen
  2. Wählen Sie den Tab Under the Hood aus.
  3. Scrollen Sie nach unten zu Webinhalte.
  4. Klicken Sie auf Schriftart- und Spracheinstellungen ändern.
  5. Wählen Sie den Tab Sprachen aus.
  6. Legen Sie im Drop-down-Menü die Google Chrome-Sprache fest.
  7. Chrome neu starten

Mac OS X

Wenn Sie das Gebietsschema auf einem Mac ändern möchten, verwenden Sie die Systemeinstellungen.

  1. Wählen Sie im Apple-Menü die Systemeinstellungen aus.
  2. Wählen Sie im Bereich Persönlich die Option International aus.
  3. Sprache und Standort auswählen
  4. Chrome neu starten

Linux

Wenn Sie das Gebietsschema unter Linux ändern möchten, beenden Sie zuerst Google Chrome. Legen Sie dann in einer Zeile die Umgebungsvariable LANGUAGE fest und starten Sie Google Chrome. Beispiel:

LANGUAGE=es ./chrome

ChromeOS

So ändern Sie das Gebietsschema in ChromeOS:

  1. Wählen Sie in der Taskleiste Einstellungen aus.
  2. Wählen Sie im Abschnitt Sprachen und Eingabe das Drop-down-Menü Sprache aus.
  3. Wenn Ihre Sprache nicht aufgeführt ist, klicken Sie auf Sprachen hinzufügen und fügen Sie sie hinzu.
  4. Klicken Sie nach dem Hinzufügen neben Ihrer Sprache auf das Dreipunkt-Menü Weitere Aktionen und wählen Sie ChromeOS in dieser Sprache anzeigen aus.
  5. Klicken Sie auf die Schaltfläche Neu starten, die neben der eingestellten Sprache angezeigt wird, um ChromeOS neu zu starten.

Beispiele

Einfache Beispiele für die Internationalisierung finden Sie im Verzeichnis examples/api/i18n. Ein vollständiges Beispiel finden Sie unter examples/extensions/news. Weitere Beispiele und Hilfe beim Anzeigen des Quellcodes finden Sie unter Beispiele.

Beispiele: getMessage

Der folgende Code ruft eine lokalisierte Nachricht vom Browser ab und zeigt sie als String an. Dabei werden zwei Platzhalter in der Nachricht durch die Strings „string1“ und „string2“ ersetzt.

function getMessage() {
  var message = chrome.i18n.getMessage("click_here", ["string1", "string2"]);
  document.getElementById("languageSpan").innerHTML = message;
}

So stellen Sie einen einzelnen String bereit und verwenden ihn:

  // In JavaScript code
  status.innerText = chrome.i18n.getMessage("error", errorDetails);
"error": {
  "message": "Error: $details$",
  "description": "Generic error template. Expects error parameter to be passed in.",
  "placeholders": {
    "details": {
      "content": "$1",
      "example": "Failed to fetch RSS feed."
    }
  }
}

Weitere Informationen zu Platzhaltern finden Sie auf der Seite Länderspezifische Nachrichten. Weitere Informationen zum Aufrufen von getMessage() finden Sie in der API-Referenz.

Beispiel: getAcceptLanguages

Mit dem folgenden Code werden die Accept-Languages aus dem Browser abgerufen und als String angezeigt, wobei die einzelnen Accept-Languages durch „,“ getrennt werden.

function getAcceptLanguages() {
  chrome.i18n.getAcceptLanguages(function(languageList) {
    var languages = languageList.join(",");
    document.getElementById("languageSpan").innerHTML = languages;
  })
}

Weitere Informationen zum Aufrufen von getAcceptLanguages() finden Sie in der API-Referenz.

Beispiel: detectLanguage

Der folgende Code erkennt bis zu drei Sprachen aus dem angegebenen String und zeigt das Ergebnis als durch Zeilenumbrüche getrennte Strings an.

function detectLanguage(inputText) {
  chrome.i18n.detectLanguage(inputText, function(result) {
    var outputLang = "Detected Language: ";
    var outputPercent = "Language Percentage: ";
    for(i = 0; i < result.languages.length; i++) {
      outputLang += result.languages[i].language + " ";
      outputPercent +=result.languages[i].percentage + " ";
    }
    document.getElementById("languageSpan").innerHTML = outputLang + "\n" + outputPercent + "\nReliable: " + result.isReliable;
  });
}

Weitere Informationen zum Aufrufen von detectLanguage(inputText) finden Sie in der API-Referenz.

Typen

LanguageCode

Chrome 47 und höher

Ein ISO-Sprachcode wie en oder fr. Eine vollständige Liste der von dieser Methode unterstützten Sprachen finden Sie unter kLanguageInfoTable. Bei einer unbekannten Sprache wird und zurückgegeben. Das bedeutet, dass [percentage] des Textes für CLD unbekannt sind.

Typ

String

Methoden

detectLanguage()

Promise Chrome 47 und höher
chrome.i18n.detectLanguage(
  text: string,
  callback?: function,
)
: Promise<object>

Erkennt die Sprache des bereitgestellten Textes mithilfe von CLD.

Parameter

  • Text

    String

    Vom Nutzer eingegebener String, der übersetzt werden soll.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus:

    (result: object) => void

    • Ergebnis

      Objekt

      „LanguageDetectionResult“-Objekt, das die Zuverlässigkeit der erkannten Sprache und ein Array von „DetectedLanguage“ enthält.

      • isReliable

        boolean

        Zuverlässigkeit der von CLD erkannten Sprache

      • Sprachen

        object[]

        Array von detectedLanguage

        • Sprache

          String

        • Prozentsatz

          Zahl

          Der Prozentsatz der erkannten Sprache

Ausgabe

  • Promise<object>

    Chrome 99 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

getAcceptLanguages()

Promise
chrome.i18n.getAcceptLanguages(
  callback?: function,
)
: Promise<LanguageCode[]>

Ruft die Accept-Languages des Browsers ab. Dies unterscheidet sich von der vom Browser verwendeten Sprache. Verwenden Sie i18n.getUILanguage, um die Sprache abzurufen.

Parameter

  • callback

    Funktion optional

    Der Parameter callback sieht so aus:

    (languages: string[]) => void

    • Sprachen

      String[]

      Array von LanguageCode

Ausgabe

  • Promise<LanguageCode[]>

    Chrome 99 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

getMessage()

chrome.i18n.getMessage(
  messageName: string,
  substitutions?: any,
  options?: object,
)
: string

Ruft den lokalisierten String für die angegebene Nachricht ab. Wenn die Nachricht fehlt, gibt diese Methode einen leeren String ('') zurück. Wenn das Format des getMessage()-Aufrufs falsch ist, z. B. wenn messageName kein String ist oder das Array substitutions mehr als 9 Elemente enthält, gibt diese Methode undefined zurück.

Parameter

  • messageName

    String

    Der Name der Nachricht, wie in der Datei messages.json angegeben.

  • Substitutionen

    Beliebig optional

    Bis zu 9 Ersetzungsstrings, falls die Nachricht welche erfordert.

  • Optionen

    object optional

    Chrome 79 und höher
    • escapeLt

      boolean optional

      Escape-Sequenz < in die Übersetzung von &lt; einfügen. Das gilt nur für die Nachricht selbst, nicht für die Platzhalter. Entwickler sollten diese Option verwenden, wenn die Übersetzung in einem HTML-Kontext verwendet wird. Wenn Closure Templates mit Closure Compiler verwendet werden, wird dies automatisch generiert.

Ausgabe

  • String

    Für die aktuelle Sprache lokalisierte Nachricht.

getUILanguage()

chrome.i18n.getUILanguage(): string

Ruft die Browsersprache des Browsers ab. Dies unterscheidet sich von i18n.getAcceptLanguages, das die bevorzugten Nutzersprachen zurückgibt.

Ausgabe

  • String

    Der Sprachcode der Browser-Benutzeroberfläche, z. B. „en-US“ oder „fr-FR“.