Relationship Calculator - Revision history

Patsyblefebre: Gramps

2013-01-20T01:10:45Z

Gramps

Patsyblefebre: /* Tests */ update

2013-01-02T20:44:52Z

‎Tests: update

Patsyblefebre: /* For GRAMPS 4.x.x */ update links

2013-01-02T20:43:31Z

‎For GRAMPS 4.x.x: update links

Patsyblefebre: /* For GRAMPS 4.x.x */ update http://svn.code.sf.net/p/gramps/code/trunk/gramps/gen/relationship.py

2013-01-02T20:36:36Z

‎For GRAMPS 4.x.x: update http://svn.code.sf.net/p/gramps/code/trunk/gramps/gen/relationship.py

Patsyblefebre: copy

2013-01-02T20:34:05Z

copy

Romjerome at 10:17, 3 March 2012

2012-03-03T10:17:05Z

Jcreus: New plugin registration system

2011-12-30T17:27:41Z

New plugin registration system

Jcreus: get_grandparents_string is not required anymore

2011-12-30T17:19:03Z

get_grandparents_string is not required anymore

Daleathan: /* How to write a relationship calculator in 2.2.x */ Handler List

2011-09-30T09:44:55Z

‎How to write a relationship calculator in 2.2.x: Handler List

Romjerome: /* How to write a relationship calculator for version 3.1 */

2011-06-14T10:08:56Z

‎How to write a relationship calculator for version 3.1

@@ Line 1: / Line 1: @@
-Rationale and requirements for the Relationship Calculator plugin for GRAMPS, and its localisation.
+Rationale and requirements for the Relationship Calculator plugin for Gramps, and its localisation.
 ==Why have different relationship calculators?==
@@ Line 10: / Line 10: @@
 ==How to write a relationship calculator==
-===For GRAMPS 4.x.x===
+===For Gramps 4.x.x===
 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.
@@ Line 32: / Line 32: @@
 ====Tests====
-You are further strongly adviced to run the same tests as are present at the bottom of those files. If you have obtained GRAMPS svn in <code>/home/me/grampssvn</code>, then you can run the test for eg. rel_it.py as follows in a terminal:
+You are further strongly adviced to run the same tests as are present at the bottom of those files. If you have obtained Gramps svn in <code>/home/me/grampssvn</code>, then you can run the test for eg. rel_it.py as follows in a terminal:
   cd /home/me/grampssvn
@@ Line 44: / Line 44: @@
   pylint gramps/plugins/rel/rel_it.py > /home/me/grampssvn/gramps/plugins/rel/it.txt
-===For GRAMPS 3.x.x===
+===For Gramps 3.x.x===
 The relationship calculator changed for version 3.0. Logic has been separated from translation, which will allow code improvements to occur more easily, being available immediately in all translated modules.
@@ Line 65: / Line 65: @@
 ====Tests====
-You are further strongly adviced to run the same tests as are present at the bottom of those files. If you have obtained GRAMPS svn in <code>/home/me/grampssvn</code>, then you can run the test for eg. rel_it.py as follows in a terminal:
+You are further strongly adviced to run the same tests as are present at the bottom of those files. If you have obtained Gramps svn in <code>/home/me/grampssvn</code>, then you can run the test for eg. rel_it.py as follows in a terminal:
   cd /home/me/grampssvn
@@ Line 77: / Line 77: @@
   pylint src/plugins/rel/rel_it.py > /home/me/grampssvn/src/plugins/rel/it.txt
-===For GRAMPS 2.2.x===
+===For Gramps 2.2.x===
 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:
 # The relationship plugins (here and below referred to as <code>rel</code> plugins) must define a class that can be instantiated with the [http://www.gramps-project.org/docs/gen/gen_db.html#module-gen.db.base GrampsDbBase] instance as its argument and that has a <code>get_relationship()</code> method obeying the following specifications:

@@ Line 35: / Line 35: @@
   cd /home/me/grampssvn
