Please note: This Blog was updated with a few clarifications on October 21st 2011.
As we announced in the release Blog for SQLyog version 9.3 we here publish instructions and tools for localizing SQLyog.
To understand how localization works you should first open the SQLyog 9.3 installation folder on your system. Inside it there is a (SQLite) database file named “L10n.db”. It contains all strings in all localizations distributed by us (currently English and Japanese) displayed by SQLyog GUI. If you have selected to run SQLyog in a non-English language SQLyog will load the localized strings from this file and use them for display and not the English strings. To enable more languages just copy an updated “L10n.db” file with support for more languages into the SQLyog installation folder.
The tools for localization are available from the SQLyog Community repository at Googlecode (http://code.google.com/p/sqlyog/). It is the contents of the ‘localization’ folder in the ‘source’ tab. From here on we will use the term SQLyog localization kit for the contents of this ../localization/ folder. To check out the localization kit for the latest SQLyog GA release use the link https://sqlyog.googlecode.com/svn/branches/stable_ga/localization/(and https://sqlyog.googlecode.com/svn/trunk/localization/ for the latest public release whether beta, RC or GA) for your SVN client (TortoiseSVN recommended for most Windows users). It contains tools and resources needed to add more languages/localizations to the “L10n.db” file.
Let us start listing the content:
* In the ‘bin’ folder you will find a “L10n.db” database completely identical to the one shipped with the SQLyog installer.
* In the ‘Strings’ folder you will find a XML-file named “Config.XML” and (in a recursive “String” folder) a folder for each language supported (named “en” and “ja”). In each of those folders you will find a number of XML files (following ‘Android XML’ specification) with English and localized Japanese strings respectively.
* The batch file ‘compile.bat’. It is a batch script calling a ‘compiler’ that generates an updated “L10n.db file” based on the content of the “Strings” folder.
* The ‘Tools’ folder is not something you should normally care about. It contains some resources, shared libraries and executables etc. (such as the ‘compiler’ referred to above). The content of it is used by the ‘compile.bat’ file – and not by user/translator directly.
To make a translation there are bascially 4 steps:
First step is to define a new language in the “Config.XML” file. We will assume that we are translating to German. In the passage that looks like
<ja langname=”日本語” />
.. add support for German like this:
<ja langname=”日本語” />
<de langname=”Deutsch” />
“de” is the language code and “Deutsch” is how it will display in the SQLyog UI. Please note that we use the language codes from this Microsoft document. It does not matter currently actually, but it may later be used for auto-detection of some LOCALE-specific parameters (decimal format, date format etc.), so please stick to the Microsoft recommendation unless there is a compelling reason not to do so. Also be careful not to change the encoding of the file. It is UTF8 and should remain so.
Make a copy of the “en” folder and rename the copy “de”.
Now comes the hard work. Translate the XML files in the “de” folder from English to German. And again be careful not to change the encoding of the files.
Also note the details:
* XML standards for encoding of special characters must be honoured (‘'’ for “‘” (apostrophe) etc.). The characters that should be encoded are & (&), < (<), > (>) , ” (") and ‘ (') – and NO MORE! This is XML and not HTML!
* occurrences of “%d” and “%s” must be kept as they are and should be in the same order they appear in “en”. Failure to do so will result in an error in the next step.
* Also keyboard shortcuts are handled from the XML files. Actually there are two kinds of keyboard shortcuts in SQLyog (like in most Windows programs):
a) One kind is ‘static shortcuts’.
Those are the ones the you find listed in the “help .. keyboard shortcuts’ menu. Let’s have a look at a randomly picked string in English here:
<string name=”1027″>Schema Synchronization Tool (Ctrl+Q)</string>
The substring “(Ctrl+Q)” should not be translated. This kind of keyboard shortcuts are not localized. “(Ctrl+Q)” is just part of what is displayed. It is a constant string. The functionality of this type of shortcut is hardcoded into SQLyog.
b) ‘language dependent shortcuts’.
This is a Windows feature that it seems a lot of people don’t really know about. To understand what it is (if you don’t) just open SQLyog (in English) and press the ALT key. You will see that some letters in the menu become underlined. For instance in the menu item “Table”, the “a” is underlined. You may next open the table menu by pressing “a” and even continue selecting from the submenu pressing a single letter key. In Windows this is achieved by preceeding “a” with an “&” in the menu (where it is not displayed – it only ‘codes’ the “a” to be a shortcut). So Windows ‘knows’ this menu item as “T&able” internally. That string is also what the “L10n.db” database contains. Do not forget here that in the XML files “&” needs to be encoded as “&”. So the German string in the XML file for the “Table” menu item could be “T&abelle” (if you want to keep “a” as the ALT-keyboard shortcut in German). When choosing this type of shortcuts you should be careful not to use the same more than once in same menu level and you should of course try to follow de-facto standards as used in localized Windows itself, utilities that ship with Windows (Notepad etc.) as well as commonly used Windows programs (like office suites, browsers etc.).
Also you may use XML/HTML-comments in the XML-files. That could be useful for instance if more people share the work of a translation or if there is something that you want to identify easily later.
A concluding comment on editors: Some editors may have issues with UTF8 and they should not be used. Notepad will work fine but it does not support syntax highlighting, auto-indenting and similar ‘developer features’ that are convenient to have. We have checked with Notepad++ that works fine – but there are undoubtedly dozens of editors available out there that will do the job. And also do not use a Word Processor – it should be a plain text editor.
Once you have completed the translation of the XML files just execute the ‘compile.bat’ file from command line. German strings from the XML files you translated will be inserted to the ‘L10n.db’ database in the ‘bin’ folder. The updated ‘L10n.db’ can now be copied into the SQLyog installation folder and SQLyog will have the option for German language.
Finally please note that we have a category in our Forums dedicated to localization. If you are facing a problem feel free to discuss with us or fellow countrymen for details of a translation.