Difference between revisions of "Interface translation"

From Inkscape Wiki
Jump to navigation Jump to search
 
(36 intermediate revisions by 15 users not shown)
Line 1: Line 1:
= Interface Translation =
+
Go back to the main [[Translation information]] page.
  
== Introduction to PO file format ==
+
== Main translation files ==
  
If you've never translated a PO file before, you will find its syntax very simple. The PO format is a really simple format, which probably at least partly explains its success and widespread use. The format is basically a hash list consisting of msgid and msgstr pairs, with the msgid being the original English string and key, and the msgstr being the translated value of it. Below is an example of a message.
+
=== 1. Get the file ===
 +
Get the most up-to-date translation files from GitLab's automatic builds:
  
  #: gedit/dialogs/gedit-plugin-program-location-dialog.c:78
+
For the 1.0.x branch:
  #: gedit/dialogs/program-location-dialog.glade2.h:2
+
https://gitlab.com/inkscape/inkscape/-/jobs/artifacts/1.0.x/download?job=translations
  msgid "Set program location..."
 
  msgstr "Ställ in programplats..."
 
  
In addition to the msgid and msgstr parts, a message usually also has lines starting with #: that tells what source files and what lines the string used as msgid was extracted from. These lines have no syntactic value. They are only there as a help for translators and developers to know where a message came from.  
+
For the main development branch:
 +
https://gitlab.com/inkscape/inkscape/-/jobs/artifacts/master/download?job=translations
  
