HOWTO-Translate ScummVM Web Site

This page contains instructions to translate the ScummVM web site.

Getting the files to edit

The sources for our web site are available on [github.com]. If you are familiar with GitHub you can clone this scummvm-web repository, make modifications and open a pull request. Otherwise you might prefer using the Download ZIP button on the GitHub page from the link above make modifications and use [patch tracker].

Adding a new language to the language menu

Edit the lang_menu.tpl file in the template directory to add an item for your language. You can copy one of the existing item and replace

• the language code in lang=en
• the language code in uppercase used for the badge on the web site (e.g. 'EN)
• The language name. Write it as it is written in your language.

Please keep the languages sorted alphabetically (except for English that comes first).

Translating lang.ini

This is the file that contains most of the web site strings. If it does not yet exist, you need to create such a file for your language by copying the lang.ini file and add the language code to the name before the extension (for example if we were to translate to english we would name the file lang.en.ini). You then simply have to translate the strings in that file. Make sure your text editor is configured to use UTF-8 encoding.

At the start of the file you will see two special strings (locale = and date format =) that are used to automatically translate date.

• The first one is the [language locale], for example fr_FR.UTF-8 for french from France using UTF-8 encoding.
• The second is the date format as described [here]. For example "%b %e, %Y" means abbreviated month name followed by the day of the month then a coma and the year coded with 4 digits. This is the format used for news in english and for example gives Dec 25, 2015 in english).

Translating the side bar

In the data directory copy the file menus.xml and add the language code in the name (e.g. menus.fr.xml for the french translation). This file does not need to be using UTF-8 encoding, but make sure the encoding mentioned at the start of the file matches the one your text editor uses to write the file. Only translate the content of the name tags (i.e. the text that appears between <name> and </name>).

Translating news

If it does not already exist you need to create a directory named after the language code (e.g. fr for french or de for german) in the /data/news/ directory. Translated news will go into that directory (e.g. data/news/fr).

To translate a news, copy the english version from data/news into the corresponding language news directory. Do not change the file name. Then you can translate the file. Do not modify the XML tags and do not change the date (it is automatically translated - see the Translating lang.ini section above).

Translating the F.A.Q

There is a lot of text in this one! To translate this file you will first to copy the english FAQ file named faq-xml.xml in the data directory to create a file for you language. As for the lang.ini, add the language code before the extension (e.g. for french the FAQ file is named faq-xml.fr.xml). Then translate the FAQ. Be careful note to translate the XML tags and the href names (they are used in links).