Lang Files Explained

Creating new languages

Copy the english.lang to [your language].lang and change all strings within the <dest> and <voice> tags.

Prerequisites to be able to translate

To avoid manual (and error-prone) diffing, copy and pasting and so on, use the script called genlang with its -u option.

Note: If you don't have or want a build environment, it should be possible to download the script to your pc and do it all without the build environment. Get a perl interpreter if you don't already have (on windows), for example ActivePerl

So be sure you can start the genlang-script either way, or opt for the hard way by doing it all yourself.

Preparation every time you update

The translation is always done "from" english, so english.lang is the master file. Monitor this file if you want to be sure to keep "your" language up to date.

The only one step of preparation you have to do every time you want to update "your" language is to run that script:

Bring yourself to the /apps/lang/-directory (or to the directory where english.lang and yourlang.lang reside if you work without build environment). Don't forget to update the file (svn up english.lang or just a fresh download). Run the genlang like the following line:

 ../../tools/genlang -u -e=english.lang yourlang.lang > yournewlang.lang

This assumes you are working "from" english, as usual, your outdated language file is called yourlang.lang and you want to get the merge to newyourlang.lang.

Now that genlang has merged the new changes from english to newyourlang.lang, you can go ahead with the actual work of translation, by opening the file in your favorite text editor. The new file has added comments starting with ### marking where you (might) need to edit the file.

The lang file format

I'm afraid we have to look into the format of lang files now. Every string needed in RockBox has a voice clip, this is why we can call such a pair a "phrase". Every phrase has absolutely unique identifier (called id), it has a description that tells you the context so you can select the wording (called desc), it has the original english string (called source), it has a string specially for the voice clips (called voice) and it finally has the string in your language (called dest).

All source/dest/voice strings must be written within double quotes ("). There are a few keywords that can be used that aren't using quotes, but they are special and are detected by the absence of quotes.

When updating a language, you are asked to solely change the dest and voice strings. changing id, source or desc will either break-up everything or turn the subsequent update job into real pain.

Comments start with the hash-sign ('#', also called hash (UK) or pound (US) key in English; 'Raute', 'Viereckchen', 'Lattenkreuz' in German; or 'Kanalgitterchen' in Austrian. No joke, but funny :-) )

Lang files must be saved with UTF-8 encoding.

Langv2

The target names used for this are picked from the configure script and are set in the ARCHOS variable in the root makefile. Currently, they are:

The translation

Mainly said, any resource that needs attention has a '###'-comment. I will now list the 'scenarios' I know and how I think they have to be handled.

Deprecation

A deprecated string is not needed anymore.

A deprecated string should be written as the following in the lang file. This example snippet deprecates the destination string for all targets:

<phrase>
  id: LANG_FOO
  desc: DEPRECATED
  <source>
    *: ""
  </source>
  <dest>
    *: deprecated
  </dest>
  <voice>
    *: ""
  </voice>
</phrase>

Added Strings

###
### This phrase below was not present in the translated file
<phrase>
  id: LANG_STEREO_WIDTH
  desc: in sound_settings 
  <source>
    *: "Stereo width"
  </source>
  <dest>
    *: "Stereo width"
  </dest>
  <voice>
    *: "Stereo width"
  </voice>
</phrase>

String Removal

The lang format allows you to completely remove a string for a particular target's language file by using the none keyword:

  <dest>
     *: "fancy LCD bitmap rotation enabled"
     player: none
  </dest>

Note however that this completely removes the string from the output and thus it may very well break backwards compatibility when you do this. Carefully consider deprecating the string instead.

Translation style

The translation should feel as correct as possible to speakers/readers of your native language you're translating this to. This means that you should follow the rules of the language you're translating to, and not try to imitate the English version. For example with capitals, you should not capitalize anything other than what would be done if you were writing the text from scratch. Also try as much as possible to avoid using English words, as tempting as it may be, unless it's very commonly known and in daily use in your language (and not just among tech-interested people).

Your main work is done if you can't find any '###'-comment anymore :-)
Now, go ahead and see if you did a mistake before posting your work in the patch tracker.
If you are able to create a patch with your changes against current SVN we prefer that but the whole .lang file is just fine. Be sure to drop a line on the mailing list after that so your updated file will get committed as soon as possible. Would be a bummer if somebody else would be doing the same work a week later.

Safety checks

Note: strings are always "within double quotes", even the empty ones

Just for safety, I do a few checks. I use a file differ (BeyondCompare, will be available for linux too in a while) for this.

1. check: comparing the newyourlang.lang to yourlang.lang. This allows you to see WHAT you changed, just in case you did a big mistake.
2. check: comparing the newyourlang.lang to english.lang. These files should only differ in new-strings and comments.
3. check: if genlang complains when making a binary .lng file. This is easily done by placing yourlang.lang inside the apps/lang directory inside your source tree and performing a 'make' and a 'make zip'. If you do not have a Rockbox development environment set up this can be done from the command line using genlang with the following swithches:
   ../../tools/genlang -e=english.lang -t=yourtarget:features -i=targetid -b=yourlang.lng yourlang.lang
   Where yourtarget is the target string that the Rockbox build system uses, for example "h300" for iriver H300, after your target enter a colon separated list of "features" supported by your target, see apps/features.txt in the Rockbox svn for which ones are define for each target. The argument for 'i' is the id_ number that the build system uses for your target, for example '11' for the H300.
   If genlang -b does not complain about anything, then this does mean that you didn't do a big mistake.
4. check: the experiment on oneself: copy the yourlang.lng to your rockbox (/.rockbox/lang), switch the language, and try it out.

Current status

Translations status overview on Rasher's website

Attachment	Action	Size	Date	Who	Comment
langstatus	manage	1.6 K	23 Aug 2006 - 03:09	JonasHaeggqvist	Language status script, generates the table on this page