15,534
edits
Changes
→Translating wiki manual
{{languages|Translating Gramps}} Tips for translators of the GRAMPS Gramps program. The page [[Coding_for_translation|coding for translation]] may also be of interest to translators. [[Category:DevelopersTranslators/LocalizationCategories]][[Category:Developers/General]] ==Gettext file format== ===Header=== ''msginit'' is a GNU utility, called on /po directory, which generates a header for gettext file template : '''gramps.pot'''. "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: \n" "POT-Creation-Date: 2004-12-30 10:52-0500\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <[email protected]>\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=CHARSET\n" "Content-Transfer-Encoding: 8bit\n" "Plural-Forms: nplurals=2; plural=(n != 1);\n" * ''Project-Id-Version'' : this is the name and version of the package. Fill it in if it has not already been filled in by xgettext. * ''Report-Msgid-Bugs-To'' : this has already been filled in by xgettext. It contains an email address or URL where you can report bugs in the untranslated strings:** Strings which are not entire sentences, see the maintainer guidelines in Preparing Strings.** Strings which use unclear terms or require additional context to be understood.** Strings which make invalid assumptions about notation of date, time or money.** Pluralisation problems.** Incorrect English spelling.** Incorrect formatting. * ''POT-Creation-Date'' : this has already been filled in by xgettext.* ''PO-Revision-Date'' : You don't need to fill this in. It will be filled by the PO file editor when you save the file.* ''Last-Translator'' : fill in your name and email address (without double quotes).* ''Language-Team'' : fill in the English name of the language, and the email address or homepage URL of the language team you are part of. Before starting a translation, it is a good idea to get in touch with your translation team, not only to make sure you don't do duplicated work, but also to coordinate difficult linguistic issues. In the Free Translation Project, each translation team has its own mailing list. The up-to-date list of teams can be found at the Free Translation Project's [http://translationproject.org/ homepage], in the "Teams" area. === msgid / msgstr / comment / fuzzy === #: gramps.py:10 #, fuzzy msgid "File not found" msgstr "" * text after ''#'' provides a comment.** The file reference and the line number after ''#:'' ** A comment on code or the main string (''msgid'') after ''#.''** A comment on your translation (''msgstr'') after ''#''This will help translator but is optional for having a translation.* ''#, fuzzy'' could be added because string is not up-to-date. It means that there was a change somewhere (a string has been added, removed or modified) and ''xgettext'' did a guess on what the translation should be. This guess is most likely not entirely correct, but it is often very close.''fuzzy'' strings are ignored, english string (''msgid'') will be used ! Need to correct/validate entry on your translation editor.* msgid is the string, present on gramps' code* msgstr is your translation string
==Tips for translators==
===Getting started===
# Always save your translations in UTF-8 encoding '''without [https://en.wikipedia.org/wiki/Byte-order_mark BOM]''' ([http://achilles-keep-moving.blogspot.de/2011/10/msgfmt-fatal-error-with-utf-8-with-bom.html take care with ''NotePad''])# Don't overwrite the English strings, your translation should be below the original string# Take heed on special characters. You must have the same number of and types as the original string.# Verify spelling and grammar on your translation.# Don't translate "too freely". Your translation should be as close match to the original as possible# Be consistent with your translations. If you decide on a specific word/phrase for something, stick to that throughout the translation.# If possible, try the translation before sending Translating GRAMPS Gramps into a new language means translating English strings used in the GRAMPS Gramps interface. To put it shortly, this amounts to
# obtaining the gramps.pot file with the strings to be translated,
# translating the strings in the template, and
# getting the translated file uploaded into gramps SVN the Gramps Git repository.Another avenue of translation is translating the documentation. This is a different and lengthy process and it is decribed described in our [[Translating the Gramps User manual]] page. Here we will concentrate on the interface translation only.
===Obtaining gramps.pot===
* Download <code>gramps.pot</code> from GRAMPS SVN Gramps Git repository, see [[Brief_introduction_to_SVNBrief_introduction_to_Git| the introduction to SVNGit]].You can also download files by browsing via [https://github.com/gramps-project/gramps GitHub web interface].* Look for <code>gramps.pot</code> in the directory <code>gramps2/'''po</code> or if you looking for the trunk version look for <code>gramps.pot</code> in the ''' directory <code>gramps30/po</code>.
===Translating messages===
* Copy <code>gramps.pot</code> to the file named <code>lang.po</code>, according to the language you are translating into (<code>fr.po</code> for French, <code>ru.po</code> for Russian, etc.)
* Use [http://gtranslator.sourceforge.net/ GTtranslator] (GNOME, windows), [http://kbabeli18n.kde.org/tools/ KBabel] (KDE), [http://userbase.kde.org/Lokalize Lokalize] (KDE, windows), Emacs po-mode, [http://translate.sourceforge.net/wiki/pootling/index pootling] (GNU/Linux, windows), [http://www.poedit.net/ poedit] (GNU/Linux, OSX, windows), or any similar tool designed for translating <code>.po</code> files. If you do not like any of these tools, you can use any text editor to translate messages. If using vim, properly setting the "langmap" option will significantly speed up your work.* Even though GRAMPS uses UNICODE (UTF-8) for its character set, you may use your native character set for your translation. Just make sure you specify the character set you are using in the <code>Content-Type</code> line in the <code>.po</code> file. GRAMPS Gramps will handle the conversion to UNICODE.* If there are non ASCII characters in the original English string, try to preserve them by copying them, if applicable. ===Context===As an extension to standard gettext, strings in Gramps can have a context prefix. This prefix should '''not''' be translated, and just be deleted in the translation. More info and an example [[#Translation context|further down]]. As a special context, you will see the manual context, eg : 'manual|Editing_Dates'these strings should only be translated if a '''wiki user manual''' is available in your language, eg in Dutch : 'Datums_aanpassen' The string refers to a section, eg [[Gramps_4.1_Wiki_Manual_-_Entering_and_Editing_Data:_Detailed_-_part_1#Editing_dates |Editing_Dates]] in Dutch becomes [[Gramps_4.1_Wiki_Manual_-_Entering_and_Editing_Data:_Detailed_-_part_1/de#Daten_bearbeiten|Datums_aanpassen]].
===Testing your <code>.po</code> file===
./check_po --skip-fuzzy lang.po or python check_po --skip-fuzzy lang.po > langwhere lang is your language code. This will give you errors in your translation, information on badly translated phrases, ... the output could resemble something like this.. File: nl.po Template total: 3816 PO total: 3671 Fuzzy: 125 Untranslated: 12 %s mismatches: 0 %d mismatches: 2 %() name mismatches:9 %() missing s/d: 0 Runaway context: 0 XML special chars: 0 Last character: 15 Shortcut in msgstr: 16 PO Coverage: 99.67% Template Coverage: 95.89% Localized at: 97% (previous gramps.pot) If you get ''previous gramps.pot'', then you are not using the last ''gramps.pot'', see [[#Updating_your_translation|update your translation]]. ''fuzzy'' and untranslated strings will be ignored, Gramps will use main strings in english. -------- %d mismatches --------------You can see that there are 3816 strings to be translated and the coverage is around 96 %. There are still 12 untranslated strings and some 120 fuzzies. The last one can be ok, but should be checked. Additional information shows e.g. that in 15 strings there is a mismatch with the 'last character': -------- last character not identical --------- msg nr: 98, lineno: 602 msgid "Could not make database directory: " msgstr "Kon geen gegevensbestandsmap aanmaken"
* Lokalize, GTranslator also provide a syntax check when saving. If an error occured we can navigate to messages which contain errors.
===Formatting (compiling) <code>.po</code> file===
* Currently, [[Coding_for_translation#How_it_works|formatting (msgfmt) is performed during build time]], so you should not have to worry about it. The translated <code>.po</code> file is the product of your work. However, try to [[Translating_Gramps#Save_as_.mo_file|check syntax]] before any commit. ===Send your contribution=== Check it into SVN Git if you obtained the permission to do so, or email it . The following configuration option simplifies pushing a branch back to [[Contact|Don Allingham or Alex Roitman]] otherwisethe server: $ git config --global push.default upstream Otherwise you can fork gramps repository with a Github account and pull a merge request. See: {{Code Browser}}
===Updating your translation===
If you have submitted a translation, changes are it may well be that after some weeks/months, new strings are added to GRAMPSGramps, implying you need to update your translation file.
Assuming you have obtained originally the GRAMPS Gramps source tree as explained in [[Brief introduction to SVNGit]]. Now:* Update your gramps Gramps tree from SVNGit. This can be done by executing the command <pre>svn upgit pull</pre> from the root GRAMPS svn Gramps directory. This will download an updated <code>gramps.pot</code> file.* Use your outdated translation to translate the strings that did not change:<pre>msgmerge lang.po templategramps.po pot -o newlang.po</pre> or <pre>msgmerge --no-wrap lang.po templategramps.po pot -o newlang.po</pre> where <code>lang</code> is your language code. The <code>--no-wrap</code> option will prevent changes due to automatic word wrapping, use it if your previous po file was constructed like that. The <code>--no-wrap</code> options allows for more readable SVN Git diffs.* Translate Check fuzzy messages and translate all untranslated messages in <code>newlang.po</code>. When you are sure everything is right, rename <code>newlang.po</code> as <code>lang.po</code> and check it into SVN Git as you did with the original file.* If command <code>msgmerge</code> is not available on your system, you have to install the <code>}gettext</code> package. For [http://wiki.wxpython.org/index.cgi/Internationalization#head-d8e0d98b64f3878f8bb828aeb41a05bcc6a02cc4 How_to_get_gettext_tools_for_Win32 windows users].* To back-port translations, e.g., to merge master branch translations onto an earlier branch, do this on the earlier branch (assuming gramps.pot is updated):<pre>msgmerge -C lang.po master-lang.po gramps.pot -o newlang.po</pre>. Then resolve the fuzzies as usual.
There is also the make target that does the following:
* Create new <code>gramps.pot</code> template from the source code files
cd po
./genpot.sh or python update_po.py -p see [[Talk:Translation_environment4|differences between tools]].
* Updates each <code>po</code> file in the source tree
It may be an overkill for you, but if you feel like using it, you can run:
===Testing your update===
You can test your update easily with the above mentioned '''check_po''' file. If you downloaded this file, just do:
===Installing your translation===
{{man warn|Environment change|For Gramps 4.0, {{stable_branch}} and master, see [[Translation_environment4|new environment]].}}
You want to use the new translation immediately, and systemwide?
You can by installing just the contents of the po directory, but you will need to build the source first, so:
make
cd po
make --prefix=/usrinstall #as root ! This should install your translations to ''/usr/share/locale/{lang}/LC_MESSAGES/gramps.mo'', with {lang} being your language. You could of course copy your files manually to that dir with the gramps.mo name. Make sure you only install from within the po directory, or you will install the development version of Gramps, which is not supported and for testing only! ==== Running the master branch with your translation ==== The i18n data are often under ''../share /locale'' according to the default prefix. So you can use: python setup.py build python setup.py install #as root !
This should will install your translations to <code>/usrthe .mo files under ''../share/locale/xx/LC_MESSAGES/gramps.mo</code>'', with xx your language. You could off course copy your files manually according to that dir with the gramps.mo namedefault prefix set.
This will install Gramps and translations under your ''/home/...'' directory. ===== $GRAMPSI18N (for your locale) ===== Actually you don't even need to install the files in order to test them. This is useful because you can develop Gramps without needing superuser privileges. Bear in mind the Gramps i18n process goes something like this when you use the master branch: * when you type <code>python build</code> in the source tree root (/home/user/Gramps e.g.) all the po/*.po files are compiled into build/mo/{lang}/*.mo files.* when you type <code>python install</code> inside the po directory, these .mo files are copied to {prefix}/share/locale/{lang}/LC_MESSAGES as gramps.mo files. But you can change the place where Gramps looks for these files by altering the environment variable $GRAMPSI18N. So you could also for instance do something like this and avoid the <code>python setup install</code> step: (if you are using csh or tcsh the syntax would be a little different) [user@localhost /home/user/Gramps]$ mkdir -p po/en_GB/LC_MESSAGES [user@localhost /home/user/Gramps]$ cp po/en_GB.gmo po/en_GB/LC_MESSAGES/gramps.mo [user@localhost /home/user/Gramps]$ cd gramps [user@localhost /home/user/Gramps/src]$ GRAMPSI18N=$PWD/../po LANG=en_GB.UTF-8 python gramps.py ===== gramps.sh ===== On a gramps launcher (copy from ''<code>{prefix}/bin/gramps</code>'') you can set : export GRAMPSDIR=/... export GRAMPSI18N=/... Where the environment variable ''$GRAMPSDIR'' is the path to your ''gramps'' directory. Where the environment variable ''$GRAMPSI18N'' is the path to your ''gramps locale'' directory. ===== Just testing your translation ===== If you don't want to compile all translations, you may save your ''.po'' file as ''.mo'' file, or use ''msgfmt'' utility on /po directory: msgfmt -o gramps.mo your_lang.po msgfmt.exe -o gramps.mo your_lang.po this will create a ''gramps.mo'' file, a compiled version of your ''.po'' file.Put it on your translation path (''see above''). ==Hard to Translate Phrasestranslate phrases==
Some things are just hard to translate. Below are a few of the more difficult items, along with some suggestions on how to handle them.
===LDS Terminologyterminology===
The Church of Jesus Christ of Latter Day Saints (a.k.a. Mormons) maintains a lot of genealogy data. In the United States, they are probably the non-government organization with the most detailed records available. Genealogical research is important to the Mormon church. They are responsible for defining the [[GEDCOM]] format.
#* Canceled
#* DNS/CAN (Do Not Submit/Previous sealing cancelled)
==Advanced issues==
In the above example, the verb "born" should be in masculine form (if verbs in your language have gender, that is), since the person born is apparently a male.
Sometimes those <nowiki>%(something)s</nowiki> are positioned in a text without spaces, like in the example below:
English:
This person was baptised%(endnotes)s.
Translation into Backward English:
Siht nosrep saw desitpab%(endnotes)s.
===Translation context===
In some cases, two different concepts can be expressed by the same word in English and yet require different translations. For example, the '''title of the book''' and the nobility '''title of the person''' are expressed by the same '''Title''' word. However, in other languages different words are needed to describe the book title and the person's title.
To mitigate such problems, a context can be added to the translation string. A context-enabled string has a vertical line separating the context from the string:
Eltitkoob
Eltitnosrep
If you are a Gramps translator and need a developer to help you add a context to the Gramps source files, please ask for it on the gramps-devel list.
====Translation context in GUI labels====
If there is a string in the Glade GUI (i.e., in a .glade source file) that requires the translation context, it's impossible to have it translated statically. In this case, one needs to add runtime code to the corresponding dialog initialization to override the label string with the text obtained with an sgettext call. I.e.,
* Verify the relevant widget has a meaningful id in the .glade file (as opposed to a silly autogenerated one). Modify the id if needed and make sure no existing code used the old widget id! E.g., change
<object class="GtkLabel" id="label3">
:into
<object class="GtkLabel" id="place_name_label">
* Add a context to the translatable string in the .glade file. This way, when you look at the POT file or a PO file derived from it, you see a reference to this place, along with the actual place in the .py file(s) which also has the same context string. E.g., change
<property name="label" translatable="yes">Name:</property>
:into
<property name="label" translatable="yes">place|Name:</property>
* In the corresponding dialog initialization, add code to set the string to the correct translation during runtime, e.g.:
:globally in the file:
PLACE_NAME = _('place|Name:')
:in the MergePlace.__init__ method:
for widget_name in ('name_btn1', 'name_btn2'):
self.get_widget(widget_name).set_label(PLACE_NAME)
:The exact method to call on the Gtk control will be different based on the actual GUI element affected. E.g., a GtkButton has a set_label method, whereas a GtkLabel has a set_text.
* Regenerate the POT, translate the new PO strings, and test your work.
===Plural forms===
There was requests for [http://www.gnu.org/software/gettext/manual/html_node/gettext_150.html#Plural-forms plural forms] support.
First, translators need to check if information is available on .po header :''"Plural-Forms:\n"''. (See [http://translate.sourceforge.net/wiki/l10n/pluralforms samples])
# msgid contains the singular string in english
# msgid_plural contains the plural string in english
# msgstr[0] contains the singular translated version (for 1 and sometimes 0, set on header)
# msgstr[1] contains the plural version (for 1 + 1 = 2 )
# msgstr[2] contains the plural form (for 2 + 1 = 3)
*For language with one form (singular=plural, ''Plural-Forms: nplurals=1; plural=0''), like Chinese, Hungarian or Turkish:
msgid "%d second"
msgid_plural "%d seconds"
msgstr [0] "%d 秒"
*For language with one plural form (''Plural-Forms: nplurals=2; plural=n != 1;''), like english:
msgid "%d hour"
msgid_plural "%d hours"
msgstr [0] "%d hour"
msgstr [1] "%d hours"
*For language with more plural forms (like Czech):
msgid "%d second"
msgid_plural "%d seconds"
msgstr [0] "%d sekunda"
msgstr [1] "%d sekundy"
msgstr [2] "%d sekund"
As a final check, please do ensure that the following command does not throw any errors:
msgfmt -c filename.po
===Translating mnemonics keys(Keyboard Shortcut keys)===
Mnemonics are accelerator keys (also known as Keyboard Shortcut keys) you find in labels, accessible by pressing the {{man key press|ALT}} key together with the mnemonic. You see then in the translated text with a low line, eg '_Help' is shown as 'Help' with a line under the H, and can be put to focus/selected by pressing {{man key press|ALT|h}}.
It is nice if mnemonics on a screen are unique, but it is not required. If you use twice the same mnemonic, the user must press repeatedly the accelerator to switch between the different entries. However, note the following rule:
*"If duplication of access keys in a window is unavoidable, you should still refrain from duplicating the access keys for any of these buttons that appear in the same window: {{man button|OK}}, {{man button|Cancel}}, {{man button|Close}}, {{man button|Apply}} or {{man button|Help}}."
So you should check in your language what the mnemonic key is for those buttons, and avoid using the same in translated text
{{man warn|Warning|Some fonts family will not properly display mnemonics on "g", "j", "p", "q" or "y" as these print the letter over the line under it making it very hard to distinguish the small line. Please avoid to use mnemonics key bindings on these letters. Also try to avoid i and l, as people have difficulty distinguishing between those.}}
Capital letters are no problem though, underlining eg G will work just fine as the letter does not write over the line.
===Translating relationships===
The need for a separate module comes from the requirements to handle culture-specific parsing and displaying of dates. For example, the month and day order is different between most European countries and the US. Also, each language has its own set of acceptable modifier and qualifiers for the date: things like "from X to Y" or "between X and Y" may have different word order. Same with "around", "calculated", "estimated". Add to this calendar names, and you have a compelling need for a dedicated module. See the [[Date Handler]] page for details on why and how to create such a module.
==Translating man pages==
{{man warn|Environment change|For gramps 4.0, {{stable_branch}} and master, see [[Translation_environment4#Translating_man_pages|new environment]].}}
You can also translated the man pages into your own language.
For the development version (master branch) you can find the required starting files under the directory data/man. You will find the files
*Makefile.am
*gramps.1.in
First off all you must make a directory for your language under data/man.
<code>cd data/man</code>
and do
<code>mkdir xx</code>
where xx is your languagecode (fr for French, sv for Swedish, etc.) You should use Git. See [[Brief_introduction_to_Git| the introduction to Git]].
Next step is to copy the Makefile.am and gramps.1.in from data/man to your new directory. Translate all relevant strings in the data/man/xx/gramps.1.in file. Change the file data/man/xx/Makefile.am:
*add the line mandir = @mandir@/xx
*change the line && CONFIG_FILES=data/man/xx/$@ $(SHELL)
Next step: change the file data/man/Makefile:
*add xx to the line SUBDIRS = fr nl sv
The final step is to alter the file ''Configure.in '':
*add data/man/xx/Makefile to the line AC_CONFIG_FILES([
All changes must be committed and pushed to the server:
git commit -am "Add man page for xx"
git push
You should see no errors when you run the
<code>./configure</code><br/>
<code>make</code><br/>
scripts.
{{man warn|Install|This last step must be done only in the data/man/xx directory. If not, your normal gramps installation will be overwritten. And this step must be done as superuser(su)}}
<code>sudo make install</code>
This will put the gramps.1.gz file into /usr/local/share/man/xx/man1 directory. You could also use a prefix. Then you do:
<code>sudo make --prefix=/usr/share install</code>
To see the result of your work, do:
<code>man -L xx gramps</code>
==Translating wiki manual==
To have the link working in Gramps, you need to have or edit the GrampsDisplay.py file to contain your language.
On line 30 of that file, you see:
MANUALS = {
'nl' : '/nl',
}
This maps a language code to the extension used on the wiki, so to add french, change this too:
MANUALS = {
'nl' : '/nl',
'fr': '/fr',
}
*Every '<code>manual|...</code>' entry in the <code>gramp.pot</code> file refers to a section in the manual, so make sure to use good section headings so this does not change too much over time.
Note that reports/tools link to a section in the page with the same name as the report name in Gramps.
*You should be able to edit directly on wiki or using tools like [http://translate.sourceforge.net/wiki/toolkit/txt2po txt2po] or [http://po4a.alioth.debian.org/ po4a]. Also previous gettext file for the manual and [http://en.wikipedia.org/wiki/Translation_memory Translation Memory] may help you to upgrade deprecated/old gettext files. eg, store existing entries from ''/usr/share/locale''.
==Language specific pages==
Check out the pages which cover some aspects of translation into a specific language, such as the glossary.
*[[Translation into Finnish|Finnish]]
*[[Translation into French|French (Français)]]
*[[Translation into Russian|Russian]]
==Translating addon plugins==
* See [[Addons_development#Get_translators_to_translate_your_addon_into_multiple_languages|3rd-party addon for Gramps]].
