Translating the documentation

Bitxor’s awesome community actively localizes the contents of this site, and we’re endlessly thankful for that.

The original text is in English and right now only the Japanese translation is complete enough to be public. Languages are made public when enough pages have been translated.

If you are planning on helping, make sure to join the Discord server and enter the #docs-general channel. There is a #translation thread for just this purpose!

Bitxor Developer Documentation uses Transifex, a collaborative localization platform, to manage translations and make the process participative. Follow these instructions to start submitting your contributions.

Getting started for translators

  1. Create a new Transifex account here.

  2. Join the bitxor-docs team. Click on Help Translate “bitxor-docs” button on the right side of the header, selecting the language you want to contribute.

  3. Wait until the translation coordinator approves your request. Once accepted you will receive an email. At this moment, you will be able to start translating the docs.

  4. Once you have joined the team, you can contribute either translating new content or reviewing translations provided by other users.

Note

First time using Transifex? We recommend you to read the following guides from Transifex’s documentation:

Caution

Please do NOT translate:

  • Words in camel-case (like EntityBody)

  • Text between pipes (|)

  • Text between colons (:)

  • Text between single or double backticks (`)

    Exception: You MUST translate everything inside backticks IF there are angle brackets inside the backticks too. What’s inside the angle brackets must NOT be translated. See the last example below.

Examples:

Original

Translated

Should translate?

This is a test

это проверка

✅

feeMultiplier

feeMultiplier

❌

|codename|

|codename|

❌

:ref:

:ref:

❌

`keyword`

`keyword`

❌

``keyword``

``keyword``

❌

:doc:`blocks`

:doc:`blocks`

❌

:doc:`one block <blocks>`

:doc:`один квартал <blocks>`

✅/❌

Notes for developers

This guide explains how to interact with Transifex service using the transifex-client tool.

Pull latest files

Follow these instructions to download the latest translations from Transifex.

  1. Install transifex-client.

    pip install transifex-client

  2. Download the latest translated files. Replace <lang> with your language code.

    tx pull --mode onlyreviewed --language <lang>

  3. Compile the docs for the target language.

    make -e SPHINXOPTS="-D language='<lang>'" livehtml

Push new literals

Follow these instructions to publish updated source literals to Transifex.

Note

You will need explicit permissions from the Transifex project coordinator to push source files.

  1. Generate the literals. For each documentation file, a .po file will be created under build/gettext.

    make gettext

  2. Push the source literals to Transifex.

    tx push --source

Submit your changes into the bitxor-docs repository.