From b43261d0e382ca31b96b5b3a13a38d27a04fe21c Mon Sep 17 00:00:00 2001 From: James McKinney <26463+jpmckinney@users.noreply.github.com> Date: Tue, 5 Mar 2024 15:20:21 -0500 Subject: [PATCH] standard/translation/using_transifex: Indent the sub-instructions --- docs/standard/translation/using_transifex.rst | 41 +++++++++++-------- 1 file changed, 23 insertions(+), 18 deletions(-) diff --git a/docs/standard/translation/using_transifex.rst b/docs/standard/translation/using_transifex.rst index 2db1fdf..e380d9a 100644 --- a/docs/standard/translation/using_transifex.rst +++ b/docs/standard/translation/using_transifex.rst @@ -14,27 +14,30 @@ Translator #. Go to the list of resources (`OCDS `__, `OC4IDS `__) #. Change the language, if appropriate #. Sort by "Untranslated (Descending)" -#. Click on a resource with untranslated strings -#. Click "Untranslated" -#. Read the English text and author the translated text +#. For all resources with untranslated strings: - .. warning:: + #. Click on the resource + #. Click "Untranslated" + #. Read the English text and author the translated text - Do not translate: + .. warning:: - - words in backticks, like \`title\` (often used for schema fields) - - words in single quotes, like 'open' (often used for codelist codes) - - relative URLs, like ``[translate this](#but-not-this)`` + Do not translate: - Absolute URLs (that is, starting with ``https://``) can be translated: for example, if the website offers content in multiple languages. + - words in backticks, like \`title\` (often used for schema fields) + - words in single quotes, like 'open' (often used for codelist codes) + - relative URLs, like ``[translate this](#but-not-this)`` + + Absolute URLs (that is, starting with ``https://``) can be translated: for example, if the website offers content in multiple languages. + + #. Click "Save Translation" (or press ``TAB``) -#. Click "Save Translation" (or press ``TAB``) #. Repeat from Step 4 #. Notify the Proofreader when strings have been translated It helps to see where the strings appear in context in the documentation (`OCDS `__, `OC4IDS `__). :doc:`understanding_transifex` describes the link between GitHub files (`OCDS `__, `OC4IDS `__), Transifex resources, and documentation pages. For Transifex resources related to :ref:`Markdown files`, you can: -#. Take the name of a resource, e.g. ``history--changelog`` or ``reference--changelog`` +#. Take the name of a resource, like ``history--changelog`` or ``reference--changelog`` #. Remove ``--index`` if present #. Replace ``--`` with ``/`` #. Put it in a pattern below, substituting ``{version}`` for the version of the standard you are translating: @@ -63,13 +66,15 @@ Reviewer #. Go to the list of resources (`OCDS `__, `OC4IDS `__) #. Change the language, if appropriate #. Sort by "Unreviewed (Descending)" -#. Click on a resource with unreviewed strings -#. Click "Unreviewed" -#. Read the English text and the translated text and confirm the translation is correct -#. If there's a translation issue, update the translated text -#. If there is a Transifex warning (e.g. "Glossary translation for term 'release' missing from translation"), update the translated text -#. Click "Review" -#. Repeat from Step 4 +#. For all resources with unreviewed strings: + + #. Click on the resource + #. Click "Unreviewed" + #. Read the English and translated texts, and confirm the translation is correct + #. If there's a translation issue, update the translated text + #. If there is a Transifex warning (like "Glossary translation for term 'release' missing from translation"), update the translated text + #. Click "Review" + #. Notify the Coordinator when strings have been reviewed Translation tasks