Translate the User Manual of the Semi-Automatic Classification Plugin

The User Manual of the Semi-Automatic Classification Plugin (SCP) has reached version 4, and it is available in English as PDF here, and online .

However, it is possible to easily translate the user manual into any language, because it is written in reStructuredText as markup language (using Sphinx).

Therefore, your contribution is fundamental for the translation of the manual into your language.
The following guide illustrates the main steps for the translation, which can be performed:
  1. using the free online service Transifex;
  2. using the gettext .po files.

Method 1. Translation using the free online service Transifex

This is probably the easiest way to translate the manual using an online service.

1. Transifex free registration

Go to the Transifex login page. You can sign in using your Google or Facebook account, or with a free registration.

2. Join the Semi-automatic Classification Manual project

Select your language and click the button Join team. If your language is not listed, click the button Request language.

3. Translation

There are several files to be translated, which refer to the sections of the SCP manual. The translation is performed through an online application, which shows you each sentence in the original English version, and a text editor allows for the translation into your language.
This should make the translation process very rapid and easy.

Method 2. Translation using the gettext .po files

In order to use this method, you should be familiar with GitHub. This translation method allows for the translation of the PO files locally.

1. Download the translation files

and download the .po files of your language (you can add your language, if it is not listed), or you can fork the repository.
Every file .po is a text file that refers to a section of the SCP manual.

2. Edit the translation files

Now you can edit the .po files. It is convenient to edit those file using one of the following programs:
for instance Poedit for Windows and Mac OS X, or Gtranslator for Linux or OmegaT (Java based) for Windows, Linux and Mac OS X.
These editors allow for an easy translation of every sentence in the SCP manual.
A screenshot of Gtranslator used for the translation of the Semi-Automatic Classification Plugin's User Manual

Every item in the list must be translated.
Please, notice that some sentences are in reStructuredText, therefore you should maintain this structure. Please read this introduction before editing the files. For instance |br| should be translated as |br| in every language.

3. Send the translation files

After you have edited the .po files you can create a pull request in GitHub or just send me the edited files through the Facebook group or the Google+ Community.

The result of your work will be merged in the SCP manual translated into your language, both as online version or PDF version such as the following page .

For any comment or question, join the Facebook group and the Google+ Community about the Semi-Automatic Classification Plugin.

Newer posts Older posts