Skip to content

Commit

Permalink
standard/translation: Remove repetition of glossary content. Small ed…
Browse files Browse the repository at this point in the history
…its.
  • Loading branch information
jpmckinney committed Mar 1, 2024
1 parent 4f21efe commit cb6edf8
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 18 deletions.
2 changes: 1 addition & 1 deletion docs/standard/translation/quality.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ After translation, `translate-toolkit <https://docs.translatehouse.org/projects/
Glossary
--------

We ensure that key terms are translated consistently using a `Transifex glossary <https://help.transifex.com/en/articles/6229127-understanding-glossaries>`__: for example, the `OCDS glossary <https://www.transifex.com/open-contracting-partnership-1/open-contracting-standard-1-1/glossary/es/>`__.
We ensure that key terms are translated consistently using a `Transifex glossary <https://help.transifex.com/en/articles/6229127-understanding-glossaries>`__: for example, the `OCDS glossary <https://www.transifex.com/open-contracting-partnership-1/open-contracting-standard-1-1/glossary/es/>`__. The glossary is also available within the translation editor.

Manage the glossary
~~~~~~~~~~~~~~~~~~~
Expand Down
19 changes: 9 additions & 10 deletions docs/standard/translation/understanding_transifex.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,15 @@ Transifex is organized into projects, like `OCDS 1.1 <https://www.transifex.com/
Strings to be translated
------------------------

From CSV and JSON files
~~~~~~~~~~~~~~~~~~~~~~~

Codelists
^^^^^^^^^
From CSV codelists
~~~~~~~~~~~~~~~~~~

In OCDS, the strings in the `codelists <https://www.transifex.com/open-contracting-partnership-1/open-contracting-standard-1-1/translate/#es/codelists/76986036>`__ resource are extracted from the CSV files in `schema/codelists/*.csv <https://github.com/open-contracting/standard/tree/HEAD/schema/codelists>`__. They provide the content for the codelist tables on the `codelists <https://standard.open-contracting.org/latest/es/schema/codelists/>`__ page.

In OC4IDS, the strings in the `infrastructure-codelists <https://app.transifex.com/open-contracting-partnership-1/oc4ids-09/infrastructure-codelists/>`__ resource are extracted from the CSV files in `schema/project-level/codelists/*.csv <https://github.com/open-contracting/infrastructure/tree/HEAD/schema/project-level/codelists>`__. They provide the content for the codelist tables on the `codelist reference <https://standard.open-contracting.org/infrastructure/latest/en/reference/codelists/>`__ page.

JSON Schema
^^^^^^^^^^^
From JSON Schema
~~~~~~~~~~~~~~~~

In OCDS, the strings in the `schema <https://www.transifex.com/open-contracting-partnership-1/open-contracting-standard-1-1/translate/#es/schema/76882756>`__ resource are extracted from the JSON files in `schema <https://github.com/open-contracting/standard/tree/HEAD/schema>`__. They provide the content for:

Expand All @@ -33,14 +30,16 @@ In OCDS, the strings in the `schema <https://www.transifex.com/open-contracting-
In OC4IDS, the strings in the `infrastructure-schema <https://app.transifex.com/open-contracting-partnership-1/oc4ids-09/infrastructure-schema/>`__ resource are extracted from the JSON files in `schema <https://github.com/open-contracting/infrastructure/tree/HEAD/schema/project-level>`__. They provide the content for:

- JSON Schema tables on the `schema reference <https://standard.open-contracting.org/infrastructure/latest/en/reference/schema/>`__ page
- schema viewers on the `schema browser <https://standard.open-contracting.org/infrastructure/latest/en/reference/browser/>`__ and `packaging data <https://standard.open-contracting.org/infrastructure/latest/en/reference/package/>`__ pages.
- schema viewers on the `schema browser <https://standard.open-contracting.org/infrastructure/latest/en/reference/browser/>`__ and `packaging data <https://standard.open-contracting.org/infrastructure/latest/en/reference/package/>`__ pages
- translated JSON Schema files distributed with the documentation

OC4IDS mappings
^^^^^^^^^^^^^^^
From OC4IDS mappings
~~~~~~~~~~~~~~~~~~~~

