CKFinder 2.x/Localization - Revision history

Anna: /* Localizing the Help Files */ Minor clarification added

2011-09-27T21:41:55Z

‎Localizing the Help Files: Minor clarification added

Anna: /* Localizing the Help Files */ Minor updates

2011-09-27T21:40:13Z

‎Localizing the Help Files: Minor updates

Anna: /* Localizing the Help Files */ Screenshot comments added

2011-09-08T14:07:02Z

‎Localizing the Help Files: Screenshot comments added

Anna: moved CKFinder 2.x/Globalization to CKFinder 2.x/Localization: New name more appropriate

2011-08-17T10:39:39Z

moved CKFinder 2.x/Globalization to CKFinder 2.x/Localization: New name more appropriate

Anna: /* Automatic Language Detection */ Link to API added

2011-08-17T10:36:31Z

‎Automatic Language Detection: Link to API added

Anna: Setting the Date and Time Format added

2011-08-17T10:34:09Z

Setting the Date and Time Format added

Anna: Article contents proof-read and formatted

2011-08-17T10:29:16Z

Article contents proof-read and formatted

Wiktor at 14:47, 18 May 2010

2010-05-18T14:47:03Z

Wiktor at 14:45, 18 May 2010

2010-05-18T14:45:58Z

Wiktor at 14:42, 18 May 2010

2010-05-18T14:42:07Z

@@ Line 48: / Line 48: @@
 It is possible to localize the CKFinder Help files. Follow these steps to translate them to, for example, German:
 * Create a copy of the <code>en</code> subfolder in the <code>help</code> folder and rename it to <code>de</code>.
-* Edit all related HTML files inside the <code>de</code> folder.
+* Translate the texts of all related HTML files inside the <code>de</code> folder.
 * In the localization file for German (<code>lang/de.js</code>), set the <code>HelpLang</code> entry to <code>de</code>.

@@ Line 47: / Line 47: @@
 == Localizing the Help Files ==
 It is possible to localize the CKFinder Help files. Follow these steps to translate them to, for example, German:
-* Create a copy of the <code>en</code> subfolder in the <code>core/help</code> folder and rename it to <code>de</code>.
+* Create a copy of the <code>en</code> subfolder in the <code>help</code> folder and rename it to <code>de</code>.
 * Edit all related HTML files inside the <code>de</code> folder.
-* In the localization file for German (<code>core/lang/de.js</code>), set the <code>HelpLang</code> entry to <code>de</code>.
+* In the localization file for German (<code>lang/de.js</code>), set the <code>HelpLang</code> entry to <code>de</code>.
 === Localizing Help Screenshots ===
 We recommend to reuse the English language CKFinder screenshots since they are always up-to-date (and you will not need to redo them yourself).
-It is also our policy to keep the bilingual names of CKFinder commands and terms in the localized Help files, with the English version given first, and its localized version given in parentheses. Examples: German: '''Cancel''' ('''Abbrechen'''), French: '''Upload''' ('''Envoyer'''), Spanish: '''Select''' ('''Seleccionar''').
+It is also our policy to keep the bilingual names of CKFinder commands and terms in the localized Help files, with the localized version given first, and its its English equivalent given in parentheses. Examples: German: '''Abbrechen''' ('''Cancel'''), French: '''Envoyer''' ('''Upload'''), Spanish: '''Seleccionar''' ('''Select''').
 Your users will now enjoy a fully localized experience with CKFinder.

@@ Line 48: / Line 48: @@
 It is possible to localize the CKFinder Help files. Follow these steps to translate them to, for example, German:
 * Create a copy of the <code>en</code> subfolder in the <code>core/help</code> folder and rename it to <code>de</code>.
-* Edit all related files inside the <code>de</code> folder.
+* Edit all related HTML files inside the <code>de</code> folder.
 * In the localization file for German (<code>core/lang/de.js</code>), set the <code>HelpLang</code> entry to <code>de</code>.
 Your users will now enjoy a fully localized experience with CKFinder.

@@ Line 6: / Line 6: @@
 By default CKFinder will try to detect the user language. If a localization file is available for that language, the interface will be adapted to it automatically. If no matching language file is available, a default language will be loaded (US English by default).
