Updated instructions for adding a translation.

This commit is contained in:
Russell Keith-Magee 2018-11-19 21:29:07 +03:00
parent 7f68d7b37f
commit 50d85edffa
No known key found for this signature in database
GPG key ID: 3D2DAB6A37BB5BC3

View file

@ -79,24 +79,15 @@ Translating
Want to make BeeWare more accessible to non-English-speakers? Help translate the site! Steps are as follows:
1. Add language specification to:
1. Add language specification to `BeeWare.lektorproject <https://github.com/pybee/pybee.github.io/blob/lektor/BeeWare.lektorproject>`_.
pybee.github.io/BeeWare.lektorproject
Fill out the name of the language, its url prefix, and the locale. Make sure you use the correct `ISO 639-1 <https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes>`_ locale code - for many countries, it's not the same as
the national TLD. For example, the ISO 639-1 Danish locale is 'da', but Denmark uses the '.dk' TLD.
Fill out the name of the language, its url prefix, and the locale.
2. Add an entry for your language to the `Atom configuration <https://github.com/pybee/pybee.github.io/blob/lektor/configs/atom.ini>`_.
2. Add translated mirror files at the same directory level as the primary English files and add appropriate suffixes.
3. Add your first translation, by translating the names for the menus at the top of each page. Edit `the menus translation file <https://github.com/pybee/pybee.github.io/blob/lektor/databags/menu.ini>`_, adding a block for your language.
For example:
4. Start adding translations for content pages ont he site. Translated files are at the same directory level as the primary English files, but have a language suffix. For example, Arabic's locale is 'ar', so you would add `contents+ar.lr` wherever the original file name is `contents.lr`
Arabic's locale is 'ar', so you would add...
contents+ar.lr
...where the original file name is:
contents.lr
Note: A great place to start translating is the contributing section:
pybee.github.io/content/contributing
A great place to start translating is the `contributing section <pybee.github.io/content/contributing>`_.