In OC4IDS, the strings in the `infrastructure-mappings <https://app.transifex.com/open-contracting-partnership-1/oc4ids-09/infrastructure-mappings/>`__ resource are extracted from the CSV files in `mapping <https://github.com/open-contracting/infrastructure/tree/HEAD/mapping>`__. They provide the content for the mapping tables on the pages in the `CoST IDS and OCDS mapping <https://standard.open-contracting.org/infrastructure/latest/en/cost/>`__ section.

.. _markdown-resources:

From Markdown files
~~~~~~~~~~~~~~~~~~~

Expand Down
16 changes: 9 additions & 7 deletions docs/standard/translation/using_transifex.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ Steps for translators, proofreaders and reviewers
Translator
~~~~~~~~~~

Before beginning, ask the :ref:`Coordinator<roles>` to ensure that the :ref:`Transifex glossary<glossary>` (OCDS only) is up-to-date. If the glossary is not yet available in your language, ask the Coordinator to arrange it.
.. admonition:: OCDS only

Before beginning, ask the :ref:`Coordinator<roles>` to ensure that the :ref:`Transifex glossary<glossary>` is up-to-date. If the glossary is not yet available in your language, ask the Coordinator to arrange it.

#. Go to the list of resources (`OCDS <https://www.transifex.com/open-contracting-partnership-1/open-contracting-standard-1-1/translate/#es>`__, `OC4IDS <https://www.transifex.com/open-contracting-partnership-1/oc4ids-09/translate/#es>`__)
#. Change the language, if appropriate
Expand All @@ -19,17 +21,17 @@ Before beginning, ask the :ref:`Coordinator<roles>` to ensure that the :ref:`Tra
#. Repeat from Step 4
#. Notify the Proofreader when strings have been translated

The `Transifex glossary <https://www.transifex.com/open-contracting-partnership-1/open-contracting-standard-1-1/glossary/en/>`__ (OCDS only) contains key terms that must be translated consistently. Change the language code at the end of the glossary's URL to view in different languages. It is also available within the translation editor.

It helps to see where the strings appear in context in the documentation (`OCDS <https://standard.open-contracting.org/>`__, `OC4IDS <https://standard.open-contracting.org/infrastructure/>`__). :doc:`understanding_transifex` describes the link between files in the GitHub repository (`OCDS <https://github.com/open-contracting/standard>`__, `OC4IDS <https://github.com/open-contracting/infrastructure>`__), Transifex resources, and documentation pages. With the exception of the resources related to the CSV and JSON files described on that page, you can:
It helps to see where the strings appear in context in the documentation (`OCDS <https://standard.open-contracting.org/>`__, `OC4IDS <https://standard.open-contracting.org/infrastructure/>`__). :doc:`understanding_transifex` describes the link between files in the GitHub repository (`OCDS <https://github.com/open-contracting/standard>`__, `OC4IDS <https://github.com/open-contracting/infrastructure>`__), Transifex resources, and documentation pages. For Transifex resources related to :ref:`Markdown files<markdown-resources>`, you can:

#. Take the name of a resource, e.g. ``history--changelog`` or ``reference--changelog``
#. Remove ``--index`` if present
#. Replace ``--`` with ``/``
#. Put it in the following patterns, substituting ``{version}`` for the version of the standard you are translating:
#. Put it in a pattern below, substituting ``{version}`` for the version of the standard you are translating:

* OCDS: ``https://standard.open-contracting.org/staging/{version}/en/{name}/``, like https://standard.open-contracting.org/staging/1.2-dev/en/history/changelog
* OC4IDS: ``https://standard.open-contracting.org/staging/infrastructure/{version}/en/{name}``, like https://standard.open-contracting.org/staging/infrastructure/0.9-dev/en/reference/changelog
OCDS
``https://standard.open-contracting.org/staging/{version}/en/{name}/``, like https://standard.open-contracting.org/staging/1.2-dev/en/history/changelog/
OC4IDS
``https://standard.open-contracting.org/staging/infrastructure/{version}/en/{name}/``, like https://standard.open-contracting.org/staging/infrastructure/0.9-dev/en/reference/changelog/

.. note::
Some titles and descriptions of codes are copied from external sources and should not be translated by OCDS. These are tagged as ``should_be_translated_upstream`` and indicated by a small tag icon.
Expand Down

0 comments on commit cb6edf8

Please sign in to comment.