Export formats for translations

Translations are available in both JSON and SQLite database formats. Some translation has footnotes as well, footnotes are embedded in the translation text using sup HTML tag. To support a wide range of applications — including websites, mobile apps, and desktop tools, we provide multiple export formats for translations.

Available export formats:

1. Nested Array Structure

Translations are grouped by Surah. Each Surah is an array containing translations for each Ayah in order. This format export translations as simple text, no formatting, no footnotes.

[
  ["translation of 1:1", "translation of 1:2"], ...
  ["translation of 2:1", "translation of 2:2"]
]

2. Key-Value Structure

Each translation is stored with the Ayah reference (e.g. 1:1) as the key and the translated text as the value. This format also exports translations as simple text, no formatting, no footnotes etc.

{
  "1:1": "translation of 1:1",
  "1:2": "translation of 1:2",
  ...
  "114:6": "translation of 114:6"
}

Translations with Footnotes

Translations with footnotes are available in three more formats:

1. Footnotes as Tags Format

Footnotes are embedded using a <sup> tag with a foot_note attribute. Footnote contents are stored separately under f key.

{
  "88:17": {
    "t": "Do the disbelievers not see how rain clouds are formed <sup foot_note=\"77646\">1</sup>",
    "f": {
      "77646": "The word ibl can mean 'camel' as well as 'rain cloud'..."
    }
  }
}

2. Inline Footnote Format

Footnotes are inserted directly using double square brackets e.g([[this is footnote]])

{
  "88:17": "Do the disbelievers not see how rain clouds are formed [[The word ibl can mean 'camel' as well as 'rain cloud'...]]"
}

3. Text Chunks Format

Translation is divided into chunks — each chunk could be a simple text or an object. Object can be either footnote for formatting tags. This format is useful for applications that need to display translations with precise control over formatting. Here is an example of Bridges` translation for Surah An-Nas , Ayah 6:

Above translation will be exported in chunks as:

<i class="s">(from the whisperers)</i>among the race of unseen beings<sup foot_note="81506">1</sup>and mankind.”

      [
      {"type":"i","text":"(from the whisperers)"}, // first chunk, should be formatted as italic
      "among the race of unseen beings", //second chunk in simple text
      {"type":"f","f":"81506","text":"1"}, // third chunk is a footnote,
      "and mankind.”"
      ]