User Tools

Site Tools


en:dev:284:translate

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
en:dev:284:translate [14.08.2015 06:34] – [Wie wird Translate benutzt?] translated first half mrbasemanen:dev:284:translate [18.07.2018 12:46] (current) – [Translations before 2.8.4] Manuela v.d.Decken
Line 1: Line 1:
-FIXME **This page is not fully translated, yet. Please help completing the translation.**\\ //(remove this paragraph once the translation is finished)// 
- 
 ====== Centralized management of translations ====== ====== Centralized management of translations ======
 **Translate** is a package consisting of several classes, that already in WB 2.8.4 take care about all the handling of translations known as 'language files' up to now. **Translate** is a package consisting of several classes, that already in WB 2.8.4 take care about all the handling of translations known as 'language files' up to now.
Line 20: Line 18:
 ==== General ==== ==== General ====
 For simplicity, I'm talking only about 'language files' here. However, in real case usage the translations no longer have to be defined necessarily as arrays in PHP files. Any conceivable suitable file format is possible now. The data don't not even have to be on the same server. The data could be provided by a web service, or stored in a database. For such use cases only a small, specialized driver is necessary, which can be loaded any time, even temporarily even for a single addon or template involved. For simplicity, I'm talking only about 'language files' here. However, in real case usage the translations no longer have to be defined necessarily as arrays in PHP files. Any conceivable suitable file format is possible now. The data don't not even have to be on the same server. The data could be provided by a web service, or stored in a database. For such use cases only a small, specialized driver is necessary, which can be loaded any time, even temporarily even for a single addon or template involved.
