Changes

Jump to: navigation, search

Rule expansions

648 bytes removed, 07:27, 16 June 2020
m
Add-on Rules: re-organize by how add-on rules are groups for install
{{-}}
==Add-on Rules==
Rules are added in sets/groups via the Plugin Manager. All the Rules in a set are added/removed when any Rule in that set is added/removed . Each set supports Multilingual internationalization services through [https://www.gnu.org/software/gettext/manual/html_node/PO-Files.html .po & .pot] files using gettext.
In the few months that add-on Rules have been a feature, two sets of rules have been collected:
'''===[https://github.com/gramps-project/addons-source/tree/master/FilterRules FilterRules] : Plugin Manager Rulebook Collection'''* [[#Families_with_Events_with_a_selected_role|Families with Events with a selected role]] <!-- familieswitheventfiltermatch.py -->* [[#Families_matching_&lt;event filter&gt;|Families matching &lt;event filter&gt;]] <!-- isfamilyfiltermatchevent.py -->* [[#People_Separated_less_than_<N>_degrees_of_<person>|People Separated less than <N> degrees of <person>]] <!-- degreesofseparation.py (1)-->* [[#People_Separated_less_than_<N>_degrees_of_<Home_person>|People Separated less than <N> degrees of <Home person>]] <!-- degreesofseparation.py (2)-->* [[#People_with_events_with_a_selected_role|People with events with a selected role]] <!-- hasrolerule.py -->* [[#People_who_are_part_of_families_matching_<filter>|People who are part of families matching <filter>]] <!-- infamilyrule.py -->* [[#People_related_to_<filter>|People related to <filter>]] <!-- isrelatedwithfiltermatch.py -->* [[#Source_matching_parameters|Source matching parameters]] <!-- hassourcefilter.py --> '''[https://github.com/gramps-project/addons-source/tree/master/FilterRules2 FilterRules2] : Plugin Manager Rulebook Collection''' * matrilinealprogenitrix.py* mtinheritance.py* mtinheritanceoffiltermatch.py* patrilinealprogenitor.py* xchromancestors.py* xchromdescendants.py* yinheritance.py* yinheritanceoffiltermatch.py {{-}} {{-}}Multilingual internationalization services [https://www.gnu.org/software/gettext/manual/html_node/PO-Files.html .po & .pot] files using gettext.===
====People related to &lt;filter&gt;====<!-- isrelatedwithfiltermatch.py -->
[[File:Rule_Person_Filter_Win.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Searching by Rule name]]{{icon|peop}}'''Person &bull; General filters''' [[{{Version manual}}_Addons|add-on]] rule to find [[Gramps_Glossary#person|Person(s)]] matching a specified filter.
Matches people who are related to anybody matched by a person filter.{{-}}[[File:Pythongadget.png|left|150px|link=https://github.com/gramps-project/addons-source/tree/master/FilterRules]]<code>'''isrelatedwithfiltermatch'''</code> provided as [https://github.com/gramps-project/addons-source/tree/master/FilterRules <code>sample '''.gpr.py''' & '''.py''' code</code> for writing add-on filter rules]. Demonstrates piping the output of one custom Filter into another.{{-}}
----====People with events with a selected role====<!-- hasrolerule.py -->
[[File:Rule_PersonEvent_Role_Win.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Searching for Person Rules which include the 'role' term.]]
{{icon|peop}}'''Person &bull; Event filters''' [[{{Version manual}}_Addons|add-on]] rule to find [[Gramps_Glossary#person|Person(s)]] having any [[Gramps_Glossary#event|Event]] with a specified [[Gramps_Glossary#event_role|Event Role]].
{{-}}
 ====Families with Events with a selected role====<!-- familieswitheventfiltermatch.py -->
[[File:Rule_FamiliesEvent_Role_Win.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Searching by Rule name]]
{{icon|fami}}'''Families &bull; Event filters''' [[{{Version manual}}_Addons|add-on]] rule to find [[Gramps_Glossary#family|Families]] having any Family member or shared Family level [[Gramps_Glossary#event|Event]] with a specified [[Gramps_Glossary#event_role|Event Role]].{{-}}[[File:Pythongadget.png|left|150px|link=https://github.com/gramps-project/addons-source/tree/master/FilterRules]]<code>'''hasrolerule'''</code> provided as [https://github.com/gramps-project/addons-source/tree/master/FilterRules <code>sample '''.gpr.py''' & '''.py''' code</code> for writing add-on filter rules]. Demonstrates including category variants of a rule in the same add-on.{{-}}
----====Source matching parameters====<!-- hassourcefilter.py -->[[File:Rule_Sources_Parameters_Win.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Searching by Rule name]]
{{icon|sour34}}'''Sources &bull; General filters''' [[{{Version manual}}_Addons|add-on]] rule to find [[Gramps_Glossary#source|Sources]] based on the following parameters: ''Title'', ''Author'', ''Abbreviation'', ''Publication''.
This add-on rule has similar options to the standard Filter Gramplet for the [[Gramps_{{Version manual}}_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_2#New_Source_dialog|Source]] [[Gramps_{{Version manual}}_Wiki_Manual_-_Categories#Sources_Category|Category View]]. It can be used to save complex filter parameters.{{-}}[[File:Pythongadget.png|left|150px|link=https://github.com/gramps-project/addons-source/tree/master/FilterRules]]<code>'''hassourcefilter'''</code> provided as sample [[Addons_development#Create_a_Gramps_Plugin_Registration_file|.gpr.py]] & '''.py''' code for [https://github.com/gramps-project/addons-source/tree/master/FilterRules writing add-on filter rules]. Demonstrates text based filtering with RegEx options.{{-}}
----====People Separated less than &lt;N&gt; degrees of &lt;Home person&gt;====<!-- degreesofseparation.py (1)-->
[[File:Rule_DegreesOfSep_HomePerson_Win.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Searching for Person Rules which include the 'degrees' term.]]
{{icon|peop}}'''Person &bull; Relationship filters''' [[{{Version manual}}_Addons|add-on]] rule to find [[Gramps_Glossary#person|Person(s)]] having a relationship to the ''[[Gramps_Glossary#home_person|Home Person]]'' within a specified degree of [[Genealogy_Glossary#consanguinity|Consanguinity]] and [[Genealogy_Glossary#affinity|Affinity]].
[https://gist.github.com/Mattkmmr/4d0369cbee38bdf14395cb2f4505fb8a GitHub Repository files]
{{-}}
 ====People Separated less than &lt;N&gt; degrees of &lt;person&gt;====<!-- degreesofseparation.py (2)-->[[File:Rule_DegreesOfSep_PersonID_Win.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Searching Person rules by 'degrees' term; roll-over hint for ID.]]
{{icon|peop}}'''Person &bull; Relationship filters''' [[{{Version manual}}_Addons|add-on]] rule to find [[Gramps_Glossary#person|Person(s)]] having a relationship to a specified Person within a specified degree of [[Genealogy_Glossary#consanguinity|Consanguinity]] and [[Genealogy_Glossary#affinity|Affinity]].
[https://github.com/gramps-project/addons-source/pull/283 GitHub Repository files]
{{-}}
 
===Add-on Rules needing additional documentation===
{{stub}}
====Events of families matching a &lt;family filter&gt;====
Events of families matching a &lt;family filter&gt;
====Families matching &lt;event filter&gt;====<!-- isfamilyfiltermatchevent.py -->
Matches families that are matched by an event filter
====People who are part of families matching &lt;filter&gt;====<!-- infamilyrule.py --> 
People who are part of families matching &lt;filter&gt;
===The Active Person===The active Person{{-}}
Requires a ===[https://grampsgithub.discourse.groupcom/tgramps-project/customaddons-filters-based-on-currently-selected-person-ssource/tree/354master/17 patchFilterRules2 FilterRules2] to be compatible with the Person Grouped View: Plugin Manager Rulebook Collection===
{{stub}}====Matrilineal progenitrix of &lt;person&gt;====<!-- matrilinealprogenitrix.py -->
Matches the earliest recorded matrilineal ancestor mother.
====Mitochondrial inheritance of &lt;filter&gt;====<!-- mtinheritanceoffiltermatch.py -->
Matches recorded descendants of a filter result following mitochondrial inheritance patterns.
====Mitochondrial inheritance of &lt;person&gt;====<!-- mtinheritance.py -->
Matches recorded descendants of person following mitochondrial inheritance patterns.
====Patrilineal progenitor of &lt;person&gt;====<!-- patrilinealprogenitor.py -->
Matches the earliest recorded patrilineal ancestor father.
====X-chromosomal ancestors of &lt;person&gt;====<!-- xchromancestors.py -->
Matches ancestors of &lt;person&gt; following a X-chromosomal inheritance pattern.
====X-chromosomal descendants of &lt;person&gt;====<!-- xchromdescendants.py -->
Matches descendants of &lt;person&gt; following a X-chromosomal inheritance pattern.
====Y-chromosomal inheritance of &lt;person filter&gt;====<!-- yinheritanceoffiltermatch.py -->Matches recorded descendants of a filter result following Y-chromosomal inheritance patterns.====Y-chromosomal inheritance of &lt;person&gt;====<!-- yinheritance.py -->Matches recorded descendants of person following Y-chromosomal inheritance patterns.{{-}}===Pre-Release Rules=======Descendants of &lt;person&gt; sharing yDNA with each other====
Matches descendants of a &lt;person&gt; sharing yDNA
===Y-chromosomal inheritance of &lt;person filter&gt;===
Matches recorded descendants of a filter result following Y-chromosomal inheritance patterns.
===Y-chromosomal inheritance of &lt;person&gt;=The Active Person====Matches recorded descendants of The active Person Requires a [https://gramps.discourse.group/t/custom-filters-based-on-currently-selected-person following Y-chromosomal inheritance patterns.{{-}}s/354/17 patch] to be compatible with the Person Grouped View
=The Evolution of of Rules as Add-Ons=
4,530
edits

Navigation menu