[Getfem-commits] (no subject)

[Tetsuo Koyama]

branch: devel-tetsuo-translation
commit 6187a32a88450a23f4e8f525c3938670a982f1c0
Author: Tetsuo Koyama <address@hidden>
Date:   Tue Oct 23 21:06:14 2018 +0900

    add content "Localization(L10N)"
---
 doc/sphinx/source/project/contribute.rst | 41 ++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)

diff --git a/doc/sphinx/source/project/contribute.rst 
b/doc/sphinx/source/project/contribute.rst
index 7ebd409..68aa64a 100644
--- a/doc/sphinx/source/project/contribute.rst
+++ b/doc/sphinx/source/project/contribute.rst
@@ -21,6 +21,15 @@ How to contribute / Git repository on Savannah
 .. |sawebgsrc| replace:: Getfem sources on Savannah
 .. _sawebgsrc: http://git.savannah.nongnu.org/gitweb/?p=getfem.git;a=tree
 
+.. |tfweb| replace:: transifex
+.. _tfweb: https://www.transifex.com
+
+.. |tfwebprj| replace:: Getfem Localization Project on Transifex
+.. _tfwebprj: https://www.transifex.com/getfem-doc
+
+.. |cfvlang| replace:: Currently supported languages by Sphinx are
+.. _cfvlang: 
http://www.sphinx-doc.org/en/stable/usage/configuration.html#confval-language
+
 |gf| is an  open source finite element library based on a collaborative 
development. If you intend to make some contributions, you can ask for 
membership of the project there. Contributions of all kinds are welcome: 
documentation, bug reports, constructive comments, changes suggestions, bug 
fix, new models, etc ...
 
 Contributors are of course required to be careful that their changes do not 
affect the proper functioning of the library and that these changes follow a 
principle of backward compatibility.
@@ -114,3 +123,35 @@ Some useful git commands
   git log --follow "filepath"   : Show all the commits modifying the specified 
file (and follow the eventual change of name of the file).
 
   gitk --follow filename : same as previous but with a graphical interface
+
+
+Localization(L10N)
+------------------
+
+If you want to contribute to the localization of document. You can join 
|tfwebprj|_ . Please make account in |tfweb|_ and get api token. In case your 
native language is not on project, please contact to administorator of 
|tfwebprj|_ . After translate or check the translation of language in 
transifex, pull translated po file from site by using transifex-client. You 
need api token which you can get in transifex site. ::
+
+  cd doc/sphinx
+  tx pull -l <lang>
+
+Set your native language to <lang> (see |cfvlang|_ ). 
+
+.. warning::
+
+  **DO NOT** tx push to transifex. It will have some trouble. You can upload 
file one by one in project page.
+
+After pulling po files, set <lang> to LANGUAGE in `doc/sphinx/Makefile.am` . ::
+
+  LANGUAGE      = <lang>
+  SPHINXOPTS    = -D language=$(LANGUAGE)
+
+Then, you can run a ::
+
+  cd doc/sphinx
+  make html
+
+in order to make html localization document. If you want to make pdf file in 
your language, you can run a ::
+
+  make latex
+  cd build/latex
+  make all-pdf-<lang>
+