TrustedUser
2,147
edits
Difference between revisions of "HOWTO-Translate ScummVM GUI"
HOWTO-Translate ScummVM GUI (view source)
Revision as of 15:34, 27 November 2016
, 15:34, 27 November 2016→Creating or Updating a translation file: update with new web site details
(→Creating or Updating a translation file: Add language name info) |
(→Creating or Updating a translation file: update with new web site details) |
||
| Line 2: | Line 2: | ||
== Creating or Updating a translation file == | == Creating or Updating a translation file == | ||
We now have a web site where you can directly add new translations and update existing ones: https://translations.scummvm.org | |||
Please note that: | Please note that: | ||
| Line 19: | Line 11: | ||
* Some strings (e.g. button labels) contain the definition of a shortcut key using the ~ characters. For example "~S~tart" will display "Start" and use 'S' has a shortcut. | * Some strings (e.g. button labels) contain the definition of a shortcut key using the ~ characters. For example "~S~tart" will display "Start" and use 'S' has a shortcut. | ||
* '%' character in a string denotes an argument. For example '%d' is an integer and '%s' is a string. They need to be kept unchanged in the translated string and furthermore their order has also to be kept. | * '%' character in a string denotes an argument. For example '%d' is an integer and '%s' is a string. They need to be kept unchanged in the translated string and furthermore their order has also to be kept. | ||
The recommended way to translate ScummVM is to use the web site mentioned above. But you can also download the translations on your computer and work locally. You can get the existing translation files either from our GitHub repository(https://github.com/scummvm/scummvm/tree/master/po - click on the file you want and use the "raw" or "View Raw" button) or from our translation web site (https://translations.scummvm.org). When working locally, translations can be produced with the use of the [http://www.gnu.org/software/gettext/ GNU gettext tools]. To create or edit a translation file you can for example use [http://www.gnu.org/software/hello/manual/gettext/PO-Mode.html Emacs PO-Mode] or [http://www.poedit.net/ Poedit] which are both free and available for various platforms. See [[#Editing Tools|Editing Tools]] for more tools. | |||
Before starting a translation it would be a good idea to check [https://translations.scummvm.org/projects/scummvm/scummvm/ the list of existing translations] and to contact the team on the forum or IRC to know if other persons are already working on a translation for this language. That way if there is already a translation in the work you can avoid duplicate efforts and work together. | |||
For a new translation, use scummvm.pot (from [https://github.com/scummvm/scummvm/tree/master/po the source code repository]) as a template and fill out the header, or create the translation on https://translations.scummvm.org. Then you just have to translate the strings and save your work in a po file. To download the file, click on scummvm.pot and then the ''raw'' or ''View Raw'' button. If this tries to display the file in your browser, do a right click on that button and select ''Save target file as...'' (the working might be different depending on the browser). You might also need to remove any extension added by your browser (for example for me Safari downloads the file as ''scummvm.pot.pps'', apparently believing it to be a MS Powerpoint file). | |||
You should also set the 'X-Language-name: Name\n' field in the header of the po file to indicate the name of the language in the ScummVM GUI. If not set, it will use the language code instead (for example 'de_DE' or 'fr_FR'). | |||
== Translating the README or QuickStart file == | == Translating the README or QuickStart file == | ||