Changes

Jump to: navigation, search

Gramps 5.1 Wiki Manual - Filters

15,270 bytes added, 21:05, 29 December 2023
m
no edit summary
{{man index|Gramps 5.1 Wiki Manual - Settings|Gramps 5.1 Wiki Manual - FAQ|5.1}}
{{languages|Gramps_5.1_Wiki_Manual_-_Filters}}
{{#vardefine:chapter|1416}}
{{#vardefine:figure|0}}
[[File:DefineFilter-dialog-default-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} {{man label|[[Gramps_5.1_Wiki_Manual_-_Filters#Define_Filter_dialog|Define filter]]}} - dialog - default]]
Lists Filters allow Gramps to limit operations to a smaller part of all a family Tree. The filtered part of the Trees shares a certain characteristic in common. (e.g., females born in France between the years 1550 and 1575.) The filter rules currently defined in Grampsspecifies which characteristics are important and allows choosing values for which to look. Each (In the example, the Filter looks for People of these rules is available for use when creating custom filtersa particular sex who have an Event in specific Place during a small timespan. )
Database queries can be a challenge to compose without errors in syntax. So Filters provide structured and pre-tested database queries that hide most of the syntax complexity while providing some safety nets to avoid routine mistakes. Common characteristics used for filtering are normally presented as "parameter" fields in a form. Then the form composes a properly written query around the parameter. Forms with multiple parameter fields will compound complex queries.  Lists of all the filtering query rules currently defined in Gramps. Each of these rules is available for use when creating custom filters.  The rules are listed by their [[Gramps_5.1_Wiki_Manual_-_Filters#Which_filters_in_which_Category.3F|categories]].
== Filter vs. Search ==
There are two primary ways to find data in Gramps: Search and Filter.  * Search uses the topbar [[Gramps_5.1_Wiki_Manual_-_Main_Window#Search_bar|Search Bar]] above a listing View (such as People, Families, etc). <br />The [[Gramps_5.1_Wiki_Manual_-_Main_Window#Search_bar|Search Bar]] only appears when the entire sidebar is closed. You can show or hide the Gramplet bars through changing the selection of the {{man menu|View &#x27a1; &#x2611;Sidebar}} or {{man menu|View &#x27a1; &#x2611;Bottombar}} menus.* Custom Filters are selected from pop-up menus in the Filter Gramplet, export option and in some reports. They can be used in combination with Search, or stand-alone in the sidebar/bottombar Gramplets. The top bar Search only appears when Custom Filters are created or edited from the entire sidebar is closed. You can close/open the Sidebar/bottombar through filter Gramplet or {{man menu| -> ViewEdit &#x27a1; Filter Editor}}menu(There is also a basic ''seek-as-you-type'' [[Gramps_5.1_Wiki_Manual_-_Navigation#Finding_records|Find box]] for navigating the active record focus within list view and object selector lists.) 
{{man note|Name filtering behavior has [[Rule_expansions#Gramps_5.1.0_.28Aug._2019.29|changed for Gramps 5.1]]|In prior versions of Gramps, the name portion of the Filter Gramplet would try to match on any single name field (given, surname, prefix, etc) of all names (primary and alternate) but only field per name &mdash; you couldn't match the given field and surname field in the same name. You could match surname, but simultaneously matching surname and given in the same query wasn't possible. For example, if you Filter on "John", you would get matches of people with firstname "John" but also those with surname "Johnson". More complex search required use of the regular expressions pattern matching options or custom filters.<br /><br />This constraint has been removed and simultaneous search of multiple terms is now the default behavior.}}
Search and Filter work completely differently and it is useful to understand these differences:
*''Search'' - the topbar search [[Gramps_5.1_Wiki_Manual_-_Main_Window#Search_bar|Search Bar]] looks through the database as it appears in the rows and columns on the screen. The Search functionality is probably the one you want to use most of the time, as it is fast and most straightforward. But speed and simplicity imposes some limitations (see below).:For example, if you have the Name Display in Preferences set to show "Surname, Given" then you can match names such as "Smith, J" and all of the correct rows will match. If you change the way that names are displayed (in Preferences) then you can match that format (for example, "John Smith"). The Search functionality is probably the one you want to use most of the time, as it is most straightforward, but has some limitations (see below).
[[File:MainWindow-SearchBar-annotated-sidebar-hidden-example-50.png|450px|thumb|right|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramps Main Window showing [[Gramps_5.1_Wiki_Manual_-_Main_Window#Search_bar|Search Bar]]]]
*''Filter'' - Filters use a more complex elaborate system. It is not limited to what you see on the screen, but looks at the actual datain all name fields, rather than just what is showing in the View. The name Filter will try to match Entering multiple words does phrase matching for most text fields. However, the Name filter line is far more powerful. Each word in the Name search is handled separately as though it was a sub-search on any single name field (given, surname, prefix, etc) of the records found with the previous search word. And it simultaneously searches '''''all names (primary and alternate) but only field per name---you can't match '''' the given field and surname field in the same Name fields. :e.g. a namesearch of "geo&nbsp;r. You can match surname, but not surname and given " in the same name[[Example. For gramps|example, if you Filter on "John", you will get matches of tree]] database finds 5 people : with firstname a variety 'Jr.' & 'Sr.' as the suffix and 'George's as first & middle names. Or searching "Johngarn&nbsp;ski&nbsp;ph" but also those with finds Phoebe Emily who has a birth surname "Johnson". You just can't filter on combinations of first Zieliński and lastnamesalternate married surname of Garner.
[[File:Sidebar-PeopleTreeView-Filter-TagDropDownList-example-50.png|450px|thumb|right|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramps Filter SideBar for People view - [[Gramps_Glossary#tag|Tag list ]] pop-up menu example]]
Filters can be created and controlled from the menu {{man menu| Edit -> &#x27a1; Filter Editor}}, or from a special sidebar/bottombar Gramplet. The Filter Gramplets allow for some quick filters that are similar to the topbar [[Gramps_5.1_Wiki_Manual_-_Main_Window#Search_bar|SearchBar]], but all Filters follow the distinction outlined here.
Some additional points:
* The Filter will search alternative & multiple names too; the [[Gramps_5.1_Wiki_Manual_-_Main_Window#Search_bar|Search Bar]] only looks in the primary name (... the one showing)in the People view. That is why if you do doing a Filter on "Smith" you might see list people listed that superficially don't appear to match. But if you edit drill down into that person's detailswith the [[Gramps_5.1_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_3#Name_Editor|Name Editor]], you might see that they have an alternate name containing "smith".* The Filter allows "regular expressions". So you can find all of the names that start with "B" and end in "ship": "B.*ship". You can't do that with the top bar [[Gramps_5.1_Wiki_Manual_-_Main_Window#Search_bar|SearchBar]].* The Search will only match what is visible. If a name or text is too big to see in listing below topbar[[Gramps_5.1_Wiki_Manual_-_Main_Window#Search_bar|Search Bar]], then you won't find it. This is something to keep in mind when Searching through Notes. Best to use Filter for notes and other long text fields.* All Filters default to use case-insensitive matching; "Ship" will match "ship", "SHIP", or "ShIp". As explained below under Regular Expressions, using Regular Expressions does not currently give a means of changing from the default.
You can find more details about making === See also ===* [[Gramps_Glossary#filter|Filter]] - a definition* [[Gramps_5.1_Wiki_Manual_-_Filters|Filters introduction]] in the Gramps Manual* [[Gramps_5.1_Wiki_Manual_-_Filters#Which_filters_in_which_Category.3F|Which filters in which Category?]]* [[Filter|Filter]]* [[Example filters]]- Multi-stage filters* [[Gramps_Glossary#rule|Rules]] - a definition* [[5.1 Addons#Addon_List|Addon list - Rules]]* [[Rule expansions|Expanding the Filter rulebook]] with Addons* [[:Category:Filters|Category: Filters]]* [[Template:Backup Omissions|Custom Filter migration]] - backing up a Gramps Tree does not include any filter customizations
{{-}}
== Regular Expressions ==
[https://en.wikipedia.org/wiki/Regular_expression Regular Expressions](aka ''regex'', ''regexp'', or sometimes ''rational expression'') are a quick condensed, precise and powerful way to describe text that matches a pattern .  Designing a effective search pattern can be formulaic. Like math formulas, a search pattern can be quickly composed which finds a subset of records but does so very crudely and we use these slowly. Elegant and efficient RegEx phrases are collected by optimization experts in data manipulations. There are many resources (books, websites, professional training) for RegEx design and strategy.  Gramps uses RegEx as a matching option that may be enabled for Custom Filtersand in the Filter Gramplets of each Category view. You must have the:* RegEx pattern matching is an advanced feature and so its checkbox is not selected by default. For Custom Filters, each individual Rule has a {{checkbox|1}}{{man label|Use regular expressions}} option check box checkedin its Edit Rule dialog. The Filter Gramplets also have {{checkbox|1}}{{man label|Use regular expressions}} option check boxes to allow regexp expression to be used directly for matching strings in their text boxes.
For example, if you were looking for a surname that started with a "B", and ended with "ship" then you could use regular expressions to describe that pattern. That would be '''<code>^B.*ship</code>''':
* The '''<code>ship</code>''' matches the exact letters s, h, i, p in that order.
Regular expressions are quite powerful, and there are many options. We use the [https://docs.python.org/3/library/re.html Python Regular Expression ] system, and we will document that here. In addition, you can use any Python Regular Expression resource. Gramps is currently implemented to make all string matching case-insensitive (which is the opposite of the usual default in Python). There is no easy way at present to override this behaviour for the relatively uncommon purpose of matching strings that have been entered into the database in a particular case format. Regular expressions in Gramps currently give identical results regardless of whether the target string is entered in upper case, title case, lower case or some mixture.
''whitespace'' - The term "whitespace" is used below to mean one or more character that you don't see. For example, whitespace includes tabs, spaces, and newlines.
There are some characters that have special meaning with regular expressions. They are:
* '''<code>. ^ $ * + ? { } [ ] \ | ( )</code>'''<br/>decimal point (full stop), caret, dollar sign, asterisk, plus sign, question mark, left and right curly braces, left and right square brackets, backslash, vertical bar (pipe), left and right parentheses 
They can be used as described:
The most complicated repeated qualifier is <code>{m,n}</code>, where <code>m</code> and <code>n</code> are decimal integers. This qualifier means there must be at least <code>m</code> repetitions, and at most <code>n</code>.
 
=== Find all defined values or blanks ===
<span id="regex_all">To find all values, <code>(.|\s)*</code> will match: any character or any whitespace character; and zero or more repetitions of those.</span>
 
<span id="regex_null">To find empty (blank or null) strings, <code>^.{0}$</code> looks from the start of the match <code>^</code> for any character (except newline) <code>.</code> occurring precisely zero times <code>{0}</code> before the end of the match <code>$</code></span>
=== Groups and Sets ===
====Testing regular expressions====
Regular Expression testers can be found online through Google. httphttps://www.regexr.com/ is simple and convenient {{Man warn|Regular Expression 'dialect' noted and Repaired|In Gramps 5.1, the sidebar filter inappropriately evaluated parameters containing spaces... attempting to re-interpret a single Regular Expression as a sequence of separate expressions. The Gramps 5.1.1 resolution for Bug {{Bug|0011321}} handles Regular Expressions more literally.}} === See Also ===Regular expressions have been in wide use across the computer industry since the 1950s. But they are "expert tools" designed for power and efficiency rather than intuitiveness. As a result, many resources have been developed on the web.  Some of these resources have excellent tutorials. Some have cheat sheets. Some have “sand boxes” where regular expressions can be explored in real-time. A sampling of RegEx reference websites:* [http://rexegg.com/ rexegg.com] (tutorials) * [https://www.regular-expressions.info/ RegexBuddy] * [https://regex101.com/ regex101.com] (sandbox with feedback)
==Custom Filters==
{{man warntip|Custom rules Filter migration|To avoid unwanted effects after Keep your collection of custom filters through a major upgrades minor updates of Gramps (ege.g., from version 35.20.x to 5.1.x), if required, you can by manually copy copying your ''custom_filter.xml'' from [[Gramps User Directory]] to the corresponding directory in new ''gramps_version_number''. <br /><br />Even minor upgrades (e.g., from a 5.0.x to a 5.1.x version) may include format changes since the recent innovation of addon rules are causing rapid evolution in Filters. So porting filters in this manner requires verification that the XML definitions haven't changed. Also, Addon rules may have to be installed in the new upgrade before copied custom filters will work safely.}}
You can carry out a considerable amount of selection of persons, events, places, etc., just using the Filter Sidebar in Person, Event, Place,etc. Views; but note, however, that the 'Use regular expressions' option '''only works with particular fields''' in each View.
If the Filter Sidebar is inadequate for your purpose, you will need to build custom filters.
{{man tip|Building a quick Custom Filter for an object|The clipboard has a Custom Filter generation shortcut. Copy any View object to the Clipboard (by drag'n'drop or by selecting and pressing the {{man key press|Ctrl|C}} [[Gramps_5.1_Wiki_Manual_-_Keybindings|keybinding]]), then select the object on the Clipboard and right-click to reveal the [[Gramps_5.1_Wiki_Manual_-_Navigation#Clipboard_context_menu|Clipboard's contextual pop-up menu]]. The bottom menu item will offer to create a Filter for the selected object.}}
===CategoryName Filters dialog===
To create new or show previously created custom filters use the {{man label|''CategoryName'' Filters}} dialog list where the ''CategoryName'' changes based on the category you are in eg:
* {{icon|peop}}&nbsp;Person Filters* {{icon|fami}}&nbsp;Family Filters* {{icon|even}}&nbsp;Event Filters* {{icon|plac}}&nbsp;Place Filters* {{icon|sour34}}&nbsp;Source Filters* Media {{icon|cite}}&nbsp;Citation Filters* {{icon|repo}}&nbsp;Repository Filters* Note {{icon|medi}}&nbsp;Media Filters* Citation {{icon|note}}&nbsp;Note Filters
When in the {{man label|''CategoryName'' Filters}} dialog you have the following options from the right hand side icons:
* {{man button|+ ({{icon|stock_add}}}}&nbsp;{{man tooltip|Add another rule to a new filter)}} button to show :shows the {{man label|Define filter}} dialog add your and adds a new (as yet unnamed) custom filterframework.* {{man button| {{icon|stock_edit}}}}&nbsp;{{man tooltip|Edit the selected filter}} button to show :opens the {{man label|Define filter}} dialog and edit loads your existing custom filterfor editing.* {{man button|Clone}}&nbsp;{{man tooltip|Clone the selected filter}} :makes an exact copy of the selected filter.* {{man button|Test}}&nbsp;{{man tooltip|Test the selected filter}} when selected :brings up the {{man label|Filter Test}} results dialog results containing a listof matches following a successful test. If the filter test is invalid, that may or an error may not show results from your custom filterbe shown instead.* {{man button| {{icon|stock_remove}}}}&nbsp;{{man tooltip|Delete the selected filter}}::removes the selected filter from the Gramps collection of custom filters.
{{-}}
====Filter Test dialog====
[[File:FilterTest-results-for-TestTheSelectedFilter-button-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Filter Test - results list example from Person Filters]]
The results list of a successful {{man label|Filter Test}} dialog results listmight be empty, may or may not show results from your a valid custom filtermight not match any records.
{{-}}
===Define Filter dialog===
{{man tip|Addon Rules for custom filters are available|Filter Rules can be expanded through the addons interface starting with the Gramps 5.1.0 version.<br />''See: '''[[Example filters]]''' and '''[[Rule_expansions|Addon Rules]]'''''}}
[[File:DefineFilter-dialog-default-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Define filter - dialog - default]]
In the '''Definition''' section type the {{man label|Name:}} for your new filter and add a {{man label|Comment:}} that would help you identify this filter in the future. Add as many rules to the {{man label|Rule list}} as you would like to your filter using {{man button|+}} button.
<span ID="multiple_rule_options">If the filter has more than one rule, select one of the {{man label|Options}} from the drop down list which allows you to choose whether
* '''All rules must apply'''(default)
* At least one rule must apply
in order for the filter to generate a match. If your filter has only one rule, this selection has no effect.
*Select {{checkbox|0}} {{man label|Return values that do not match the filter rules}} to invert the filter rule. For example, inverting '''"has a common ancestor with I1"''' rule will match everyone who does not have a common ancestor with that person). (Check box unchecked by default)</span>
{{-}}
===Add Rule dialog===
{{man tip| A filter you have already designed may be used as a rule parameter for another filter.|This gives you nearly infinite flexibility in custom-tailoring your selection criteria that can be later used in most of the exports, reports, and some of the tools (such as comparing individual events).<br/>''See: '''[[Example filters]]''' and '''[[Rule_expansions|Addon Rules]]'''''}}
[[File:AddRule-selector-dialog-PersonFilters-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Add Rule - selector dialog - available for Person filters - example]]
The pane on the left-hand side displays available filter rules arranged by their categories in an expandable tree.
For detailed filter rule reference.you can either, use the search box to find the rule, or:* Click on the {{man button|&#x25B6;}} arrows to fold/unfold the appropriate category.
* Select the rule from the tree by clicking on its name. The right-hand side displays the name, the description, and the values for the currently selected rule.
{{man tip|Finding a rule|It can be hard to remember which filter grouping contains a rule. And, since the "[[Rule_expansions|addon rule]]" is a recent innovation, there can be too many rules to peruse easily. So you can narrow down the rule list -- based on keywords from the rule titles.<br /><br />Type a keyword by using the search box (box with the magnifying glass) and only the groupings with matches will be expanded.}}
Once you are satisfied with your rule selection and its values, click {{man button|OK}} to add this rule to the rule list of the currently edited filter. Clicking {{man button|Cancel}} will abort adding the rule to the filter.
{{-}}
<span id== "Which filters in which Category? ==">
Depending on the used [[Gramps_5.1_Wiki_Manual_-_Categories|== Which filter rules in which Category]], you will get a different set of [[Gramps_5.1_Wiki_Manual_-_Gramplets#Filter|filters]]. Also see [[Gramps_5.1_Wiki_Manual_-_Gramplets#Summary_of_Gramplets|Summary of Gramplets]].? ==
*; Dashboard Depending on the used [[Gramps_5.1_Wiki_Manual_-_Categories|Category: no filters available]], you will get a different set of [[Gramps_5.1_Wiki_Manual_-_Gramplets#Filter|filter]] rules. Also see [[Gramps_5.1_Wiki_Manual_-_Gramplets#Summary_of_Gramplets|Summary of Gramplets]].
*; People, Relationships and Charts Dashboard Category: [[#Ancestral_filters|Ancestral filters]], [[#Citation/source filters|Citation/source filters]], [[#Descendant_filters|Descendant filters]], [[#Event_filters|Event filters]], [[#Family_filters|Family filters]], [[#General_filters|General filters]], and [[#Relationship filters|Relationship Filters]].no filter rules available
*; Families People, Relationships and Charts Category: rules for [[#Child filtersAncestral_filters|Child Ancestral filters]], [[#Citation/source filters|Citation/source filters]], [[#Descendant_filters|Descendant filters]], [[#Event_filters|Event filters]], [[#Father filtersFamily_filters|Father Family filters]], [[#General_filters|General filters]], and [[#Mother Relationship filters|Mother filtersRelationship Filters]].
*; Events, and Media Families Category: rules for [[#Child filters|Child filters]], [[#Citation/source filters|Citation/source filters]], and [[#Event_filters|Event filters]], [[#Father filters|Father filters]], [[#General_filters|General filters]]. , and [[#Mother filters|Mother filters]]
*; Places Events, and Media Category: rules for [[#Citation/source filters|Citation/source filters]], and [[#General_filters|General filters]], and [[#Position filters|Position filters]].
*; Geography Places Category (Only from the filter sidebar/bottombar): [[#Ancestral_filters|Ancestral filters]], rules for [[#Citation/source filters|Citation/source filters]], [[#Descendant_filters|Descendant filters]], [[#Event_filters|Event filters]], [[#Family_filters|Family filters]], [[#General_filters|General filters]], and [[#Relationship Position filters|Relationship FiltersPosition filters]].
*; SourcesGeography Category (Only from the filter sidebar/bottombar): rules for [[#Ancestral_filters|Ancestral filters]], Repositories[[#Citation/source filters|Citation/source filters]], [[#Descendant_filters|Descendant filters]], [[#Event_filters|Event filters]], [[#Family_filters|Family filters]], and Notes Category: only [[#General_filters|General filters]] available, and [[#Relationship filters|Relationship Filters]].
*; Sources, Repositories, and Notes Category: rules for only [[#General_filters|General filters]] available *; Citations Category: rules for [[#General_filters|General filters]], and [[#Source filters|Source filters]]
== Ancestral filters ==
This rule category includes the following rules that match people based on their ancestral relations to other people: ===Ancestor of <filter> match===This rule matches people who are ancestors of someone who is matched by the specified filter. The specified filter name should be selected from the menu. ===Ancestor of <person>===This rule matches people who are ancestors of the specified person. The Inclusive option determines whether the specified person should be considered his/her own ancestor (useful for building reports). You can either enter the ID into a text entry field, or select a person from the list by clicking {{man button|Select...}} button. In the latter case, the ID will appear in the text field after the selection was made. ===Ancestor of <person> at least <N> generations away===This rule matches people who are ancestors of the specified person and are at least N generations away from that person in their lineage. For example, using this rule with the value of 2 for the number of generations will match grandparents, great-grandparents, etc., but not the parents of the specified person. ===Ancestor of <person> not more than <N> generations away===This rule matches people who are ancestors of the specified person and are no more than N generations away from that person in their lineage. For example, using this rule with the value of 2 for the number of generations will match parents and grandparents, but not great-grandparents, etc., of the specified person. ===Ancestor of bookmarked people not more than <N> generations away===
*;Ancestor of <filter> match: This rule matches people who are ancestors of someone who is matched by the specified filter. The specified filter name should be selected from the menu.
*;===Ancestor of the default person not more than <personN>: This rule matches people who are ancestors of the specified person. The Inclusive option determines whether the specified person should be considered his/her own ancestor (useful for building reports). You can either enter the ID into a text entry field, or select a person from the list by clicking {{man button|Select...}} button. In the latter case, the ID will appear in the text field after the selection was made.generations away===
*;Ancestor of <person> at least <N> generations away: This rule matches people who are ancestors of The ”default person” is the specified person and are at least N generations away from individual that person in their lineage. For example, using this rule with the value of 2 for has been defined as the number of generations will match grandparents, great-grandparents, etc”Home Person”., but not (The ”default” is a legacy term in Gramps that caused minor confusion she nice the parents word is used in so many different parts of the specified personwiki to describe different things.)
*;Ancestor of <person> not more than <N> generations away: This rule matches people who are ancestors of the specified person and are no more than N generations away from that person in their lineage. For example, using this rule with the value of 2 for the number of generations will match parents and grandparents, but not great-grandparents, etc., of the specified person.
*;===Duplicate ancestors of <person>: ===Matches people that are ancestors twice or more of a specified person
*;===People with a common ancestor with <filter> match: ===This rule matches people who have common ancestors with someone who is matched by the specified filter. The specified filter name should be selected from the menu.
*;===People with a common ancestor with <person>: ===This rule matches people who have common ancestors with the specified person.
== Child filters ==
*;This rule category finds families having children that match the rule: ===Families having child with id containing <text>: ===Matches families where child has a specified Gramps ID
*;===Families with child with the <name>: ===Matches families where child has a specified (partial) name
*;===Families with twins: ===Matches families with twinstwo (or more) children having a [[Gramps_5.1_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_1#Child_Reference_Editor|'Birth' role for the Relationship to the Mother]] and the same birthdate.
== Citation/source filters ==
These filters filter rules are view dependent
* [[#People-.2C_and_Relationships_Category|People-, and Relationships Category]]* [[#Families_Category|Families Category]]* [[#Events_Category|Events Category]]* [[#Places_Category|Places Category]]* [[#Media_Category|Media Category]] === PersonsPeople-, and Relationship Relationships Category===
This category includes the following citation and source rules:
*;====People with <count> source: ====Matches people with a certain number of items in the source. Values: Number of instances -- Number must be greater than/lesser/equal to
*;====People with the <citation>: ====Matches people with a citation of a particular value
*;====People with the <source>: ====Matches people who have a particular source. values: Source ID ====Person with at least one direct source >= <confidence level>====
*;Person with at least one direct source >= <confidence level>:
=== Families Category===
This category includes the following citation and source rules:
*;====Families with <count> source: sources====Matches families with a certain number of items in the source. Values: Number of instances -- Number must be greater than/lesser/equal to
*;====Families with at least one direct source >= <confidence level>: ====Matches families with at least one direct source with confidence level(s)
*;====Families with the <citation>: ====Matches families with a citation of a particular value
*;====Families with the <source>: ====Matches families who have a particular source. values: Source ID
=== Events Category===
This category includes the following citation and source rules:
*;====Events with <count> source: ====Matches events with a certain number of items in the source. Values: Number of instances -- Number must be greater than/lesser/equal to
*;====Events with at least one direct source >= <confidence level>: ====Matches events with at least one direct source with confidence level(s)
*;====Events with source matching the <source filter>:====
*;====Events with the <citation>: ====Matches events with a citation of a particular value
=== Places Category===
This category includes the following citation and source rules:
*;Places ====Place with <count> source: sources====Matches places with a certain number of items in the source. Values: Number of instances -- Number must be greater than/lesser/equal to
*;Places ====Place with a direct source >= <confidence level>: ====Matches places with at least one direct source with confidence level(s)
*;Places ====Place with the <citation>: ====Matches places with a citation of a particular value
*;====Places with the <source>: ====Matches places who have a particular source. values: Source ID
=== Media Category===
This category includes the following citation and source rules:
*;====Media with <count> source: sources====Matches media with a certain number of items in the source. Values: Number of instances -- Number must be greater than/lesser/equal to
*;====Media with a direct source >= <confidence level>: ====Matches media with at least one direct source with confidence level(s)
*;====Media with the <citation>: ====Matches media with a citation of a particular value
*;====Media with the <source>: ====Matches media who have a particular source. values: Source ID
== Descendant filters ==
This descendant filters category includes include the following rules that match people based on their descendant relations to other people:
*;===Descendant family member of <filter> match:===Matches people that are descendants or the spouse of anybody matched by a filter
*;===Descendant family member of <person>: ===This rule not only matches people who are descendants of the specified person, but also those descendants' spouses.
*;===Descendant of <filter> match: ===This rule matches people who are descendants of someone who is matched by the specified filter. The specified filter name should be selected from the menu.
*;===Descendant of <person>: ===This rule matches people who are descendants of the specified person. The Inclusive option determines whether the specified person should be considered his/her own descendant (useful for building reports). You can either enter the ID into a text entry field, or select a person from the list by clicking {{man button| Select...}} button. In the latter case, the ID will appear in the text field after the selection was made.
*;===Descendant of <person> at least <N> generations away: ===This rule matches people who are descendants of the specified person and are at least N generations away from that person in their lineage. For example, using this rule with the value of 2 for the number of generations will match grandchildren, great-grandchildren, etc., but not the children of the specified person.
*;===Descendant of <person> not more than <N> generations away: ===This rule matches people who are descendants of the specified person and are no more than N generations away from that person in their lineage. For example, using this rule with the value of 2 for the number of generations will match children and grandchildren, but not great-grandchildren, etc., of the specified person.
== Event filters ==
These filters filter rules are view dependent* [[#People-.2C_and_Relationships_Category_2|People-, and Relationships Category]]* [[#Families_Category_2|Families Category]]
=== PersonsPeople-, and Relationship Relationships Category===
This category includes the following rules that match people based on their recorded events:
*;====Families with incomplete events: ====This rule matches people missing date or place in any family event of any of their families. ====People with incomplete events====This rule matches people missing date or place in any personal event.
*;====People with incomplete events: the <birth data>====This rule matches people missing date or place whose birth event matches specified values for Date, Place, and Description. The rule returns a match even if the person's birth event matches the value partially. The matching rules are case-insensitive. For example, anyone born in any personal eventSweden will be matched by the rule using the value "sw" for the Place. The rule returns a match if, and only if, all non-empty values are (partially) matched by a person's birth. To use just one value, leave the other values empty.
*;====People with the <birth death data>: ====This rule matches people whose birth death event matches specified values for Date, Place, and Description. The rule returns a match even if the person's birth death event matches the value partially. The matching rules are case-insensitive. For example, anyone born who died in Sweden will be matched by the rule using the value "sw" for the Place. The rule returns a match if, and only if, all non-empty values are (partially) matched by a person's birthdeath. To use just one value, leave the other values empty.
*;====People with the family <death dataevent>: ====This rule matches people whose death that have a family event matches matching specified values for the Event type, Date, Place, and Description. The rule returns a match even if the person's death event matches the value partially. The matching rules are case-insensitive. For example, anyone who died was married in Sweden will be matched by the rule using the Marriage event and the value "sw" for the Place. The family events should be selected from a pull-down menu. The rule returns a match if, and only if, all non-empty values are (partially) matched by a person's deaththe personal event. To use just one value, leave the other values empty.
*;====People with the family personal <event>: ====This rule matches people that have a family personal event matching specified values for the Event type, Date, Place, and Description. The rule returns a match even if the person's event matches the value partially. The matching rules are case-insensitive. For example, anyone who was married graduated in Sweden will be matched by the rule using the Marriage Graduation event and the value "sw" for the Place. The family personal events should be selected from a pull-down menu. The rule returns a match if, and only if, all non-empty values are (partially) matched by the personal event. To use just one value, leave the other values empty.
*;People ====Persons with events matching the personal <eventfilter>: This rule matches people ====Matches persons who have events that have a personal event matching specified values for the Event type, Date, Place, and Description. The rule returns a match even if the person's event matches the value partially. The matching rules are case-insensitive. For example, anyone who graduated in Sweden will be matched by the rule using the Graduation event and the value "sw" for the Place. The personal events should be selected from a pull-down menu. The rule returns a match if, and only if, all non-empty values are (partially) matched by the personal certain eventfilter. To use just one value, leave the other values emptyValues: Event filter name.
*;Witness: ====Witnesses====This rule matches people who are present as a witness in the event. If the personal or family event type is specified, only the events of this type will be searched.
=== Families Category===
This category includes the following rules that match families based on their recorded events:
*;====Families with the <event>: ====This rule matches famikies families that have a event matching specified values for the Event type, Date, Place, and Description. The rule returns a match even if the person's event matches the value partially. The matching rules are case-insensitive. For example, anyone who was married in Sweden will be matched by the rule using the Marriage event and the value "sw" for the Place. The family events should be selected from a pull-down menu. The rule returns a match if, and only if, all non-empty values are (partially) matched by the personal event. To use just one value, leave the other values empty.
== Family filters ==
This category includes the following rules that match people based on their family relationships:
*;===Adopted people: ===This rule matches adopted people.
*;Child ===Children of <filter> match: ===This rule matches people for whom either parent is matched by the specified filter. The specified filter name should be selected from the menu.
*;===Parents of <filter> match: ===This rule matches people whose child is matched by the specified filter. The specified filter name should be selected from the menu.
*;===People missing parents: ===Matches people that are children in a family with less than two parents or are not children in any family.
*;===People with children: ===This rule matches people with children.
*;===People with multiple marriage records: ===This rule matches people with more than one spouse.
*;===People with no marriage records: ===This rule matches people with no spouses.
*;===People with the <relationships>: ===This rule matches people with a particular relationship. The relationship must match the type selected from the menu. Optionally, the number of relationships and the number of children can be specified. The rule returns a match if, and only if, all non-empty values are (partially) matched by a person's relationship. To use just one value, leave the other values empty.
*;===Siblings of <filter> match: ===This rule matches people whose sibling is matched by the specified filter. The specified filter name should be selected from the menu.
*;===Spouses of <filter> match: ===This rule matches people married to someone who is matched by the specified filter. The specified filter name should be selected from the menu.
== Father filters ==
*;This rule category finds families having fathers that match the rule: ===Families having father with id Id containing <text>: ===Matches families whose father has a specified Gramps ID
*;===Families with father with the <name>: ===Matches families whose father has a specified (partial) name
== General filters ==
These filters filter rules are view dependent* [[#People-.2C_and_Relationships_Category_3|People-, and Relationships Category]]* [[#Families_Category_3|Families Category]]* [[#Events_Category_2|Events Category]]* [[#Places_Category_2|Places Category]]* [[#Sources_Category|Sources Category]]* [[#Citations_Category|Citations Category]]* [[#Repositories_Category|Repositories Category]]* [[#Media_Category_2|Media Category]]* [[#Notes_Category|Notes Category]]
=== PersonsPeople-, and Relationship Relationships Category===
This category includes the following general rules:
*;====Bookmarked people: ====Matches the people on the bookmark list. <span id="Default person">====Home person====</span>Matches the [[Gramps_Glossary#home_person|Home Person]]. ====Disconnected People====Matches people that have no family relationships to any other person in the database. ====Everyone====Matches everyone in the family tree database. ====Females====Matches all females. ====Males====Matches all males. ====People having <count> notes====Matches people having a certain number of notes: Values: Number of instances -- Number must be greater than/lesser/equal to
*;Default person: ====People having notes containing <text>====Matches the default person.people whose notes contain text matching a regular expression
*;Disconnected ====People: marked private====Matches people that have no family relationships to any other person in the databaseare indicated as private.
*;Everyone====People matching the <filter>====Matches people matched by the specified filter name. Values: Matches everyone in Filter name. The specified filter name should be selected from the databasemenu.
*;Females: ====People not marked private====Matches all females.people that are not indicated as private
*;Males: ====People probably alive====Matches all malespeople without indications of death that are not too old.Values: On Date<!-- link to page on how Gramps calculates this-->
*;People having <count> notes: Matches people having a certain number of notes: Values: Number of instances [[Gramps_5.1_Wiki_Manual_-- Number must be greater than/lesser/equal to _Probably_Alive#Probably_Alive_Filter|Probably Alive Filter]]
*;====People having notes containing with <textcount>: LDS events====Matches people whose notes contain text matching with a regular expressioncertain number of LDS events. Values: Number of instances -- Number must be greater than/lesser/equal to
*;====People marked private: with <count> addresses====Matches people that are indicated as privatewith a certain number of personal addresses.Values: Number of instances -- Number must be greater than/lesser/equal to
*;====People matching the with <filtercount>: associations====Matches people matched by the specified filter namewith a certain number of associations. Values: Filter name. The specified filter name should Number of instances -- Number must be selected from the menu.greater than/lesser/equal to
*;====People not marked private: with <count> media====Matches people that are not indicated as privatewith a certain number of items in the gallery. Values: Number of instances -- Number must be greater than/lesser/equal to
*;====People probably alive: with id containing <text>====Matches people without indications of death that are not too old. Values: On Datewhose Gramps ID matches the regular expression
*;====People with <count> LDS events: a nickname====Matches people with a certain number of LDS events. Values: Number of instances -- Number must be greater than/lesser/equal to nickname
*;====People with <count> addresses: an alternate name====Matches people with a certain number of personal addresses. Values: Number of instances -- Number must be greater than/lesser/equal to an alternate name
*;====People with <count> associations: incomplete names====Matches people with a certain number of associations. Values: Number of instances first-name or last- Number must be greater than/lesser/equal to name missing.
*;====People with records containing <countsubstring> media: ====Matches people with whose records contain text matching a certain number of items in the gallerysubstring. Values: Number of instances Substring -- Case Sensitive or not --Regular- Number must be greater than/lesser/equal to Expression matching or not
*;====People with id containing the <textName type>: ====Matches people whose Gramps ID matches the regular expressionwith a type of name
*;====People with a nickname: the <Surname origin type>====Matches people with a nicknamesurname origin
*;====People with an alternate the <name: >====Matches people with an alternate a specified (partial) name. Values: Given Name -- Family Name -- Suffix -- Title -- Prefix -- Patronymic -- Call Name
*;====People with incomplete names: <tag>====Matches people with first-name or last-a tag of a particular value. Values: Tag name missing.
*;====People with records containing the family <substringattribute>: ====Matches people whose records contain text with the family attribute of a particular value. Use RegEx pattern matching a substringto search for [[Gramps_5. Values: Substring -1_Wiki_Manual_- Case Sensitive _Filters#regex_all|all values]] or not attributes that have been [[Gramps_5.1_Wiki_Manual_-_Filters#regex_null|left blank]]. Values: Family Attribute: Identification Number - Regular-Expression matching or notAge ...
*;====People with the personal <Name typeattribute>: ====Matches people with the personal attribute of a type of nameparticular value. Use RegEx pattern matching to search for [[Gramps_5.1_Wiki_Manual_-_Filters#regex_all|all values]] or attributes that have been [[Gramps_5.1_Wiki_Manual_-_Filters#regex_null|left blank]]. Values: Personal Attribute: Identification Number -- Age ...
*;====People with the <Surname origin type>: unknown gender====Matches all people with a surname originunknown gender.
*;====People with without a known birth date====This General filter in the <name>: Matches People category will matches people with without a specified (partial) nameknown birth date. Values: Given Name -- Family Name -- Suffix -- Title -- Prefix -- Patronymic -- Call Name
*;People This rule includes both Persons without any birth-type event and Persons with <tag>: Matches people with a tag of a particular value. Values: Tag nameundated Birth-type events.
*;====People with the family <attribute>: without a known death date====Matches people with the family attribute of without a particular value. Values: Family Attribute: Identification Number -- Age ..known death date.
*;====People with the personal <attributeid>: ====Matches people with Gramps ID. The rule returns a match only if the ID is matched exactly. You can either enter the personal attribute of ID into a particular valuetext entry field, or select an object from the list by clicking {{man button|Select. Values: Family Attribute: Identification Number -- Age ..}} button. In the latter case, the ID will appear in the text field after the selection was made.
*;====People with unknown gender: changed after <date time>====Matches all people with unknown genderperson records changed during a particular time period.Used to identify records that were imported or modified during particular work-sessions.
*;People without Filtering based on specified date and timestamp being after a particular timestamp in the format <code>yyyy-mm-dd hh:mm:ss</code>. This filter rules will look for records modified within a known birth date: Matches people without range, if a known birth second date-time is given.
*;People without a known death dateValues: Changed after: but before: Matches people without a known death date.
*;People with Values must be after January 1st, 1970 at UTC. Future dates until <idcode>3001-01-01 01:59: Matches people with Gramps ID. The rule returns a match only if the ID is matched exactly. You can either enter the ID into a text entry field, or select an object from the list by clicking {{man button|Select...}} button. In the latter case, the ID will appear in the text field after the selection was made59</code> are valid.
*;The {{man menu|People changed after <date time>: Matches person records changed after a specified date-time (yyy-mm-dd hh:mm:ss) or }} filter rules are available in the {{man menu|General filters}} section for custom rules in the rangePeople, Relationships, Charts, if a second date-time is given: Values: Changed after: -- but before:and Geography views.
*;Persons Equivalent rules exist for records of the corresponding category type in People, Families, Events, Places, Sources, Citations, Repositories, Media, and Notes category views. ====Soundex match of People with events matching the <event filtername>====Soundex Match of people with a specified name. First name, Surname, Call name, and Nickname are searched in primary and alternate names.  This rule compares names of People against a phonetic pattern. It uses the [[Gramps_5.1_Wiki_Manual_-_Gramplets#Soundex_what_is_this.3F|Soundex]] phonetic algorithm for indexing names by sound, as pronounced in English. Match criteria can be a Soundex code (which can be found with the Soundex Gramplet) consisting of of a letter followed by three numerical digits: Matches persons who have events that the letter is the first letter of the name, and the digits encode the remaining consonants. But if the match criteria is not a certain event valid Soundex code, the filterwill simply generate Soundex code for the word entered. Values: Event filter  All namefields (and the separate words within those fields) are searched individually against the Soundex code.
=== Families Category===
This category includes the following general rules:
*;Bookmarked ====Ancestor families: Matches the families on the bookmark list.of <family>====
*;Every family: Matches every family in the database.
*;Families changed after <date time>: ====Bookmarked families====Matches the families records changed after a specified date-time (yyy-mm-dd hh:mm:ss) or in on the range, if a second date-time is given: Values: Changed after: -- but before:bookmark list.
*;Families having ====Descendant families of <countfamily> notes: Matches families having a certain number of notes: Values: Number of instances -- Number must be greater than/lesser/equal to ====
*;Families having notes containing <text>: Matches families whose notes contain text matching a regular expression
*;Families marked private: ====Every family====Matches families that are indicated as privateevery family in the database.
*;====Families matching the changed after <filterdate time>: ====Matches families matched by records changed after a specified date-time (yyy-mm-dd hh:mm:ss) or in the specified filter name. range, if a second date-time is given: Values: Filter name. The specified filter name should be selected from the menuChanged after: -- but before:.
*;====Families with having <count> LDS events: notes====Matches families with having a certain number of LDS events. notes: Values: Number of instances -- Number must be greater than/lesser/equal to
*;====Families with having notes containing <counttext> media: ====Matches families with whose notes contain text matching a certain number of items in the gallery. Values: Number of instances -- Number must be greater than/lesser/equal to regular expression
*;====Families with id containing <text>: marked private====Matches families whose Gramps ID matches the regular expressionthat are indicated as private.
*;====Families with a reference count of matching the <countfilter>: ====Matches families with a certain number of referencesmatched by the specified filter name. Values: Number of references -- Number must Filter name. The specified filter name should be greater than/lesser/equal to selected from the menu.
*;====Families with the <tagcount>: LDS events====Matches families with a tag certain number of a particular valueLDS events. Values: Tag name.Number of instances -- Number must be greater than/lesser/equal to
*;====Families with the family <attributecount>: media====Matches families with a certain number of items in the family attribute of a particular valuegallery. Values: Family Attribute: Identification Number of instances -- Age ...Number must be greater than/lesser/equal to
*;====Families with the relationship type: id containing <text>====Matches families with whose Gramps ID matches the relationship type of a particular valueregular expression
*;====Families with a reference count of <count>====Matches families with a certain number of references. Values: Number of references -- Number must be greater than/lesser/equal to  ====Families with the <tag>====Matches families with a tag of a particular value. Values: Tag name. ====Families with the family <attribute>====Matches families with the family attribute of a particular value. Values: Family Attribute: Identification Number -- Age ... ====Families with the relationship type====Matches families with the relationship type of a particular value ====Families with <id>: ====Matches families with Gramps ID. The rule returns a match only if the ID is matched exactly. You can either enter the ID into a text entry field, or select an object from the list by clicking {{man button|Select...}} button. In the latter case, the ID will appear in the text field after the selection was made.
=== Events Category===
This category includes the following general rules:
*;====Event with <id>: ====Matches events with Gramps ID. The rule returns a match only if the ID is matched exactly. You can either enter the ID into a text entry field, or select an object from the list by clicking {{man button|Select...}} button. In the latter case, the ID will appear in the text field after the selection was made.
*;====Events changed after <date time>: ====Matches events records changed after a specified date-time (yyy-mm-dd hh:mm:ss) or in the range, if a second date-time is given: Values: Changed after: -- but before:.
*;====Events having <count> notes: ====Matches events having a certain number of notes: Values: Number of instances -- Number must be greater than/lesser/equal to
*;====Events having notes containing <text>: ====Matches events whose notes contain text matching a regular expression
*;====Events marked private: ====Matches events that are indicated as private.
*;====Events matching the <filter>: ====Matches events matched by the specified filter name. Values: Filter name. The specified filter name should be selected from the menu.
*;====Events occurring on a particular day of the week: ====Matches events occurring on a particular day of the week
*;====Events of persons matching the <person filter>: ====Matches events of person matched by the specified person filter name
*;====Events of places matching the <place filter>: ====Matches events that occurred at places that match the specified place filter name
*;====Events with <count> media: ====Matches events with a certain number of items in the gallery. Values: Number of instances -- Number must be greater than/lesser/equal to
*;====Events with <datedata>: ====Matches events with data of a particular value
*;====Events with id Id containing <text>: ====Matches events whose Gramps ID matches the regular expression
*;====Events with a reference count of <count>: ====Matches events with a certain number of references. Values: Number of references -- Number must be greater than/lesser/equal to
*;====Events with the <tag>: ====Matches events with a tag of a particular value. Values: Tag name.
*;====Events with the attribute <attribute>: ====Matches events with the attribute of a particular value. Values: Family Attribute: Identification Number -- Age ...
*;====Events with the particular type: ====Matches events with the particular type
*;====Every event: ====Matches every event in the database.
=== Places Category===
This category includes the following general rules:
*;====Every place: ====Matches every place in the database.
*;====Place with <idId>: ====Matches places with Gramps ID. The rule returns a match only if the ID is matched exactly. You can either enter the ID into a text entry field, or select an object from the list by clicking {{man button|Select...}} button. In the latter case, the ID will appear in the text field after the selection was made.
*;====Places changed after <date time>: ====Matches places records changed after a specified date-time (yyyyyyy-mm-dd hh:mm:ss) or in the range, if a second date-time is given: Values: Changed after: -- but before:.
*;====Places having <count> notes: Matches places having a certain number of notes: Values: Number of instances -- Number must be greater than/lesser/equal to enclosed by another place====
*;Places having notes containing <text>: Matches places whose notes contain text matching a regular expression
*;====Places marked private: having <count> notes====Matches places that are indicated as private.having a certain number of notes: Values: Number of instances -- Number must be greater than/lesser/equal to
*;====Places matching a title: having notes containing <text>====Matches places with whose notes contain text matching a particular titleregular expression
*;====Places matching parameters: marked private====Matches places with particular parametersthat are indicated as private.
*;====Places matching the <filter>: a title====Matches places matched by the specified filter name. Values: Filter name. The specified filter name should be selected from the menu.with a particular title
*;====Places of events matching the <event filter>: parameters====Matches places where events happened that match the specified event filter namewith particular parameters
*;====Places with matching the <countfilter> media: ====Matches places with a certain number of items in matched by the galleryspecified filter name. Values: Number of instances -- Number must Filter name. The specified filter name should be greater than/lesser/equal toselected from the menu.
*;====Places with id containing of events matching the <textevent filter>: ====Matches places whose Gramps ID matches where events happened that match the regular expressionspecified event filter name
*;====Places with a reference count of <count>: media====Matches places with a certain number of referencesitems in the gallery. Values: Number of references instances -- Number must be greater than/lesser/equal to
*;====Places with Id containing <text>====Matches places whose Gramps ID matches the regular expression ====Places with a reference count of <count>====Matches places with a certain number of references. Values: Number of references -- Number must be greater than/lesser/equal to  ====Places with the <tag>: ====Matches places with a tag of a particular value. Values: Tag name.
=== Sources Category===
This category includes the following general rules:
*;====Every source: ====Matches every source in the database.
*;Sources ====Source with <idId>: ====Matches sources with Gramps ID. The rule returns a match only if the ID is matched exactly. You can either enter the ID into a text entry field, or select an object from the list by clicking {{man button|Select...}} button. In the latter case, the ID will appear in the text field after the selection was made.
*;====Sources changed after <date time>: ====Matches sources records changed after a specified date-time (yyy-mm-dd hh:mm:ss) or in the range, if a second date-time is given: Values: Changed after: -- but before:.
*;====Sources having <count> notes: ====Matches sources having a certain number of notes: Values: Number of instances -- Number must be greater than/lesser/equal to
*;====Sources having notes containing <text>: ====Matches sources whose notes contain text matching a regular expression
*;====Sources marked private: ====Matches sources that are indicated as private.
*;====Sources matching the <filter>: ====Matches sources matched by the specified filter name. Values: Filter name. The specified filter name should be selected from the menu.
*;====Sources with <count> Repository references: ====Matches sources with a certain number of repository references
*;====Sources with <count> media: ====Matches sources with a certain number of items in the gallery. Values: Number of instances -- Number must be greater than/lesser/equal to
*;====Sources with id Id containing <text>: ====Matches sources whose Gramps ID matches the regular expression
*;====Sources with a reference count of <count>: ====Matches sources with a certain number of references. Values: Number of references -- Number must be greater than/lesser/equal to
*;====Sources with repository reference containing <text> in '"Call Number': "====Matches sources with a repository reference containing a substring in 'Call Number'
*;====Sources with repository reference matching the <repository filter>: ====Matches sources with a repository reference that match a certain repository filter
*;====Sources with the <tag>: ====Matches sources with a tag of a particular value. Values: Tag name.
*;====Sources with title containing <text>: ====Matches sources whose title contains a certain substring
=== Citations Category===
This category includes the following general rules:
*;====Citation with <idId>: ====Matches citations with Gramps ID. The rule returns a match only if the ID is matched exactly. You can either enter the ID into a text entry field, or select an object from the list by clicking {{man button|Select...}} button. In the latter case, the ID will appear in the text field after the selection was made.
*;====Citations changed after <date time>: ====Matches citations records changed after a specified date-time (yyy-mm-dd hh:mm:ss) or in the range, if a second date-time is given: Values: Changed after: -- but before:.
*;====Citations having <count> notes: ====Matches citations having a certain number of notes: Values: Number of instances -- Number must be greater than/lesser/equal to
*;====Citations having notes containing <text>: ====Matches citations whose notes contain text matching a regular expression
*;====Citations marked private: ====Matches citations that are indicated as private.
*;====Citations matching parameters: ====Matches citations with particular parameters
*;====Citations matching the <filter>: ====Matches citations matched by the specified filter name. Values: Filter name. The specified filter name should be selected from the menu.
*;====Citations with <count> media: ====Matches citations with a certain number of items in the gallery. Values: Number of instances -- Number must be greater than/lesser/equal to
*;====Citations with id Id containing <text>: ====Matches citations whose Gramps ID matches the regular expression
*;====Citations with Volume/Page containing <text>: ====Matches citations whose Volume/Page contains a certain substring
*;====Citations with a reference count of <count>: ====Matches citations with a certain number of references. Values: Number of references -- Number must be greater than/lesser/equal to
*;====Citations with a source with a repository reference matching the <repository filter>: ====Matches citations with a source with a repository reference that match a certain repository filter
*;====Citations with source matching the <source filter>: ====Matches citations with sources that match the specified source filter name
*;====Citations with the <tag>: ====Matches citations with a tag of a particular value. Values: Tag name.
*;====Every citation: ====Matches every citation in the database.
=== Repositories Category===
This category includes the following general rules:
*;====Every repository: ====Matches every repository in the database.
*;====Repositories changed after <date time>: ====Matches repository records changed after a specified date-time (yyy-mm-dd hh:mm:ss) or in the range, if a second date-time is given: Values: Changed after: -- but before:.
*;====Repositories having notes containing <text>: ====Matches repositories whose notes contain text matching a regular expression
*;====Repositories marked private: ====Matches repositories that are indicated as private.
*;====Repositories matching the <filter>: ====Matches repositories matched by the specified filter name. Values: Filter name. The specified filter name should be selected from the menu.
*;====Repositories with id Id containing <text>: ====Matches repositories whose Gramps ID matches the regular expression
*;====Repositories with a reference count of <count>: ====Matches repositories with a certain number of references. Values: Number of references -- Number must be greater than/lesser/equal to
*;====Repositories with name containing <text>: ====Matches repositories whose name contains substring
*;====Repositories with the <tag>: ====Matches repositories with a tag of a particular value. Values: Tag name.
*;====Repository with <idId>: ====Matches repositories with Gramps ID. The rule returns a match only if the ID is matched exactly. You can either enter the ID into a text entry field, or select an object from the list by clicking {{man button|Select...}} button. In the latter case, the ID will appear in the text field after the selection was made.
=== Media Category===
This category includes the following general rules:
*;====Every media object: ====Matches every media object in the database. ====Media object with <Id>====Matches media objects with Gramps ID. The rule returns a match only if the ID is matched exactly. You can either enter the ID into a text entry field, or select an object from the list by clicking {{man button|Select...}} button. In the latter case, the ID will appear in the text field after the selection was made.
*;====Media object with objects changed after <iddate time>: ====Matches media objects with Gramps ID. The rule returns object records changed after a match only if the ID is matched exactly. You can either enter the ID into a text entry field, specified date-time (yyy-mm-dd hh:mm:ss) or select an object from the list by clicking {{man button|Select...}} button. In in the latter caserange, the ID will appear in the text field if a second date-time is given: Values: Changed after the selection was made: -- but before:.
*;====Media objects changed after having notes containing <date timetext>: ====Matches media object records changed after a specified date-time (yyy-mm-dd hh:mm:ss) or in the range, if objects whose notes contain text matching a second date-time is given: Values: Changed after: -- but before:.regular expression
*;====Media objects having notes containing <text>: marked private====Matches media objects whose notes contain text matching a regular expressionthat are indicated as private.
*;====Media objects marked private: Matches media objects that are indicated as private.matching parameters====
*;Media objects matching the <filter>: Matches media objects matched by the specified filter name. Values: Filter name. The specified filter name should be selected from the menu.
*;====Media objects with id containing matching the <textfilter>: ====Matches media objects whose Gramps ID matches matched by the specified filter name. Values: Filter name. The specified filter name should be selected from the regular expressionmenu.
*;====Media objects with a reference count of Id containing <counttext>: ====Matches media objects with a certain number of references. Values: Number of references -- Number must be greater than/lesser/equal towhose Gramps ID matches the regular expression
*;====Media objects with the a reference count of <tagcount>: ====Matches media objects with a tag certain number of a particular valuereferences. Values: Tag name.Number of references -- Number must be greater than/lesser/equal to
*;====Media objects with the <tag>====Matches media objects with a tag of a particular value. Values: Tag name. ====Media objects with the attribute <attribute>: ====Matches media objects with the attribute of a particular value
=== Notes Category===
This category includes the following general rules:
*;====Every note: ====Matches every note in the database.
*;====Note with <idId>: ====Matches notes with Gramps ID. The rule returns a match only if the ID is matched exactly. You can either enter the ID into a text entry field, or select an object from the list by clicking {{man button|Select...}} button. In the latter case, the ID will appear in the text field after the selection was made.
*;====Notes changed after <date time>: ====Matches notes records changed after a specified date-time (yyy-mm-dd hh:mm:ss) or in the range, if a second date-time is given: Values: Changed after: -- but before:.
*;====Notes containing <text>: ====Matches notes contain text matching a regular expression
*;====Notes marked private: ====Matches notes that are indicated as private.
*;====Notes matching parameters: ====Matches notes with particular parameters
*;====Notes matching the <filter>: ====Matches notes matched by the specified filter name. Values: Filter name. The specified filter name should be selected from the menu.
*;====Notes with id Id containing <text>: ====Matches notes whose Gramps ID matches the regular expression
*;====Notes with a reference count of <count>: ====Matches notes with a certain number of references. Values: Number of references -- Number must be greater than/lesser/equal to
*;====Notes with the <tag>: ====Matches notes with a tag of a particular value. Values: Tag name.
*;====Notes with the particular type: ====Matches notes with the particular type
== Mother filters ==
*;Families This rule category finds families having mother with id containing <text>mothers that match the rule: Matches families whose mother has a specified Gramps ID
*;===Families having mother with Id containing <text>===Matches families whose mother has a specified Gramps ID ===Families with mother with the <name>: ===Matches families whose mother has a specified (partial) name
==Position filters==
*;This rule category finds Places by their Global Positioning System coordinates proximity: ===Places in neighborhood of given position: ===Matches places with latitude or longitude position in a rectangle of given height and width (in degrees), and with middle point the given latitude and longitude. ===Places with no latitude or longitude given===Matches places with empty latitude or longitude ===Places within an area===
*;Places with no latitude or longitude given: Matches places with empty latitude or longitude
== Source filters ==
*;This rule category finds Citations that match the rule: ===Citation with Source <idId>: ===Matches a citation with a source with a specified Gramps ID
*;===Citations having source notes containing <text>: ===Matches citations whose source notes contain a substring or match a regular expression
*;===Citations with Source Id containing <text>: ===Matches citations whose source has a Gramps ID that matches the regular expression
*;===Sources matching parameters: ===Matches citations with a source of a particular value
== Relationship filters ==
This category includes the following rules that match people based on their mutual relationship:
*;===People related to <Person>: ===Matches people related to a specified person
*;===Relationship path between <person> and people matching <filter>: ===Searches over the database starting from a specified person and returns everyone between that person and a set of target people specified with a filter. This produces a set of relationship paths (including by marriage) between the specified person and the target people. Each path is not necessarily the shortest path.
*;===Relationship path between <persons>: ===This rule matches all ancestors of both people back to their common ancestors (if exist). This produces the "relationship path" between these two people, through their common ancestors. You can either enter the ID of each person into the appropriate text entry fields, or select people from the list by clicking their {{man button|Select...}} buttons. In the latter case, the ID will appear in the text field after the selection was made.
*;===Relationship path between bookmarked persons: ===Matches the ancestors of bookmarked individuals back to common ancestors, producing the relationship path(s) between bookmarked persons.
== Tagging ==
{{stub}}<!--reorganise this /moved from navigation as unrelated--> The concept of tagging for most people using ''gmail'' or ''thunderbird'', tags will not be something new. Instead of classifying emails into folders like in ''Outlook'' (Windows) or ''Evolution'' (Linux), emails are classified by assigning tags to them. So instead of having a disjoint N:1 classification (a email can be in one and only one folder, and a folder can contain many emails), in ''gmail'' or ''thunderbird'' there is a N:M classification (a email can have several tags, and a tag can be applied to several emails) See also:* [[Tags in Gramps]]
The concept of tagging for most people using ''gmail'' or ''thunderbird'', the [[Gramps_Glossary#tag|Tag]] feature will seem quite familiar. Instead of classifying emails into folders like in ''Outlook'' (Windows) or ''Evolution'' (Linux), emails are classified by assigning tags to them. So instead of having a disjoint N:1 classification (a email can be in one and only one folder, and a folder can contain many emails), in ''gmail'' or ''thunderbird'' there is a N:M classification (where a email can have several tags, and a tag can be applied to several emails)
Likewise, when you have a big tree, you might want to make subsets of the tree, and these subsets might be overlapping. For example, the subsets of your fathers family and your mothers family, some subset of your family that emigrated to Australia.
[[File:gramps-tag.png|right]]The idea is to assign a different tag to each subset: ''Paternal'', ''Maternal'', ''Australia'' and ''ToDo'' for example.
The differences with Gramps previous '''Markers''' are like the folders for emails. A person can be given at most one marker. Tags are thus are like multiple-valued markers.
{{-}}
Or click the Toolbar [[File:16x16-Grampsgramps-tag.png]]{{man button|Tag}} button.
[[File:Toolbar-TagSelectedRows-Icon-DropDownMenu-overview-example-50.png|thumb|right|300px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Available Tag actions from "Tag selected rows" Toolbar icon - drop down menu overview - example]]
You are able to add a new tag either a single or multiple list entries from any of the list views, by making the selection and then using the New Tag dialog.
{{stub}}
{{-}}
<!-- merge with above? -->
Due to the '''static''' nature of tags, it might be useful to add a tag to a selection of objects. For example one should be able to select a number of person in the [[Gramps_5.1_Wiki_Manual_-_Main_Window_Categories#People_Category|Person View]], and add them a new tag or an existing one.
{{-}}
 
===Organize Tags Window===
The order in the {{man label|Organize Tags}} dialog defines the priority for coloring rows in the category views.
{{stub}}
{{-}}
[[File:EditPersonEditor-TagSelectionWindow-50.png|thumb|right|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Tag selection in the Person Editor]]
When you use [[File:16x16-Grampsgramps-tag.png]]{{man button|Edit the tag list}} button from any of the Editor dialogs like {{man label|Person Edit}} the {{man label|[[Gramps_5.1_Wiki_Manual_-_Filters#Tag_selection_dialog|Tag selection]]}} dialog list is shown that lets you remove or assign existing custom tags. The tags are shown in alphabetical order.
{{-}}
To easily see your tags, you can use the {{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Column_Editor|Column Editor]]}} to add the {{man label|Tags}} column to the list views of objects. The content is then displayed as a comma-separated list of the tags of the objects.
==== Tags Usage Report ====
The [[Gramps_5.1_Wiki_Manual_-_Reports_-_part_6#Tag_Report|Tag Usage Report]] lists [[Gramps_Glossary#primary_object|primary objects]] (person, family, notes) having the selected Tag.
===See also===
* [[Tags in Gramps]] - an introduction
* Automatic [[Gramps_5.1_Wiki_Manual_-_Settings#General_Gramps_settings|Import timestamp Tags]]
* filtered [[Addon:RemoveTagTool|Add/Remove Tag Tool]] (Third party addon for Gramps)

Navigation menu