Skip to content

Commit 69403ff

Browse files
committed
Add translation guideline
1 parent bf3dbfc commit 69403ff

1 file changed

Lines changed: 23 additions & 19 deletions

File tree

source/contribute.rst

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -71,48 +71,52 @@ an agreed-upon interface for interoperability between packaging tools.
7171
Translations
7272
============
7373

74-
We use `Weblate`__ to manage translations of this project.
75-
Please visit the `packaging.python.org`__ project on Weblate to contribute.
74+
We use `Weblate`_ to manage translations of this project.
75+
Please visit the `packaging.python.org`_ project on Weblate to contribute.
7676

7777
If you are experiencing issues while you are working on translations,
78-
please open an issue on `Github`__.
78+
please open an issue on `Github`_.
7979

8080
.. note::
8181

82-
Any translations of this project should follow `reStructuredText syntax`__.
82+
Any translations of this project should follow `reStructuredText syntax`_.
8383

84-
.. __: https://weblate.org/
85-
.. __: https://hosted.weblate.org/projects/pypa/packaging-python-org/
86-
.. __: https://github.com/pypa/packaging.python.org/issues
87-
.. __: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
84+
.. _Weblate: https://weblate.org/
85+
.. _packaging.python.org: https://hosted.weblate.org/projects/pypa/packaging-python-org/
86+
.. _Github: https://github.com/pypa/packaging.python.org/issues
87+
.. _reStructuredText syntax: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
8888

8989
Adding a language
9090
-----------------
9191

92-
If your language is not listed on `Weblate`__, click the button
92+
If your language is not listed on `packaging.python.org`_, click the button
9393
"Start new translation" at the bottom of the languages list and add
9494
the language you want to translate.
9595

96-
.. __: https://hosted.weblate.org/projects/pypa/packaging-python-org/
97-
9896
Following reStructuredText syntax
9997
---------------------------------
10098

101-
If you are not familiar with reStructuredText (RST) syntax, please read `this guide`__
99+
If you are not familiar with reStructuredText (RST) syntax, please read `this guide`_
102100
before translating on Weblate.
103101

104-
Example:
102+
**Do not translate the text in reference directly**
103+
104+
When translating the text in reference, please do not translate them directly.
105+
106+
| Wrong: Translate the following text directly:
107+
108+
.. code-block::
105109
106-
Wrong: Translate the following text directly::
110+
`some ref`_ -> `TRANSLATED TEXT HERE`_
107111
108-
`some ref`_ -> `TRANSLATED TEXT HERE`_
112+
| Right: Translate the following text with your own language and add reference to the
113+
original language:
109114
110-
Right: Translate the following text with your own language and add reference to the
111-
original language::
115+
.. code-block::
112116
113-
`some ref`_ -> `TRANSLATED TEXT HERE <some ref>`_
117+
`some ref`_ -> `TRANSLATED TEXT HERE <some ref>`_
114118
115-
.. __: https://docutils.sourceforge.io/docs/user/rst/quickref.html
119+
.. _this guide: https://docutils.sourceforge.io/docs/user/rst/quickref.html
116120

117121
Building the guide locally
118122
==========================

0 commit comments

Comments
 (0)