Specification:Relationship Calculator

From Gramps
Revision as of 11:59, 7 March 2007 by Bmcage (Talk | contribs) (conversion of relationshipcalculator)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This article provides the rationale and requirements for the Relationship Calculator plugin for GRAMPS, and it's localisation.

Why have different relationship calculators?

Different cultures and regions tend to view relationships in different ways. In the United States (and probably other English speaking regions), you can encounter a third cousin, twice removed, which in other regions is meaningless. Other cultures have different terms for your mother's grandfather and your father's grandfather, while English speaking regions would refer to both as a great-grandfather.

By providing relationship calculators, several problems are resolved.

  • Meaningful relation descriptions are returned localized for the user's region.
  • The relationship calculator plugin can return the relationship outside of the Relationship Calculator, allowing relationships to be used in reports and other areas.
  • Translators do not have to worry about trying to translate strings such as "third cousin twice removed" into a local phrase that has no equivalent.

How to write a relationship calculator

The framework for relationship calculator plugins is in place. Here are the rules the language-specific plugins must obey to be compatible with the framework:

  1. The relationship plugins (here and below referred to as rel plugins) must define a class that can be instantiated with the GrampsDbBase instance as its argument and that has a get_relationship method obeying the following rules:
    • The arguments of get_relationship method are two Person objects. To be determined is the relationship of the second person to the first person.
    • The values returned by the function are the string of the relationship (e.g. "father", or "grandson") and the list of the closest common ancestors of these two persons.
    • For the sake of the following example, assume that the above function is defined in src/plugins/rel_xx.py (where xx is your language code), and it's name is get_relationship(first_person,second_person). Also assume that it returns a pair of values: (rel_string, acnestor_list).
    • 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.
  2. The rel plugin must register itself with the plugins system as the relcalc tool. This is done by inserting the following code at the end of your rel_xx.py plugin:
    from PluginMgr import register_relcalc
       register_relcalc(RelationshipCalculatorClass,["xx","XX",
               "xx_YY","xxxxxx","Xxxxxx","Xxxxxxx_xx"])
where RelationshipCalculatorClass is the class whose method is the get_relationship and the items in quotes are language identifiers that may possibly be associated with your language. For example, different systems use ru, RU, ru_RU, koi8r, ru_koi8r, russian, Russian, ru_RU.koi8r, etc. to identify the Russian language.


That's it for the requirements. The example relcalc plugins can be found in src/Relationship.py and src/plugins/rel_ru.py.