weblate/docs/formats/toml.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

45 lines
1.5 KiB
ReStructuredText

TOML
----
.. versionadded:: 5.15
.. include:: /snippets/format-in-development.rst
TOML is a generic format like :doc:`/formats/yaml` or :doc:`/formats/json` and can be used to localize applications.
Weblate supports TOML in several variants:
`TOML file`
Plain TOML file without support for plurals.
`go-i18n TOML file`
go-i18n variant with plurals support.
.. seealso::
* :doc:`tt:formats/toml`
* :ref:`updating-target-files`
Example file:
.. literalinclude:: ../../weblate/trans/tests/data/cs.toml
:language: toml
.. literalinclude:: ../../weblate/trans/tests/data/cs.goi18n.toml
:language: toml
.. include:: /snippets/format-features/toml-features.rst
Weblate configuration
+++++++++++++++++++++
+-------------------------------------------------------------------+
| Typical Weblate :ref:`component` |
+================================+==================================+
| File mask | ``langs/*.toml`` |
+--------------------------------+----------------------------------+
| Monolingual base language file | ``langs/en.toml`` |
+--------------------------------+----------------------------------+
| Template for new translations | `Empty` |
+--------------------------------+----------------------------------+
| File format | `TOML file` |
+--------------------------------+----------------------------------+