View source for Slicer4:Internationalization of Slicer

[[Slicer4:Developers| Back to Slicer 4 Developers]]

=Introduction=

This pages contains notes on source code additions and modifications of different modules within Slicer for the internationalization purpose.
=QT-based Internationalization=
Internationalization is well supported in QT. A lot of modules of Slicer are developed on QT. This has set a good ground for the internationalization of Slicer. 
*basic idea
In Qt, tr() is one of the static public members of QObject class, which returns a translated version of input sourceText.
    QString QObject::tr ( const char * sourceText, const char * disambiguation = 0, int n = -1 ) [static]
tr() will search the translation in a so-called translation file. If nothing is found, then the sourceText instead of the translated version will be displayed directly. For example,
    label->setText(tr("Measurement"));
*translation file template
The following is an example of the translation file, from English to Chinese.

<pre>
    <?xml version="1.0" encoding="utf-8"?>
    <!DOCTYPE TS>
    <TS version="2.0" language="zh_CN">
    <context>
    <name>qSlicerMainWindow</name>
    <message>
        <source>&amp;File</source>
        <translation>文件</translation>
    </message>
    <message>
        <source>&amp;Edit</source>
        <translation>编辑</translation>
    </message>
    <message>
        <source>Feedback</source>
        <translation>反馈</translation>
    </message>
    <message>
        <source>Import Scene</source>
        <translation>导入场景</translation>
    </message>
    <message>
        <source>Add Data</source>
        <translation>添加数据</translation>
    </message>
    </context>
    </TS>
</pre>

In the above example, all the texts are within the scope of qSlicerMainWindow class. So, 'qSlicerMainWindow' occurs in section 'name'.

*Prepare translation file
The translation file can be prepared manually based on the above template and file name extension should be like .ts, for example, lang_hz.ts, lang_de.hz, etc.
Translation file can also be created conviently by a tool called lupdate. lupdate is a command line tool that finds the translatable strings (tr())in the specified source, header and Qt Designer interface files, and produces or updates .ts translation files. TS files are text files, which can be viewed or edited by any text editor tools. The following command searchs the folder and subfolders for tr() occurences in files (.ui, .h, .cxx) and create translation file test.ts.
       Usage: lupdate c:\myproject\slicer4\ -ts   test.ts
 
lrelease is a command line tool that produces QM files out of TS files. The QM file format is a compact binary format that is used by the localized application. It provides extremely fast lookups for translations. 
       Usage: lrelease test.ts

*Modifications to the source codes:

In file \Slicer4\Base\QTCore\qSlicerCoreApplication.h, add the following line:
    #include <QTranslator>
In file \Slicer4\Applications\SlicerQT\main.cxx (around line#230), add the following lines:
<pre>
    static QTranslator* translator;
    if (translator != NULL)
    {
        qApp->removeTranslator(translator);
        delete translator;
        translator = NULL;
    }
    QString langCode= argv[1];
    translator = new QTranslator;
    QString qmFilename = "lang_" + langCode; 
    if (translator->load(qmFilename))
    {
        qApp->installTranslator(translator);
    }
</pre>

If slicer4 launches with the first argument being 'zh', lang_zh.qm will be installed. The extension .qm doesn't need to be specified, for installTranslator only loads QM file.

*To be continued

=Scripted Module=
Some modules are implemented in Python. Endoscopy is one of the typical examples. In endoscopy.py, if we change the code in line#10 
    parent.titel = “Endoscopy”
to
    parent.title = slicer.app.translate(self.__class__.__name__, "Endoscopy")
then "Endoscopy" can be shown in other languages.Similarily, other displayable strings can be handled in the same way.
In endoscopy.py, classes 'Endoscopy' and 'EndoscopyWidget' are defined. String "Endoscopy" is used in Class 'Endoscopy'. Strings like 'Path' ,'Input Fiducial' and 'camera' are used in 'EndoscopyWidget'. The following lines should be appended in the TS file:

<pre>
    <context>
         <name>Endoscopy</name>
         <message>
         <source>Endoscopy</source>
         <translation>内窥镜</translation>
         </message>
    </context>
    <context>
         <name>EndoscopyWidget</name>
         <message>
         <source>Path</source>
         <translation>路径</translation>
         </message>
         <message>
         <source>Camera</source>
         <translation>相机(Camera)</translation>
         </message>
         <message>
         <source>Input Fiducials</source>
         <translation>输入参考点(Input Fiducials)</translation>
         </message>
    </context>
</pre>

[[image:EndoscopyGUI.png|left|thumb|400px|Screenshot of the Chinese version of the GUI for Endoscopy module]]

=To be continued=