datastructure-intl-doc.md

Resulting data structure - Document wide translation

There are 3 aspects to the document wide translation

1. Each document will have a new property called __i18n_lang (you can customize this by setting the fieldNames.lang property in the i18n settings object) which contains the name of the language of this document.

{
  "_id": "document-id",
  "_type": "document-type",
  "__i18n_lang": "en_US"
}

2. Translated documents will have following ID structure: i18n.{base-document-id}.{lang}. This ID structure changed from V4 and if you are migrating from V4 to V5 you can use the maintenance tab to align the document ID's or manually update the ID's to the new structure.

3. The base language document will have a property called __i18n_refs (you can customize this by setting the fieldNames.references property in the i18n settings object) which contains references to the translated documents (per language).

{
  "_id": "document-id",
  "_type": "document-type",
  "__i18n_lang": "en_US",
  "__i18n_refs": [
    {
      "lang": "nl_NL",
      "ref": {
        "_type": "reference",
        "_id": "i18n.document-id.nl_NL"
      }
    }
  ]
}