-In order to disable automatic language detection, edit the <code>config.js</code> file and set the language to one of available languages.
+In order to disable automatic language detection, edit the <code>config.js</code> file and set the language to one of available languages by using the <code>[http://docs.cksource.com/ckfinder_2.x_api/symbols/CKFinder.config.html#.language config.language]</code> configuration setting.
 For example, the following setting forces CKEditor to display the interface in German, disabling the automatic detection feature:

@@ Line 39: / Line 39: @@
 * <code>HelpLang</code> &ndash; sets the language of the Help files. If you have not localized them, leave this entry intact (<code>en</code>) or set it to any of the available translated Help files.
 * <code>HelpTip</code> &ndash; if you have not localized the Help files, we recommend you indicate the Help language in the tooltip. For example, for Italian you may translate it to "Aiuto (Inglese)".
 == Localizing the Help Files ==

← Older revision	Revision as of 10:39, 17 August 2011
(No difference)

@@ Line 1: / Line 1: @@
 __TOC__
-CKFinder is fully localizable considering specific language cultural aspects, like date formatting.
+CKFinder is fully localizable, including language-specific cultural aspects like date formatting.
 == Automatic Language Detection ==
-By default, CKFinder will try to detect the user language. If a localization file is available for that language the interface is automatically adapted to it. If no language file is available, a default language is loaded (by default US English).
+In order to disable automatic language detection, edit the <code>config.js</code> file and set the language to one of available languages.
-To disable the automatic language detection, simply edit the '''config.js''' file and set language to one of available languages.
+For example, the following setting forces CKEditor to display the interface in German, disabling the automatic detection feature:
+<source lang="javascript">
 config.language = 'de';
 </source>
 == Localizing CKFinder ==
-Localize is the act of adapting a software to a culture. In CKFinder, this is done by creating a localization file in the "lang" folder and a small localization file for the server side part of CKFinder inside of core/connector/ext/lang folder.
+For example, to create a Japanese localization file, follow the steps described below:
+* Create a copy of the English localization file (<code>en.js</code>) and name it <code>jp.js</code>.
-For example, to create a Japanese localization file, just follow these steps:
+* Edit the <code>jp.js</code> file and translate all language strings. This file is in JavaScript format, so the string format must respect the JavaScript specification.
 * Save the file. We recommend using the UTF-8 encoding.
-* Open ckfinder.js in your favourite editor (make a backup first), search for:
+* Open the <code>ckfinder.js</code> file in your favourite editor (make a backup first), and search for:
-<source>
+<source lang="javascript">
 var l={};a.lang={ko:{cs:1,de:1,en:1,'es-mx':1,hu:1,lv:1,nl:1,no:1,'pt-br':1,sk:1,sv:1,'zh-tw':1,
 da:1,el:1,es:1,fr:1,it:1,nb:1,nn:1,pl:1,ru:1,sl:1,'zh-cn':1}
 </source>
-and add there '''<code>'jp':1</code>'''
+and add '''<code>'jp':1</code>''' there:
-<source>
+<source lang="javascript">
 var l={};a.lang={ko:{'jp':1,cs:1,de:1,en:1,'es-mx':1,hu:1,lv:1,nl:1,no:1,'pt-br':1,sk:1,sv:1,'zh-tw':1,da:1,
 el:1,es:1,fr:1,it:1,nb:1,nn:1,pl:1,ru:1,sl:1,'zh-cn':1}
 </source>
-(and save the file).
+Save the file.
-* You may disable the automatic language detection and set the new language as the default one, to force the browser to load your file.
+* You may disable automatic language detection and set the new language as the default one in order to force the browser to load your file.
-* Test the interface.
+* Test the user interface to check the correctness of your localization.
-* Note: to avoid having to change ckfinder.js, simply send us your translation (see [[#Contributing_Localizations|Contributing Localizations]]) and we will include it in the next release.
+* Note: to avoid having to change <code>ckfinder.js</code>, you can send us your translation (see [[#Contributing_Localizations|Contributing Localizations]]) and we will include it in the next release.
 The following are some notes about a few localization entries in the language file:
+* <code>dir</code> &ndash; sets the interface reading direction. You can choose between <code>ltr</code> for Left-to-Right languages like English and <code>rtl</code> for Right-to-Left languages like Hebrew or Arabic.
-* '''dir''': sets the interface reading direction. At this time, CKFinder is not compatible with right-to-left languages, so leave this entry as 'ltr'.
+* <code>HelpLang</code> &ndash; sets the language of the Help files. If you have not localized them, leave this entry intact (<code>en</code>) or set it to any of the available translated Help files.
-* '''HelpLang''': if you don't have also localized the help files, leave this entry intact ('en') or set it to any of the available help translated languages.
+* <code>HelpTip</code> &ndash; if you have not localized the Help files, we recommend you indicate the Help language in the tooltip. For example, for Italian you may translate it to "Aiuto (Inglese)".
 == Localizing the Help Files ==
-It is possible to localize the CKFinder help files. Just follow these steps to translate it to, for example, German:
+Your users will now enjoy a fully localized experience with CKFinder.
 == Contributing Localizations ==
-We of course welcome localization files contributions. In this way, others can also give their contributions to make the translations better and more complete. Feel free to [http://cksource.com/contact contact us] for it.
+<note>We prepared a '''''nice gift''''' for each person who will send us a complete (new) translation ;-) Just make sure to provide us with your e-mail address so we can contact you.</note>

@@ Line 43: / Line 43: @@
 * '''HelpTip''': if you don't have localized the help files, we recommend indicating the help language in the tooltip. For example, in Italian you may translate it to "Aiuto (Inglese)".
-== Localizing the Help files ==
+== Localizing the Help Files ==
 It is possible to localize the CKFinder help files. Just follow these steps to translate it to, for example, German: