Initial commit

01_overview.rst

@@ -0,0 +1,71 @@
+Overview
+=========
+
+iRIC support multiple languages. Language setting can be changed with
+the following menu.
+
+[Option] --> [Preferences...]
+
+When you change language setting,
+you have to restart iRIC to apply the setting.
+
+This document describes the procedure to prepare
+translation dictionaries of iRIC.
+
+Language dictionary files you need to prepare translation for
+iRIC software are shown in :numref:`table_dic_files`.
+
+.. list-table:: Dictionary files
+   :name: table_dic_files
+   :header-rows: 1
+
+   * - Extension
+     - Description
+     - Solver
+     - GUI
+
+   * - \*.ts
+     - | Xml text file
+       | This file contains the translated texts used in iRIC.
+     - x
+     - x
+
+   * - \*.qm
+     - | Binary file
+       | This file is created from "\*.ts" by "lrelease.exe".
+       | "lrelease.exe" is a executable program which is
+       | included in Qt SDK. Refer to Appendix for detail.
+     - 
+     - x
+
+You can find the translation file(\*.ts and \*.qm) for iRIC GUI
+at the following folder:
+
+  (Install folder)\\iRIC\\guis\\prepost\\languages
+
+The languages currently supported in iRIC, and the file names of
+translation files for each language are shown in
+:numref:`table_languages`. If you want to add translation for
+additional languages, please contact us.
+
+.. list-table:: Languages currently supported
+   :name: table_languages
+   :header-rows: 1
+
+   * - Language
+     - File name
+
+   * - Japanese
+     - \*_ja_JP.ts
+
+   * - Korean
+     - \*_ko_KR.ts
+
+   * - Thai
+     - \*_th_TH.ts
+
+   * - Indonesian
+     - \*_id_ID.ts
+
+   * - Chinese
+     - \*_zh_CN.ts

02_gui_translation.rst

@@ -0,0 +1,69 @@
+GUI translation
+================
+
+Step 1
+------
+
+Find the translation file (\*.ts) you want to edit, which is located in:
+
+  (Install folder)\\iRIC\\guis\\prepost\\languages
+
+
+Step 2
+-------
+
+Open the translation file with text editor and add translations for each English word.
+Please refer to :numref:`code_ts_before_editing` and
+:numref:`code_ts_after_editing`.
+
+.. code-block:: xml
+   :caption: *.ts before editing
+   :name: code_ts_before_editing
+
+   <message>
+     <location filename="../main/animationcontroller.cpp" line="48"/>
+     <source>Animation ToolBar</source>
+     <translation type="unfinished"></translation>
+   </message>
+
+.. code-block:: xml
+   :caption: *.ts after editing
+   :name: code_ts_after_editing
+
+   <message>
+     <location filename="../main/animationcontroller.cpp" line="48"/>
+     <source>Animation ToolBar</source>
+     <translation>アニメーションツールバー</translation>
+   </message>
+
+What you should do is as follows:
+
+1. Delete "type=unfinished"
+2. Add translated text between <translation> and </translation>
+3. Save the file
+
+Step 3
+-------
+
+Compile "*.ts" file using "lrelease.exe"
+
+**You should install Qt SDK to get lrelease.exe. See Appendix for detail.**
+
+1. Launch "Qt 5.5 64-bit for Desktop (MSVC 2013)" from menu below:
+
+      [Windows Start Menu] --> [Qt] --> [5.5] --> [MSVC 2013 (64-bit)]
+
+2. Move to the folder which contains "*.ts" file.
+3. Execute the following command.
+
+.. code-block:: batch
+
+   lrelease.exe (dictionary file name)
+
+After you execute the command, you'll see that *.qm is created in the same folder.
+
+Step 4
+-------
+
+You can check the translated text in the iRIC GUI after restarting it.
+

03_solver_translation.rst

