Changes

Jump to: navigation, search

Gramps 5.1 Wiki Manual - Filters

1,418 bytes added, 20:27, 6 January 2020
m
Add Rule dialog
== Filter vs. Search ==
There are two ways to find data in Gramps: Search and Filter. Search uses the [[Gramps_{{Version manual}}_Wiki_Manual_Gramps_5.1_Wiki_Manual_-_Main_Window#Search_bar|Search Bar]] above a listing View (such as People, Families, etc). Filter can be used in combination with Search, or stand-alone in the sidebar/bottombar Gramplets. The [[Gramps_{{Version manual}}_Wiki_Manual_Gramps_5.1_Wiki_Manual_-_Main_Window#Search_bar|Search Bar]] only appears when the entire sidebar is closed. You can close/open the Sidebar/bottombar through {{man menu| -> View}}.
Search and Filter work completely differently and it is useful to understand these differences:
*''Search'' - the [[Gramps_{{Version manual}}_Wiki_Manual_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. 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_{{Version manual}}_Wiki_Manual_Gramps_5.1_Wiki_Manual_-_Main_Window#Search_bar|Search Bar]]]]
*''Filter'' - Filters use a more complex system. It is not limited to what you see on the screen, but looks at the actual data, rather than just what is showing in the View. The name Filter will try to match on any single name field (given, surname, prefix, etc) of all names (primary and alternate) but only field per name---you can't match the given field and surname field in the same name. You can match surname, but not surname and given in the same name. For example, if you Filter on "John", you will get matches of people with firstname "John" but also those with surname "Johnson". You just can't filter on combinations of first and lastnames.
[[File:Sidebar-PeopleTreeView-Filter-TagDropDownList-example-50.png|450px|thumb|right|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramps Filter SideBar - Tag list example]]
Filters can be created and controlled from the menu {{man menu| Edit -> Filter Editor}}, or from a special sidebar/bottombar Gramplet. The Filter Gramplets allow for some quick filters that are similar to the [[Gramps_{{Version manual}}_Wiki_Manual_Gramps_5.1_Wiki_Manual_-_Main_Window#Search_bar|Search Bar]], but all Filters follow the distinction outlined here.
Some additional points:
* The Filter will search alternative names too; the [[Gramps_{{Version manual}}_Wiki_Manual_Gramps_5.1_Wiki_Manual_-_Main_Window#Search_bar|Search Bar]] only looks in the primary name (the one showing). That is why if you do a Filter on "Smith" you might see people listed that don't appear to match. But if you edit that person's details, 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 [[Gramps_{{Version manual}}_Wiki_Manual_Gramps_5.1_Wiki_Manual_-_Main_Window#Search_bar|Search Bar]].* The Search will only match what is visible. If a name or text is too big to see in listing below [[Gramps_{{Version manual}}_Wiki_Manual_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 use case-insensitive matching; "Ship" will match "ship", "SHIP", or "ShIp".
You can find more details about making === See also ===* [[Gramps_Glossary#filter|Filter]] - a definition* [[Gramps_{{Version manual}}_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]]
{{-}}
Regular Expression testers can be found online through Google. http://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.}}
==Custom Filters==
{{man warn|Custom rules Filter migration|To avoid unwanted effects after a major upgrades of Gramps (eg, from version 3.2.x to 5.1.x), if required, you can manually copy your ''custom_filter.xml'' from [[Gramps User Directory]] to ''gramps_version_number''.}}
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.
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}} Person Filters* {{icon|fami}} Family Filters* {{icon|even}} Event Filters* {{icon|plac}} Place Filters* {{icon|sour34}} Source Filters* {{icon|medi}} Media Filters* {{icon|repo}} Repository Filters* {{icon|note}} Note Filters* {{icon|cite}} Citation Filters
When in the {{man label|''CategoryName'' Filters}} dialog you have the following options from the right hand side icons:
* {{icon|stock_add}} {{man button|+ (Add another rule to a new filter)}} button to show the {{man label|Define filter}} dialog add your new custom filter.* {{icon|stock_edit}} {{man button|Edit the selected filter}} button to show the {{man label|Define filter}} dialog and edit your existing custom filter.
* {{man button|Clone the selected filter}} makes an exact copy of the selected filter.
* {{man button|Test the selected filter}} when selected brings up the {{man label|Filter Test}} dialog results list, that may or may not show results from your custom filter.
* {{icon|stock_remove}} {{man button|Delete the selected filter}}
{{-}}
====Filter Test dialog====
===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]]}}
[[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]]
*;Bookmarked people: Matches the people on the bookmark list.
*;Default person: Matches the default person[[Gramps_Glossary#home_person|Home Person]].
*;Disconnected People: Matches people that have no family relationships to any other person in the database.
{{stub}}<!--reorganise this /moved from navigation as unrelated-->
The concept of tagging for most people using ''gmail'' or ''thunderbird'', tags the [[Gramps_Glossary#tag|Tag]] feature will not be something newseem 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) See also:* [[Tags in Gramps]] 
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.
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|Remove Tag Tool]] (Third party add-on for Gramps)
4,602
edits

Navigation menu