TrustedUser
2,147
edits
Difference between revisions of "HOWTO-Translate ScummVM GUI"
Jump to navigation
Jump to search
HOWTO-Translate ScummVM GUI (view source)
Revision as of 00:31, 26 March 2021
, 00:31, 26 March 2021→Creating or Updating a translation file: Remove obsolete information
(→Using the translation in ScummVM: Add link to compiled translations creation tool and instructions to use them) |
(→Creating or Updating a translation file: Remove obsolete information) |
||
| (65 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
This page contains instructions to translate the ScummVM GUI.Translations from the community are welcome and should be proposed on the [http://sourceforge.net/tracker/?group_id=37116&atid=418822 patch tracker]. | This page contains instructions to translate the ScummVM GUI, the QuickStart file and/or the README file.Translations from the community are welcome and should be proposed on the [http://sourceforge.net/tracker/?group_id=37116&atid=418822 patch tracker]. | ||
== 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: | ||
* Some strings are attached to a context (defined with msgctxt "context string" before the msgstr "translated text" in the po files). This means the same english string can be translated differently depending on the context. For example: | * Some strings are attached to a context (defined with msgctxt "context string" before the msgstr "translated text" in the po files). This means the same english string can be translated differently depending on the context. For example: | ||
** "None" is defined with two different contexts: "path" and "soundfont". Therefore the translation can be different if needed depending if "None" refers to a path or a soundfont. | ** "None" is defined with two different contexts: "path" and "soundfont". Therefore the translation can be different if needed depending if "None" refers to a path or a soundfont. | ||
| Line 15: | Line 10: | ||
* 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 https://translations.scummvm.org web site mentioned above. | |||
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. Then visit https://translations.scummvm.org to upload your updated po file. | |||
Default users of the website can make suggestions and vote on the suggestions, but they cannot save translations or create new translations. Only official translators can start a new translations, accept suggestions and save changes to a translations. Thus if you want to start a translation for a new language you will need to speak to us. Also 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. | |||
You can also start your translation effort offline before it is added to the website by using the scummvm.pot (from [https://github.com/scummvm/scummvm/tree/master/po the source code repository]) as a template and fill out the header. 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 == | |||
You can also provide a translation of the [http://github.com/scummvm/scummvm/blob/master/README README file] or of the [https://github.com/scummvm/scummvm/blob/master/doc/QuickStart QuickStart file] to distribute with ScummVM. The QuickStart file is actually an excerpt of the README file, so you can start by translating that file and later when you have more time translate the full README file. | |||
== Using the translation in ScummVM == | == Using the translation in ScummVM == | ||
ScummVM does not use the po files directly. They need to be transformed into a ''translations.dat'' file instead. To use or test your translation you will therefore need regenerate that file. | ScummVM does not use the po files directly. They need to be transformed into a ''translations.dat'' file instead. To use or test your translation you will therefore need to regenerate that file. | ||
=== Generate Translations Data file outside of ScummVM code repository === | === Generate Translations Data file outside of ScummVM code repository === | ||
This is the simplest option. Simply grab below one or the pre-compiled binary for the creation tool or compile it yourself. If you want to compile it yourself, you can get the source code from the [http://scummvm.svn.sourceforge.net/viewvc/scummvm/scummvm/trunk/ ScummVM source code repository] (in tools/create_translations/). | This is the simplest option. Simply grab below one or the pre-compiled binary for the creation tool or compile it yourself. If you want to compile it yourself, you can get the source code from the [http://scummvm.svn.sourceforge.net/viewvc/scummvm/scummvm/trunk/ ScummVM source code repository] (in tools/create_translations/). | ||
<pre style="color: red">WARNING: The create_translations tools linked below are outdated and will not work with a recent version of ScummVM</pre> | |||
* [http://wiki.scummvm.org/images/7/75/Create_translations_windows.zip create_translations tool for Windows] | * [http://wiki.scummvm.org/images/7/75/Create_translations_windows.zip create_translations tool for Windows] | ||
* [http://wiki.scummvm.org/images/8/83/Create_translations_mac_10.6.zip create_translations tool for | * [http://wiki.scummvm.org/images/8/83/Create_translations_mac_10.6.zip create_translations tool for Mac OS X Snow Leopard] | ||
* [http://wiki.scummvm.org/images/c/cf/ | * [http://wiki.scummvm.org/images/c/cf/Create_translations_ubuntu_10.04.zip create_translations tool for Linux Ubuntu 10.04] | ||
Then place the creation tool and all the po translations files you want to include in the generated data into the same directory and run the following command on the command line: | Then place the creation tool and all the po translations files you want to include in the generated data into the same directory and run the following command on the command line: | ||
./create_translations *.po | ./create_translations *.po | ||
For Windows you can simply run the included bat file. | If you have codepages present in po - which enable other charsets from languages, you will also need to include it as a command-line argument, along with *.po, like this: | ||
./create_translations *.po *.cp | |||
For Windows, you can simply run the included bat file. | |||
This will generate a translations.dat file that you need to place in your ScummVM Theme path. | This will generate a translations.dat file that you need to place in your ScummVM Theme path. | ||
| Line 45: | Line 57: | ||
== Proposing your translation to the team == | == Proposing your translation to the team == | ||
The preferred way to propose your new translation (or an update to an existing one) is to use a pull request on [https://github.com/scummvm/scummvm GitHub]. | |||
As a simpler alternative you can also use [http://sourceforge.net/tracker/?group_id=37116&atid=418822 our patch tracker]. Please select the ''Translation'' category for the tracker item. | |||
== Existing translations == | == Existing translations == | ||
See https://translations.scummvm.org/projects/scummvm/scummvm/ | |||
<div id="mw-scummvm-weblate-status"></div> | |||
== Limitations == | == Limitations == | ||
| Line 107: | Line 114: | ||
* [http://gtranslator.sourceforge.net/ GTranslator] (Unix Gnome) | * [http://gtranslator.sourceforge.net/ GTranslator] (Unix Gnome) | ||
* [http://translate.sourceforge.net/wiki/virtaal/index Virtaal] (Multiplatform) | * [http://translate.sourceforge.net/wiki/virtaal/index Virtaal] (Multiplatform) | ||
== Contacting the Team == | |||
There are several ways you can contact the team for translations related question. You can visit the #scummvm IRC channel on [http://freenode.net/irc_servers.shtml irc.freenode.net], use the [http://forums.scummvm.org forum] or send an email to translation(AT)scummvm(DOT)org | |||