Forum

About multilingual ...
 
Notifications
Clear all

About multilingual user manual

8 Posts
3 Users
0 Reactions
8,819 Views
(@richard-pare)
Posts: 165
Active Member
Topic starter
 
[#2316]

Do you plan to produce a multilingual user manual?
Do you know a contributor has produced a multilingual user manual?


 
Posted : 11 May 2015 18H58
(@babynus)
Posts: 14952
Member Admin
 

Do you plan to produce a multilingual user manual?

No

Do you know a contributor has produced a multilingual user manual?

translation to french has been stated and is available on the download page (but it is incomplete and not up to date)


 
Posted : 13 May 2015 18H52
(@richard-pare)
Posts: 165
Active Member
Topic starter
 

I'm working on an online help produced with Sphinx-doc.
I will offer a French-Canadian translation.
I guess you could be of interest. 😉


 
Posted : 13 May 2015 20H01
Igor
 Igor
(@lysakov)
Posts: 27
Active Member
 

I'm working on Russian translation for help.
I guess you could be of interest. 😉


 
Posted : 01 Sep 2015 18H11
(@babynus)
Posts: 14952
Member Admin
 

Hi,
Yes, of course it is of great interest.
But pay attention : User Manual will be completely refactored on V5.1 (Richard is working hard on this subject) under Sphinx-doc, which offers translation facilities.
Do not invlove in traslating odl-format PPT document, wait for the refactored one (you can fond sources on sourceforge SVN reporistory).


 
Posted : 01 Sep 2015 19H21
(@richard-pare)
Posts: 165
Active Member
Topic starter
 

Hi,
User Manual will be completely refactored on V5.1 under Sphinx-doc.

Why Sphinx-doc?
- Documentation is with the source code. You can deploy the software with an updated documentation.
- Easier to contribute to the evolution of documentation.
- Translation possible via Pootle.
- The documentation will be produced in HTML and PDF formats.

I structure the documentation for which is easy to translate.
I tried to translate from English to French. The translation was easy.

First, we want to write a stable version in English. After translation can begin.


 
Posted : 02 Sep 2015 17H16
Igor
 Igor
(@lysakov)
Posts: 27
Active Member
 

Hi,
richard.pare.

I don't know Sphinx-doc. But I already have some ranslation for old documentation. I could participate in translation.

Could you send me some instructions?


 
Posted : 02 Sep 2015 18H01
(@richard-pare)
Posts: 165
Active Member
Topic starter
 

First, You must install Python and Python Image Lybrary (PIL).
Second, You must install Sphinx :
- pip install Sphinx
- pip install Sphinx-intl

If you want produce PDF documentation on Windows, you must install MiKTeX because Latex is not supported under Windows.

Download source code from branch 5.1.

Go to on /docs/user directory.

The documentation is in RST file.

If you want to built documentation in HTML or PDF format.

Command: make html or make latexpdf

--- Translation ---

See: http://sphinx-doc.org/latest/intl.html

Under /docs/user/locale directory, you can see PO and MO files.

PO : Translation files
MO : Formatted translation files

Under /docs/user/_built/locale, you can see POT files.

- Each RST file has a POT file.
- POT is a reference file to all string translable from the original document.
- Use by Pootle to update PO files.

Instructions :

Command: make gettext

- Update the POT files

Command: sphinx-intl update -l ru -p _build/locale

- Update PO files for this language.
- PO files localized in /docs/user/locale/ru/LC_MESSAGES/
- You made the translate in the POT files.

Command: sphinx-intl build

- Update MO files.

Command: make SPHINXOPTS="-Dlanguage=ru" html or make SPHINXOPTS="-Dlanguage=ru" latexpdf

- Produce HTML or PDF document.

-------

The repository content the first draft of user guide.
Do not start the translation for now. Wait the official release.
But you can try to translate into Russian.
The translation is well in a Latin language.
Russian language, I do not know.

Keep me informed.


 
Posted : 02 Sep 2015 20H07
Share:

Scroll to Top