weblate/docs/formats/tbx.rst
Gersona 725bd96349
feat(docs): Automatically generate format features docmentation (#18106)
* initial implementation suggestion

* basic supported features snippets generation

* Add API identifiers, read-only strings and common extensions to features table

* generate doc features snippet files

* autogenerated snippets cleanup

* changelog update

* delete one file to test auto-update

* replace SUPPORTS_FUZZY with file format additional_states flag

* docs: Documentation snippets update

* fix include statetement typo

* fix incorrect monolingual attributes

* minor styling change

* docs: Documentation snippets update

* exclude snippets from being treated as standalone documents

* Set YAMLFormat as both mono/bilingual

* docs: Documentation snippets update

* fix duplicate format IDs

* only use backwards quotes for literals

---------

Co-authored-by: gersona <6675010+gersona@users.noreply.github.com>
Co-authored-by: Michal Čihař <michal@weblate.org>
2026-04-01 15:41:20 +00:00

49 lines
1.5 KiB
ReStructuredText

.. _tbx:
TermBase eXchange format
------------------------
.. versionadded:: 4.5
.. versionchanged:: 5.12
TBX is an XML format for the exchange of terminology data.
.. seealso::
* `TBX on Wikipedia <https://en.wikipedia.org/wiki/TermBase_eXchange>`_
* :doc:`tt:formats/tbx`
* :ref:`glossary`
.. include:: /snippets/format-features/tbx-features.rst
Explanations
++++++++++++
Weblate loads and saves explanation from TBX files to be displayed in :ref:`glossary`.
* Translation explanation is stored as ``<note from="translator"></note>`` tag.
* Source string explanation is stored as ``<descrip></descrip>`` tag.
Example files
+++++++++++++
Example file:
.. literalinclude:: ../../weblate/trans/tests/data/cs.tbx
:language: xml
Weblate configuration
+++++++++++++++++++++
+-------------------------------------------------------------------+
| Typical Weblate :ref:`component` |
+================================+==================================+
| File mask | ``tbx/*.tbx`` |
+--------------------------------+----------------------------------+
| Monolingual base language file | `Empty` |
+--------------------------------+----------------------------------+
| Template for new translations | `Empty` |
+--------------------------------+----------------------------------+
| File format | `TermBase eXchange file` |
+--------------------------------+----------------------------------+