Personal tools

OpenEMR Internationalization Configuration

From OpenEMR Project Wiki

(Difference between revisions)
Jump to: navigation, search
(Manage Translations)
 
(41 intermediate revisions not shown)
Line 1: Line 1:
-
<span style="color:red;">NOTE THAT IF YOU ARE INTERESTING IN HELPING WITH TRANSLATIONS, PLEASE CLICK [[OpenEMR Internationalization Development|HERE]] FOR MORE INFORMATION</span>
 
-
 
-
 
__TOC__
__TOC__
= <center> OpenEMR Internationalization Documentation </center> =
= <center> OpenEMR Internationalization Documentation </center> =
-
== Multi Language Tool. ==
+
== Language Translations Settings ==
-
This is the Language Administration page in OpenEMR (Adminstration->Language). This is where you can customize languages and language definitions. You can add new languages,
+
These are configured in [[Administration_Globals#Locale|Administration->Globals->Locale]].
-
,add new English Constants, and modify/add language definitions. (Please note
+
Mainly, you can configure the default language and
-
you can also enter your translations into the official OpenEMR Language
+
what is displayed in the login language selection menu (you
-
Translation GoogleDoc spreadsheet; see section II. for details)
+
can also disable this menu). There are also more advanced
-
 
+
setting to turn off certain parts of the translation
-
  The following is an explanation of the options in this tool:
+
engine. Please see the Locale section of the
-
    Add Language: You get a box to enter a new language.
+
[[Administration_Globals#Locale|Administration Globals]] wiki page for more details.
-
    Add Constant: You get a box to add a new string to be used in the translation
+
-
                  function, this one should be used only if you know what you are
+
-
                  doing, mostly, if you added some custom programming with new
+
-
                  text output. The "constant" string can be literally what you
+
-
                  want to say or a shorter reference to it.
+
-
    Edit Definitions: English is used as the reference language, if you click
+
-
                      the English label you'll get a set of all constants and
+
-
                      the English definitions at the side. If no definition is
+
-
                      loaded yet for a given constant then a blank box is shown,
+
-
                      by entering a definition and clicking "Load Definition"
+
-
                      you save whatever changes you made. If you click other
+
-
                      label than English, you get a set of all constants,
+
-
                      the English definition at the side, and an input box
+
-
                      to enter/modify the definition in the selected language.
+
-
    Manage Translations: This tool allows you to re-synchronize your
+
-
                        local language modifications after importing
+
-
                        an official released set of OpenEMR translations.
+
== Official OpenEMR Language Translations ==
== Official OpenEMR Language Translations ==
-
The OpenEMR language translations are built from a collaborative Google
+
The OpenEMR language translations are built from a [http://spreadsheets.google.com/ccc?key=0AtTW60zHo6HzcGg0UE9JMGJHM1NsSWpuYkh0Snl4Q0E&hl=en collaborative Google Doc]. If you would like to add a language or help with a current language,
-
Doc. If you would like to add a language or help with a current language,
+
please see the [[OpenEMR Internationalization Translator Guide]] wiki page for more details .  You could then enter your translations into this
-
please contact us.  You could then enter your translations into this
+
spreadsheet, which will then become a permanent part of OpenEMR. This
spreadsheet, which will then become a permanent part of OpenEMR. This
-
process has become very streamlined with a fast turnaround time, so
+
process has become very streamlined with a fast turnaround time(daily builds), so
we would suggest you enter data on this collaborative spreadsheet rather
we would suggest you enter data on this collaborative spreadsheet rather
than entering into your local OpenEMR installation only. Note that the
than entering into your local OpenEMR installation only. Note that the
-
translations sets are built daily. To download the most uptodate set of
+
translations sets are built daily. [[Install Translations|The most uptodate set of
-
translations, go [[Install Translations|HERE]].
+
translations can be downloaded here]].
-
== Language Translations Setting ==
+
== Multi Language Tool. ==
-
 
+
-
These are configured in the openemr/interface/globals.php
+
-
file. Mainly, you can configure the default language and
+
-
what is displayed in the login language selection menu (you
+
-
can also disable this menu). There are also more advanced
+
-
setting to turn off certain parts of the translation
+
-
engine. Please see the Language section of
+
-
openemr/interface/globals.php for more details.
+
-
 
+
-
 
+
-
== Developer Instructions ==
+
-
 
+
-
The translation is done by the xl() custom function, which can be found
+
-
at openemr/library/translation.inc.php.
+
-
Its semantics are very simple.
+
-
 
+
-
<pre>xl(string)</pre>
+
-
 
+
-
Which with examples means:
+
-
 
+
-
<pre>xl('translate this')</pre>
+
-
 
+
-
By default the function will return the translation.
+
-
 
+
-
First it uses the LANGUAGE constant defined to pick the translation.
+
-
Second it goes for the translation, if none is found, then the same string entered is used and returned as is.
+
This is the Language Administration page in OpenEMR (Administration->Language). This is where you can customize languages and language definitions. You can add new languages,
 +
,add new English Constants, modify/add language definitions, and synchronize your local changes back after importing the official OpenEMR language translation sets.
-
Another example of use includes:
+
The following is an explanation of the options in this tool:
 +
===Add Language===
 +
:You get a box to enter a new language.
 +
===Add Constant===
 +
:You get a box to add a new string to be used in the translation function, this one should be used only if you know what you are doing. The "constant" string can be literally what you want to say or a shorter reference to it.
-
<pre>echo ("this and " . xl('translate this') . " that too");</pre>
+
===Edit Definitions===
 +
:English is used as the reference language, if you click the English label you'll get a set of all constants and the English definitions at the side. If no definition is loaded yet for a given constant then a blank box is shown, by entering a definition and clicking "Load Definition" you save whatever changes you made. If you click other label than English, you get a set of all constants, the English definition at the side, and an input box to enter/modify the definition in the selected language.
-
Further details and rules on use can be found on the wiki here:
+
===Manage Translations===
-
[[Development_Policies#Internationalization|Development Policies - Internationalization]]
+
:This tool allows you to re-synchronize your local language modifications after importing an official released set of OpenEMR translations.
-
There are also wrappers to the xl() function that are used infrequently in specific situations. Please
 
-
refer to openemr/library/translation.inc.php for more details.
 
-
[[Category:Internationalization]]
+
[[Category:User Guide 4.1.2]][[Category:User Guide]][[Category:User Guide 4.1.1]][[Category:User Guide 4.1.0]][[Category:Translator Guide]][[Category:Configuration Guide]][[Category:Internationalization]]

Latest revision as of 06:58, 8 July 2013

Contents


OpenEMR Internationalization Documentation

Language Translations Settings

These are configured in Administration->Globals->Locale. Mainly, you can configure the default language and what is displayed in the login language selection menu (you can also disable this menu). There are also more advanced setting to turn off certain parts of the translation engine. Please see the Locale section of the Administration Globals wiki page for more details.

Official OpenEMR Language Translations

The OpenEMR language translations are built from a collaborative Google Doc. If you would like to add a language or help with a current language, please see the OpenEMR Internationalization Translator Guide wiki page for more details . You could then enter your translations into this spreadsheet, which will then become a permanent part of OpenEMR. This process has become very streamlined with a fast turnaround time(daily builds), so we would suggest you enter data on this collaborative spreadsheet rather than entering into your local OpenEMR installation only. Note that the translations sets are built daily. The most uptodate set of translations can be downloaded here.

Multi Language Tool.

This is the Language Administration page in OpenEMR (Administration->Language). This is where you can customize languages and language definitions. You can add new languages, ,add new English Constants, modify/add language definitions, and synchronize your local changes back after importing the official OpenEMR language translation sets.

The following is an explanation of the options in this tool:

Add Language

You get a box to enter a new language.

Add Constant

You get a box to add a new string to be used in the translation function, this one should be used only if you know what you are doing. The "constant" string can be literally what you want to say or a shorter reference to it.

Edit Definitions

English is used as the reference language, if you click the English label you'll get a set of all constants and the English definitions at the side. If no definition is loaded yet for a given constant then a blank box is shown, by entering a definition and clicking "Load Definition" you save whatever changes you made. If you click other label than English, you get a set of all constants, the English definition at the side, and an input box to enter/modify the definition in the selected language.

Manage Translations

This tool allows you to re-synchronize your local language modifications after importing an official released set of OpenEMR translations.