-==== Translations before 2.8.==== +==== Translations before 2.10.==== 
-Let's start at the current level at the beginning of 2.8.and earlier. In the central language directory of the core, there are a large number of language files (DE.php | EN.php | etc.). Each of these files contains an overwhelmingly large number of language variables (specifically, currently about 600 !!). The used system requires that in each language file, each entry is present. Missing one often ends up in a runtime error. Once WebsiteBaker starts, one of these language files will be loaded with its full 600 entries forcibly. completely independent of whether even one of them is required! Of course, different addons then load their own language files still additionally. Having several different addons on one page even a very considerable number can also come together.\\ //(From historical times, the translation of many ancient modules are included and a real care of the files, with a reasonable time / effort is virtually impossible. Whoever says otherwise, must be happy from now on take care of these fossil files. ;-))//\\+Let's start at the current level at the beginning of 2.10.and earlier. In the central language directory of the core, there are a large number of language files (DE.php | EN.php | etc.). Each of these files contains an overwhelmingly large number of language variables (specifically, currently about 600 !!). The used system requires that in each language file, each entry is present. Missing one often ends up in a runtime error. Once WebsiteBaker starts, one of these language files will be loaded with its full 600 entries forcibly. completely independent of whether even one of them is required! Of course, different addons then load their own language files still additionally. Having several different addons on one page even a very considerable number can also come together.\\ //(From historical times, the translation of many ancient modules are included and a real care of the files, with a reasonable time / effort is virtually impossible. Whoever says otherwise, must be happy from now on take care of these fossil files. ;-))//\\ 
 +=== Aufbau der Sprachdateien (EN.php) === 
 +<PHP> 
 +//Modul Description 
 +$module_description = 'Enter here a really short description of your module. About 200-250 characters should suffice.'; 
 + 
 +$MOD_MyModule['PRINT'                      = 'Please print this page, if a copy is desired for your records.'; 
 +$MOD_MyModule['LOAD_LAYOUT'                = 'Load Default Layout'; 
 +$MOD_MyModule['TEXT_GUEST'                 = 'Guest'; 
 +$MOD_MyModule['TEXT_UNKNOWN'               = 'unknown'; 
 +$MOD_MyModule['TEXT_PRINT_PAGE'            = 'Print page'; 
 +$MOD_MyModule['MESSAGE_ARCHIVE_DELETED'    = 'Zip(s) deleted successfully.'; 
 +$MOD_MyModule['MESSAGE_ARCHIVE_NOT_DELETED'] = 'Cannot delete the selected Zip(s).'; 
 +</PHP> 
 +somebody wrote this kind of entries: 
 +<PHP> 
 +$MOD_MyModule['PRINT'                      = 'Please print this page, if a copy is desired for your records.'; 
 +$MOD_MyModule_TEXT['GUEST'                 = 'Guest'; 
 +$MOD_MyModule_MESSAGE['ARCHIVE_DELETED'    = 'Zip(s) deleted successfully.'; 
 +</PHP> 
 +It does not look that good, but it works. Both syntax lead to the same Translate keys. 
 +<PHP> 
 +echo $oTrans->MOD_MyModule_PRINT; 
 +echo $oTrans->MOD_MyModule_LOAD_LAYOUT; 
 +echo $oTrans->MOD_MyModule_TEXT_GUEST; 
 +echo $oTrans->MOD_MyModule_TEXT_UNKNOWN; 
 +echo $oTrans->MOD_MyModule_TEXT_PRINT_PAGE; 
 +echo $oTrans->MOD_MyModule_MESSAGE_ARCHIVE_DELETED; 
 +echo $oTrans->MOD_MyModule_MESSAGE_ARCHIVE_NOT_DELETED; 
 +</PHP> 
 + 
 + 
  
 ==== The basic system behind Translate ==== ==== The basic system behind Translate ====
Line 36: Line 66:
  
 When you look at the table on the left (Extract from the Language support of Firefox), you can already see various Chinese, several German and English language in several dialects. The previously used, simple 2-letter codes purely following [[http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes|ISO 639-1]] no longer satisfy at least the most languages with their major, regional to define variations. The use of [[http://en.wikipedia.org/wiki/IETF_language_tag|IETF language tag]] according to [[http://tools.ietf.org/html/rfc5646|RFC 5646]] has therefore in the meantime become to an established standard.  //**Translate**// supports at least the major part of the IETF tags. Not supported are currently the optional //script subtags//, //extension subtags//, and the //private-use subtag//.\\ When you look at the table on the left (Extract from the Language support of Firefox), you can already see various Chinese, several German and English language in several dialects. The previously used, simple 2-letter codes purely following [[http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes|ISO 639-1]] no longer satisfy at least the most languages with their major, regional to define variations. The use of [[http://en.wikipedia.org/wiki/IETF_language_tag|IETF language tag]] according to [[http://tools.ietf.org/html/rfc5646|RFC 5646]] has therefore in the meantime become to an established standard.  //**Translate**// supports at least the major part of the IETF tags. Not supported are currently the optional //script subtags//, //extension subtags//, and the //private-use subtag//.\\
-{{ :dev:284:translate:translatemixing.gif?nolink|}}+{{ :dev:284:translate:translatemixing.png?nolink|}}
 //**Translate**// itself currently includes the following tags: //**Translate**// itself currently includes the following tags:
   * //**Primary language subtag**// based on [[http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes|ISO-639-1/639-2T/639-3]]   * //**Primary language subtag**// based on [[http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes|ISO-639-1/639-2T/639-3]]
Line 59: Line 89:
 Even simpler with add-on files that are called Core-controlled: Here the addon is already activated from the Core. Only the template and/or the theme must still be activated by the addon itself. The deactivation is performed automatically by the core. Even simpler with add-on files that are called Core-controlled: Here the addon is already activated from the Core. Only the template and/or the theme must still be activated by the addon itself. The deactivation is performed automatically by the core.
  
-Jetzt müssen eigentlich nur noch die Übersetzungstexte von Translate abgerufen werdenDer einfachste Weg ist:\\ +Now basically the only thing left is actually to call the translated texts by Translate. The easiest way is: \\ 
-<php> $sText = Translate::getInstance()->TEXT_CANCEL; </php> (entspricht dem früheren <php> $sText = $GLOBALS['TEXT']['CANCEL']; </php>) +<php> $sText = Translate::getInstance()->TEXT_CANCEL; </php>  (corresponds to the former <php> $sText = $GLOBALS['TEXT']['CANCEL']; </php>)
- +
-Für ältere Addons existiert vorübergehend eine Methode, sämtliche Übersetzungstexte in einem Zug an die //**phplib**// Templateengine zu übergeben:\\ +
-<php> $template->set_var(Translate::getInstance()->getLangArray()); </php> eingebunden werden die Texte im Template mit ''{TEXT_CANCEL}''.  +
-Das Problem bei dieser Methode ist, dass immer eine komplette Kopie der Übersetzungstabelle an die Templateengine übergeben wird. +
- +
-Wesentlich einfacher und platzsparender ist die Verwendung in Verbindung mit Twig, da hier nur eine speichersparende Referenz auf das Translateobjekt übergeben wird:\\ +
-<php> $aTwigData['Trans'] = Translate::getInstance(); </php> die Anzeige im Template erfolgt durch ''%%{{ Trans.TEXT_CANCEL }}%%'' +
- +
  
 +Temporarily for older Addons a method exists that allows to pass all translation texts in one rushto the //**phplib**// Template Engine:\\
 +<php> $template->set_var(Translate::getInstance()->getLangArray()); </php> in the template the texts are inserted with ''{TEXT_CANCEL}''.
 +The problem with this method is that always a complete copy of the translation table is passed to the Template Engine.
  
 +Much easier and less space is used in conjunction with Twig, since only a memory-saving reference is passed to the Translate object:\\
 +<php> $aTwigData['Trans'] = Translate::getInstance(); </php> - in order to display it in the template use ''%%{{ Trans.TEXT_CANCEL }}%%''
  
en/dev/284/translate.1439534070.txt.gz · Last modified: 14.08.2015 06:34 by mrbaseman