mirror of
https://github.com/pretix/pretix.git
synced 2026-05-07 15:34:02 +00:00
Add documentation on the translation process
This commit is contained in:
@@ -40,6 +40,9 @@ Contributing
|
|||||||
If you want to contribute to pretix, please read the `developer documentation`_
|
If you want to contribute to pretix, please read the `developer documentation`_
|
||||||
in our documentation. If you have any further questions, please do not hesitate to ask!
|
in our documentation. If you have any further questions, please do not hesitate to ask!
|
||||||
|
|
||||||
|
.. image:: https://translate.pretix.eu/widgets/pretix/-/pretix/multi-blue.svg
|
||||||
|
:target: https://translate.pretix.eu/engage/pretix/
|
||||||
|
|
||||||
Code of Conduct
|
Code of Conduct
|
||||||
---------------
|
---------------
|
||||||
We have a `Code of Conduct`_ in place that applies to all project contributions,
|
We have a `Code of Conduct`_ in place that applies to all project contributions,
|
||||||
|
|||||||
@@ -8,5 +8,6 @@ Developer documentation
|
|||||||
setup
|
setup
|
||||||
contribution/index
|
contribution/index
|
||||||
implementation/index
|
implementation/index
|
||||||
|
translation/index
|
||||||
api/index
|
api/index
|
||||||
structure
|
structure
|
||||||
|
|||||||
@@ -145,6 +145,10 @@ and update the ``*.po`` files accordingly::
|
|||||||
|
|
||||||
make localegen
|
make localegen
|
||||||
|
|
||||||
|
However, most of the time you don't need to care about this. Just create your pull request
|
||||||
|
with functionality and English strings only, and we'll push the new translation strings
|
||||||
|
to our translation platform after the merge.
|
||||||
|
|
||||||
To actually see pretix in your language, you have to compile the ``*.po`` files to their
|
To actually see pretix in your language, you have to compile the ``*.po`` files to their
|
||||||
optimized binary ``*.mo`` counterparts::
|
optimized binary ``*.mo`` counterparts::
|
||||||
|
|
||||||
|
|||||||
BIN
doc/development/translation/img/weblate1.png
Normal file
BIN
doc/development/translation/img/weblate1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
BIN
doc/development/translation/img/weblate2.png
Normal file
BIN
doc/development/translation/img/weblate2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 45 KiB |
BIN
doc/development/translation/img/weblate3.png
Normal file
BIN
doc/development/translation/img/weblate3.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 61 KiB |
BIN
doc/development/translation/img/weblate4.png
Normal file
BIN
doc/development/translation/img/weblate4.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 89 KiB |
BIN
doc/development/translation/img/weblate5.png
Normal file
BIN
doc/development/translation/img/weblate5.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 64 KiB |
BIN
doc/development/translation/img/weblate6.png
Normal file
BIN
doc/development/translation/img/weblate6.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 83 KiB |
81
doc/development/translation/index.rst
Normal file
81
doc/development/translation/index.rst
Normal file
@@ -0,0 +1,81 @@
|
|||||||
|
Translating pretix
|
||||||
|
==================
|
||||||
|
|
||||||
|
pretix has been designed for multi-language capabilities from its start. Organizers can enter their event information
|
||||||
|
in multiple languages at the same time. However, the software interface of pretix also needs to be translated for
|
||||||
|
this to be useful.
|
||||||
|
|
||||||
|
Since we (the developers of pretix) only speak a very limited number of languages, we need help from the community
|
||||||
|
to achieve this goal. To make translating pretix easy not only for software developers, we set up a translation
|
||||||
|
platform at `translate.pretix.eu`_.
|
||||||
|
|
||||||
|
Official and inofficial languages
|
||||||
|
---------------------------------
|
||||||
|
|
||||||
|
In the pretix project, there are three types of languages:
|
||||||
|
|
||||||
|
Official languages
|
||||||
|
are translated and maintained by the core team behind pretix or as part of long-term partnerships. We are
|
||||||
|
committed to keeping these translations up-to-date with new features or changes in pretix and try to offer
|
||||||
|
support in this language.
|
||||||
|
|
||||||
|
Inofficial languages
|
||||||
|
are contributed and maintained by the Community. We ship them with pretix so you can use them, but we can not
|
||||||
|
guarantee that new or changed features in pretix will be translated in time.
|
||||||
|
|
||||||
|
Incubating languages
|
||||||
|
are currently in the process of being translated. They can not yet be selected in pretix by end users.
|
||||||
|
|
||||||
|
Please contact translate@pretix.eu if you think an incubated language should be promoted to an inofficial one or if
|
||||||
|
you are interested in a partnership to make your language official.
|
||||||
|
|
||||||
|
The current translation status of various languages is:
|
||||||
|
|
||||||
|
.. image:: https://translate.pretix.eu/widgets/pretix/-/multi-blue.svg
|
||||||
|
:target: https://translate.pretix.eu/engage/pretix/?utm_source=widget
|
||||||
|
|
||||||
|
|
||||||
|
Using our translation platform
|
||||||
|
------------------------------
|
||||||
|
|
||||||
|
If you visit `translate.pretix.eu`_ for the first time, it admittedly looks pretty bare.
|
||||||
|
|
||||||
|
.. image:: img/weblate1.png
|
||||||
|
:class: screenshot
|
||||||
|
|
||||||
|
It gets better if you create an account, which you will need to contribute translations. Click on "Register" in the
|
||||||
|
top-right corner to get started:
|
||||||
|
|
||||||
|
.. image:: img/weblate2.png
|
||||||
|
:class: screenshot
|
||||||
|
|
||||||
|
You can either create an account or choose to log in with your GitHub account, whichever you like more.
|
||||||
|
After creating and activating your account, we recommend that you change your profile and select which languages you
|
||||||
|
can translate to and which languages you understand. You can find your profile settings by clicking on your name in
|
||||||
|
the top-right corner.
|
||||||
|
|
||||||
|
.. image:: img/weblate3.png
|
||||||
|
:class: screenshot
|
||||||
|
|
||||||
|
Going back to the dashboard by clicking on the logo in the top-left corner, you can select between different lists
|
||||||
|
of translation projects. You can either filter by projects that already have a translation in your language, or you
|
||||||
|
go to the `pretix project page`_ where you can select specific components.
|
||||||
|
|
||||||
|
.. image:: img/weblate4.png
|
||||||
|
:class: screenshot
|
||||||
|
|
||||||
|
Once you selected a component of a language, you can start going through strings to translate. You can start of by
|
||||||
|
clicking the "Strings needing action" line in this view:
|
||||||
|
|
||||||
|
.. image:: img/weblate5.png
|
||||||
|
:class: screenshot
|
||||||
|
|
||||||
|
In the translate view, you can input your translation for a given source string. If you're unsure about your
|
||||||
|
translation, you can also just "Suggest" it or mark it as "Needs editing". If you have no idea, just "Skip". If you
|
||||||
|
scroll down, there is also a "Comments" section to discuss any questions with fellow translators or us developers.
|
||||||
|
|
||||||
|
.. image:: img/weblate6.png
|
||||||
|
:class: screenshot
|
||||||
|
|
||||||
|
.. _translate.pretix.eu: https://translate.pretix.eu
|
||||||
|
.. _pretix project page: https://translate.pretix.eu/projects/pretix/
|
||||||
0
doc/doc_warnings
Normal file
0
doc/doc_warnings
Normal file
6
src/pretix/locale/README
Normal file
6
src/pretix/locale/README
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
Translating pretix
|
||||||
|
------------------
|
||||||
|
|
||||||
|
If you want to help translating, please read this page in our documentation:
|
||||||
|
|
||||||
|
https://docs.pretix.eu/development/translation/index.html
|
||||||
Reference in New Issue
Block a user