@@ -0,0 +1,82 @@
+Solver translation
+===================
+
+Step 1
+------
+
+Create or update the translation file (*.ts) for the solver you
+want to prepare translation.
+
+1. Select [Option] --> [Create/Update Translation Files] in iRIC GUI menu.
+   Refer to :numref:`img_tr_menu`.
+
+2. Click the next button on the dialog in :numref:`img_tr_wizard_introduction`.
+
+3. Select Solver and Languages you want to prepare translation on the dialog in
+   :numref:`img_tr_wizard_select`. Click the Next button.
+
+4. Click the Finish button. The path you'll get translation file (*.ts) is shown
+   on the dialog, as in :numref:`img_tr_wizard_confirm`.
+
+
+.. _img_tr_menu:
+
+.. figure:: images/tr_menu.png
+
+   "Create/Update Translation Files" menu
+
+.. _img_tr_wizard_introduction:
+
+.. figure:: images/tr_wizard_introduction.png
+
+   Introduction page
+
+.. _img_tr_wizard_select:
+
+.. figure:: images/tr_wizard_select.png
+
+   Select Program and Languages page
+
+.. _img_tr_wizard_confirm:
+
+.. figure:: images/tr_wizard_confirm.png
+
+   Confirm the result page
+
+Step 2
+------
+
+Open the translation file with text editor and add translations for each English word.
+Please refer :numref:`code_ts_before_editing_solver` and
+:numref:`code_ts_after_editing_solver`.
+
+.. code-block:: xml
+   :caption: *.ts before editing
+   :name: code_ts_before_editing_solver
+
+   <message>
+      <source>Boundary Condition</source>
+      <translation></translation>
+   </message>
+
+.. code-block:: xml
+   :caption: *.ts after editing
+   :name: code_ts_after_editing_solver
+
+
+   <message>
+     <source>Boundary Condition</source>
+     <translation>境界条件</translation>
+   </message>
+
+
+What you should do is as follows:
+
+1. Add translated text between <translation> and </translation>
+2. Save the file
+
+Step 3
+-------
+
+You can see the translated text in the iRIC software when you restart
+the iRIC and starts a project for the solver you prepared translation file.

04_appendix.rst

@@ -0,0 +1,91 @@
+.. _sec_appendix:
+
+Appendix: Installilng Qt SDK
+=============================
+
+You can download the Qt SDK installer from following url:
+
+https://www.qt.io/download
+
+1. Click on "Go open source" link. It is at almost the bottom of the page.
+2. Click on "Accept" link.
+3. Click on "Download" link.
+
+Then, you'll get qt-unified-windows-x86-3.0.2-online.exe (Maybe the version number is different).
+
+Now, launch the installer by double-clicking.
+
+1. In :numref:`qt_installer1`, click on "Next" button.
+   If you are connecting internet where you need proxy setting,
+   Please press "Setting" button before you proceed, to setup
+   proxy setting.
+
+2. In :numref:`qt_installer2`, click on "Skip" button.
+   If you already have Qt account, or want to create a new Qt Account,
+   You can fill in "Login" or "Sign-up" form.
+
+3. In :numref:`qt_installer3`, click on "Next" button.
+   Downloading meta data about files to install will start.
+   This will take some time.
+
+4. In :numref:`qt_installer4`, enter the directory where you want to
+   install Qt, and click on "Next" button.
+
+5. In :numref:`qt_installer5`, check on Qt / Qt 5.5 / msvc2013 64-bit,
+   and click on "Next" button.
+
+6. In :numref:`qt_installer6`, read the license, check on
+   "I have read and agree to the terms contained in the license agreements",
+   and click on "Next" button.
+
+7. In :numref:`qt_installer7`, click on "Next" button.
+
+8. In :numref:`qt_installer8`, click on "Install" button.
+
+.. _qt_installer1:
+
+.. figure:: images/qt_installer1.png
+
+   Qt Installer welcome page
+
+.. _qt_installer2:
+
+.. figure:: images/qt_installer2.png
+
+   Qt Account page
+
+.. _qt_installer3:
+
+.. figure:: images/qt_installer3.png
+
+   Qt Installer setup page
+
+.. _qt_installer4:
+
+.. figure:: images/qt_installer4.png
+
+   Qt Install folder select page
+
+.. _qt_installer5:
+
+.. figure:: images/qt_installer5.png
+
+   Component select page
+
+.. _qt_installer6:
+
+.. figure:: images/qt_installer6.png
+
+   License agreement page
+
+.. _qt_installer7:
+
+.. figure:: images/qt_installer7.png
+
+   Start menu shortcut page
+
+.. _qt_installer8:
+
+.. figure:: images/qt_installer8.png
+
+   Install ready page

_static/css/custom.css

@@ -0,0 +1,13 @@
+@import url('theme.css');
+
+div.figure {
+	text-align: center;
+}
+
+div.figure p.caption {
+	text-align: center;
+}
+
+div.code-block-caption {
+	text-align: center;
+}