Difference between revisions of "Translation information"

From Inkscape Wiki
Jump to navigation Jump to search
m (Wow, I made an inconsistent typo…)
(New version of the page: gives useful links and general info about dealing with PO files)
Line 1: Line 1:
{{Outdated}}
This page gathers useful information about translation.


'''See the translation home [https://inkscape.org/en/contribute/translations/ on the main website].'''
== Links and docs ==


== Introduction ==
* '''[https://inkscape.org/contribute/translations/ How to contribute to translations]'''
=== Community based, user oriented ===
* [https://inkscape.org/doc/devel/translations-statistics-trunk.html Translation statistics]
The translations of the various documents focusing on Inkscape rely on the work of volunteers. Motivation for this work can range from the simple pleasure to contribute to take the opportunity of learning a lot about Inkscape and translation processes.
* [https://inkscape.org/develop/inkscape-bzr/ Using Inkscape's repositories]
It is very important not to forget that Inkscape is an open source, community based and user oriented project, which implies that software developers/contributors are generally users. It also implies that the translation efforts are user oriented, with a strong focus on interface, user documentation and website.
* [https://lists.sourceforge.net/lists/listinfo/inkscape-translator Subscribe to the translator mailing list]
* [https://sourceforge.net/p/inkscape/mailman/inkscape-translator/ Translator mailing list archives]
* [[Interface translation]]
* [[Documentation translation]]
* [[WebSite#Translations|Website translation]]


=== Guidelines/workflow ===
== PO translation files ==


# '''Contact to a local translation group, to get support and help on your language'''. Rather than working alone, you should work with an experienced translation team for your language. Thus you will benefit from their knowledge, as well as being able to communicate with them on your own mother tongue. Moreover, translation teams use to have style guidelines and a standarized vocabulary for technical terms that you should be aware of. Contact information is likely available on top of the po file for your language (see point 3). If you do not have detailed contact information, there may be many communities working on translations for your own language: a good starting point is subscribing to your local [http://developer.gnome.org/projects/gtp/teams.html GNOME translation team] or [http://l10n.kde.org/teams/ KDE translation team].
=== Tools for translators ===
# '''Subscribe to''' [https://lists.sourceforge.net/lists/listinfo/inkscape-translator Inkscape translator mailing list]. By subscribing on Inkscape's translator list you will be able to ask for help on some questions more related to Inkscape issues to other Inkscape translators, as well as the mantainers.
# '''Get files for your language'''. If you only want to translate the interface messages, you can get the files from [http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/head%3A/po/ Inkscape's bazaar repository web interface]. Besides getting files from web interface, you can obtain the full repository (see [[Working with Bazaar]]). See section [[#Translatable_content]] for which files you have to modify to translate each part of Inkscape.
# '''Submit finished work to patch tracker'''. Finished translations must be sent to patch tracker and/or mailing list in order to be integrated into the trunk. You will need a Launchpad account to commit patches to [http://bugs.launchpad.net/inkscape Inkscape's patch tracker]. Before sending a file, remember to check that the file(s) you are submitting doesn't have syntax errors that would break the building process.
# '''Send a mail on the translator mailing list'''. Your contribution will be reviewed/commited as soon as possible.


=== Best practices ===
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.


* Best case for a good translation: translate from English to your mother tongue.
Recommended:
* Test the behavior of the interface before starting translation.
* [https://poedit.net/ Poedit]
* Several small updates are more efficient than only a big one.
* [https://userbase.kde.org/Lokalize Lokalize]
* If you're new to Inkscape, or to vector software, taking a look at [http://wiki.inkscape.org/wiki/index.php/InkscapeTerminology Inkscape Terminology page] can be a good idea. It is a work in progress, but can give some clues on basic vocabulary of Inkscape.
* Some good explanations of the behavior of Inkscape, also using some reference terminology can be found here: [http://tavmjong.free.fr/INKSCAPE/MANUAL/html/index.php A Guide to Inkscape] and [http://wiki.inkscape.org/wiki/index.php/UserManual User manual].
* Always keep in mind consistency of terminology; a simple, precise & explicit vocabulary/style will result in an efficient and thus good translation.
* Don't hesitate to ask others (developers/translators/users) if you don't understand a word/sentence or if you think an original string is not good (too complex, not precise enough, etc.).


=== Polishing Translations - Microtypography ===
You might also try:
Here are some things to note in order to achieve good microtypography (typography at the word or character level).
* Emacs' po-mode (contained in the gettext distribution; the version in po-utils is old)
* use the proper quotes (e.g. »foo« or «foo» or “foo”, depending on your local rules)
* [https://wiki.gnome.org/action/show/Apps/Gedit gedit] (installed on GNOME desktops, has a syntax highlight mode for PO file syntax)
* use the proper kind of dashes (with the proper amount of whitespace around them) - EN DASH (U+2013): "–", MINUS (U+2212): "−"
* [http://virtaal.translatehouse.org/ Virtaal] — cross-platform PO editor that is clean, simple to use yet powerful
* use non-breakable space where appropriate (e.g. before units; some countries use a halfspace here) - NO-BREAK SPACE (U+00A0): " "
* [https://wiki.gnome.org/Apps/Gtranslator Gtranslator]
* use halfspace where appropriate (example: "z. B.") NARROW No-BREAK SPACE U+202F: " "
* use "24×24", not "24x24"
* use "90°", not "90 degrees" where appropriate
* use the proper Unicode codepoint for "..." - "…". In German at least, a space comes before this ellipsis.
* see http://www.cs.tut.fi/~jkorpela/chars/si.html for information on the use of SI units in Unicode
* write numbers correctly - either with a decimal comma or a decimal point (see http://en.wikipedia.org/wiki/Decimal_separator#Dot_countries)
* see http://translate.sourceforge.net/wiki/toolkit/pofilter


==== Links ====
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:
* http://de.wikipedia.org/wiki/Typografie (German)
<pre>
* [http://www.dante.de/dante/DTK/dtk96_4/Text/dtk96_4_neubauer_feinheiten.pdf  Marion Neubauer: ''Feinheiten bei wissenschaftlichen Publikationen – Mikrotypographie-Regeln, Teil I''] (PDF, German)
info gettext
* [http://www.dante.de/dante/DTK/dtk97_1/Text/dtk97_1_neubauer_feinheiten.pdf  Marion Neubauer: ''Feinheiten bei wissenschaftlichen Publikationen – Mikrotypographie-Regeln, Teil II''] (PDF, German)
</pre>
* [http://www.zvisionwelt.de/typokurz.pdf Christoph Bier: ''typokurz – Einige wichtige typografische Regeln''] (PDF, German)
* http://www.cs.tut.fi/~jkorpela/html/french.html (in English, for French)


== Translatable content ==
=== File format ===


Inkscape's translation effort covers many areas, from aplication UI itself to web pages and tutorials. This is a summary of all those areas, sorted by priority.
If you open a PO file with a text editor for the first time, 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.


These tasks, rather than being for hackers only, can be achieved by most software enthusiasts, whether they have a technological background or were just plain users. The main requirement is the wish to provide support for Inkscape on your language: the technology required for you to do that has been developed in a simple approach, and it involves mainly text files and applications used to verify its syntax. Supporting applications were existing to make these tasks much easier.
<pre>
#: gedit/dialogs/gedit-plugin-program-location-dialog.c:78
#: gedit/dialogs/program-location-dialog.glade2.h:2
msgid "Set program location..."
msgstr "Ställ in programplats..."
</pre>


=== User interface ===
In addition to the msgid and msgstr parts, a message usually also has lines starting with <code>#:</code> that tell 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.


PO files contain the strings for the Inkscape user interface (main software and extentions). A PO file is a text file which contains the original English message and its translation. That's why it is obviously the translation to start with.
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:


See  [[Interface translation#Interface_Translation|Interface translation]] page for detailed information on the PO files.
* 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.
* A new string has been added to the source, and the string is 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.


=== Tutorials ===
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 (<code>""</code>) 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.


As you know, Inkscape comes with some very nice SVG tutorials. By translating them, users will learn how to use the application, as well its tips and tricks.
=== A few important things to remember ===
It is even a good opportunity for '''you''' to become more acquainted with Inkscape.
 
See [[DocumentationTranslation#Tutorial_Translation|Documentation Translation]] page for detailed information on tutorial translation.


=== Keyboard and mouse shortcuts ===
* Some strings that can be ambiguous or having several meanings according to different contexts may have a context prefix : ‘Context|Ambiguous string’. In this case, simply translate ‘Ambiguous string’, the ‘Context|’ string is just a not to translate indication. (Some info on how to disambiguate a string can be found [http://developer.gnome.org/doc/API/2.0/glib/glib-I18N.html#Q-:CAPS here].)
* 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.
* 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.


Inkscape is proud for having keyboard and mouse shortcuts for almost all of its functionality. Those shortcuts can help you increase your drawing productivity/efficiency. The map of the default shortcuts is embedded in the interface (help menu) next to the tutorials, and can also be accessed from the web site.
If you use a translation software, it may automatically deal with the last two points for you (see its preferences).


See [[DocumentationTranslation#Keyboard_and_mouse_translation|Documentation Translation]] page for detailed information on translating shortcuts.
=== Verification ===


=== Windows installer ===
Before submitting your file to the project, please make sure it is valid.
* 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 <code>msgfmt --statistics -cv translation_file.po</code> from a command window.
* Make sure it is correctly formatted: run <code>check-markup translation_file.po</code> from a command window and verify it doesn't output any error message. The ‘check-markup’ Perl script can be found in the /po directory of Inkscape trunk.


High value for users, even if the installation process of Inkscape is quite simple, translating the Windows installer helps potential users a lot to get a good feeling when they use Inkscape.
=== Programmers ===


Please make sure you use [http://www.gnu.org/software/gettext/manual/html_mono/gettext.html#SEC150 dgettext] for any pluralized strings.


See [[Interface translation#Windows_installer_translation|Interface translation]] page for detailed information for Windows installer translation.
== Review ==


=== Templates ===
This is the start of a list of places to get translation reviews done. So far:
* http://www.linux.it/tp/


The default template of the Inkscape document can be localized to make the localization consistent. Localized can be the (size?) of the default document and also the name of the default layer.
[[Category:Translation]]
 
See [[Interface translation#Default_template_translation|Interface translation]] page for detailed information on default document's template.
 
=== Man pages ===
The man pages consist of a standard user documentation, available from the command line. On Unixbased systems simply type "man inkscape" from the prompt of a command window.
 
Some distributions also generate a browsable (html) man page, accessible from a dedicated help shortcut.
 
The man page of Inkscape provides some insightful information about the software, especially focused on operations that do not require GUI (example: export to png from the command line, or extract one object from a svg file).
 
 
See [[DocumentationTranslation#Man_pages|Documentation Translation]] page for detailed information for man page translation.
 
=== Release notes ===
Translating [http://wiki.inkscape.org/wiki/index.php/Release_Notes release notes] helps the "normal user" to get a lot of insight into the capabilities of Inkscape.
 
* gives a general overview of the possibilities of the software to potential users
* can be used for local marketing (local Free Software/Linuw/Graphics oriented web sites, articles in fanzines, e-magazines and even magazines...)
 
See [[WebSiteTranslation#Release_notes|WebSite Translation]] page for detailed information on translating release notes.
 
=== User manual ===
Some members of the Inkscape community are also focusing on an [[UserManual]]. This document can be read as a reference document for advanced users and as a good introduction to the functionalities of Inkscape by everyone.
 
See [[DocumentationTranslation#User_Manual|Documentation Translation]] page for detailed information on translating the user manual.
 
=== Web pages, News and Wiki ===
English is generaly the exchange-tongue of developers, and developer/user documentation is mainly written in English.
 
Translation efforts should be first oriented on user documentation.
 
You can take a look at the [[WebSiteTranslation|WebSite Translation]] page for detailed information about how to translate the web content of Inkscape
 
See the [[Main_Page|main wiki page of Inkscape]] to get some examples (Spanish and German) of the translation of this wiki.
 
=== Others ===
Text files found in the inkscape directory
...
 
== Status ==
See this [[TranslationStatus|dedicated page]].

Revision as of 21:51, 11 July 2016

This page gathers useful information about translation.

Links and docs

PO translation files

Tools for translators

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.

Recommended:

You might also try:

  • Emacs' po-mode (contained in the gettext distribution; the version in po-utils is old)
  • gedit (installed on GNOME desktops, has a syntax highlight mode for PO file syntax)
  • Virtaal — cross-platform PO editor that is clean, simple to use yet powerful
  • Gtranslator

And last but not least, gettext utils, which are installed on every Linux distribution. You can see a complete reference too from installed info pages by running the command:

info gettext

File format

If you open a PO file with a text editor for the first time, 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.

#: gedit/dialogs/gedit-plugin-program-location-dialog.c:78
#: gedit/dialogs/program-location-dialog.glade2.h:2
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 tell 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.

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:

  • 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.
  • A new string has been added to the source, and the string is 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.

A few important things to remember

  • Some strings that can be ambiguous or having several meanings according to different contexts may have a context prefix : ‘Context|Ambiguous string’. In this case, simply translate ‘Ambiguous string’, the ‘Context|’ string is just a not to translate indication. (Some info on how to disambiguate a string can be found here.)
  • 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.
  • 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.

If you use a translation software, it may automatically deal with the last two points for you (see its preferences).

Verification

Before submitting your file to the project, please make sure it is valid.

  • 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 translation_file.po from a command window.
  • Make sure it is correctly formatted: run check-markup translation_file.po from a command window and verify it doesn't output any error message. The ‘check-markup’ Perl script can be found in the /po directory of Inkscape trunk.

Programmers

Please make sure you use dgettext for any pluralized strings.

Review

This is the start of a list of places to get translation reviews done. So far: