4,599
edits
Changes
m
===Families with Events with a selected role===Multilingual internationalization services [[Filehttps:Rule_FamiliesEvent_Role_Win//www.gnu.png|thumb|right|450px|Figorg/software/gettext/manual/html_node/PO-Files. {{#var:chapter}}html .{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Searching by Rule name]]{{icon|fami}}'''Families po • 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].pot]files using gettext.{{-}}
[[Category:WikiContributors]][[Category:How do I...]]
{{Languages|Rule expansions}}
→Add-on Rules: placeholder for other Rules (increase visibility for downloads)
{{man tip| 1=Changes to Rules are inconspicuous|2=New built-in Rules appear without any fanfare. Plus there a so many of them, grouped in so many subcategories that they may remain concealed.<br />Addons require downloading and installation, so the addon Rules have more visibility than the builtins. Plus they can be searched as a category in the Plugin Manager.}}
[[File:Preferences UpdateAddons-Rule-51.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Preferences: Check for Updated Addons showing Rules]]
Rules are the basic building blocks of custom [[Filter|Filters]].
With the Release release of [[Template:Releases/5.1.0|Gramps version 5.1]], the first addon Rules were released as [https://github.com/gramps-project/addons-source/tree/master/FilterRules posted as examples of coding a Filter Rule addon]. [[{{Version manual}}_Addons#Installing_Addons_in_Gramps|Installing similarly to any other addon]], a New Rule appears as a menu item within [[Gramps_{{Version manual}}_Wiki_Manual_-_Filters#Add_Rule_dialog|Add Rule dialog]] while [[Gramps_{{Version manual}}_Wiki_Manual_-_Filters#Define_Filter_dialog|Defining a custom Filter]].
Filters created with these Rules can tested, cloned or deleted using the [[Gramps_5.1_Wiki_Manual_-_Filters#CategoryName_Filters_dialog|Filter Editor]]. The dialog is invoked from the {{Man menu|Edit}} menu in each Category view.
{{-}}
===People related to <filter>===
[[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 • 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===
[[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 • 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===[[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 • 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===
[[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 • 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]]Provided <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 <code>sample code</code> for writing add-on filter rules]. Demonstrates text based filtering with RegEx options.{{-}}----
===People Separated less than <N> degrees of <Home person>===
[[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.]]
[https://github.com/gramps-project/addons-source/pull/283 GitHub Repository files]
{{-}}
==Add-on Rules needing additional documentation==
{{stub}}
===Descendants of <person> sharing yDNA with each other===
Matches descendants of a <person> sharing yDNA
===Events of families matching a <family filter>===
Events of families matching a <family filter>
===Families matching <event filter>===
Matches families that are matched by an event filter
===Matrilineal progenitrix of <person>===
Matches the earliest recorded matrilineal ancestor mother.
===Mitochondrial inheritance of <filter>===
Matches recorded descendants of a filter result following mitochondrial inheritance patterns.
===Mitochondrial inheritance of <person>===
Matches recorded descendants of person following mitochondrial inheritance patterns.
===Patrilineal progenitor of <person>===
Matches the earliest recorded patrilineal ancestor father.
===People who are part of families matching <filter>===
People who are part of families matching <filter>
===The Active Person===
The active Person
===X-chromosomal ancestors of <person>===
Matches ancestors of <person> following a X-chromosomal inheritance pattern.
===X-chromosomal descendants of <person>===
Matches descendants of <person> following a X-chromosomal inheritance pattern.
===Y-chromosomal inheritance of <person filter>===
Matches recorded descendants of a filter result following Y-chromosomal inheritance patterns.
===Y-chromosomal inheritance of <person>===
Matches recorded descendants of person following Y-chromosomal inheritance patterns.
{{-}}
[[Category:Addons]]
[[Category:Plugins]]
<!--
{{man warn|1=WarningTitle/Heading |2=warning text }}</onlyinclude>
-->
