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

64 lines
2.1 KiB
ReStructuredText

.. _txt:
Text files
----------
.. versionadded:: 4.6
The translatable content is extracted from the plain text files and offered for
the translation. Each paragraph is translated as a separate string.
There are several flavors of this format:
* Plain text file
* DokuWiki text file
* MediaWiki text file
* :ref:`markdown`
.. include:: /snippets/format-database-backed.rst
.. seealso::
:doc:`tt:formats/text`
Example file:
.. literalinclude:: ../../weblate/trans/tests/data/cs.txt
.. include:: /snippets/format-features/txt-features.rst
Weblate configuration
+++++++++++++++++++++
+--------------------------------+-------------------------------------+
| Typical Weblate :ref:`component` |
+================================+=====================================+
| File mask | ``path/*.txt`` |
+--------------------------------+-------------------------------------+
| Monolingual base language file | ``path/en.txt`` |
+--------------------------------+-------------------------------------+
| Template for new translations | ``path/en.txt`` |
+--------------------------------+-------------------------------------+
| File format | `Plain text file` |
+--------------------------------+-------------------------------------+
| File format parameters | ``txt_merge_duplicates=True`` |
+--------------------------------+-------------------------------------+
.. _txt-duplicates:
Handling duplicate strings
++++++++++++++++++++++++++
By default, Weblate treats each paragraph as a separate translation unit to
provide line-based context. This can be problematic in text files where
paragraphs are frequently reordered, as it changes the context and can lead
to translation loss.
To consolidate identical strings into a single translation unit, enable
:guilabel:`Deduplicate identical strings` in the
:ref:`component-file_format_params`.
.. note::
This parameter is shared with **DokuWiki** and **MediaWiki** formats.
Enabling this option disables line-based context for the merged units.