A message in a PO file can be in one of essentially three different states. The message can be translated, fuzzy, or untranslated. A message counts as translated as soon as the msgstr part of it is non-empty. In a similar manner, an untranslated message is one where the msgstr is empty. The fuzzy state is special and essentially means that there is a translation in the msgstr part, but that this translation is most likely not entirely correct, and that it thus needs manual attention by a translator. A message can become fuzzy in one of two ways:
+
In some cases, this will give a 'Page not found' error. In that case, visit the [https://gitlab.com/inkscape/inkscape/ main Inkscape repository page on GitLab], select the correct branch at the top, then on the right side, click on the download icon and select to download the 'translations' artifact.
  
* The original string that the msgid represents was changed in the source code.  A typo in the string may have been fixed or the string altered in some other way. The translator needs to check that the msgstr is still valid and make changes if necessary.
+
Unzip the downloaded file and select the po file for your language from it.
* A new string has been added to the source, and the string is very similar, but not identical, to the msgid of an already existing, translated message. Then the msgstr of that message will be automatically reused for the new message, but the new message will also at the same time be marked fuzzy so that the translator knows there is some difference that he or she needs to adapt the translation to match.
 
  
There is always one special message in each valid PO file: the PO file header. It is encoded with the msgid for the empty string ("") as the key, and the actual header values are in the msgstr part. This unfortunately means that if you mark an empty string for translation, you will get the entire PO file header back as the "translation". In almost all cases this is probably not what you want. Hence, do not mark empty strings for translation.
+
=== 2. Translate ===
  
== Get the PO file for your language ==
+
Translate the file for your language from the archive above with your [https://wiki.inkscape.org/wiki/index.php/Translation_information#Tools_for_translators favorite translation software].
  
Download the .po file for your language from here:
+
=== 3. Test ===
  
    http://svn.sourceforge.net/viewcvs.py/inkscape/inkscape/trunk/po/
+
# Make sure you have the release of Inkscape you are translating installed. If you're translating the coming release, pick a pre-release and compile it.
 +
# Compile your PO file to .mo. Some translation tools (e.g. Poedit) have an option for that.
 +
# Find and replace your language's .mo file. It is a file named ‘locale/your_language/LC_MESSAGES/inkscape.mo’, in the directory listed under '''Edit > Preferences > System > Inkscape Data''' in Inkscape. <br>''Note: This will not work with the snap, .dmg, AppImage or flatpak version of Inkscape, but only with a version that has been properly installed on your system and with extracted binary archives (zip files for Windows) or self-compiled versions. In some cases, you may need administrator privileges to edit files in said directory.''
 +
# Rename the original inkscape.mo file to inkscape.mo.bak and save your compiled .mo file into its place as inkscape.mo instead
 +
# Then start Inkscape and you'll see your strings!
  
If a .po file for your language does not yet exist, then you will have to get an empty template file to start a new translation.
+
=== 4. Get a GitLab account ===
The most straightforward way to obtain the inkscape.pot template is to download it from here (updated weekly):
 
  
    http://inkscape.modevia.com/potfile/inkscape.pot
+
If you don't have an account yet, now is the time to [https://gitlab.com/users/sign_up create one]
  
Alternatively, you can checkout the full SVN project repository and generate the project template. Information on how to get the source tree can be found [http://inkscape.org/svn.php here]. Then, you have to follow some steps in order to generate the template:
+
=== 5. Exchange the file on GitLab ===
  
1. "./autogen.sh"
+
For Inkscape 1.0.x, visit
2. "./configure"
+
<code><nowiki>https://gitlab.com/inkscape/inkscape/-/blob/1.0.x/po/<your_locale>.po</nowiki></code>
3. enter the "po" directory: "cd po"
 
4. generate the current PO template: "intltool-update --pot"
 
  
To make an absolutely up-to-date translation (in case the PO file in SVN is not up-to-date enough),
+
For the main development branch, go to  
 +
<code><nowiki>https://gitlab.com/inkscape/inkscape/-/blob/master/po/<your_locale>.po</nowiki></code>
  
1. update your local copy of Inkscape in the usual way: "svn update"
+
Click on the "Replace" button and upload your translated file.
2. merge your existing translations into the new POT file (inkscape.pot):
 
  
    "msgmerge your_latest_PO_file inkscape.pot > new_PO_file"
+
Enter your commit message below (something like "Update <your_locale>").
  
If you want to update ALL .po files in po/, cd there and run:
+
=== 6. Make a merge request ===
  
make update-po
+
Click on the "Create merge request" button.
  
Now that you have an empty PO template, you can start translating the messages.
+
In the form, check 'Allow commits from members who can merge to the target branch' and also 'squash commits'.
  
== Tools for translators ==
+
Submit the merge request.
  
You can edit PO files from any plain text editor, since they are simple text files. However, many useful tools have been developed to provide a simple experience translating PO files.
+
<!--
  
* emacs' po-mode (contained in the gettext distribution; the version in po-utils is old)
+
== Windows installer ==
* kbabel (http://i18n.kde.org/tools/kbabel/)
 
* gtranslator (http://gtranslator.sourceforge.net/)
 
* poEdit (http://poedit.sourceforge.net/)
 
* GEdit (installed on GNOME desktops) has a syntax highlight mode for PO file syntax.
 
  
And last but not least, [http://www.gnu.org/software/gettext/manual/ gettext] utils, which are installed on every linux distribution. You can see a complete reference too from installed info pages by running the command:
+
# Get the file according to your language [https://gitlab.com/inkscape/inkscape/tree/master/packaging/win32/languages here]. If there's no such file, copy the ‘English.nsh’ file and rename it to ‘YourLanguage.nsh’ (make sure someone updates the file [https://gitlab.com/inkscape/inkscape/blob/master/packaging/win32/languages/_language_lists.nsh _language_lists.nsh] in this case).
 +
# Translate the strings in the file.
 +
# Change/update header information in ‘YourLanguage.nsh’ (language name, [https://msdn.microsoft.com/en-us/goglobal/bb895996.aspx locale ID] and authors list) to proper values.
 +
# Save the file. (Translation files should always use Unicode, encoded as UTF8!).
 +
# Optionally, test your translation as described below.
 +
# [[Translation information#Submit finished work|Submit your work]] (specify whether you tested it or not).
  
  info gettext
+
=== Test ===
  
== A few important things to remember ==
+
# [[Compiling Inkscape|Compile Inkscape]] (you'll probably want to [[Compiling Inkscape on Windows|Compile Inkscape on Windows]]) and run <code>make install</code> to create the binary distribution directory of Inkscape.
 +
# Install [http://nsis.sourceforge.net/Main_Page NSIS].
 +
# Right-click on the ‘inkscape.nsi’ file and choose ‘Compile NSIS Script’. The installer compilation will start.
 +
# When the installer is ready, run it to test your translations for the installer and the uninstaller.
  
* Some strings that can be ambiguous or having several meanings according to different contexts may have a context prefix : "Context|Amibiguous string". In this case, simply translate "Ambiguous string", the "Context|" string is just a not to translate indication.
+
== Default template ==
* After translating a fuzzy string (one that is marked with a ", fuzzy" comment), please remove its "fuzzy" tag -- otherwise this translation will be discarded by the build process, meaning that this string will show up untranslated. KBabel can do this automatically (see KBabel settings).
 
* Before publishing your work (after you have finished updating the PO file), please update the "PO-Revision-Date" and "Last-Translator" fields in the PO file header. KBabel can do this automatically.
 
  
== Review ==
+
To translate the default template:
 +
* Modify the ‘default.svg’ file and save it as ‘default.xx.svg’ where ‘xx’ is the ISO code of your language. You will find the current template [https://gitlab.com/inkscape/inkscape/tree/master/share/templates here].
 +
* Modify your PO translation to use your localized default template. Look up for a ‘default.svg’ string and translate it accordingly to the file name of the localized template.
 +
* To test your template, save it as well as the compiled PO file (.mo) to the proper location for your system and restart Inkscape. New documents should now be based on your localized template (this is valid if your system is properly set to your locale).
 +
* [[Translation information#Submit finished work|Submit your work]].
  
This is the start of a list of places to get translation reviews done. So far:
+
To translate the default template, you can use Inkscape as well as any UTF-8 encoding capable text editor.
  http://www.linux.it/tp/
 
  
== Verification ==
+
-->
  
Before submitting your file in the patch tracker, please make sure it is valid:
+
[[Category:Translation]]
* Make sure the file is encoded in UTF-8
 
* Make sure it is a valid po file and obtain some statistics about it: simply run "msgfmt --statistics -cv translationFile.po" from a command window
 
* Make sure it is correctly formatted: run "check-markup translationFile.po" from a command window and verify it doesn't output any error message. "check-markup" perl script can be found in the /po directory of Inkscape svn trunk
 
 
 
== Locale Testing ==
 
 
 
Before reporting that a locale doesn't work in Inkscape, you need to make sure that your system has that locale correctly set up.  To do this, you need to generally find a way to run "locale-gen".  (Under Debian/Ubuntu this is via "dpkg-reconfigure locales".)  If you set both the LANG and LANGUAGE variables and check a regular tool, you should see the correct language for both the libc error (first line) and the tool error (second line):
 
 
 
LANG=es_MX LANGUAGE=es_MX ls -z
 
ls: opci&oacute;n inv&aacute;lida -- z
 
Pruebe `ls --help' para m&aacute;s informaci&oacute;n.
 
 
 
If it reports the regular C messages, your locale has not been correctly configured, and you'll need to find the right way to run "locale-gen" for your distribution:
 
 
 
LANG=es_ES LANGUAGE=es_MX ls -z
 
ls: invalid option -- z
 
Try `ls --help' for more information.
 
 
 
== Submit finished work ==
 
 
 
Upload your work via the [[SourceForge]] patch tracker:
 
 
 
    http://sourceforge.net/tracker/?func=add&group_id=93438&atid=604308
 
 
 
(Check the Upload checkbox and add your file or patch.)
 
 
 
(Don't forget to compress your file before uploading it, as sourcefoge tracker doesn't accept large files.)
 
 
 
Additionally, you may send a message to Inskcape's translators mailing list.
 
 
 
== Programmers ==
 
Please make sure you use [http://www.gnu.org/software/gettext/manual/html_mono/gettext.html#SEC150 dgettext] for any pluralized strings.
 
 
 
= Windows installer translation =
 
 
 
Strings for Windows installer are saved in *.nsh files. Each translation has its own file located in ''packaging\win32\'' directory of subversion checkout. Get this file in similar way of getting *.po file.
 
=== Translating ===
 
# Get the file according to your language. If there is not such a file, copy ''english.nsh'' file and rename it to ''yourlanguage.nsh''.
 
# Translate strings in the file
 
# Change '''!insertmacro MUI_LANGUAGE "English"''' and each occurence of '''${LANG_ENGLISH}''' to values corresponding with your language. For example '''!insertmacro MUI_LANGUAGE "Czech"''' and '''${LANG_CZECH}'''.
 
# Change header information in '''yourlanguage.nsh''' file, like "windows code page" and "Authors" to proper values.
 
=== Testing the translation ===
 
# This part is optional but recommended. For this part you need [http://nsis.sourceforge.net/Main_Page NSIS installer] and run <pre>make -f Makefile.mingw dist</pre> command after succesfull compilation of Inkscape. This command prepares binary of Inkscape for installator creation.
 
# Add filename of your file to '''inkscape.nsi''' file, "STRING LOCALIZATION" section, "Language files" subsection.
 
# Right click on the inkscape.nsi file and choose "Compile NSIS Script". The installer compilation will start.
 
# When the installer is finished, run it to test translations of strings in Installer and Uninstaller parts.
 
# If the translation is tested succesfully, submit it to the patch tracker at sourceforge.net and mark as "Translation". If you haven't tested your translation yet, submit it too but enter this information to the patch information. You will be contacted about its correctness.
 
 
 
= Default template translation =
 
 
 
* To translate default template, modify the default.svg file and save it as default.xx.svg where "xx" is ISO code of your language. The file can be found in ''/usr/share/inkscape/templates/'' directory on Linux, or ''C:\Program Files\Inkscape\share\templates\'' directory on MS Windows(tm). Also you can get it from [http://svn.sourceforge.net/viewcvs.cgi/inkscape/inkscape/trunk/share/templates/ SVN repository].
 
* You need to modify your PO translation as well to use your localized default template. Look up for a msgid "default.svg" on the PO file and translate it accordingly to the file name of the localized template.
 
* To test it, save it to the proper location and restart Inkscape. Default document should be now based on your localized template. (This is valid if your system is properly set to your locales).
 
* Upload default.xx.svg to the patch tracker.
 
 
 
To translate default template can be used Inkscape as well as any UTF-8 encoding capable text editor.
 

Latest revision as of 21:40, 17 August 2020

Go back to the main Translation information page.

Main translation files

1. Get the file

Get the most up-to-date translation files from GitLab's automatic builds:

For the 1.0.x branch: https://gitlab.com/inkscape/inkscape/-/jobs/artifacts/1.0.x/download?job=translations

For the main development branch: https://gitlab.com/inkscape/inkscape/-/jobs/artifacts/master/download?job=translations

In some cases, this will give a 'Page not found' error. In that case, visit the main Inkscape repository page on GitLab, select the correct branch at the top, then on the right side, click on the download icon and select to download the 'translations' artifact.

Unzip the downloaded file and select the po file for your language from it.

2. Translate

Translate the file for your language from the archive above with your favorite translation software.

3. Test

  1. Make sure you have the release of Inkscape you are translating installed. If you're translating the coming release, pick a pre-release and compile it.
  2. Compile your PO file to .mo. Some translation tools (e.g. Poedit) have an option for that.
  3. Find and replace your language's .mo file. It is a file named ‘locale/your_language/LC_MESSAGES/inkscape.mo’, in the directory listed under Edit > Preferences > System > Inkscape Data in Inkscape.
    Note: This will not work with the snap, .dmg, AppImage or flatpak version of Inkscape, but only with a version that has been properly installed on your system and with extracted binary archives (zip files for Windows) or self-compiled versions. In some cases, you may need administrator privileges to edit files in said directory.
  4. Rename the original inkscape.mo file to inkscape.mo.bak and save your compiled .mo file into its place as inkscape.mo instead
  5. Then start Inkscape and you'll see your strings!

4. Get a GitLab account

If you don't have an account yet, now is the time to create one

5. Exchange the file on GitLab

For Inkscape 1.0.x, visit https://gitlab.com/inkscape/inkscape/-/blob/1.0.x/po/<your_locale>.po

For the main development branch, go to https://gitlab.com/inkscape/inkscape/-/blob/master/po/<your_locale>.po

Click on the "Replace" button and upload your translated file.

Enter your commit message below (something like "Update <your_locale>").

6. Make a merge request

Click on the "Create merge request" button.

In the form, check 'Allow commits from members who can merge to the target branch' and also 'squash commits'.

Submit the merge request.