wiki:TranslationGuide

Version 3 (modified by Eoin, 13 years ago) (diff)

--

Making a Translation

I decided to opt for Subversion as the means of managing these files over an earlier idea of using a wiki page per language. The reason for this is due to the way the files themselves will change inclemently and a wiki page would have quickly become very unwieldy. Unfortunately this does mean the any translators will need to use SVN too. However, anyone who doesn't want to go to that difficultly can get in touch with me through email.

For those happy to use the SVN setup let me explain how to use it. To get write access to the lang folder you need to use the user name and password. To try and avoid casual spam these won't be posted but are available upon request, just send me a mail.

Using SVN commandline

In many ways the commandline svn approach is the easiest to explain. To login in for the first time cd the a desired working directory and issue the command

svn checkout svn://svn.geekisp.com/halite/lang

That should download all the language files. Now if there isn't already a translation for language make a copy of the Template.txt file renamed appropriately. Then add this file to the local repository with the command

svn add ./lang/NewLang.txt

In future you won't need to perform these two steps, instead you need only cd to your local working directory and issue the command

svn update

I would recommend always updating your local repo in case someone else has modified your translation file since you last updated it.

Finally after you've made changes you can commit them back to the online repository with the simple command

svn commit ./lang --username the_user_name --message "Some message just needed for the logs."

You'll also be asked for the password at this point.

Using RapidSVN

Alternatively I'd recommend RapidSVN as an easy to use GUI to Subversion. When you fire it goto 'Bookmmarks' >> 'Add existing repository' and use the URL  svn://svn.geekisp.com/halite.

The file format

The language files are the .TXT files, the .RC files are generated automatically from the .TXT files and don't need to be worried about.

So if you want to contribute a translation download the Template.txt file and rename it to your language. When naming the file try to stick to non-unicode file names, inside the files you can of course use unicode as necessary.

The file will look something like this-

"English" --->  ???
"MS Shell Dlg" --->  ???
"Torrent" --->  ???
"Tracker" --->  ???
"" --->  ???
"msctls_progress32" --->  ???
"N/A" --->  ???

Replace the '???'s with your translations, any you don't add will remain in English. This can be an incremental process, half translated files will work, they'll just still contain some English text. Also note that not all strings should be translated, for example "msctls_progress32" needs to remain as it is. In future I'll screen those bits of text out to avoid any confusion but for the moment if you do translate something which needed to remain unchanged I can fix that so it's no problem. So for example you might end up with a file like the following-

"English" --->  "1337"
"MS Shell Dlg" --->  ???
"Torrent" ---> "70|2|23n7"
"Tracker" ---> "7|24CK3|2"
"" --->  ???
"msctls_progress32" --->  ???
"N/A" ---> "N/4"

Also note that the very first string "English" should be set to the language name, here you can use unicode and this name is what the UI will use when presenting a list of language options to users. If you run into any troubles committing these files back onto the repository send them to me in an email and I'll do it.