Open main menu

Gramps β

Rule expansions


Contents

Rule Ammendments

 
Changes to Rules are inconspicuous

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.
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.

 
Fig. Addons (Rules).1 Preferences: Check for Updated Addons showing Rules

Rules are the basic building blocks of custom Filters.

With the release of Gramps version 5.1, the first addon Rules were posted as examples of coding a Filter Rule addon. Installing similarly to any other addon, a New Rule appears as a menu item within Add Rule dialog while Defining a custom Filter.

Filters created with these Rules can tested, cloned or deleted using the Filter Editor. The dialog is invoked from the Edit menu in each Category view.


locating Filter Rule Add-Ons

 
Fig. Addons (Rules).2 Search for Rule in the Enhanced Plugin Manager

The Plugin Manager can be used for more than installing & updating plug-in modules. It can help you discover the growing capabilities that might not be obvious.

Open the Plugin Manager from the Help menu and use its Search box to filter the view to only those addons which have a row or filename which include the 'Rule' term.

 
Fig. Addons (Rules).3 Info on 'People related to <filter>' addon Rule

Add-on Rules that have been peer-reviewed will be added to Gramps' Update Manager system. This automates the installation process

When manually installed, each add-on rule's Python source code (.py) file and Gramps Plugin Registration (.gpr.py) file will be located in the \gramps5.1\plugins\FilterRules\ subdirectory of your User Directory

Looking at the Info on any currently installed Rule will verify the file location where add-on rules have been installed.

Add-on Rules



Multilingual internationalization services .po & .pot files using gettext.

People related to <filter>

 
Fig. Addons (Rules).4 Searching by Rule name

 Person • General filters add-on rule to find Person(s) matching a specified filter. Matches people who are related to anybody matched by a person filter.

isrelatedwithfiltermatch provided as sample .gpr.py & .py code for writing add-on filter rules. Demonstrates piping the output of one custom Filter into another.


People with events with a selected role

 
Fig. Addons (Rules).5 Searching for Person Rules which include the 'role' term.

 Person • Event filters add-on rule to find Person(s) having any Event with a specified Event Role.

Families with Events with a selected role

 
Fig. Addons (Rules).6 Searching by Rule name

 Families • Event filters add-on rule to find Families having any Family member or shared Family level Event with a specified Event Role.

hasrolerule provided as sample .gpr.py & .py code for writing add-on filter rules. Demonstrates including category variants of a rule in the same add-on.


Source matching parameters

 
Fig. Addons (Rules).7 Searching by Rule name

 Sources • General filters add-on rule to find Sources based on the following parameters: Title, Author, Abbreviation, Publication.

This add-on rule has similar options to the standard Filter Gramplet for the Source Category View. It can be used to save complex filter parameters.

hassourcefilter provided as sample .gpr.py & .py code for writing add-on filter rules. Demonstrates text based filtering with RegEx options.


People Separated less than <N> degrees of <Home person>

 
Fig. Addons (Rules).8 Searching for Person Rules which include the 'degrees' term.

 Person • Relationship filters add-on rule to find Person(s) having a relationship to the Home Person within a specified degree of Consanguinity and Affinity.

The Home person is point of reference for calculating (<N>) Degrees. For N, Minimum value is 1, Maximum is value 32.

  • Degree 1: person/spouse + children ( <zero N> ancestors, because the selected person is generation 1 + 1N descendants)
  • Degree 2: person plus person’s parents, siblings, niece/nephew, children, grandchildren, etc. (= 1N ancestors + 2N descendants)
  • Degree 3: persons grandparents and 3 generations down. (= 2N ancestors + 3N descendants).

The ancestors and descendants generations have an offset of 1 to mimic the built-in filter rule behavior.

GitHub Repository files

People Separated less than <N> degrees of <person>

 
Fig. Addons (Rules).9 Searching Person rules by 'degrees' term; roll-over hint for ID.

 Person • Relationship filters add-on rule to find Person(s) having a relationship to a specified Person within a specified degree of Consanguinity and Affinity.

GitHub Repository files

Add-on Rules needing additional documentation

 

Please update or expand this section.


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.

The Evolution of of Rules as Add-Ons

Gramps 5.1.1 (Sept. 2019)

  • Fix bug 0011114: resolve crashes in withinarea filter rule:
Avoid bad coordinates in the ref place
Avoid alphabetic characters in filter rules
Could not convert string to float by using withinarea filter rule
Difference between sidebar filter and filter rule
Fix Bug 0011293 Fix internationalization issue where untranslated English GUI items appear in Event filter

Gramps 5.1.0 (Aug. 2019)

  • New feature : Filter Rules can now be expanded through the addons interface.
  • Filter Rule editor, save pane position
  • Fix Bugs 0007950 and 0011430: Name Filter rule now supports multiple attribute: Check all values of an attribute type and not only the first one
  • filters rule have children person filter: Check all families of a person for children and not only the first
  • Person Sidebarfilter:
Fix Person Sidebarfilter when using ‘Event’ and Reg expressions
In personsidebarfilter, search on each part of name Instead of requiring that the entire search string matches a single one of the Person’s names, the function will require that each word in the search string matches any of the Person’s name fields.
  • Fix exception when merging with active sidebar filter

Gramps 5.0.2 (Aug. 2019)

  • Fix bug 0010509: resolves silent fail - relationship path between filter rule when parent is missing
  • Fix crash when using sidebar filter and merging in another view
  • Fix Place Tree view when using enclosed by sidebar filter
  • Fix Relationship Graph; extra people when using filters & subgraphs

Gramps 5.0.1 (Dec. 2018)

  • Fix bug 0010685: resolves crash in IsDuplicatedAncestorOf filter rule on tree loop
  • Fix Person Sidebarfilter when using ‘Event’ and Reg expressions
  • Fix FilterParser for much older 3.x custom_filters.xml files
  • Fix crash when a filter with loop in definition is defined
  • Fix view so column widths are preserved when using filters

Gramps 5.0.0 (Jul. 2018)

  • Fix Custom filter update when created via sidebar.

Developing New Rule Add-Ons

Beginning with version 5.0, Gramps implemented an database API (application programming interface) infrastructure supporting user selectable backends. This new exploration of database support lead developer to extend the add-on (plug-in) framework to support expanding Filter Rules via the Plugin Manager.

The 5.1 release changed the default database backend from BSDDB (Berkeley database) to SQLite. With the broader group of user familiar with optimizing searches, it made sense to open Gramps to the specialized knowledge.

Resources

See also

The Group As name override
unify similar surmanes thread
threads with "Group As name"