Skip to content

Commit 0810b46

Browse files
committed
Update Translation Guide
1 parent 57e8e76 commit 0810b46

1 file changed

Lines changed: 19 additions & 2 deletions

File tree

source/contribute.rst

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,12 @@ Please visit the `packaging.python.org`__ project on Weblate to contribute.
7777
If you are experiencing issues while you are working on translations,
7878
please open an issue on `Github`__.
7979

80+
.. Note:: Any translations of this project should follow `reStructuredText syntax`__.
81+
8082
.. __: https://weblate.org/
8183
.. __: https://hosted.weblate.org/projects/pypa/packaging-python-org/
8284
.. __: https://github.com/pypa/packaging.python.org/issues
85+
.. __: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
8386

8487
Adding a language
8588
-----------------
@@ -90,10 +93,24 @@ the language you want to translate.
9093

9194
.. __: https://hosted.weblate.org/projects/pypa/packaging-python-org/
9295

93-
.. Note:: Any translations of this project should follow `RST syntax`__.
96+
Following reStructuredText syntax
97+
--------------------
9498

95-
.. __: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
99+
If you are not familiar with reStructuredText (RST) syntax, please read `this guide`__
100+
before translating on Weblate.
101+
102+
Example:
103+
104+
Wrong: Translate the following text directly::
105+
106+
`some ref`_ -> `TRANSLATED TEXT HERE`_
107+
108+
Right: Translate the following text with your own language and add reference to the
109+
original language::
110+
111+
`some ref`_ -> `TRANSLATED TEXT HERE <some ref>`_
96112

113+
.. __: https://docutils.sourceforge.io/docs/user/rst/quickref.html
97114

98115
Building the guide locally
99116
==========================

0 commit comments

Comments
 (0)