Citations

In general, software programs developed in TINC are translated in 23 different languages. To facilitate the translation of the user interface (UI) and the document, a system of citations is used. This allows for a consistent reference between the document and the UI elements across all languages.

This citation system is based on the XLATE .json export, which contains all the phrases used in the UI. Each phrase has a unique ID that can be referenced in the documentation. When translating the documentation, these IDs are used to ensure that the correct phrases are linked to their corresponding UI elements.

All the UI elements from the source code are exported to the Xlate database (internally named as translation tables).

To insert these IDs, the following syntax is used in the asciidoc file of the bento documentation:
UI phrase.

While compiling a document, the Bento tool will replace these syntaxes with the actual phrases from the XLATE .json file.

To achieve this, Xlate .json files are converted into .txt format for each product across all supported languages, and then stored in their corresponding documentation repositories.

The following image illustrates how to insert the syntax in the documentation: