Changes between Version 2 and Version 3 of OSGeoLive_Translation_Process


Ignore:
Timestamp:
20 Dec 2017 13:56:35 (14 months ago)
Author:
bakaniko
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • OSGeoLive_Translation_Process

    v2 v3  
    5353== Prepare your clone for documentation ==
    5454
    55 <pre>
     55{{{
    5656## Prepare the directory
    5757git clone https://github.com/OSGeo/OSGeoLive-doc docClone
     
    7373Best when reviewing the file:
    7474
    75 <pre>
     75{{{
    7676tx pull -l fr -r osgeolive.quickstart--ideditor_quickstart
    7777</pre>
     
    7979* Download the latest translated <code>*.po</code> files of your language based on translation percentage.
    8080
    81 <pre>
     81{{{
    8282tx pull -l fr --minimum-perc=100
    8383</pre>
     
    8686* Ask for help:
    8787
    88 <pre>
     88{{{
    8989tx pull --help
    9090</pre>
     
    9292=== Checking the download ===
    9393
    94 <pre>
     94{{{
    9595git status
    9696</pre>
     
    102102Viewing your language html will help to put strings in context and/or check the translation.
    103103
    104 <pre>tools/transifex/create_translations.sh fr</pre>
     104{{{tools/transifex/create_translations.sh fr</pre>
    105105The French documentation would be in
    106106
    107 <pre>build/doc/html/fr/doc/index.html</pre>
     107{{{build/doc/html/fr/doc/index.html</pre>
    108108
    109109== Transifex files that are not accepting translations. ==
     
    127127Don't use &quot;translate&quot; button on stand alone references like
    128128
    129 <pre>en:  :ref:`sample`
     129{{{en:  :ref:`sample`
    130130ja:  :ref:`サンプル`    &lt;--- wrong</pre>
    131131== Use a &quot;suggestion&quot; ==
     
    133133When you work with transifex it builds up a translated string bank and it will show one or more suggestions. If the suggestion is very close to what is needed, use it, and change the translation to the final translation of the string. Example:
    134134
    135 <pre>en:              :ref:`pgr_astar&lt;pgr_astar&gt;` - Shortest Path A*
     135{{{en:              :ref:`pgr_astar&lt;pgr_astar&gt;` - Shortest Path A*
    136136Use suggestion:   pgr_astar - A*アルゴリズムを用いた最短経路探索
    137137Modify to:       :ref:`pgr_astar&lt;pgr_astar&gt;` - A*アルゴリズムを用いた最短経路探索</pre>
     
    140140Copy the the stand alone references like
    141141
    142 <pre>en:  :ref:`sample`
     142{{{en:  :ref:`sample`
    143143ja:  :ref:`sample`</pre>
    144144== Type a translation ==
     
    162162If the file you modified in transifex is doc--src--changelog--index and want to check the Japanese translation
    163163
    164 <pre>tools/transifex/download_translation.sh ja pgrouting.doc--src--changelog--index
     164{{{tools/transifex/download_translation.sh ja pgrouting.doc--src--changelog--index
    165165tools/transifex/create_translations.sh ja</pre>
    166166Navigate to the the translated file, for this example it would be
    167167
    168 <pre>build/doc/html/ja/doc/src/changelog/index.html</pre>
     168{{{build/doc/html/ja/doc/src/changelog/index.html</pre>
    169169Notice the relation between names:
    170170
    171 <pre>Transifex name:              pgrouting.doc--src--changelog--index
     171{{{Transifex name:              pgrouting.doc--src--changelog--index
    172172Html Generated File: build/doc/html/ja/doc/src/changelog/index.html</pre>
    173173And visualy compare the &quot;looks&quot; with the [English version] (http://docs.pgrouting.org/2.0/en/doc/index.html)
     
    181181Example:
    182182
    183 <pre>html:    上記クエリは サンプルデータ のネットワークを使用しています。   &lt;-- sample data is translated
     183{{{html:    上記クエリは サンプルデータ のネットワークを使用しています。   &lt;-- sample data is translated
    184184or:      上記クエリは Sample Data のネットワークを使用しています。   &lt;--- sample data needs translation</pre>
    185185If you can navigate the links, you are ok
     
    250250Example
    251251
    252 <pre>en:      The queries use the :ref:`sampledata` network.
     252{{{en:      The queries use the :ref:`sampledata` network.
    253253ja:      上記クエリは :ref:`sampledata` のネットワークを使用しています。 
    254254html:    上記クエリは Sample Data のネットワークを使用しています。</pre>
     
    259259Example
    260260
    261 <pre>en:      The queries use the :ref:`sampledata` network.
     261{{{en:      The queries use the :ref:`sampledata` network.
    262262ja:      The queries use the :ref:`sampledata` network.
    263263html:    The queries use the サンプルデータ  network.</pre>
     
    269269Example
    270270
    271 <pre>en:      The queries use the :ref:`sampledata` network.
     271{{{en:      The queries use the :ref:`sampledata` network.
    272272ja:      上記クエリは: ref:'sampledata'のネットワークを使用しています。   
    273273html:    上記クエリは: ref:'sampledata'のネットワークを使用しています。</pre>
    274274The link's generated by the button need to be corrected, I suggest to copy the link together with its sorrounding spaces from the English version:
    275275
    276 <pre>                            -------------------
     276{{{                            -------------------
    277277en:      The queries use the :ref:`sampledata` network.
    278278ja:      上記クエリは :ref:`sampledata` のネットワークを使用しています。   
     
    286286Inline literals [specs] (http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#inline-markup) require a space before and after. The inline literals we use the most are of the type ``inlineliteral`` like in:
    287287
    288 <pre>``int4`` id of the end point
     288{{{``int4`` id of the end point
    289289``int4``型の始点ノードのID         &lt;--- this will generate the error
    290290``int4 `` 型の始点ノードのID       &lt;--- this will also generate the error (a space is after the 4)
     
    306306To download all language translations:
    307307
    308 <pre>tools/transifex/download_translation.sh</pre>
     308{{{tools/transifex/download_translation.sh</pre>
    309309To download all the translations of a particular language:
    310310
    311 <pre>tools/transifex/download_translation.sh [es|ja|fr|de]</pre>
     311{{{tools/transifex/download_translation.sh [es|ja|fr|de]</pre>
    312312To download the translation of a specific file you need to state the language also
    313313
    314 <pre>tools/transifex/download_translation.sh [es|ja|fr|de] [pgrouting.&lt;filename&gt;]</pre>
     314{{{tools/transifex/download_translation.sh [es|ja|fr|de] [pgrouting.&lt;filename&gt;]</pre>
    315315
    316316== tools/transifex/create_translations.sh ==
     
    325325To create the documentation of all the languages
    326326
    327 <pre>tools/transifex/create_translations.sh</pre>
     327{{{tools/transifex/create_translations.sh</pre>
    328328To create the documentation of a particular language:
    329329
    330 <pre>tools/transifex/create_translations.sh [es|ja|fr|de]</pre>
     330{{{tools/transifex/create_translations.sh [es|ja|fr|de]</pre>
    331331The main index.html of the documentation will be located at:
    332332
    333 <pre>build/doc/html/[es|ja|fr|de]/doc/index.html</pre>
     333{{{build/doc/html/[es|ja|fr|de]/doc/index.html</pre>
    334334
    335335= Main wiki page =