-  export PYTHONPATH=/home/me/grampssvn/src
+  export PYTHONPATH=/home/me/grampssvn/gramps
-  python src/plugins/rel/rel_it.py
+  python gramps/plugins/rel/rel_it.py
 You could also run [[Programming_Guidelines#Pylint|pylint]] as follows in a terminal
   cd /home/me/grampssvn
-  export PYTHONPATH=/home/me/grampssvn/src
+  export PYTHONPATH=/home/me/grampssvn/gramps
-  pylint src/plugins/rel/rel_it.py > /home/me/grampssvn/src/plugins/rel/it.txt
+  pylint gramps/plugins/rel/rel_it.py > /home/me/grampssvn/gramps/plugins/rel/it.txt
 ===For GRAMPS 3.x.x===

@@ Line 21: / Line 21: @@
 :Note that the signature of the methods must be identical to the ones in [http://svn.code.sf.net/p/gramps/code/trunk/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>relplugins.grp.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.
+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/gramps/plugins/rel/relplugins.gpr.py relplugins.grp.py]</code> in the directory <code>gramps/code/trunk/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>src/Relationship.py</code> and <code>src/plugins/rel/rel_it.py</code> or <code>src/plugins/rel/rel_nl.py</code>.
+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/gramps/gen/relationship.py gramps/gen/relationship.py]</code> and <code>[http://svn.code.sf.net/p/gramps/code/trunk/gramps/plugins/rel/rel_it.py gramps/plugins/rel/rel_it.py]</code> or <code>[http://svn.code.sf.net/p/gramps/code/trunk/gramps/plugins/rel/rel_nl.py gramps/plugins/rel/rel_nl.py]</code>.
 ====Tests====

@@ Line 11: / Line 11: @@
 ==How to write a relationship calculator==
 ===For GRAMPS 4.x.x===
-The relationship calculator Logic is the same as Gramps version 3.0. Only paths have been updated due to the Code reorganisation.
+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 [http://www.gramps-project.org/docs/relationship.html framework]:
@@ Line 20: / Line 20: @@
 :#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 Relationship.py
+:Note that the signature of the methods must be identical to the ones in [http://svn.code.sf.net/p/gramps/code/trunk/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.

@@ Line 10: / Line 10: @@
 ==How to write a relationship calculator==
 The relationship calculator changed for version 3.0. Logic has been separated from translation, which will allow code improvements to occur more easily, being available immediately in all translated modules.
@@ Line 28: / Line 62: @@
 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>.
-===Tests===
+====Tests====
 You are further strongly adviced to run the same tests as are present at the bottom of those files. If you have obtained GRAMPS svn in <code>/home/me/grampssvn</code>, then you can run the test for eg. rel_it.py as follows in a terminal:
@@ Line 42: / Line 76: @@
   pylint src/plugins/rel/rel_it.py > /home/me/grampssvn/src/plugins/rel/it.txt
-==How to write a relationship calculator in 2.2.x==
+===For GRAMPS 2.2.x===
 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:
 # The relationship plugins (here and below referred to as <code>rel</code> plugins) must define a class that can be instantiated with the [http://www.gramps-project.org/docs/gen/gen_db.html#module-gen.db.base GrampsDbBase] instance as its argument and that has a <code>get_relationship()</code> method obeying the following specifications:

← Older revision		Revision as of 10:17, 3 March 2012
Line 67:		Line 67:
	[[Category:Developers/General]]		[[Category:Developers/General]]
	[[Category:Plugins]]		[[Category:Plugins]]
		+	[[Category:Tools]]

@@ Line 22: / Line 22: @@
 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.
+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 register itself with the plugin system as the <code>relcalc</code> tool. This is done by inserting the following code at the end of your <code>rel_xx.py</code> file:
-     from PluginMgr import register_relcalc
+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.grp.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.
-     register_relcalc(RelationshipCalculatorClass,["xx","XX","xx_YY","xxxxxx","Xxxxxx","Xxxxxxx_xx"])
-−
-:where <code>RelationshipCalculatorClass</code> is the class you defined inheriting from Relationship.RelationshipCalculator, and the items in quotes are 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>.

@@ Line 65: / Line 65: @@
 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_ru.py</code>.
 [[Category:Translators/Categories]]
 [[Category:Developers/General]]
 [[Category:Plugins]]

@@ Line 9: / Line 9: @@
 * 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 for version 3.1==
+==How to write a relationship calculator==
 The relationship calculator changed for version 3.0. Logic has been separated from translation, which will allow code improvements to occur more easily, being available immediately in all translated modules.
-Here are the rules the language-specific plugins must obey to be compatible with the framework:
+Here are the rules the language-specific plugins must obey to be compatible with the [http://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'')