Changes

Jump to: navigation, search

Specification:Relationship Calculator

32 bytes removed, 16:24, 1 September 2019
m
linked to intro to Relationship Calculator
Rationale and requirements for the [[Gramps_5.1_Wiki_Manual_-_Tools#Relationship_Calculator|Relationship Calculator ]] plugin for Gramps, and its localisationlocalization.
==Why have different relationship calculators?==
The relationship calculator Logic is the same as Gramps version 3.0. Only paths and filename etc have been updated due to the Code reorganisation.
Here are the rules the language-specific plugins must obey to be compatible with the [httphttps://www.gramps-project.org/docs/relationship.html framework]:
# You need to make localized versions of the methods:
:#get_single_relationship_string (used on ''quick report'')
:#get_partner_relationship_string - only make a localized version of this if the gettext translation present in Relationship.py is not sufficient
:Note that the signature of the methods must be identical to the ones in [http:{{Code Base}}gramps/gen/svnrelationship.code.sf.net/p/gramps/code/trunk/py gramps/gen/relationship.py relationship.py]
All other methods are unique to the English module, and should not be overwritten. You can however define your own helper functions like present in relationship.py, eg _get_father(). Helper functions start with a _ and are not used outside of the Relationship class module.
Text strings returned by the function should be in the UNICODE character set. GNOME expects all displayed strings to be UNICODE characters, and most report formats use UNICODE. While it may be tempting to use ISO-8859 or other character sets, these will not display correctly and will cause errors.
The relationship plugin must be [[GEPS 014: Plugin registration and management|registered]] in the plugin system. In short, you have to edit the file <code>[http://svn.code.sf.net/p/gramps/code/trunk/{{Code Base}}gramps/plugins/rel/relplugins.gpr.py relplugins.grpgpr.py]</code> in the directory <code>gramps/codetree/trunkmaster/gramps/plugins/rel</code>. Follow the model of any of the other languages, and fill in all the possible language identifiers that '''may possibly''' be associated with your language: for example, different systems use <code>ru</code>, <code>RU</code>, <code>ru_RU</code>, <code>koi8r</code>, <code>ru_koi8r</code>, <code>russian</code>, <code>Russian</code>, <code>ru_RU.koi8r</code>, etc. to identify the Russian language.
That's it for the requirements. The example <code>relcalc</code> plugins can be found in <code>[http://svn.code.sf.net/p/gramps/code/trunk/{{Code Base}}gramps/gen/relationship.py gramps/gen/relationship.py]</code> and <code>[http://svn.code.sf.net/p/gramps/code/trunk{{Code Base}}/gramps/plugins/rel/rel_it.py gramps/plugins/rel/rel_it.py]</code> or <code>[http://svn.code.sf.net/p/gramps/code/trunk/{{Code Base}}gramps/plugins/rel/rel_nl.py gramps/plugins/rel/rel_nl.py]</code>.
====Tests====
You are further strongly adviced advised to run the same tests as are present at the bottom of those files. If you have obtained Gramps Git in <code>/home/me/Gramps</code>, then you can run the test for eg. rel_it.py as follows in a terminal:
cd /home/me/Gramps
Text strings returned by the function should be in the UNICODE character set. GNOME expects all displayed strings to be UNICODE characters, and most report formats use UNICODE. While it may be tempting to use ISO-8859 or other character sets, these will not display correctly and will cause errors.
The relationship plugin must be [[GEPS 014: Plugin registration and management|registered]] in the plugin system. In short, you have to edit the file <code>relplugins.grpgpr.py</code> in the directory <code>src/plugins/rel</code>. Follow the model of any of the other languages, and fill in all the possible language identifiers that '''may possibly''' be associated with your language: for example, different systems use <code>ru</code>, <code>RU</code>, <code>ru_RU</code>, <code>koi8r</code>, <code>ru_koi8r</code>, <code>russian</code>, <code>Russian</code>, <code>ru_RU.koi8r</code>, etc. to identify the Russian language.
That's it for the requirements. The example <code>relcalc</code> plugins can be found in <code>src/Relationship.py</code> and <code>src/plugins/rel/rel_it.py</code> or <code>src/plugins/rel/rel_nl.py</code>.
==See also==
*[[Handler List]]
*[[Calendar tools holidays]]
[[Category:Translators/Categories]]
[[Category:Plugins]]
[[Category:Tools]]
[[Category:GEPS|C]]
1,644
edits

Navigation menu