Making a Language File
WARNING: Translation for software is no "walk in the park". If you're up for the challenge, your help is appreciated and the steps are below.
- Languages that have already been completed are:
- First, you'll need a UTF-8 capable text editor. I really like the free Notepad++ if you need one.
- Right click and download language_english.xml (This file always is from the latest version of SteadyMouse)
- Rename the file to "language_<your language goes here>.xml"
- Open the file in Notepad++:
- You'll only be modifying fields like those highlighted in red in the picture above (click for full size).
- Follow the instructions in the comments to set:
- Translate each of the strings. These have the format:
- <string lookup_id="1001">TEXT TO TRANSLATE</string>
- For context of where an XML string shows up in the GUI use the Quick Reference here
- Within some of the strings you will occasionally see special symbols such as:
- When you see those symbols, simply leave them be. They get automatically replaced by the software with line-breaks, numbers, and short words. The order of these symbols must be preserved within each string. Simply translate around them.
- Within translated strings avoid use of these symbols: &, <, >
- Brevity will be important. Shorter is better. Try to keep overall length of each translated string under 130% of the length of the English version. This is so the strings have room to fit in the GUI.
- Save and email the new file to localization @steadymouse.com and it will be included in the next update.
Testing a Language File
SteadyMouse 2 or later should be installed prior to testing out a language file. Additionally, make sure it's updated to the latest version by checking for updates!
- Place a copy of your new language xml file into the installation folder at "C:\Program Files (x86)\SteadyMouse"
- Next, quit SteadyMouse and re-launch so that is scans and finds the new language file.
- Open the language selection dialog from the tray menu:
- You should now see the new language as a selectable option in the pop-up dialog
- Select the desired language and click OK.
- You'll want to navigate through all of the GUI windows, controls, and info bubbles to verify things look correct and that no text was so long that it gets cut off.
- To force SteadyMouse to show some of the "first time running" messages, exit SteadyMouse and follow the steps here to edit the settings file. Change <is_first_time>0</is_first_time> to <is_first_time>1</is_first_time>. Then re-launch.
- If any text turns out to be problematic (too long, grammer, spelling, etc.) simply quit SteadyMouse, and make further edits to the language file.
- Once you're happy with the look email the new file to localization @steadymouse.com and it will be included in the next update.