Difference between revisions of "Interface translation"

Latest revision as of 18:43, 6 June 2023

Go back to the main Translation information page.

Main translation files

1. Coordinate

As there may be other persons also currently working on the translation to your language, as a first step, please let your colleagues on the translators mailing list know that you'd like to start working on your language's translation, and coordinate your efforts (e.g. divide the work, set up a review system, … ). You can also check the mailing list archives to see whether there may be others who have started working on it recently. You can also ask for help finding previous translators for your language in the chat, to join their team.

2. Get the file

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

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

For release branches: https://gitlab.com/inkscape/inkscape/-/jobs/artifacts/<branch name>/download?job=translations

The name of the release branch is usually something like '1.0.x' or '1.1.x'. You can ask on the mailing list or in the chat which branch is the current translation target.

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.

3. Translate

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

Tip: if you encounter a case where, in the English text, the order of formatting arguments (numbers or text snippets that will be inserted into the string when the program runs) is different from the order in your language, and the arguments are not numbered in the original string, you can try this.

4. Test

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.
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!

5. Get a GitLab account

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

6. Exchange the file on GitLab

For Inkscape 1.3.x, visit https://gitlab.com/inkscape/inkscape/-/blob/1.3.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>"). Choose a name for your branch. Do not use the same name as the target branch, but something like 'es_translations_for_1.3'.

7. 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.

@@ Line 1: / Line 1: @@
 Go back to the main [[Translation information]] page.
-== Main translation file ==
+== Main translation files ==
-See [[Translation information#PO translation files|here]] to get information about how to deal with PO files.
+=== 1. Coordinate ===
-=== Get the PO file for your language ===
+As there may be other persons also currently working on the translation to your language, as a first step, please let your colleagues on the translators mailing list know that you'd like to start working on your language's translation, and coordinate your efforts (e.g. divide the work, set up a review system, … ). You can also check the mailing list archives to see whether there may be others who have started working on it recently. You can also ask for help finding previous translators for your language in the chat, to join their team.
-Download the .po file for your language from [http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/head:/po/ here].
+=== 2. Get the file ===
+Get the most up-to-date translation files from GitLab's automatic builds:
-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.
+For the main development branch:
-You may also need to use the updated template file (mentioned blow) to bring the .po file up to date with new strings introduced in the UI.
+https://gitlab.com/inkscape/inkscape/-/jobs/artifacts/master/download?job=translations
-The most straightforward way to obtain the inkscape.pot template is to download it from [http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/annotate/head:/po/inkscape.pot here].
+For release branches:
+https://gitlab.com/inkscape/inkscape/-/jobs/artifacts/<branch name>/download?job=translations
-Alternatively, you can checkout the full Bazaar project repository and generate the project template. Information on how to get the source tree can be found [https://inkscape.org/develop/inkscape-bzr/ here]. Then, you have to follow some steps in order to generate the template:
+The name of the release branch is usually something like '1.0.x' or '1.1.x'. You can ask on the mailing list or in the chat which branch is the current translation target.
-# <code>./autogen.sh</code>
+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.
-# <code>./configure</code>
-# Enter the ‘po’ directory: <code>cd po</code>
-# Generate the current PO template: <code>intltool-update --pot</code>
-To make an absolutely up-to-date translation (in case the PO file in bzr is not up-to-date enough):
+Unzip the downloaded file and select the po file for your language from it.
-# Update your local copy of Inkscape in the usual way: <code>bzr pull</code>
+=== 3. Translate ===
-# Merge your existing translations into the new POT file (inkscape.pot):<br/> <code>msgmerge your_latest_PO_file inkscape.pot > new_PO_file</code>
-If you want to update ALL .po files in po/, cd there and run:
+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].
-<pre>
-make update-po
-</pre>
-Now that you have an empty PO template, you can start translating the messages.
+Tip: if you encounter a case where, in the English text, the order of formatting arguments (numbers or text snippets that will be inserted into the string when the program runs) is different from the order in your language, and the arguments are not numbered in the original string, [https://gitlab.com/inkscape/inbox/-/issues/6544#note_996695887 you can try this].
-=== Locale Testing ===
+=== 4. Test ===
-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 <code>dpkg-reconfigure locales</code>). 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):
+# 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!
-<pre>
+=== 5. Get a GitLab account ===
-LANG=es_MX LANGUAGE=es_MX ls -z
-ls: opción inválida -- z
-Pruebe `ls --help' para más información.
-</pre>
-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:
+If you don't have an account yet, now is the time to [https://gitlab.com/users/sign_up create one]
-<pre>
+=== 6. Exchange the file on GitLab ===
-LANG=es_ES LANGUAGE=es_MX ls -z
-ls: invalid option -- z
-Try `ls --help' for more information.
-</pre>
-=== Submit finished work ===
+For Inkscape 1.3.x, visit
+<code><nowiki>https://gitlab.com/inkscape/inkscape/-/blob/1.3.x/po/<your_locale>.po</nowiki></code>
-Upload your work via the [https://bugs.launchpad.net/inkscape/ Launchpad bug tracker]. Report a new bug and attach your translated file to it. Don't forget to compress your file before uploading it.
+For the main development branch, go to
+<code><nowiki>https://gitlab.com/inkscape/inkscape/-/blob/master/po/<your_locale>.po</nowiki></code>
-Additionally, you may send a message to Inkscape's translators mailing list.
+Click on the "Replace" button and upload your translated file.
+Enter your commit message below (something like "Update <your_locale>"). Choose a name for your branch. Do not use the same name as the target branch, but something like 'es_translations_for_1.3'.
+=== 7. 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.
+<!--
 == Windows installer ==
-# Get the file according to your language [http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/head:/packaging/win32/languages/ here]. If there is not such a file, copy the ‘English.nsh’ file and rename it to ‘YourLanguage.nsh’.
+# 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 strings in the file.
+# Translate the strings in the file.
-# Change header information in ‘YourLanguage.nsh’ file (language name, [https://msdn.microsoft.com/en-us/goglobal/bb895996.aspx local ID], [https://msdn.microsoft.com/en-us/goglobal/bb964654 windows code page] and authors list) to proper values.
+# 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).
-=== Testing the translation ===
+=== Test ===
-This part is optional but recommended.
+# [[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].
-# Run the <code>make -f Makefile.mingw dist</code> command after successful compilation of Inkscape. This command prepares binary of Inkscape for installer creation.
-# Add the filename of your file to the ‘inkscape.nsi’ file (in the parent folder) in the <code>; Localization</code> section (with other languages).
 # 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 your translations for the installer and the uninstaller.
+# When the installer is ready, run it to test your translations for the installer and the uninstaller.
-# If the translation is tested successfully, submit it to the [https://bugs.launchpad.net/inkscape/ Launchpad bug tracker] and mark as ‘Translation’.
-If you submit your translation but haven't tested it yet, enter this information to the patch information. You will be contacted about its correctness.
 == Default template ==
 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 [http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/head:/share/templates/ here].
+* 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 it, save it as well as the compiled PO file (.mo) to the proper location 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).
+* 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).
-* Upload your ‘default.xx.svg’ file to the bug tracker.
+* [[Translation information#Submit finished work|Submit your work]].
 To translate the default template, you can use Inkscape as well as any UTF-8 encoding capable text editor.
+-->
 [[Category:Translation]]