Difference between revisions of "Talk:Translating Gramps"

From Gramps
Jump to: navigation, search
m (Translating third-party plugins: Making GRAMPS easier to translate)
(Replacing page with '==Making GRAMPS easier to translate== Are there any plans to setup something like Pootle server for GRAMPS translations? (sorry for the double post)Dm1407 23:40...')
Line 1: Line 1:
== 如何翻译 GRAMPS !  20090528 端午节 练习页面第一版 ==
Tips for translators of the GRAMPS program.
==Gettext file format==
''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 <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=CHARSET\n"
"Content-Transfer-Encoding: 8bit\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. This will help translator but is optional for having a translation.
* msgid is the string, present on gramps' code
* msgstr is your 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.
==Tips for translators==
===Getting started===
# Always save your translations in UTF-8 encoding
# 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 into a new language means translating English strings used in the 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 repository.
Another avenue of translation is translating the documentation. This is a different and lengthy process and it is decribed in our [[Translating the manual]] page. Here we will concentrate on the interface translation only.
===Obtaining gramps.pot===
* Download <code>gramps.pot</code> from GRAMPS SVN repository, see [[Brief_introduction_to_SVN| the introduction to SVN]].
* Look for <code>gramps.pot</code> in the directory <code>gramps30/po</code> or if you looking for the trunk version look for <code>gramps.pot</code> in the directory <code>trunk/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), [http://kbabel.kde.org/ KBabel] (KDE), 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.
* 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 will handle the conversion to UNICODE.
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 :
these strings should only be translated if a wiki manual is available in your language. The string refers to a section, eg [[Gramps_3.0_Wiki_Manual_-_Entering_and_Editing_Data:_Detailed#Editing_Dates |Editing_Dates]] in Dutch becomes [[Gramps_3.0_Wiki_Manual_-_Entering_and_Editing_Data:_Detailed/nl#Datums_aanpassen|Datums_aanpassen]].
===Testing your <code>.po</code> file===
In the directory <code>gramps30/po</code> or the <code>trunk/po</code> run the command: <pre>make</pre> If there are errors in your po file, this will fail and give you an error message. You should correct these errors. If you have trouble understanding the error, try to run the next test, which might give a more verbose output.
In the directory <code>gramps30/po</code> or the <code>trunk/po</code> run the command: <pre>./check_po lang.po</pre> or <pre>python check_po lang.po > lang</pre> or <pre>alternative under Windows OS ???</pre> where 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"
This is very valuable information, because you can easily see what the problem is, even if you do not understand the language! Clearly the last characters must be ": "
In the directory <code>gramps30/po</code> or the <code>trunk/po</code> run the command: <pre>msgfmt --statistics lang.po</pre>  where lang is your language code. This should not throw an error.
Basically this gives the same info in a condensed format: 3533 translated messages, 125 fuzzy translations, 12 untranslated messages.
====GNU `gettext' utilities====
[http://www.gnu.org/software/gettext/ GNU `gettext' utilities] provides a few stand-alone programs to massage in various ways the sets of translatable strings, or already translated strings:
msgattrib - attribute matching and manipulation on message catalog
msgcat - combines several message catalogs
msgcmp - compare message catalog and template
msgcomm - match two message catalogs
msgconv - character set conversion for message catalog
msgen - create English message catalog
msgexec - process translations of message catalog
msgfilter - edit translations of message catalog
msgfmt - compile message catalog to binary format (.po->.mo)
msggrep - pattern matching on message catalog
msginit - initialize a message catalog
msgmerge - merge message catalog and template
msgunfmt - uncompile message catalog from binary format
msguniq - unify duplicate translations in message catalog
For checking syntax :
msgfmt -c nl.po
===Formatting (compiling) <code>.po</code> file===
* Currently, formatting 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. Check it into SVN if you obtained the permission to do so, or email it to [[Contact|Brian or Benny]] otherwise.
===Updating your translation===
If you have submitted a translation, changes are that after some weeks/months, new strings are added to GRAMPS, implying you need to update your translation file.
Assuming you have obtained originally the GRAMPS source tree as explained in [[Brief introduction to SVN]]. Now:
* Update your gramps tree from SVN. This can be done by executing the command <pre>svn up</pre> from the root GRAMPS svn 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 gramps.pot -o newlang.po</pre> or <pre>msgmerge --no-wrap lang.po gramps.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 diffs.
* 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 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  windows users].
There is also the make target that does the following:
* Create new <code>gramps.pot</code> template from the source code files
  cd po
  make gramps.pot
* 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:
  make update-po
in the <code>po</code> directory. This assumes that you have already succesfully configured the source.
===Testing your update===
You can test your update easily with the above mentioned '''check_po''' file. If you downloaded this file, just do:
<pre>python check_po newlang.po</pre>. If everything is ok, the output will be something like this:
File:              newlang.po
Template total:    3075
PO total:          3075
Fuzzy:              0
Untranslated:      0
%s mismatches:      0
%d mismatches:      0
%() name mismatches:0
%() missing s/d:    0
Runaway context:    0
XML special chars:  0
Last character:    0
Shortcut in msgstr: 0
PO Coverage:        100.00%
Template Coverage:  100.00%
===Installing your translation===
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:
cd po
make --prefix=/usr install    #as root !
This should install your translations to <code>/usr/share/locale/xx/LC_MESSAGES/gramps.mo</code>, with xx 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 trunk with your translation ====
The current GRAMPS trunk as of February 2009 by default looks for the i18n data under <code>/usr/local/share/locale</code>. So you can use:
cd po
make install    #as root !
This will install the .mo files under /usr/local/share/locale/xx/LC_MESSAGES, since the default prefix is /usr/local
===== $GRAMPSI18N =====
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 proccess goes something like this when you use trunk:
* when you type <code>make</code> in the source tree root (/home/user/trunk e.g.) all the trunk/po/*.po files are compiled into trunk/po/*.gmo files.
* when you type <code>make install</code> inside the /home/user/trunk/po directory, these .gmo files are copied to /usr/local/share/locale/xx/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 intance do something like this and avoid the <code>make install</code> step: (if you are using csh or tcsh the syntax would be a little different)
[user@localhost /home/user/trunk]$ mkdir -p po/en_GB/LC_MESSAGES
[user@localhost /home/user/trunk]$ cp po/en_GB.gmo po/en_GB/LC_MESSAGES/gramps.mo
[user@localhost /home/user/trunk]$ cd src
[user@localhost /home/user/trunk/src]$ GRAMPSI18N=$PWD/../po LANG=en_GB.UTF-8 python gramps.py
===== Just testing your translation =====
If you don't want to compile all translations, you may use ''msgfmt'' utility on /po directory:
msgfmt your_lang.po
this will create a messages.mo file, a compiled version of your ''.po'' file.
Rename messages.mo to gramps.mo and put it on your translation path (''see above'').
==Hard to Translate 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 Terminology===
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.
The LDS Church has some specific terminology that can present difficulty in translating. There are two approaches to handling the information.
# If the LDS Church has a presence in your country, contact the LDS Temple in your area and ask them what the correct terminology is in your native language
# If the LDS Church does not have a presence in your country, it would probably be safe to simply not translate the phrases.
These terms include:
# LDS Ordinance names:
#* Sealed to Parents
#* Sealed to Spouse
#* LDS Baptism
#* Endowment
# LDS Status names for Ordinances:
#* Child
#* Cleared
#* Completed
#* Infant
#* Pre-1970
#* Qualified
#* Stillborn
#* Submitted
#* Uncleared
#* BIC (Born In the Covenant)
#* DNS (Do Not Submit)
#* Canceled
#* DNS/CAN (Do Not Submit/Previous sealing cancelled)
==Advanced issues==
===Format line parameters===
Format line parameters such as <nowiki>%s</nowiki> and <nowiki>%d</nowiki> '''should not''' be translated. The order of these parameters '''should not''' be changed. Examples:
    Long widowhood: %s was a widow %d years.
Translation (using Backward English as an example :-):
    Gnol doohwodiw: %s saw a wodiw %d sraey.
Named format line parameters such as <nowiki>%(something)s and %(something)d</nowiki> also '''should not''' be translated. Feel free to change the order of named parameters to correctly phrase the message in your language. Also, use hints provided by the names. Examples:
    Baptized before birth: %(male_name)s
            born %(byear)d, baptized %(bapyear)d.
Translation into Backward English:
    Dezitpab erofeb htrib: %(byear)d
            nrob %(male_name)s, dezitpab %(bapyear)d.
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:
    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:
The correct translation '''should not''' include either the context or the separator. The context is to give the translator idea of what  the string means. However, '''both the context and the separator must not be in the translated string''', so in backward english the above is translated into
===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.
(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"
msgstr_plural "%d seconds"
msgstr [0] "%d 秒"
*For language with one plural form (''Plural-Forms: nplurals=2; plural=n != 1;''), like english:
msgid "%d hour"
msgstr_plural "%d hours"
msgstr [0] "%d hour"
msgstr [1] "%d hours"
*For language with more plural forms (like Czech):
msgid "%d second"
msgstr_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===
Mnemonics are accelerator keys you find in labels, accessible by pressing the 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 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: OK, Cancel, Close, Apply or Help."
So you should check in your language what the mnemonic key is for those buttons, and avoid using the same in translated text
'''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===
Translating relationships is not done within the <code>.po</code> files, except for occasional <code>father</code> and <code>mother</code> strings here and there in the interfaces and reports. Complete translation of all relationships for the language/culture is done inside a relationship calculator plugin.
In short, the need for a plugin comes from the impossibility to translate "first cousin twice removed" in languages such as, e.g., German or Russian. See the [[Relationship Calculator]] page for details on why and how to create such a plugin.
===Translating dates===
Handling date translation is not entirely done within the <code>.po</code> files. Complete handling of date translation for each language/culture is done inside a dedicated date handler module.
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==
You can also translated the man pages into your own language.
For the development (trunk) version you can find the required starting files under the directory (/trunk)/data/man. You will find the files
First off all you must make a directory for your language under data/man.
  cd data/man
and do <code>
  mkdir xx
where xx is your languagecode (fr for French, sv for Swedish, etc.) You should use SVN. See [[Brief_introduction_to_SVN| the introduction to SVN]]. Then do <code>
  svn add xx
  svn commit -m "xx dir for man pages" xx
This will add the xx dir under svn revision control and upload the new dir.
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([
Because you added new files, SVN requires that you set the correct propset for those files. Two things are to be done.
  svn propset svn:mime-type text/plain xx/gramps.1.in xx/Makefile.am
  svn propset svn:eol-type native xx/gramps.1.in xx/Makefile.am
You could also in the config file of subversion ( HOMEDIR/.subversion/config) enable the auto-prop feature (enable-auto-props = yes) and uncomment the relevant lines in the [auto-props] section.
All changes must be committed and do not forget to change the ChangeLog file.
You should see no errors when you run the <code>
</code> 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)}}
  sudo make install
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
To see the result of your work, do:<code>
  man -L xx gramps
==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:
    'nl' : '/nl',
This maps a language code to the extension used on the wiki, so to add french, change this too:
    'nl' : '/nl',
    'fr':  '/fr',
*Every 'manual|...' entry in the gramp.pot 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]. 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.
==Translating third-party plugins==
As [[Third-party Plugins]] are not officially part of GRAMPS and are not supported by the GRAMPS Developers but give users more tools to work with your genealogy data in GRAMPS, we can translate them !
Trying to avoid duplicate strings which could generate conflicts, [[Media:additional.pot.gz|here an additional template]]. We should be able to copy/paste references at the end of main translation file for supporting translation on third-party plugins.
==Making GRAMPS easier to translate==
==Making GRAMPS easier to translate==
Are there any plans to setup something like Pootle server for GRAMPS translations? (sorry for the double post)[[User:Dm1407|Dm1407]] 23:40, 28 May 2009 (UTC)
Are there any plans to setup something like Pootle server for GRAMPS translations? (sorry for the double post)[[User:Dm1407|Dm1407]] 23:40, 28 May 2009 (UTC)

Revision as of 08:27, 29 May 2009

Making GRAMPS easier to translate

Are there any plans to setup something like Pootle server for GRAMPS translations? (sorry for the double post)Dm1407 23:40, 28 May 2009 (UTC)