Gramps - User contributions [en]

Gramps 5.1 Wiki Manual - Filters

2022-07-02T03:22:40Z

Adrian Davey:

{{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|16}}
{{#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 of all the filter 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 ways to find data in Gramps: Search and Filter.

* Search uses the [[Gramps_5.1_Wiki_Manual_-_Main_Window#Search_bar|Search Bar]] above a listing View (such as People, Families, etc). 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 ➡ ☑Sidebar}} or {{man menu|View ➡ ☑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. Custom Filters are created or edited from the filter Gramplet or {{man menu|Edit ➡ 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 — 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. 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 [[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").

[[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 elaborate system. It is not limited to what you see on the screen, but looks at the actual data in all name fields, rather than just what is showing in the View. 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 the records found with the previous search word. And it simultaneously searches '''''all''''' the Name fields.
:e.g. a name search of "geo r." in the [[Example.gramps|example tree]] database finds 5 people: with a variety 'Jr.' & 'Sr.' as the suffix and 'George's as first & middle names. Or searching "garn ski ph" finds Phoebe Emily who has a birth surname of Zieliński and alternate 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]] pop-up menu 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_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 & 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 doing a Filter on "Smith" might list people that superficially don't appear to match. But if you drill down into that person's details with 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 [[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_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.

=== 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]]
* [[Template:Backup Omissions|Custom Filter migration]] - backing up Gramps does not back up your filters.
{{-}}

== Regular Expressions ==

[https://wikipedia.org/wiki/Regular_expression Regular Expressions](aka ''regex'', ''regexp'', or sometimes ''rational expression'') are a 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 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 Filters and in the Filter Gramplets of each Category view.

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 in 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>^B</code>''' indicates text that starts with B
* The '''<code>.</code>''' indicates any single character (letter, number, or anything)
* The '''<code>*</code>''' indicates zero or more of the previous (in this case, any single character)
* 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>''' 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:

* '<code>.</code>' matches any character (letter, number, or other)
* '<code>^</code>' matches beginning of text
* '<code>$</code>' matches end of text
* '<code>*</code>' matches zero or more of the previous item
* '<code>+</code>' matches one or more of the previous item
* '<code>?</code>' matches zero or one of the previous item (makes it optional)
* '<code>{</code>' - defines a number of matches
* '<code>}</code>' - ends number of matches
* '<code>[</code>' - beginning of set
* '<code>]</code>' - end of set
* '<code>\</code>' - next character is special sequence
* '<code>|</code>' - or
* '<code>(</code>' - beginning of a group
* '<code>)</code>' - ending of a group

Some of the special sequences beginning with '<code>\</code>' represent predefined sets of characters that are often useful, such as the set of digits, the set of letters, or the set of anything that isn't whitespace. The following predefined special sequences are a subset of those available.

* <code>\d</code> Matches any decimal digit; this is equivalent to the class <code>[0-9]</code>.
* <code>\D</code> Matches any non-digit character; this is equivalent to the class <code>[^0-9]</code>.
* <code>\s</code> Matches any whitespace character; this is equivalent to the class <code>[ \t\n\r\f\v]</code>.
* <code>\S</code> Matches any non-whitespace character; this is equivalent to the class <code>[^ \t\n\r\f\v]</code>.
* <code>\w</code> Matches any alphanumeric character; this is equivalent to the class <code>[a-zA-Z0-9_]</code>.
* <code>\W</code> Matches any non-alphanumeric character; this is equivalent to the class <code>[^a-zA-Z0-9_]</code>.

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 ===
To find all values, <code>(.|\s)*</code> will match: any character or any whitespace character; and zero or more repetitions of those.

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>

=== Groups and Sets ===

Groups are marked by the '<code>('</code>, '<code>)</code>' metacharacters. '<code>(</code>' and '<code>)</code>' have much the same meaning as they do in mathematical expressions; they group together the expressions contained inside them, and you can repeat the contents of a group with a repeating qualifier, such as <code>*, +, ?, or {m,n}</code>. For example, <code>(ab)*</code> will match zero or more repetitions of <code>ab</code>.

Sets are marked by the '<code>[</code>' and '<code>]</code>' metacharacters.

You can think of groups as a list of alternatives separated by the '<code>|</code>' metacharacter, where each alternative consists of one, several or zero characters and sets as a list of alternatives where each alternative is a single character.

=== Examples ===

* '''<code>^B.*ship$</code>''' - matches all text that starts with a '<code>B</code>', followed by anything, ending with '<code>ship</code>'.
** matches: '''<code>Blankenship</code>''', '''<code>Blueship</code>''', '''<code>Beeship</code>'''
** does not match: '''<code>Blankenships</code>'''
* '''<code>^B.*ship</code>''' - matches all text that starts with a '<code>B</code>', followed by anything, followed by '<code>ship</code>' (could be followed by more).
** matches: '''<code>Blankenship</code>''', '''<code>Blankenships</code>''', '''<code>Blueship</code>''', '''<code>Blueshipman</code>''', '''<code>Beeship</code>''', '''<code>Beeshipness</code>'''
** does not match: '''<code>Blankenschips</code>'''

====Common variations of a surname====

;Example 1: Using the expression '''<code>Eri(ch|ck|k|c)(ss|s)on</code>''' the following are matched:
<pre>
Erikson
Eriksson
Ericson
Ericsson
Erickson
Ericksson
Erichson
Erichsson
</pre>

'''Explanation''': Because of the following
* '''<code>Eri</code>''' = Eri
* '''<code>(ch|ck|k|c)</code>''' = group matching '''<code>ch</code>''', '''<code>ck</code>''', '''<code>k</code>''' or '''<code>c</code>'''. It tries to make the longest match first
* '''<code>(ss|s)</code>''' = group matching '''<code>ss</code>''' or '''<code>s</code>'''. It tries to make the longest match first
* '''<code>on</code>''' = on

<hr>

;Example 2: Using the expression '''<code>Ba(in|yn|m|n)bri(dge|cke|g(g|e|))</code>''' the following are matched:
<pre>
Bainbricke
Bainbridge
Bainbrig
Bainbrigg
Bambridge
Banbrig
Banbrige
Baynbrige
</pre>

'''Explanation:''' Because of the following
* '''<code>Ba</code>''' = Ba
* '''<code>(in|yn|m|n)</code>''' = group matching '''in''', '''yn''', '''m''' or '''n'''. It tries to make the longest match first.
* '''<code>bri</code>''' = bri
* '''<code>(dge|cke|g(g|e|))</code>''' = group matching '''dge''', '''cke''' or ('''g''' with '''g''', '''g''' with '''e''' or '''g''' with nothing)

<hr>

;Example 3: Using the expression '''<code>n(es|oua|oai|o[iya]|a[iy])r(r|)(on|((e|)au(x|t|d|lt|)))</code>''' the following are matched:
<pre>
nairaud
nairault
naireaud
nayrault
nesrau
nesrault
nesreau
nesreaud
noirau
noiraud
noirauld
noirault
noiraut
noiraux
noireau
noireaud
noireault
noireaut
noirraux
noirreau
noirreaud
nouarault
noyraud
noyrault
</pre>

'''Explanation:''' Because of the following
* '''<code>n</code>''' = n
* '''<code>(es|oua|oai|set1|set2)</code>''' = group matching '''es''', '''oua''', '''oai''', '''set1''' or '''set2'''
* '''<code>set1</code>''' is '''<code>o[iya]</code>''' = set matching '''o''' AND '''i''', '''y''' or '''a'''. In other words '''oi''', '''oy''' or '''oa'''
* '''<code>set2</code>''' is '''<code>a[iy]</code>''' = set matching '''a''' AND '''i''' or '''y'''. In other words '''ai''' or '''ay'''
* '''<code>r</code>''' = r
* '''<code>(r|)</code>''' = group matching '''r''' or nothing
* '''<code>(on|(subgroup1)</code>''' = group matching '''on''' or '''subgroup1'''.
* '''subgroup1''' is group matching ('''subgroup2 au subgroup3''')
* '''subgroup2''' is '''(e|)''' = group matching '''e''' or nothing
* '''<code>au</code>''' = au
* '''subgroup3''' is '''(x|t|d|lt)''' = group matching '''x''', '''t''', '''d''' or '''lt'''

====Testing regular expressions====

Regular Expression testers can be found online through Google. https://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 tip|Custom Filter migration|Keep your collection of custom filters through a minor updates of Gramps (e.g., from version 5.0.x to 5.1.x) by manually copying your ''custom_filter.xml'' from [[Gramps User Directory]] to the corresponding directory in new ''gramps_version_number''. 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===

{{man note|1=Note:Changes on filters |2=The changes made to the filters only take effect after you use the {{man button|Close}} button from this window.}}

[[File:PersonFilters-dialog-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Person Filters - dialog - example]]

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|cite}} Citation Filters
* {{icon|repo}} Repository Filters
* {{icon|medi}} Media Filters
* {{icon|note}} 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}}}} {{man tooltip|Add a new filter}}
:shows the {{man label|Define filter}} dialog and adds a new (as yet unnamed) custom filter framework.
* {{man button| {{icon|stock_edit}}}} {{man tooltip|Edit the selected filter}}
:opens the {{man label|Define filter}} dialog and loads your existing custom filter for editing.
* {{man button|Clone}} {{man tooltip|Clone the selected filter}}
:makes an exact copy of the selected filter
* {{man button|Test}} {{man tooltip|Test the selected filter}}
:brings up the {{man label|Filter Test}} results dialog containing a list of matches following a successful test. If the filter test is invalid, an error may be shown instead.
* {{man button| {{icon|stock_remove}}}} {{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 might be empty, a valid custom filter might 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. ''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]]

The {{man label|Define filter}} dialog allow you to build custom filters that can be used to select people included in reports, exports, and other tools and utilities. This is in fact a very powerful tool in genealogical analysis.

To list all the filters (if any) previously defined by you, access the {{man label|Define filter}} dialog from:
* The Sidebar/Bottombar Filters
* In most categories via the menu {{man menu|Edit > ''CategoryName'' Filter Editor}} which will bring up the {{man label|''CategoryName'' Filters}} dialog where you can select the {{man button|+ (Add another rule to filter)}} button or {{man button|Edit the selected filter}} button.

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.

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
* Exactly 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)
{{-}}

===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). ''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]]

To define a new filter click the {{man button|+ (Add another rule to filter)}} button from the {{man label|Define filter}} dialog as this invokes the {{man label|Add Rule}} dialog

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

See also [[Gramps_5.1_Wiki_Manual_-_Filters#Which_filters_in_which_Category.3F|Which filters in which Category?]]
{{-}}



== Which filter rules in which Category? ==

Depending on the used [[Gramps_5.1_Wiki_Manual_-_Categories|Category]], 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]].

*; Dashboard Category: no filter rules available

*; People, Relationships and Charts Category: rules for [[#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]].

*; Families Category: rules for [[#Child filters|Child filters]], [[#Citation/source filters|Citation/source filters]], [[#Event_filters|Event filters]], [[#Father filters|Father filters]], [[#General_filters|General filters]], and [[#Mother filters|Mother filters]]

*; Events, and Media Category: rules for [[#Citation/source filters|Citation/source filters]], and [[#General_filters|General filters]].

*; Places Category: rules for [[#Citation/source filters|Citation/source filters]], [[#General_filters|General filters]], and [[#Position filters|Position filters]].

*; Geography Category (Only from the filter sidebar/bottombar): rules for [[#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]].

*; 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===
{{stub}}

===Ancestor of the default person not more than <N> generations away===
{{stub}}

===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 two (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 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]]

=== People-, and 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>====
{{stub}}

=== Families Category===

This category includes the following citation and source rules:

====Families with <count> 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>====
{{stub}}

====Events with the <citation>====
Matches events with a citation of a particular value

=== Places Category===

This category includes the following citation and source rules:

====Place with <count> sources====
Matches places with a certain number of items in the source. Values: Number of instances -- Number must be greater than/lesser/equal to

====Place with a direct source >= <confidence level>====
Matches places with at least one direct source with confidence level(s)

====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> 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 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 filter rules are view dependent
* [[#People-.2C_and_Relationships_Category_2|People-, and Relationships Category]]
* [[#Families_Category_2|Families Category]]

=== People-, and 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 the <birth data>====
This rule matches people 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 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 birth. To use just one value, leave the other values empty.

====People with the <death data>====
This rule matches people whose death event matches specified values for 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 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 death. To use just one value, leave the other values empty.

====People with the family <event>====
This rule matches people that have a family 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.

====People with the personal <event>====
This rule matches people 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 event. To use just one value, leave the other values empty.

====Persons with events matching the <event filter>====
Matches persons who have events that match a certain event filter. Values: Event filter name.

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

===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 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 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]]

=== People-, and Relationships Category===

This category includes the following general rules:

====Bookmarked people====
Matches the people on the bookmark list.


====Home person====

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

====People having notes containing <text>====
Matches people whose notes contain text matching a regular expression

====People marked private====
Matches people that are indicated as private.

====People matching the <filter>====
Matches people matched by the specified filter name. Values: Filter name. The specified filter name should be selected from the menu.

====People not marked private====
Matches people that are not indicated as private

====People probably alive====
Matches people without indications of death that are not too old. Values: On Date
{{stub}}

* [[Gramps_5.1_Wiki_Manual_-_Probably_Alive#Probably_Alive_Filter|Probably Alive Filter]]

====People with <count> LDS events====
Matches people with a certain number of LDS events. Values: Number of instances -- Number must be greater than/lesser/equal to

====People with <count> addresses====
Matches people with a certain number of personal addresses. Values: Number of instances -- Number must be greater than/lesser/equal to

====People with <count> associations====
Matches people with a certain number of associations. Values: Number of instances -- Number must be greater than/lesser/equal to

====People with <count> media====
Matches people with a certain number of items in the gallery. Values: Number of instances -- Number must be greater than/lesser/equal to

====People with id containing <text>====
Matches people whose Gramps ID matches the regular expression

====People with a nickname====
Matches people with a nickname

====People with an alternate name====
Matches people with an alternate name

====People with incomplete names====
Matches people with first-name or last-name missing.

====People with records containing <substring>====
Matches people whose records contain text matching a substring. Values: Substring -- Case Sensitive or not -- Regular-Expression matching or not

====People with the <Name type>====
Matches people with a type of name

====People with the <Surname origin type>====
Matches people with a surname origin

====People with the <name>====
Matches people with a specified (partial) name. Values: Given Name -- Family Name -- Suffix -- Title -- Prefix -- Patronymic -- Call Name

====People with <tag>====
Matches people with a tag of a particular value. Values: Tag name.

====People with the family <attribute>====
Matches people with the family attribute of a particular 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: Family Attribute: Identification Number -- Age ...

====People with the personal <attribute>====
Matches people with the personal attribute of a particular 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 unknown gender====
Matches all people with unknown gender.

====People without a known birth date====
Matches people without a known birth date.

====People without a known death date====
Matches people without a known death date.

====People with <id>====
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 made.

====People changed after <date time>====
Matches person records changed during a particular time period. Used to identify records that were imported or modified during particular work-sessions.

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 date range, if a second date-time is given.

Values:
Changed after:
but before:

Values must be after January 1st, 1970 at UTC. Future dates until <code>3001-01-01 01:59:59</code> are valid.

The {{man menu|People changed after <date time>}} filter rules are available in the {{man menu|General filters}} section for custom rules in the People, Relationships, Charts, and Geography views.

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 the <name>====
{{stub}}

=== Families Category===

This category includes the following general rules:

====Ancestor families of <family>====
{{stub}}

====Bookmarked families====
Matches the families on the bookmark list.

====Descendant families of <family>====
{{stub}}

====Every family====
Matches every family in the database.

====Families changed after <date time>====
Matches families 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:.

====Families having <count> 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====
Matches families that are indicated as private.

====Families matching the <filter>====
Matches families matched by the specified filter name. Values: Filter name. The specified filter name should be selected from the menu.

====Families with <count> LDS events====
Matches families with a certain number of LDS events. Values: Number of instances -- Number must be greater than/lesser/equal to

====Families with <count> media====
Matches families with a certain number of items in the gallery. Values: Number of instances -- Number must be greater than/lesser/equal to

====Families with id containing <text>====
Matches families whose Gramps ID matches the regular 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 <data>====
Matches events with data of a particular value

====Events with 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 <Id>====
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 (yyyy-mm-dd hh:mm:ss) or in the range, if a second date-time is given: Values: Changed after: -- but before:.

====Places enclosed by another place====
{{stub}}

====Places having <count> notes====
Matches places having a certain number of notes: Values: Number of instances -- Number must be greater than/lesser/equal to

====Places having notes containing <text>====
Matches places whose notes contain text matching a regular expression

====Places marked private====
Matches places that are indicated as private.

====Places matching a title====
Matches places with a particular title

====Places matching parameters====
Matches places with particular parameters

====Places matching the <filter>====
Matches places matched by the specified filter name. Values: Filter name. The specified filter name should be selected from the menu.

====Places of events matching the <event filter>====
Matches places where events happened that match the specified event filter name

====Places with <count> media====
Matches places with a certain number of items in the gallery. Values: Number of 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.

====Source with <Id>====
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 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 <Id>====
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 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 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 <Id>====
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 objects changed after <date time>====
Matches media object 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:.

====Media objects having notes containing <text>====
Matches media objects whose notes contain text matching a regular expression

====Media objects marked private====
Matches media objects that are indicated as private.

====Media objects matching parameters====
{{stub}}

====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 <text>====
Matches media objects whose Gramps ID matches the regular expression

====Media objects with a reference count of <count>====
Matches media objects with a certain number of references. Values: 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 <Id>====
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 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 ==

This rule category finds families having mothers that match the rule:

===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===
{{stub}}

== Source filters ==

This rule category finds Citations that match the rule:

===Citation with Source <Id>===
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}}

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

Go to the Menu {{man menu|Edit ->Tag}}.

[[File:Menu-Edit-Tag-Options-50.png|thumb|right|300px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Tag actions from Edit menu]]

{{-}}

Or click the Toolbar [[File:16x16-gramps-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]]
{{-}}
See also [[Gramps_5.1_Wiki_Manual_-_Reports_-_part_6#Tag_Report|Tag Report]]
{{-}}
===New Tag dialog===
[[File:NewTag-dialog-ShowingMultipleListSelection-example-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Attaching a "New Tag" to multiple list entry selections - example with "New Tag" dialog]]

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

{{-}}
===== Tagging a selection of objects =====


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_-_Categories#People_Category|Person View]], and add them a new tag or an existing one.
{{-}}

===Organize Tags Window===

[[File:MenuEditTag-OrganizeTags-dialog-example-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Organize Tags - dialog - example]]

The order in the {{man label|Organize Tags}} dialog defines the priority for coloring rows in the category views.

{{stub}}
{{-}}

===Tag selection dialog===
[[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-gramps-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.
{{-}}

=== Usage of tags ===

Here are a some ideas of operations that can be done with tags

==== Filtering ====

[[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]]

The most obvious use is that of filtering.
* Tags and filters both create subsets of the tree. However they have practical differences in usage.

Specifying your fathers family using filters is an easy thing; there are already filters based on some logic's that do it. On the other hand, specifying the people that emigrated to the USA is harder, while for the famous people in your family it is simply impossible as there is no logical rule. Tags are much more practical here.

However filters have the advantage of being '''dynamical'''. If you add an ancestor of your father in the database, it will be automatically added to the filter.

On the other hand, tags are '''static'''. When adding a famous person in the tree, you have to explicitly tag them as ''FAMOUS''.

* The most immediate object that comes to mind are the individuals, and that is also the most useful. However, other objects could be tagged:
** Places: For example "places to visit",
** Source: For example "sources in german",
** Notes: For example "notes in progess", or "notes in german",
** Media: For example "Picture belonging to Uncle Alfred".

Tags are available to use with '''all primary objects'''.
{{-}}

==== Tags Column ====

[[File:PeopleListView-ExampleTagColoredRows-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} People (List) View - Showing "Tag" column and colored tag rows - example]]

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)

{{-}}
{{man index|Gramps 5.1 Wiki Manual - Settings|Gramps 5.1 Wiki Manual - FAQ|5.1}}
{{languages|Gramps_5.1_Wiki_Manual_-_Filters}}
{{grampsmanualcopyright}}

[[Category:Documentation]]
[[Category:Filters]]

Gramps 5.1 Wiki Manual - Filters

2022-07-02T02:57:04Z

Adrian Davey:

{{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|16}}
{{#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 of all the filter 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 ways to find data in Gramps: Search and Filter.

* Search uses the [[Gramps_5.1_Wiki_Manual_-_Main_Window#Search_bar|Search Bar]] above a listing View (such as People, Families, etc). 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 ➡ ☑Sidebar}} or {{man menu|View ➡ ☑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. Custom Filters are created or edited from the filter Gramplet or {{man menu|Edit ➡ 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 — 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. 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 [[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").

[[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 elaborate system. It is not limited to what you see on the screen, but looks at the actual data in all name fields, rather than just what is showing in the View. 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 the records found with the previous search word. And it simultaneously searches '''''all''''' the Name fields.
:e.g. a name search of "geo r." in the [[Example.gramps|example tree]] database finds 5 people: with a variety 'Jr.' & 'Sr.' as the suffix and 'George's as first & middle names. Or searching "garn ski ph" finds Phoebe Emily who has a birth surname of Zieliński and alternate 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]] pop-up menu 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_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 & 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 doing a Filter on "Smith" might list people that superficially don't appear to match. But if you drill down into that person's details with 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 [[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_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".

=== 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]]
* [[Template:Backup Omissions|Custom Filter migration]] - backing up Gramps does not back up your filters.
{{-}}

== Regular Expressions ==

[https://wikipedia.org/wiki/Regular_expression Regular Expressions](aka ''regex'', ''regexp'', or sometimes ''rational expression'') are a 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 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 Filters and in the Filter Gramplets of each Category view.

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 in 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>^B</code>''' indicates text that starts with B
* The '''<code>.</code>''' indicates any single character (letter, number, or anything)
* The '''<code>*</code>''' indicates zero or more of the previous (in this case, any single character)
* 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, or lower case.

''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>''' 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:

* '<code>.</code>' matches any character (letter, number, or other)
* '<code>^</code>' matches beginning of text
* '<code>$</code>' matches end of text
* '<code>*</code>' matches zero or more of the previous item
* '<code>+</code>' matches one or more of the previous item
* '<code>?</code>' matches zero or one of the previous item (makes it optional)
* '<code>{</code>' - defines a number of matches
* '<code>}</code>' - ends number of matches
* '<code>[</code>' - beginning of set
* '<code>]</code>' - end of set
* '<code>\</code>' - next character is special sequence
* '<code>|</code>' - or
* '<code>(</code>' - beginning of a group
* '<code>)</code>' - ending of a group

Some of the special sequences beginning with '<code>\</code>' represent predefined sets of characters that are often useful, such as the set of digits, the set of letters, or the set of anything that isn't whitespace. The following predefined special sequences are a subset of those available.

* <code>\d</code> Matches any decimal digit; this is equivalent to the class <code>[0-9]</code>.
* <code>\D</code> Matches any non-digit character; this is equivalent to the class <code>[^0-9]</code>.
* <code>\s</code> Matches any whitespace character; this is equivalent to the class <code>[ \t\n\r\f\v]</code>.
* <code>\S</code> Matches any non-whitespace character; this is equivalent to the class <code>[^ \t\n\r\f\v]</code>.
* <code>\w</code> Matches any alphanumeric character; this is equivalent to the class <code>[a-zA-Z0-9_]</code>.
* <code>\W</code> Matches any non-alphanumeric character; this is equivalent to the class <code>[^a-zA-Z0-9_]</code>.

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 ===
To find all values, <code>(.|\s)*</code> will match: any character or any whitespace character; and zero or more repetitions of those.

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>

=== Groups and Sets ===

Groups are marked by the '<code>('</code>, '<code>)</code>' metacharacters. '<code>(</code>' and '<code>)</code>' have much the same meaning as they do in mathematical expressions; they group together the expressions contained inside them, and you can repeat the contents of a group with a repeating qualifier, such as <code>*, +, ?, or {m,n}</code>. For example, <code>(ab)*</code> will match zero or more repetitions of <code>ab</code>.

Sets are marked by the '<code>[</code>' and '<code>]</code>' metacharacters.

You can think of groups as a list of alternatives separated by the '<code>|</code>' metacharacter, where each alternative consists of one, several or zero characters and sets as a list of alternatives where each alternative is a single character.

=== Examples ===

* '''<code>^B.*ship$</code>''' - matches all text that starts with a '<code>B</code>', followed by anything, ending with '<code>ship</code>'.
** matches: '''<code>Blankenship</code>''', '''<code>Blueship</code>''', '''<code>Beeship</code>'''
** does not match: '''<code>Blankenships</code>'''
* '''<code>^B.*ship</code>''' - matches all text that starts with a '<code>B</code>', followed by anything, followed by '<code>ship</code>' (could be followed by more).
** matches: '''<code>Blankenship</code>''', '''<code>Blankenships</code>''', '''<code>Blueship</code>''', '''<code>Blueshipman</code>''', '''<code>Beeship</code>''', '''<code>Beeshipness</code>'''
** does not match: '''<code>Blankenschips</code>'''

====Common variations of a surname====

;Example 1: Using the expression '''<code>Eri(ch|ck|k|c)(ss|s)on</code>''' the following are matched:
<pre>
Erikson
Eriksson
Ericson
Ericsson
Erickson
Ericksson
Erichson
Erichsson
</pre>

'''Explanation''': Because of the following
* '''<code>Eri</code>''' = Eri
* '''<code>(ch|ck|k|c)</code>''' = group matching '''<code>ch</code>''', '''<code>ck</code>''', '''<code>k</code>''' or '''<code>c</code>'''. It tries to make the longest match first
* '''<code>(ss|s)</code>''' = group matching '''<code>ss</code>''' or '''<code>s</code>'''. It tries to make the longest match first
* '''<code>on</code>''' = on

<hr>

;Example 2: Using the expression '''<code>Ba(in|yn|m|n)bri(dge|cke|g(g|e|))</code>''' the following are matched:
<pre>
Bainbricke
Bainbridge
Bainbrig
Bainbrigg
Bambridge
Banbrig
Banbrige
Baynbrige
</pre>

'''Explanation:''' Because of the following
* '''<code>Ba</code>''' = Ba
* '''<code>(in|yn|m|n)</code>''' = group matching '''in''', '''yn''', '''m''' or '''n'''. It tries to make the longest match first.
* '''<code>bri</code>''' = bri
* '''<code>(dge|cke|g(g|e|))</code>''' = group matching '''dge''', '''cke''' or ('''g''' with '''g''', '''g''' with '''e''' or '''g''' with nothing)

<hr>

;Example 3: Using the expression '''<code>n(es|oua|oai|o[iya]|a[iy])r(r|)(on|((e|)au(x|t|d|lt|)))</code>''' the following are matched:
<pre>
nairaud
nairault
naireaud
nayrault
nesrau
nesrault
nesreau
nesreaud
noirau
noiraud
noirauld
noirault
noiraut
noiraux
noireau
noireaud
noireault
noireaut
noirraux
noirreau
noirreaud
nouarault
noyraud
noyrault
</pre>

'''Explanation:''' Because of the following
* '''<code>n</code>''' = n
* '''<code>(es|oua|oai|set1|set2)</code>''' = group matching '''es''', '''oua''', '''oai''', '''set1''' or '''set2'''
* '''<code>set1</code>''' is '''<code>o[iya]</code>''' = set matching '''o''' AND '''i''', '''y''' or '''a'''. In other words '''oi''', '''oy''' or '''oa'''
* '''<code>set2</code>''' is '''<code>a[iy]</code>''' = set matching '''a''' AND '''i''' or '''y'''. In other words '''ai''' or '''ay'''
* '''<code>r</code>''' = r
* '''<code>(r|)</code>''' = group matching '''r''' or nothing
* '''<code>(on|(subgroup1)</code>''' = group matching '''on''' or '''subgroup1'''.
* '''subgroup1''' is group matching ('''subgroup2 au subgroup3''')
* '''subgroup2''' is '''(e|)''' = group matching '''e''' or nothing
* '''<code>au</code>''' = au
* '''subgroup3''' is '''(x|t|d|lt)''' = group matching '''x''', '''t''', '''d''' or '''lt'''

====Testing regular expressions====

Regular Expression testers can be found online through Google. https://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 tip|Custom Filter migration|Keep your collection of custom filters through a minor updates of Gramps (e.g., from version 5.0.x to 5.1.x) by manually copying your ''custom_filter.xml'' from [[Gramps User Directory]] to the corresponding directory in new ''gramps_version_number''. 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===

{{man note|1=Note:Changes on filters |2=The changes made to the filters only take effect after you use the {{man button|Close}} button from this window.}}

[[File:PersonFilters-dialog-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Person Filters - dialog - example]]

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|cite}} Citation Filters
* {{icon|repo}} Repository Filters
* {{icon|medi}} Media Filters
* {{icon|note}} 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}}}} {{man tooltip|Add a new filter}}
:shows the {{man label|Define filter}} dialog and adds a new (as yet unnamed) custom filter framework.
* {{man button| {{icon|stock_edit}}}} {{man tooltip|Edit the selected filter}}
:opens the {{man label|Define filter}} dialog and loads your existing custom filter for editing.
* {{man button|Clone}} {{man tooltip|Clone the selected filter}}
:makes an exact copy of the selected filter
* {{man button|Test}} {{man tooltip|Test the selected filter}}
:brings up the {{man label|Filter Test}} results dialog containing a list of matches following a successful test. If the filter test is invalid, an error may be shown instead.
* {{man button| {{icon|stock_remove}}}} {{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 might be empty, a valid custom filter might 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. ''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]]

The {{man label|Define filter}} dialog allow you to build custom filters that can be used to select people included in reports, exports, and other tools and utilities. This is in fact a very powerful tool in genealogical analysis.

To list all the filters (if any) previously defined by you, access the {{man label|Define filter}} dialog from:
* The Sidebar/Bottombar Filters
* In most categories via the menu {{man menu|Edit > ''CategoryName'' Filter Editor}} which will bring up the {{man label|''CategoryName'' Filters}} dialog where you can select the {{man button|+ (Add another rule to filter)}} button or {{man button|Edit the selected filter}} button.

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.

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
* Exactly 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)
{{-}}

===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). ''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]]

To define a new filter click the {{man button|+ (Add another rule to filter)}} button from the {{man label|Define filter}} dialog as this invokes the {{man label|Add Rule}} dialog

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

See also [[Gramps_5.1_Wiki_Manual_-_Filters#Which_filters_in_which_Category.3F|Which filters in which Category?]]
{{-}}



== Which filter rules in which Category? ==

Depending on the used [[Gramps_5.1_Wiki_Manual_-_Categories|Category]], 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]].

*; Dashboard Category: no filter rules available

*; People, Relationships and Charts Category: rules for [[#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]].

*; Families Category: rules for [[#Child filters|Child filters]], [[#Citation/source filters|Citation/source filters]], [[#Event_filters|Event filters]], [[#Father filters|Father filters]], [[#General_filters|General filters]], and [[#Mother filters|Mother filters]]

*; Events, and Media Category: rules for [[#Citation/source filters|Citation/source filters]], and [[#General_filters|General filters]].

*; Places Category: rules for [[#Citation/source filters|Citation/source filters]], [[#General_filters|General filters]], and [[#Position filters|Position filters]].

*; Geography Category (Only from the filter sidebar/bottombar): rules for [[#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]].

*; 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===
{{stub}}

===Ancestor of the default person not more than <N> generations away===
{{stub}}

===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 two (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 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]]

=== People-, and 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>====
{{stub}}

=== Families Category===

This category includes the following citation and source rules:

====Families with <count> 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>====
{{stub}}

====Events with the <citation>====
Matches events with a citation of a particular value

=== Places Category===

This category includes the following citation and source rules:

====Place with <count> sources====
Matches places with a certain number of items in the source. Values: Number of instances -- Number must be greater than/lesser/equal to

====Place with a direct source >= <confidence level>====
Matches places with at least one direct source with confidence level(s)

====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> 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 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 filter rules are view dependent
* [[#People-.2C_and_Relationships_Category_2|People-, and Relationships Category]]
* [[#Families_Category_2|Families Category]]

=== People-, and 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 the <birth data>====
This rule matches people 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 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 birth. To use just one value, leave the other values empty.

====People with the <death data>====
This rule matches people whose death event matches specified values for 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 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 death. To use just one value, leave the other values empty.

====People with the family <event>====
This rule matches people that have a family 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.

====People with the personal <event>====
This rule matches people 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 event. To use just one value, leave the other values empty.

====Persons with events matching the <event filter>====
Matches persons who have events that match a certain event filter. Values: Event filter name.

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

===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 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 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]]

=== People-, and Relationships Category===

This category includes the following general rules:

====Bookmarked people====
Matches the people on the bookmark list.


====Home person====

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

====People having notes containing <text>====
Matches people whose notes contain text matching a regular expression

====People marked private====
Matches people that are indicated as private.

====People matching the <filter>====
Matches people matched by the specified filter name. Values: Filter name. The specified filter name should be selected from the menu.

====People not marked private====
Matches people that are not indicated as private

====People probably alive====
Matches people without indications of death that are not too old. Values: On Date
{{stub}}

* [[Gramps_5.1_Wiki_Manual_-_Probably_Alive#Probably_Alive_Filter|Probably Alive Filter]]

====People with <count> LDS events====
Matches people with a certain number of LDS events. Values: Number of instances -- Number must be greater than/lesser/equal to

====People with <count> addresses====
Matches people with a certain number of personal addresses. Values: Number of instances -- Number must be greater than/lesser/equal to

====People with <count> associations====
Matches people with a certain number of associations. Values: Number of instances -- Number must be greater than/lesser/equal to

====People with <count> media====
Matches people with a certain number of items in the gallery. Values: Number of instances -- Number must be greater than/lesser/equal to

====People with id containing <text>====
Matches people whose Gramps ID matches the regular expression

====People with a nickname====
Matches people with a nickname

====People with an alternate name====
Matches people with an alternate name

====People with incomplete names====
Matches people with first-name or last-name missing.

====People with records containing <substring>====
Matches people whose records contain text matching a substring. Values: Substring -- Case Sensitive or not -- Regular-Expression matching or not

====People with the <Name type>====
Matches people with a type of name

====People with the <Surname origin type>====
Matches people with a surname origin

====People with the <name>====
Matches people with a specified (partial) name. Values: Given Name -- Family Name -- Suffix -- Title -- Prefix -- Patronymic -- Call Name

====People with <tag>====
Matches people with a tag of a particular value. Values: Tag name.

====People with the family <attribute>====
Matches people with the family attribute of a particular 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: Family Attribute: Identification Number -- Age ...

====People with the personal <attribute>====
Matches people with the personal attribute of a particular 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 unknown gender====
Matches all people with unknown gender.

====People without a known birth date====
Matches people without a known birth date.

====People without a known death date====
Matches people without a known death date.

====People with <id>====
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 made.

====People changed after <date time>====
Matches person records changed during a particular time period. Used to identify records that were imported or modified during particular work-sessions.

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 date range, if a second date-time is given.

Values:
Changed after:
but before:

Values must be after January 1st, 1970 at UTC. Future dates until <code>3001-01-01 01:59:59</code> are valid.

The {{man menu|People changed after <date time>}} filter rules are available in the {{man menu|General filters}} section for custom rules in the People, Relationships, Charts, and Geography views.

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 the <name>====
{{stub}}

=== Families Category===

This category includes the following general rules:

====Ancestor families of <family>====
{{stub}}

====Bookmarked families====
Matches the families on the bookmark list.

====Descendant families of <family>====
{{stub}}

====Every family====
Matches every family in the database.

====Families changed after <date time>====
Matches families 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:.

====Families having <count> 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====
Matches families that are indicated as private.

====Families matching the <filter>====
Matches families matched by the specified filter name. Values: Filter name. The specified filter name should be selected from the menu.

====Families with <count> LDS events====
Matches families with a certain number of LDS events. Values: Number of instances -- Number must be greater than/lesser/equal to

====Families with <count> media====
Matches families with a certain number of items in the gallery. Values: Number of instances -- Number must be greater than/lesser/equal to

====Families with id containing <text>====
Matches families whose Gramps ID matches the regular 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 <data>====
Matches events with data of a particular value

====Events with 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 <Id>====
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 (yyyy-mm-dd hh:mm:ss) or in the range, if a second date-time is given: Values: Changed after: -- but before:.

====Places enclosed by another place====
{{stub}}

====Places having <count> notes====
Matches places having a certain number of notes: Values: Number of instances -- Number must be greater than/lesser/equal to

====Places having notes containing <text>====
Matches places whose notes contain text matching a regular expression

====Places marked private====
Matches places that are indicated as private.

====Places matching a title====
Matches places with a particular title

====Places matching parameters====
Matches places with particular parameters

====Places matching the <filter>====
Matches places matched by the specified filter name. Values: Filter name. The specified filter name should be selected from the menu.

====Places of events matching the <event filter>====
Matches places where events happened that match the specified event filter name

====Places with <count> media====
Matches places with a certain number of items in the gallery. Values: Number of 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.

====Source with <Id>====
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 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 <Id>====
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 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 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 <Id>====
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 objects changed after <date time>====
Matches media object 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:.

====Media objects having notes containing <text>====
Matches media objects whose notes contain text matching a regular expression

====Media objects marked private====
Matches media objects that are indicated as private.

====Media objects matching parameters====
{{stub}}

====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 <text>====
Matches media objects whose Gramps ID matches the regular expression

====Media objects with a reference count of <count>====
Matches media objects with a certain number of references. Values: 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 <Id>====
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 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 ==

This rule category finds families having mothers that match the rule:

===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===
{{stub}}

== Source filters ==

This rule category finds Citations that match the rule:

===Citation with Source <Id>===
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}}

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

Go to the Menu {{man menu|Edit ->Tag}}.

[[File:Menu-Edit-Tag-Options-50.png|thumb|right|300px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Tag actions from Edit menu]]

{{-}}

Or click the Toolbar [[File:16x16-gramps-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]]
{{-}}
See also [[Gramps_5.1_Wiki_Manual_-_Reports_-_part_6#Tag_Report|Tag Report]]
{{-}}
===New Tag dialog===
[[File:NewTag-dialog-ShowingMultipleListSelection-example-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Attaching a "New Tag" to multiple list entry selections - example with "New Tag" dialog]]

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

{{-}}
===== Tagging a selection of objects =====


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_-_Categories#People_Category|Person View]], and add them a new tag or an existing one.
{{-}}

===Organize Tags Window===

[[File:MenuEditTag-OrganizeTags-dialog-example-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Organize Tags - dialog - example]]

The order in the {{man label|Organize Tags}} dialog defines the priority for coloring rows in the category views.

{{stub}}
{{-}}

===Tag selection dialog===
[[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-gramps-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.
{{-}}

=== Usage of tags ===

Here are a some ideas of operations that can be done with tags

==== Filtering ====

[[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]]

The most obvious use is that of filtering.
* Tags and filters both create subsets of the tree. However they have practical differences in usage.

Specifying your fathers family using filters is an easy thing; there are already filters based on some logic's that do it. On the other hand, specifying the people that emigrated to the USA is harder, while for the famous people in your family it is simply impossible as there is no logical rule. Tags are much more practical here.

However filters have the advantage of being '''dynamical'''. If you add an ancestor of your father in the database, it will be automatically added to the filter.

On the other hand, tags are '''static'''. When adding a famous person in the tree, you have to explicitly tag them as ''FAMOUS''.

* The most immediate object that comes to mind are the individuals, and that is also the most useful. However, other objects could be tagged:
** Places: For example "places to visit",
** Source: For example "sources in german",
** Notes: For example "notes in progess", or "notes in german",
** Media: For example "Picture belonging to Uncle Alfred".

Tags are available to use with '''all primary objects'''.
{{-}}

==== Tags Column ====

[[File:PeopleListView-ExampleTagColoredRows-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} People (List) View - Showing "Tag" column and colored tag rows - example]]

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)

{{-}}
{{man index|Gramps 5.1 Wiki Manual - Settings|Gramps 5.1 Wiki Manual - FAQ|5.1}}
{{languages|Gramps_5.1_Wiki_Manual_-_Filters}}
{{grampsmanualcopyright}}

[[Category:Documentation]]
[[Category:Filters]]

Gramps 5.1 Wiki Manual - Settings

2019-12-20T04:16:08Z

Adrian Davey: /* Display */

{{man index|Gramps 5.1 Wiki Manual - Tools|Gramps 5.1 Wiki Manual - Filters|5.1}}
{{languages|Gramps_5.1_Wiki_Manual_-_Settings}}
{{#vardefine:chapter|13}}
{{#vardefine:figure|0}}
This section deals with various settings you can manage within Gramps.

== Preferences ==
[[File:EditPreferencesTabsOnly-overview-51.png|right|thumb|650px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Overview of all Preferences tabs]]

Most of the settings in Gramps are configured in the {{man label|Preferences}} dialog. To invoke it, select the menu {{man menu|Edit ->Preferences...}}.

The tabs on the top display the available option categories as follows:
*{{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#General|General]]}}
*{{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Family_Tree|Family Tree]]}}
*{{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Display|Display]]}}
*{{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Text|Text]]}}
*{{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#ID_Formats|ID Formats]]}}
*{{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Dates|Dates]]}}
*{{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Researcher|Researcher]]}}
*{{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Warnings|Warnings]]}}
*{{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Colors|Colors]]}}
*{{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Genealogical Symbols|Genealogical Symbols]]}}

Also ''other'' additional tabs maybe shown from any [[5.1_Addons#Addon_List|addons]] you may have installed.
{{-}}
=== General ===

[[File:EditPreferences-General-tab-example-51.png|Right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} General Preferences (Linux)]]

This tab contains two sections containing preferences relevant to the general operation of the program. Sections and options are:

==== General Gramps settings ====
*[ ]{{man label|Add default source on GEDCOM import}}: This checkbox option affects the importing of [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#GEDCOM_import|GEDCOM data]]. If this is set, each item that is imported will contain a [[Gramps_Glossary#source|Source]] reference to the imported file. '''Note - Adding a default source can significantly slow down the importing of your GEDCOM data.'''
*[ ]{{man label|Add tag on import}}: Checkbox (Default: <code>Imported %Y/%m/%d %H:%M:%S</code> ) '''Note - Adding a [[Gramps_Glossary#tag|Tag]] on import can significantly slow down the importing of your data.'''
*[ ]{{man label|Enable spelling checker}}: This checkbox option controls the enabling and disabling of the spelling checker for notes. The '''gtkspell''' package must be loaded for this to have an effect.
*{{checkbox|0}}{{man label|Display Tip of the Day}}: This checkbox option controls the enabling and disabling of the {{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Tip_of_the_Day_dialog|Tip of the Day]]}} dialog at startup.
*{{checkbox|0}}{{man label|Remember last view displayed}}: This checkbox option controls the enabling and disabling of the the display of the last [[Gramps_Glossary#view|View]]. Enabling will bring you to the view where you stopped the program the last time.
*{{man label|Max generations for relationships:}} You can enter the number of generations used to determine relationships. The default value is '''<code>15</code>'''.
*{{man label|Base path for relative media paths:}} Here you can fill in a base path for the media objects. Selecting the {{man button|Directory}} button gives you a {{man label|Select media directory}} editor where you can fill in the required path.

==== Third party addons management ====
*{{man label|Check for addon updates:}} Select the frequency that Gramps checks for updates to [[5.1_Addons#Installing_Addons_in_Gramps|Addons]]. Default: ''Never''
*{{man label|What to check:}} Default: ''New addons only''
*{{man label|Where to check:}} Default: <code>https://raw.githubusercontent.com/gramps-project/addons/master/gramps51</code>
*{{checkbox|1}}{{man label|Do not ask about previously notified addons}}: Checkbox selected by default
*{{man button|Check for updated addons now}}: Button to force a check for Addons, if Addons are available you will then be presented the {{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Available_Gramps_Updates_for_Addons|Available Gramps Updates for Addons]]}} window where you choose and install them from.
{{-}}

======Available Gramps Updates for Addons======
[[File:AvailableGrampsUpdatesforAddons-example-listing-50.png|Right|thumb|550px|"Available Gramps Updates for Addons" window showing example listing output for Gramps 5.1]]

The {{man label|Available Gramps Updates for Addons}} window you will be shown a list broken down by '''Type''' that you can view by selecting the "Select" column expand out each "Type".
* You can then select the check box of those Addons you want to install.
* Then select the {{man button|Install Selected Addons}} button to download those Addons from the ''Internet''.
* Once downloaded from the {{man label|Done downloading and installing addons}} dialog select the {{man button|Close}} button
* From the {{man label|Preferences}} dialog select {{man button|Close}} button.
* To use the Addons you need to {{man menu|Family Trees>Quit}} and restart Gramps.

{{-}}

====Tip of the Day dialog====

[[File:TipOfTheDay-dialog--example-keeping-good-records-50.png|Right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Tip of the Day dialog]]

When enabled in {{man menu|Edit > Preferences}} {{man label|General}} tab the {{man label|Tip of the Day}} dialog shows helpful hints.

The following options are available:
*{{checkbox|1}} {{man label|Display on startup}} (check box checked by default - once enabled) - uncheck to stop further tips appearing.
*{{man button|Forward}} - Advance to the next tip.
*{{man button|Close}} - exit for this session until the Gramps program is restarted.
{{-}}

=== Family Tree ===
{{stub}}
[[File:EditPreferences-FamilyTree-tab-example-51.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menu: {{man menu|Edit>Preferences...}} - "Family Tree" - tab - example - defaults]]

This tab contains preferences relevant to the '''Family Tree Database settings and Backup management'''.

*{{man label|Database backend:}} -
** ''BSDDB'' - Legacy Database backend.
** '''SQLite''' (default) - the [[DB-API Database Backend]]
*{{man label|Host:}} -
*{{man label|Port:}} -
*{{man label|Family Tree Database path:}} The default path where the Databases are stored is '''home directory<code>/.gramps/grampsdb</code>'''. Unless you absolutely want to change this, stay with the default path. This path will be located in the relevant Operating Systems [[Gramps_5.1_Wiki_Manual_-_User_Directory|User Directory]].
*{{checkbox|0}}{{man label|Automatically load last family tree}}: This checkbox option controls the enabling and disabling of the loading on start up of the last used database.
*{{man label|Backup path:}} -
*{{checkbox|1}}{{man label|Backup on exit}}
*{{man label|Autobackup:}} -
** '''Never''' (default)
** ''Every 15 minutes''
** ''Every 30 minutes''
** ''Every hour''
{{-}}

See also:
* Addon [[PostgreSQL]] - this adds support for PostgreSQL databases.

=== Display ===
{{stub}}
[[File:EditPreferences-Display-tab-default-51.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menu: "Edit>Preferences..." - "Display" - tab - defaults]]

This tab contains preferences relevant to the display of data and names, '''Appearance and format settings'''. Options are:

*{{man label|Name format:}} This option controls the display of names in the current database (the setting is saved in the database and is not system wide). In Gramps there are two type of name display formats: the predefined formats, and the user defined custom formats. Several different predefined name formats are available: Given - Prefix Patronymic, Suffix Given - Prefix Surname, Given Patronymic Suffix etc.
** Clicking on the right hand side {{man button|Edit...}} button will bring up a {{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Display_Name_Editor|Display Name Editor]]}} window where the available list of options is shown. The format is given as well as an example. When predefined formats are not suitable one can define one's own format. You can use the {{man button|Add}} button to add a Name format to the list. Clicking once will give you a '''SURNAME,Given Suffix(call)''' format and as example : '''SMITH, Edwin Jose Sr (Ed)'''. If you added new name formats to the list the {{man button|Remove}} and {{man button|Edit}} buttons become available to change the name format list.
***{{checkbox|0}}{{man label|Consider single pa/matronymic as surname}}: Checkbox unselected by default. If selected enables Gramps to consider patronymic and matronymic names as surnames.

{{man note|1=Note|2=Besides this database-wide setting Gramps allows you to decide the name display format individually for every single name via the {{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Display_Name_Editor|Display Name Editor]]}} dialog}}

*{{man label|Date format:}} This option controls the display of dates. It is a global setting, requiring a restart of Gramps to take effect, and applies to the display of dates in all databases loaded within Gramps until such time as the date display format is changed again. Several different formats are available, which may be dependent on your locale. {{man menu|Please note once changed it is necessary to restart Gramps to view the new date display format}}
** '''YYYY-MM-DD (ISO)''' (Default)
** Numerical
** Month Day, Year
** MON DAY, YEAR
** Day Month Year
** DAY MON YEAR

*{{man label|Place format(auto place title:}} This option controls the display of places.
** '''Full''' (Default)
*** Selecting the {{man button|Edit...}} button will show the {{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Place_Format_Editor|Place format editor]]}}

*{{man label|Age display precision(requires restart):}}
** '''Years'''(default)
** Years, Months
** Years, Months, Days
{{man warn|Reported Bug in version 5.1|Changes made in the "Age Display Precision" in the Preferences Display tab cannot be saved in this version of Gramps. A manual workaround is detailed in the Bug Report. ''See'' bug report {{Bug|11384}}.}}

*{{man label|Calendar on reports:}} '''Gregorian'''(default). This option controls the display of calendar on reports, tools, gramplets, views. Several different calendars are available (see [[Gramps_5.1_Wiki_Manual_-_Entering_and_Editing_Data:_Detailed_-_part_1#Editing_dates|Date Edition]]). Two dates with two different calendars will not properly display timeline or period, (e.g. Using the Gregorian calendar as the default displayed calendar, users will have a better coherency for displaying dates on period).

*{{man label|Surname Guessing:}} This option affects the initial family name of a child when he/she is added to the database. The default {{man label|Father's surname}} will use the family name of the father. Selecting {{man label|None}} means that no surname guessing will be attempted. Selecting {{man label|Combination of mother's and father's surname}} will use the father's name followed by the mother's name. Finally, {{man label|Icelandic style}} will use the father's given name followed by the "sson" suffix (e.g. the son of Edwin will be guessed as Edwin''sson'').

{{man tip|1=Tip |2=The {{man label|Surname Guessing:}} option only affects the initial family name guessed by Gramps when the {{man label|Edit Person}} dialog is launched.
You can modify that name the way you see fit. Set this option to the value that you will most frequently use, as it will save you a lot of typing.}}

*{{man label|Default family relationship:}}
** '''Unknown'''(default)
** Married
** Unmarried
** Civil Union

*{{man label|Height multiple surname box(pixels):}} Default:'''150'''

*{{man label|Status bar:}} This option controls the information displayed in the status bar. This can be either the '''Active person's name and ID'''(default) or '''Relationship to home person'''.

*{{checkbox|1}}{{man label|Show text label beside Navigator buttons (requires restart)}} ''checked'' (default) This checkbox controls whether or not a text description is displayed next to the icon in the [[Gramps_5.1_Wiki_Manual_-_Main_Window#Navigator|Navigator]] in the [[Gramps_5.1_Wiki_Manual_-_Main_Window#Main_Window|Main Window]]. This option takes effect after the program has been restarted.

*{{checkbox|0}}{{man label|Show close button in gramplet bar tabs}} ''unchecked''(default)

====Display Name Editor====

{{man note|1=Note|2=Custom name display formats are stored in the Family Trees, thus before loading any Family Tree the {{man label|Custom format details}} expander is disabled.}}

[[File:EditPreferences-Display-tab-DisplayNameEditor-dialog-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Display Name Editor - dialog (example) from Menu: "Edit>Preferences..." - "Display" - tab]]

The following keywords are replaced with the appropriate name parts:
* Given - given name (first name)
* Title - title (Dr., Mrs.)
* Call - call name
* Initials - first letters of Given
* Primary, Primary[pre] or [sur] or [con]- full primary surname, prefix, surname only, connector
* Patronymic, or [pre] or [sur] or [con] - full pa/matronymic surname, prefix, surname only, connector
* Familynick - family nick name
* Rest - non primary surnames
* Rawsurnames- surnames (no prefixes and connectors)
* Surname - surnames (with prefix and connectors)
* Suffix - suffix (Jr., Sr.)
* Nickname - nick name
* Common - nick name, otherwise first of Given
* Prefix - all prefixes (von, de)
* Notpatronymic- all surnames, except pa/matronymic & primary

{{man menu|UPPERCASE versions of these keywords forces uppercase to be displayed.}} Extra parentheses, commas are removed. Other text appears literally.

Example: 'Dr. Edwin Jose von der Smith and Weston Wilson Sr ("Ed") - Underhills' Edwin Jose is given name, von der is the prefix, Smith and Weston surnames, and a connector, Wilson patronymic surname, Dr. title, Sr suffix, Ed nick name, Underhills family nick name, Jose callname.
{{-}}

{{stub}}

==== Place Format Editor ====
{{stub}}
{{man note|Feature - introduced in Gramps 4.1|[[Hierarchical Place Structure]]}}

[[File:EditPreferences-Display-tab-PlaceFormatEditor-dialog-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Place Format Editor - dialog (example) from Menu: "Edit>Preferences..." - "Display" - tab]]

Accessed from the [[Gramps_5.1_Wiki_Manual_-_Settings#Display|Display]] tabs Place Format option.

This tab contains preferences relevant to how Places should be shown.

*{{man label|Name:}} A unique name for the place format.
*{{man label|Levels:}} The place names to be displayed.
Each level in the hierarchy is represented by a positive integer, starting with 0 for the selected place and increasing by 1 for each level up the hierarchy. The levels can also be represented by negative integers, starting with -1 for the top level (usually a country) and decreasing by 1 for each level lower in the hierarchy. In addition, the populated place (city, town, village or hamlet) is represented by the letter p; this can be used with an offset (e.g. p+1 or p-2).

The names to be displayed are defined as a comma-separated list of ranges. A range can either be a single level, or a start level and an end level separated by a colon. The start level must be less than the end level in a range. The start and end levels default to 0 and -1 if missing.

*{{man label|Street format:}} "None" (Default), "Number Street" or "Street Number". Option to concatenate the number and street in order to suppress the comma. For this option to work, the street must have the [[Gramps_5.1_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_2#Place_Editor_dialog|'''Type''']] ''Street'' and house number must have the '''Type''' ''Number''.
*{{man label|Language:}} (Empty by Default) A two-digit language code.
*{{checkbox|0}} {{man label|Reverse display order}} (checkbox unchecked by default)

See also:
* [[Gramps_5.1_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_2#Place_Editor_dialog|Place Editor dialog]]
* [[Gramps_5.1_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_2#Place_Name_Editor_dialog|Place Name Editor dialog]]
{{-}}

=== Text ===

[[File:EditPreferences-Text-tab-default-51.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menu: "Edit>Preferences..." - "Text" - tab - defaults]]

This tab contains preferences relevant to how missing and private names and records should be shown.

*{{man label|Missing surname:}} in the input field you can determine how a missing surname should be displayed. Default value is '''<code>[Missing Surname]</code>'''. You can change this to [--] or whatever is most convenient for you.
*{{man label|Missing given name}} in the input field you can determine how a missing given name should be displayed. Default value is '''<code>[Missing Given Name]</code>'''. You can change this to whatever you want.
*{{man label|Missing record:}} Default: <code>[Missing Record]</code>
*{{man label|Private surname:}} Default: <code>[Living]</code>
*{{man label|Private given name:}} Default: <code>[Living]</code>
*{{man label|Private record:}} Default: <code>[Private Record]</code>
{{-}}

=== ID Formats ===

{{man tip|ID Prefixes |The ID prefixes use formatting conventions common for C, Python, and other programming languages. For example, the <code>%04d</code> expands to an integer, prepended with zeros to have the total width of four digits. If you would like IDs to be 1, 2, 3, etc., simply set the formatting parameter to <code>%d</code>, the 'd' specifies Decimal Integer, outputting the number in base 10. See: Python [https://docs.python.org/3/library/string.html#format-specification-mini-language (String) Format Specification Mini-Language]}}

[[File:EditPreferences-IDFormats-tab-default-51.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menu: "Edit>Preferences..." - "ID Formats" - tab - defaults]]

This tab contains preferences relevant to the automatic generation of Gramps IDs.

*{{man label|Person:}} Provides the template for generating IDs for a Person. Default value: <code>I%04d</code>
*{{man label|Family:}} Provides the template for generating IDs for a Family. Default value: <code>F%04d</code>
*{{man label|Place:}} Provides the template for generating IDs for a Place. Default value: <code>P%04d</code>
*{{man label|Source:}} Provides the template for generating IDs for a Source. Default value: <code>S%04d</code>
*{{man label|Citation:}} Provides the template for generating IDs for a Citation. Default value: <code>C%04d</code>
*{{man label|Media Object:}} Provides the template for generating IDs for a Media Object. Default value: <code>O%04d</code>
*{{man label|Event:}} Provides the template for generating IDs for an Event. Default value: <code>E%04d</code>
*{{man label|Repository:}} Provides the template for generating IDs for a Repository. Default value: <code>R%04d</code>
*{{man label|Note:}} Provides the template for generating IDs for a Note. Default value: <code>N%04d</code>

You can use the [[Gramps_5.1_Wiki_Manual_-_Tools#Reorder_Gramps_ID|Reorder Gramps ID]] tool to change the format.
{{-}}

=== Dates ===

[[File:EditPreferences-Dates-tab-default-51.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menu: "Edit>Preferences..." - "Dates" - tab - defaults]]

Date settings used for calculation operations.

*{{man label|Markup for invalid date format:}} Default: <code>%s</code>
** Convenience markups are:
*** Bold (Default)
*** <big><big>Makes font relatively larger</big></big>
*** Italic
*** <s><s>Strikethrough</s></s>
*** Subscript
*** Superscript
*** Makes font relatively smaller
*** <tt><tt>Monospace font</tt></tt>
*** Underline
**** For example: %s will display Underlined bold date.
*{{man label|Date about range:}} Default: <code>50</code>
*{{man label|Date after range:}} Default: <code>50</code>
*{{man label|Date before range:}} Default: <code>50</code>
*{{man label|Maximum age probably alive:}} Default: <code>110</code>
*{{man label|Maximum sibling age difference:}} Default: <code>20</code>
*{{man label|Minimum years between generations:}} Default: <code>13</code>
*{{man label|Average years between generations:}} Default: <code>20</code>
{{-}}
See also:
* [[Gramps 5.1 Wiki Manual - Probably Alive]]
* [[Gramps_5.1_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_1#Editing_dates|Editing dates]]
{{-}}

=== Researcher ===

[[File:EditPreferences-Researcher-tab-default-51.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menu: "Edit>Preferences..." - "Researcher" - tab - defaults]]

Allows you to {{man label|Enter your information so people can contact you when you distribute your Family Tree}} in the corresponding text entry fields. Although Gramps requests information about you, this information is used only so that Gramps can create valid GEDCOM output files. A valid GEDCOM file requires information about the file's creator. If you choose, you may leave the information empty, however none of your exported GEDCOM files will be valid.

The available text entry fields are (by default all fields are blank):
*{{man label|Name:}}
*{{man label|Address:}}
*{{man label|Locality:}}
*{{man label|City:}}
*{{man label|State/County:}}
*{{man label|Country:}}
*{{man label|ZIP/Postal Code:}}
*{{man label|Phone:}}
*{{man label|Email:}}

The information entered under this preference acts as default value for family tree specific values that can be adjusted with the [[Gramps_5.1_Wiki_Manual_-_Tools#Edit_Database_Owner_Information|Edit Database Owner Information]] tool.
{{-}}

=== Warnings ===

[[File:EditPreferences-Warnings-tab-default-51.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menu: "Edit>Preferences..." - "Warnings" - tab - defaults]]

This tab controls the display of warning dialogs, allowing the re-enabling of dialogs that have been disabled.

*{{checkbox|1}}{{man label|Suppress warning when adding parents to a child.}} Checkbox checked by Default (See [[Gramps_5.1_Wiki_Manual_-_Error_and_Warning_Reference#Suppress_warning_when_adding_parents_to_a_child|Dialog]])
*{{checkbox|0}}{{man label|Suppress warning when cancelling with changed data.}} Checkbox unchecked by Default (See [[Gramps_5.1_Wiki_Manual_-_Error_and_Warning_Reference#Suppress_warning_when_cancelling_with_changed_data|Dialog]])
*{{checkbox|0}}{{man label|Suppress warning about missing researcher when exporting to GEDCOM.}} Checkbox unchecked by Default (See [[Gramps_5.1_Wiki_Manual_-_Error_and_Warning_Reference#Suppress_warning_about_missing_researcher_when_exporting_to_GEDCOM|Dialog]])
*{{checkbox|0}}{{man label|Show plugin status dialog on plugin load error.}} Checkbox unchecked by Default (See [[Gramps_5.1_Wiki_Manual_-_Error_and_Warning_Reference#Module_not_loaded_warnings|Dialog]])

See the [[Gramps_5.1_Wiki_Manual_-_Error_and_Warning_Reference|Error and Warning Reference]] page for examples.
{{-}}

=== Colors ===

[[File:EditPreferences-Colors-tab-default-51.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menu: "Edit>Preferences..." - "Colors" - tab - defaults]]

This tab allows you to '''Set the colors used for boxes in the graphical views'''
{{stub}}
{{-}}
==== Pick a Color selector ====

[[File:PickAColor-selector-dialog-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Pick a Color" - selector dialog]]

Select a color from the color pallet area, or select the {{man label|Custom}} {{man button|+}} button to create your own color either via direct 'color Hex color code'; the slider or mouse click.
{{-}}

=== Genealogical Symbols ===

{{man tip|Note|The Genealogical Symbols tab can only be used if the prerequisite program <code>[[Gramps_5.1_Wiki_Manual_-_Settings#Prerequisite_to_use_Genealogical_Symbols|python-fontconfig]]</code> is present that Gramps can use.}}

[[File:EditPreferences-GenealogicalSymbols-tab-activated-51.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Genealogical Symbols" - Preferences tab - activated defaults]]

Allows you to use Genealogical symbols instead of text abbreviations in reports, charts and the Gramps interface.

This tab gives you the possibility to use one font which is able to show all genealogical symbols. (Once configured see: [[Gramps_5.1_Wiki_Manual_-_Settings#Prerequisite_to_use_Genealogical_Symbols|Prerequisite to use Genealogical Symbols]])

If you select the "use symbols" checkbox, Gramps will use the selected font if it exists.

This can be useful if you want to add phonetic in a note to show how to pronounce a name or if you mix multiple languages like Greek and Russian.

You can only configure the death symbol from this tab.

:List of Genealogical Symbols shown (listed in order shown at bottom screenshot):

* Female
* Male
* Asexuality, sexless, genderless
* Lesbianism
* Male homosexuality
* Heterosexuality
* Transgender, hermaphrodite (in entomology)
* Transgender
* Neuter

* Illegitimate
* Birth
* Baptism/Christening
* Engaged
* Marriage
* Divorce
* Unmarried partnership
* Buried
* Cremated/Funeral urn
* Killed in action
* Extinct

* Death

{{-}}

{{-}}
====Prerequisite to use Genealogical Symbols====

[[File:EditPreferences-GenealogicalSymbols-tab-default-51.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Genealogical Symbols" - Preferences tab - defaults]]

=====Initial setup=====

If the fontconfig [[Gramps_5.1_Wiki_Manual_-_Settings#Prerequisite|prerequisite has been installed]], then on the {{man label|Genealogical Symbols}} tab select the {{man button|Try to find}} button, Gramps will attempt to detect any suitable unicode text fonts that can be used.

When the search has completed select one of the fonts from the {{man button|Choose font}} list and then select the checkbox:

{{checkbox|1|Use symbols}}
=====Prerequisite=====
Prerequisite : '''fontconfig''' : Python bindings of fontconfig are required for displaying genealogical symbols
{{man note|Use the [[Addon:Prerequisites_Checker_Gramplet|Prerequisites Checker]]|Do you have <code>fontconfig</code> installed? Run the Prerequisites Checker Addon and look for something similar to the following line:<pre>* python-fontconfig 0.5.0 (Success version 0.5.x is installed.)</pre>}}

See also:
* [[GEPS 039: Genealogical symbols in gramps]]
* Feature request: {{bug|9098}} Gramps should be able to use genealogy symbols everywhere.
* lookup table located in [https://github.com/gramps-project/gramps/blob/maintenance/gramps51/gramps/gen/utils/symbols.py gramps\gen\utils\symbols.py]
{{-}}

== Other settings ==

Besides {{man label|Preferences}} dialog, there are other settings available in Gramps. For various reasons they have been made more readily accessible, as listed below.

===Column Editor===

{{man tip|1=Column Editor|2=The {{man label|Column Editor}} is available and works in the same way for all list views. Specifically, it is available for People View, Family View (children list). Sources View, Citations View, Places View, Media View, Repositories View and the Notes View.}}

[[File:ColumnEditor-dialog-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Column Editor - Dialog - example]]

The columns of the list views may be added, removed, or reordered in a {{man label|Column Editor}} dialog. To use the {{man label|Column Editor }} dialog, choose via the menu {{man menu|View ->Configure View...}} or click on toolbar {{man button|Configure View...}} button. Only checked columns will be shown in the view. You can also change the position of a column in People View by clicking and dragging it to a new position in the Editor ([http://en.wikipedia.org/wiki/Drag-and-drop ''drag and drop'']). Once you have made the changes you want click {{man button|Apply}}, then click {{man button|OK}} to exit the Editor and see your changes in the View.

By default, the View List, displays several columns of information about the respective category. You can add or remove columns to and from the display

The default sort key for the view [always ascending] is the left-most field [i.e. at the top in the Column Editor], so changing which field is in that position affects default sorting.
{{-}}

=== Sorting columns ===

[[File:PeopleCategory-PeopleListView-SortedByBirthDateColumn-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Sorted by "Birth Date" column in People(List)View - People Category - example]]

Clicking once sorts in ascending order, clicking again sorts in descending order. The {{man label|Column Editor}} dialog can be used to add, remove and rearrange the displayed columns, or to change the default sorting of the view [though always ascending].
{{-}}

===Setting Home person===

[[File:MenuEdit-SetHomePerson-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menu showing ''Set Home Person'']]

To set the [[Gramps_Glossary#home_person|Home person]], select the People Category and make the desired person active and then choose via the menu {{man menu|Edit ->Set Home Person}}.

Also, when editting any Person, right-clicking on inactive areas (areas without a text-entry box) of the top section displays a pop-up menu which includes an option to {{man menu|Make Home Person}} of that profile.

The Home person is the default person who becomes active when one of the following occurs:
*the Family tree database is opened (The [[Gramps_5.1_Wiki_Manual_-_Settings#General_Gramps_settings|General]] setting in [[Gramps_5.1_Wiki_Manual_-_Settings#Preferences|Preferences]] can modify this default behavior. The "Remember last view displayed" will return to the last Active Person of the previous session.)
*when the toolbar {{man button|Home}} button is clicked
*the Home menu item is selected from either the {{man button|Go}} menu or the right-click context menu in selected views
*the [[Gramps_5.1_Wiki_Manual_-_Keybindings#15|keybinding]] {{Man key press|ALT|Home}} is used to return to the '''Home Person'''.

The toolbar {{man button|Home}} button is available in the People Category, Relationships Category, and Pedigree Category.

* [[Gramps_5.1_Wiki_Manual_-_Navigation#Setting_the_Home_Person|Setting the Home Person]]
{{-}}

===Adjusting viewing controls===

Whether the toolbar, the sidebar, or the filter (not available on Pedigree and Relationships Views) are displayed in the main window is adjusted through the View menu.

In the different views clicking the {{man menu|[[Gramps_5.1_Wiki_Manual_-_Navigation#View|View]]}} menu will shows for boxes you can click:
*Navigator
*Toolbar
*Sidebar
*Bottombar
*Full Screen {{man key press|F11}}

Additionally, depending on the view you are in, other options will be available on {{man label|Configure}}.

*Gramplets:
**Set Columns to 1
**Set Columns to 2
**Set Columns to 3
*Relationships:
**Show Siblings
**Show Details
*Geography:
**Time period
**Layout

All other Views: the [[Gramps_5.1_Wiki_Manual_-_Settings#Column_Editor|column editor]].

===Export View===

[[File:Menubar-FamilyTrees-overview-example-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menubar - "Family Trees" - overview example showing "Export View" menu entry]]

On most Category List Views, displayed data maybe be exported, choose via the [[Gramps_5.1_Wiki_Manual_-_Navigation#Main_Menus|menu]] {{man menu|Family Trees ->Export View...}}.

Menu only appears on most Views, if the displayed data can be exported. Gramps will export data on screen according your choice: '''CSV''' or '''Open Document''' spreadsheet format.
{{-}}
====Export View as Spreadsheet dialog====

[[File:ExportViewAsSpreadsheet-CSV-file-dialog-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Export View as Spreadsheet" CSV(default) file-dialog - example]]

Gramps will then display the {{man label|Export View as Spreadsheet}} dialog where after choosing a file location to save to and a name for your file; export data on from the Category List View in one of two spreadsheet formats:
* '''CSV''' (default)
* '''OpenDocument Spreadsheet''' - ODS format.

{{-}}
[[File:ExportViewAsSpreadsheet-exampleODS-Displayed-in-LibreOfficeCalc-50.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Example ODS Spreadsheet - Displayed in LibreOffice Calc]]

The example screenshot shows an export to the '''OpenDocument Spreadsheet''' (ODS format) displayed as a Spreadsheet in Libreoffice Calc.

{{-}}

===Modularity and plugins===

See [[Gramps_5.1_Wiki_Manual_-_Plugin_Manager|Plugin Manager]] and [[5.1 Addons|Third-Party Addons]].
{{-}}

===Customize report output formats===
[[File:TextReports-DocumentOptions-PlainText-output-settings-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Document Options - tab defaults for Text Reports (Plain Text - output selected) example]]

What does it do? It allows you to change the fonts, font sizes, font color, background color of the text and alignment of paragraphs on the report.

For most report dialogs in the top part are options related that specific report and in the lower part you will see the {{man label|[[Gramps_5.1_Wiki_Manual_-_Reports_-_part_6#Document_Options|Document Options]]}} section.

From the {{man label|Style:}} drop down list you can choose an existing custom style. Or to make your own {{man label|Style:}} select the {{man button|Style Editor...}} button to show the {{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Document_Styles_dialog|Document Styles]]}} dialog and then select the {{man button|Add a new style}} button to show the {{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Style_editor_dialog|Style editor]]}} dialog.

{{stub}}
{{-}}
====Document Styles dialog====

[[File:DocumentStyles-dialog-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Document Styles - dialog - default]]

The {{man label|Document Styles}} dialog, list the ''default'' style and any custom styles for that report and allows you to edit or delete any custom styles you have created. Select the {{man button|+ (Add a new style)}} button to show the {{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Style_editor_dialog|Style editor]]}} dialog.
{{-}}

====Style editor dialog====

The {{man label|Style editor}} dialog allow you to customize the document style specific to each report.

Change the {{man label|Style sheet name:}} (<code>New Style</code>default) field to a unique name as it will appear in {{man label|Document Options}} {{man label|Style:}} drop down list.

Once changes for your custom style have been finalized select the {{man button|OK}} button to save the changes or {{man button|Cancel}} to exit.

{{-}}
=====Style editor dialog tabs=====
On the left hand side you will see the {{man label|Style}} column that list the paragraph options specific to that report that you may modify. For example the {{man label|Ahnentafel Report}} shows the style options for AHN-Entry, AHN-Generation and AHN-Title.

On the right hand side are three tabs associated with each style listed in the left hand column:
{{-}}
======Description======

[[File:StyleEditor-dialog-Description-tab-example-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Description options tab - Document Styles - dialog (default styles for Ahnentafel Report) (Gramps 4.2.0 Windows 7) ]]

*{{man label|Description}} : The description describes what each paragraph is all about. For example shown here is the style used for the Ahnentafel Report ( AHN-Entry ).
{{-}}

======Font options======

[[File:StyleEditor-dialog-FontOptions-tab-example-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Font options" tab - "Style Editor" dialog for "Document Styles" (default styles for Ahnentafel Report)]]

*{{man label|Font options}} : Here you can set the {{man label|Type face}} Roman or Swiss, the {{man label|Size}} of the font in pt., the {{man label|Color}} of the font and some {{man label|Options}} like Bold, Italic or Underline.
{{-}}

======Paragraph options======

[[File:StyleEditor-dialog-ParagraphOptions-tab-example-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Paragraph options" tab - "Style Editor" dialog for "Document Styles" (default styles for Ahnentafel Report)]]

*{{man label|Paragraph options}} : Here you set the {{man label|Alignment}}, the {{man label|Background color}}, {{man label|Indentation}}, {{man label|Spacing}} and {{man label|Borders}} of your style.
{{-}}

== Customizing ==
Here are some ways that you can customize Gramps.
=== Preferences ===

See [[Gramps_5.1_Wiki_Manual_-_Settings#Preferences|Preferences]]

=== Language ===

Gramps has been translated into a number of [[Portal:Translators|languages]]. Usually Gramps automatically starts in your local language, as chosen for other applications, but sometimes this may not be right for you.

If you want to run Gramps in other language than English, you must select it during installation process.

Otherwise it will not be available.

More information can be found at [[Download]] page.

{{stub}} '''{{man warn|tbd|Describe for each main platform how the normal language is determined and how the user can [[Howto:Change_the_language_of_reports#Run_Gramps_in_a_different_language|choose a different language]].'''}}

==== Linux ====
{{stub}}

If you want to choose a locale 'variant' for sorting that is not the default variant, then you can start Gramps from the terminal (or console) with a different LC_COLLATE environment. For example, the default sorting (collation) variant for Swedish is "reformed", but you can instead choose "standard" by typing:
export LC_COLLATE="sv_SE.UTF-8@collation=standard"
python Gramps.py

==== Mac OS X ====

For Mac OS X see [[Mac_OS_X:Application_package#Advanced_setup|Advanced setup]] for details on how the language is normally chosen, and how to choose a special, non-default setting for the language, the sorting order or the format of such things as day and month names and number separators.

==== MS Windows ====

===Add Windows OS Menu Item===
To make Gramps work in your selected language (See table below for your language code), complete the following:
* Using your mouse right button click on the "GrampsAIOxx 5.x.x" icon on Desktop and from menu choose: Copy.
* Right click anywhere on Desktop and from menu choose: Paste shortcut
* New icon will be created with name: "GrampsAIOxx 5.x.x (2)"
* Right click on that and from menu choose: Properties
* A new window will open, click on first tab called General and change text from "GrampsAIOxx 5.x.x (2)" to something more descriptive like: "GrampsAIO Danish"
** Click on second tab called Shortcut, change text in first entry called Target from (note path will vary depending on Gramps version used):
***<code>"C:\Program Files(xxx)\GrampsAIOxx-5.x.x\grampsw.exe"</code> to:
***<code>%comspec% /c set LANG=da_DK.UTF-8 && start grampsw.exe"</code>
* Click OK and now when you click on that icon Gramps will start in Danish.

===Change the windows LANG variables===
Another option if you want Gramps to always load in say:French Canadian language, you can go to Windows > System Properties, and add the LANG variable in the user section of the environment variables dialog with the appropriate Value.

The value to add is:
<pre>
Name: LANG
Value: fr_CA.UTF-8
</pre>

===Language codes===
Select from the following table of [[Portal:Translators|languages Gramps]] has been translated into:

{| {{prettytable}}
!Language
!ISO code
!Example
!Notes
|-
| Dutch
| nl_BE.UTF-8
|
|
|-
| English (British)
| en_GB.UTF-8
|
|
|-
| Finnish
| fi-UTF-8
|
|
|-
| French Canadian
| fr_CA.UTF-8
|
|
|-
| Russian
| ru_RU.UTF-8
|
|
|-
|}
*The language codes are two-letter lowercase ISO language codes (such as "da") as defined by [https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes ISO 639-1].
*The country codes are two-letter uppercase ISO country codes (such as "BE") as defined by [https://en.wikipedia.org/wiki/ISO_3166-1 ISO 3166-1].

===Advanced manipulation of settings===
{{stub}}

{{man warn| Warning |The contents of this section is outside the scope of interest of a general user of Gramps. If you proceed with tweaking the options on the low level you may damage your Gramps installation. Be careful. '''YOU HAVE BEEN WARNED!'''}}

Beyond the settings in Preferences, you may also wish to explore the advanced settings.

Gramps uses '''INI keys''' for managing user preferences and program settings these are stored in the file ''gramps.ini'' under ''.gramps'' folder in your home or user directory.

The list has following sub-items:
*'''behavior''': typical Key names are: betawarn, enable-autobackup, use-tips...
*'''database''': related to database settings for the Family Tree.
*'''export''': export and import dirs
*'''interface''': a lot of keys regarding height and width of the different Views: e.g. event-height: 450, event-ref-height: 585, event-ref-width: 728, event-width: 712...
*'''paths''': keys related to recent imported files and dirs
*'''preferences''': keys related to preferences: all the common prefixes , todo -colors..
*'''researcher''': all information regarding the researcher

Example contents of the <code>gramps.ini</code> file:

<pre>
;; Gramps key file
;; Automatically created at 2017/12/30 09:54:12

[behavior]
;;addmedia-image-dir=''
;;addmedia-relative-path=0
;;addons-url='https://raw.githubusercontent.com/gramps-project/addons/master/gramps50'
;;autoload=0
;;avg-generation-gap=20
;;betawarn=0
;;check-for-addon-update-types=['new']
;;check-for-addon-updates=0
;;date-about-range=50
;;date-after-range=50
;;date-before-range=50
...
</pre>

{{-}}
{{man index|Gramps 5.1 Wiki Manual - Tools|Gramps 5.1 Wiki Manual - Filters|5.1}}
{{languages|Gramps_5.1_Wiki_Manual_-_Settings}}
{{grampsmanualcopyright}}

[[Category:Documentation]]

Gramps 5.1 Wiki Manual - Settings

2019-12-19T22:55:41Z

Adrian Davey: /* Display */

{{man index|Gramps 5.1 Wiki Manual - Tools|Gramps 5.1 Wiki Manual - Filters|5.1}}
{{languages|Gramps_5.1_Wiki_Manual_-_Settings}}
{{#vardefine:chapter|13}}
{{#vardefine:figure|0}}
This section deals with various settings you can manage within Gramps.

== Preferences ==
[[File:EditPreferencesTabsOnly-overview-51.png|right|thumb|650px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Overview of all Preferences tabs]]

Most of the settings in Gramps are configured in the {{man label|Preferences}} dialog. To invoke it, select the menu {{man menu|Edit ->Preferences...}}.

The tabs on the top display the available option categories as follows:
*{{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#General|General]]}}
*{{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Family_Tree|Family Tree]]}}
*{{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Display|Display]]}}
*{{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Text|Text]]}}
*{{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#ID_Formats|ID Formats]]}}
*{{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Dates|Dates]]}}
*{{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Researcher|Researcher]]}}
*{{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Warnings|Warnings]]}}
*{{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Colors|Colors]]}}
*{{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Genealogical Symbols|Genealogical Symbols]]}}

Also ''other'' additional tabs maybe shown from any [[5.1_Addons#Addon_List|addons]] you may have installed.
{{-}}
=== General ===

[[File:EditPreferences-General-tab-example-51.png|Right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} General Preferences (Linux)]]

This tab contains two sections containing preferences relevant to the general operation of the program. Sections and options are:

==== General Gramps settings ====
*[ ]{{man label|Add default source on GEDCOM import}}: This checkbox option affects the importing of [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#GEDCOM_import|GEDCOM data]]. If this is set, each item that is imported will contain a [[Gramps_Glossary#source|Source]] reference to the imported file. '''Note - Adding a default source can significantly slow down the importing of your GEDCOM data.'''
*[ ]{{man label|Add tag on import}}: Checkbox (Default: <code>Imported %Y/%m/%d %H:%M:%S</code> ) '''Note - Adding a [[Gramps_Glossary#tag|Tag]] on import can significantly slow down the importing of your data.'''
*[ ]{{man label|Enable spelling checker}}: This checkbox option controls the enabling and disabling of the spelling checker for notes. The '''gtkspell''' package must be loaded for this to have an effect.
*{{checkbox|0}}{{man label|Display Tip of the Day}}: This checkbox option controls the enabling and disabling of the {{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Tip_of_the_Day_dialog|Tip of the Day]]}} dialog at startup.
*{{checkbox|0}}{{man label|Remember last view displayed}}: This checkbox option controls the enabling and disabling of the the display of the last [[Gramps_Glossary#view|View]]. Enabling will bring you to the view where you stopped the program the last time.
*{{man label|Max generations for relationships:}} You can enter the number of generations used to determine relationships. The default value is '''<code>15</code>'''.
*{{man label|Base path for relative media paths:}} Here you can fill in a base path for the media objects. Selecting the {{man button|Directory}} button gives you a {{man label|Select media directory}} editor where you can fill in the required path.

==== Third party addons management ====
*{{man label|Check for addon updates:}} Select the frequency that Gramps checks for updates to [[5.1_Addons#Installing_Addons_in_Gramps|Addons]]. Default: ''Never''
*{{man label|What to check:}} Default: ''New addons only''
*{{man label|Where to check:}} Default: <code>https://raw.githubusercontent.com/gramps-project/addons/master/gramps51</code>
*{{checkbox|1}}{{man label|Do not ask about previously notified addons}}: Checkbox selected by default
*{{man button|Check for updated addons now}}: Button to force a check for Addons, if Addons are available you will then be presented the {{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Available_Gramps_Updates_for_Addons|Available Gramps Updates for Addons]]}} window where you choose and install them from.
{{-}}

======Available Gramps Updates for Addons======
[[File:AvailableGrampsUpdatesforAddons-example-listing-50.png|Right|thumb|550px|"Available Gramps Updates for Addons" window showing example listing output for Gramps 5.1]]

The {{man label|Available Gramps Updates for Addons}} window you will be shown a list broken down by '''Type''' that you can view by selecting the "Select" column expand out each "Type".
* You can then select the check box of those Addons you want to install.
* Then select the {{man button|Install Selected Addons}} button to download those Addons from the ''Internet''.
* Once downloaded from the {{man label|Done downloading and installing addons}} dialog select the {{man button|Close}} button
* From the {{man label|Preferences}} dialog select {{man button|Close}} button.
* To use the Addons you need to {{man menu|Family Trees>Quit}} and restart Gramps.

{{-}}

====Tip of the Day dialog====

[[File:TipOfTheDay-dialog--example-keeping-good-records-50.png|Right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Tip of the Day dialog]]

When enabled in {{man menu|Edit > Preferences}} {{man label|General}} tab the {{man label|Tip of the Day}} dialog shows helpful hints.

The following options are available:
*{{checkbox|1}} {{man label|Display on startup}} (check box checked by default - once enabled) - uncheck to stop further tips appearing.
*{{man button|Forward}} - Advance to the next tip.
*{{man button|Close}} - exit for this session until the Gramps program is restarted.
{{-}}

=== Family Tree ===
{{stub}}
[[File:EditPreferences-FamilyTree-tab-example-51.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menu: {{man menu|Edit>Preferences...}} - "Family Tree" - tab - example - defaults]]

This tab contains preferences relevant to the '''Family Tree Database settings and Backup management'''.

*{{man label|Database backend:}} -
** ''BSDDB'' - Legacy Database backend.
** '''SQLite''' (default) - the [[DB-API Database Backend]]
*{{man label|Host:}} -
*{{man label|Port:}} -
*{{man label|Family Tree Database path:}} The default path where the Databases are stored is '''home directory<code>/.gramps/grampsdb</code>'''. Unless you absolutely want to change this, stay with the default path. This path will be located in the relevant Operating Systems [[Gramps_5.1_Wiki_Manual_-_User_Directory|User Directory]].
*{{checkbox|0}}{{man label|Automatically load last family tree}}: This checkbox option controls the enabling and disabling of the loading on start up of the last used database.
*{{man label|Backup path:}} -
*{{checkbox|1}}{{man label|Backup on exit}}
*{{man label|Autobackup:}} -
** '''Never''' (default)
** ''Every 15 minutes''
** ''Every 30 minutes''
** ''Every hour''
{{-}}

See also:
* Addon [[PostgreSQL]] - this adds support for PostgreSQL databases.

=== Display ===
{{stub}}
[[File:EditPreferences-Display-tab-default-51.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menu: "Edit>Preferences..." - "Display" - tab - defaults]]

This tab contains preferences relevant to the display of data and names, '''Appearance and format settings'''. Options are:

*{{man label|Name format:}} This option controls the display of names in the current database (the setting is saved in the database and is not system wide). In Gramps there are two type of name display formats: the predefined formats, and the user defined custom formats. Several different predefined name formats are available: Given - Prefix Patronymic, Suffix Given - Prefix Surname, Given Patronymic Suffix etc.
** Clicking on the right hand side {{man button|Edit...}} button will bring up a {{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Display_Name_Editor|Display Name Editor]]}} window where the available list of options is shown. The format is given as well as an example. When predefined formats are not suitable one can define one's own format. You can use the {{man button|Add}} button to add a Name format to the list. Clicking once will give you a '''SURNAME,Given Suffix(call)''' format and as example : '''SMITH, Edwin Jose Sr (Ed)'''. If you added new name formats to the list the {{man button|Remove}} and {{man button|Edit}} buttons become available to change the name format list.
***{{checkbox|0}}{{man label|Consider single pa/matronymic as surname}}: Checkbox unselected by default. If selected enables Gramps to consider patronymic and matronymic names as surnames.

{{man note|1=Note|2=Besides this database-wide setting Gramps allows you to decide the name display format individually for every single name via the {{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Display_Name_Editor|Display Name Editor]]}} dialog}}

*{{man label|Date format:}} This option controls the display of dates. Several different formats are available, which may be dependent on your locale. {{man menu|Please note once changed it is necessary to restart Gramps to view the new date display format}}
** '''YYYY-MM-DD (ISO)''' (Default)
** Numerical
** Month Day, Year
** MON DAY, YEAR
** Day Month Year
** DAY MON YEAR

*{{man label|Place format(auto place title:}} This option controls the display of places.
** '''Full''' (Default)
*** Selecting the {{man button|Edit...}} button will show the {{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Place_Format_Editor|Place format editor]]}}

*{{man label|Age display precision(requires restart):}}
** '''Years'''(default)
** Years, Months
** Years, Months, Days
{{man warn|Reported Bug in version 5.1|Changes made in the "Age Display Precision" in the Preferences Display tab cannot be saved in this version of Gramps. A manual workaround is detailed in the Bug Report. ''See'' bug report {{Bug|11384}}.}}

*{{man label|Calendar on reports:}} '''Gregorian'''(default). This option controls the display of calendar on reports, tools, gramplets, views. Several different calendars are available (see [[Gramps_5.1_Wiki_Manual_-_Entering_and_Editing_Data:_Detailed_-_part_1#Editing_dates|Date Edition]]). Two dates with two different calendars will not properly display timeline or period, (e.g. Using the Gregorian calendar as the default displayed calendar, users will have a better coherency for displaying dates on period).

*{{man label|Surname Guessing:}} This option affects the initial family name of a child when he/she is added to the database. The default {{man label|Father's surname}} will use the family name of the father. Selecting {{man label|None}} means that no surname guessing will be attempted. Selecting {{man label|Combination of mother's and father's surname}} will use the father's name followed by the mother's name. Finally, {{man label|Icelandic style}} will use the father's given name followed by the "sson" suffix (e.g. the son of Edwin will be guessed as Edwin''sson'').

{{man tip|1=Tip |2=The {{man label|Surname Guessing:}} option only affects the initial family name guessed by Gramps when the {{man label|Edit Person}} dialog is launched.
You can modify that name the way you see fit. Set this option to the value that you will most frequently use, as it will save you a lot of typing.}}

*{{man label|Default family relationship:}}
** '''Unknown'''(default)
** Married
** Unmarried
** Civil Union

*{{man label|Height multiple surname box(pixels):}} Default:'''150'''

*{{man label|Status bar:}} This option controls the information displayed in the status bar. This can be either the '''Active person's name and ID'''(default) or '''Relationship to home person'''.

*{{checkbox|1}}{{man label|Show text label beside Navigator buttons (requires restart)}} ''checked'' (default) This checkbox controls whether or not a text description is displayed next to the icon in the [[Gramps_5.1_Wiki_Manual_-_Main_Window#Navigator|Navigator]] in the [[Gramps_5.1_Wiki_Manual_-_Main_Window#Main_Window|Main Window]]. This option takes effect after the program has been restarted.

*{{checkbox|0}}{{man label|Show close button in gramplet bar tabs}} ''unchecked''(default)

====Display Name Editor====

{{man note|1=Note|2=Custom name display formats are stored in the Family Trees, thus before loading any Family Tree the {{man label|Custom format details}} expander is disabled.}}

[[File:EditPreferences-Display-tab-DisplayNameEditor-dialog-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Display Name Editor - dialog (example) from Menu: "Edit>Preferences..." - "Display" - tab]]

The following keywords are replaced with the appropriate name parts:
* Given - given name (first name)
* Title - title (Dr., Mrs.)
* Call - call name
* Initials - first letters of Given
* Primary, Primary[pre] or [sur] or [con]- full primary surname, prefix, surname only, connector
* Patronymic, or [pre] or [sur] or [con] - full pa/matronymic surname, prefix, surname only, connector
* Familynick - family nick name
* Rest - non primary surnames
* Rawsurnames- surnames (no prefixes and connectors)
* Surname - surnames (with prefix and connectors)
* Suffix - suffix (Jr., Sr.)
* Nickname - nick name
* Common - nick name, otherwise first of Given
* Prefix - all prefixes (von, de)
* Notpatronymic- all surnames, except pa/matronymic & primary

{{man menu|UPPERCASE versions of these keywords forces uppercase to be displayed.}} Extra parentheses, commas are removed. Other text appears literally.

Example: 'Dr. Edwin Jose von der Smith and Weston Wilson Sr ("Ed") - Underhills' Edwin Jose is given name, von der is the prefix, Smith and Weston surnames, and a connector, Wilson patronymic surname, Dr. title, Sr suffix, Ed nick name, Underhills family nick name, Jose callname.
{{-}}

{{stub}}

==== Place Format Editor ====
{{stub}}
{{man note|Feature - introduced in Gramps 4.1|[[Hierarchical Place Structure]]}}

[[File:EditPreferences-Display-tab-PlaceFormatEditor-dialog-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Place Format Editor - dialog (example) from Menu: "Edit>Preferences..." - "Display" - tab]]

Accessed from the [[Gramps_5.1_Wiki_Manual_-_Settings#Display|Display]] tabs Place Format option.

This tab contains preferences relevant to how Places should be shown.

*{{man label|Name:}} A unique name for the place format.
*{{man label|Levels:}} The place names to be displayed.
Each level in the hierarchy is represented by a positive integer, starting with 0 for the selected place and increasing by 1 for each level up the hierarchy. The levels can also be represented by negative integers, starting with -1 for the top level (usually a country) and decreasing by 1 for each level lower in the hierarchy. In addition, the populated place (city, town, village or hamlet) is represented by the letter p; this can be used with an offset (e.g. p+1 or p-2).

The names to be displayed are defined as a comma-separated list of ranges. A range can either be a single level, or a start level and an end level separated by a colon. The start level must be less than the end level in a range. The start and end levels default to 0 and -1 if missing.

*{{man label|Street format:}} "None" (Default), "Number Street" or "Street Number". Option to concatenate the number and street in order to suppress the comma. For this option to work, the street must have the [[Gramps_5.1_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_2#Place_Editor_dialog|'''Type''']] ''Street'' and house number must have the '''Type''' ''Number''.
*{{man label|Language:}} (Empty by Default) A two-digit language code.
*{{checkbox|0}} {{man label|Reverse display order}} (checkbox unchecked by default)

See also:
* [[Gramps_5.1_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_2#Place_Editor_dialog|Place Editor dialog]]
* [[Gramps_5.1_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_2#Place_Name_Editor_dialog|Place Name Editor dialog]]
{{-}}

=== Text ===

[[File:EditPreferences-Text-tab-default-51.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menu: "Edit>Preferences..." - "Text" - tab - defaults]]

This tab contains preferences relevant to how missing and private names and records should be shown.

*{{man label|Missing surname:}} in the input field you can determine how a missing surname should be displayed. Default value is '''<code>[Missing Surname]</code>'''. You can change this to [--] or whatever is most convenient for you.
*{{man label|Missing given name}} in the input field you can determine how a missing given name should be displayed. Default value is '''<code>[Missing Given Name]</code>'''. You can change this to whatever you want.
*{{man label|Missing record:}} Default: <code>[Missing Record]</code>
*{{man label|Private surname:}} Default: <code>[Living]</code>
*{{man label|Private given name:}} Default: <code>[Living]</code>
*{{man label|Private record:}} Default: <code>[Private Record]</code>
{{-}}

=== ID Formats ===

{{man tip|ID Prefixes |The ID prefixes use formatting conventions common for C, Python, and other programming languages. For example, the <code>%04d</code> expands to an integer, prepended with zeros to have the total width of four digits. If you would like IDs to be 1, 2, 3, etc., simply set the formatting parameter to <code>%d</code>, the 'd' specifies Decimal Integer, outputting the number in base 10. See: Python [https://docs.python.org/3/library/string.html#format-specification-mini-language (String) Format Specification Mini-Language]}}

[[File:EditPreferences-IDFormats-tab-default-51.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menu: "Edit>Preferences..." - "ID Formats" - tab - defaults]]

This tab contains preferences relevant to the automatic generation of Gramps IDs.

*{{man label|Person:}} Provides the template for generating IDs for a Person. Default value: <code>I%04d</code>
*{{man label|Family:}} Provides the template for generating IDs for a Family. Default value: <code>F%04d</code>
*{{man label|Place:}} Provides the template for generating IDs for a Place. Default value: <code>P%04d</code>
*{{man label|Source:}} Provides the template for generating IDs for a Source. Default value: <code>S%04d</code>
*{{man label|Citation:}} Provides the template for generating IDs for a Citation. Default value: <code>C%04d</code>
*{{man label|Media Object:}} Provides the template for generating IDs for a Media Object. Default value: <code>O%04d</code>
*{{man label|Event:}} Provides the template for generating IDs for an Event. Default value: <code>E%04d</code>
*{{man label|Repository:}} Provides the template for generating IDs for a Repository. Default value: <code>R%04d</code>
*{{man label|Note:}} Provides the template for generating IDs for a Note. Default value: <code>N%04d</code>

You can use the [[Gramps_5.1_Wiki_Manual_-_Tools#Reorder_Gramps_ID|Reorder Gramps ID]] tool to change the format.
{{-}}

=== Dates ===

[[File:EditPreferences-Dates-tab-default-51.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menu: "Edit>Preferences..." - "Dates" - tab - defaults]]

Date settings used for calculation operations.

*{{man label|Markup for invalid date format:}} Default: <code>%s</code>
** Convenience markups are:
*** Bold (Default)
*** <big><big>Makes font relatively larger</big></big>
*** Italic
*** <s><s>Strikethrough</s></s>
*** Subscript
*** Superscript
*** Makes font relatively smaller
*** <tt><tt>Monospace font</tt></tt>
*** Underline
**** For example: %s will display Underlined bold date.
*{{man label|Date about range:}} Default: <code>50</code>
*{{man label|Date after range:}} Default: <code>50</code>
*{{man label|Date before range:}} Default: <code>50</code>
*{{man label|Maximum age probably alive:}} Default: <code>110</code>
*{{man label|Maximum sibling age difference:}} Default: <code>20</code>
*{{man label|Minimum years between generations:}} Default: <code>13</code>
*{{man label|Average years between generations:}} Default: <code>20</code>
{{-}}
See also:
* [[Gramps 5.1 Wiki Manual - Probably Alive]]
* [[Gramps_5.1_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_1#Editing_dates|Editing dates]]
{{-}}

=== Researcher ===

[[File:EditPreferences-Researcher-tab-default-51.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menu: "Edit>Preferences..." - "Researcher" - tab - defaults]]

Allows you to {{man label|Enter your information so people can contact you when you distribute your Family Tree}} in the corresponding text entry fields. Although Gramps requests information about you, this information is used only so that Gramps can create valid GEDCOM output files. A valid GEDCOM file requires information about the file's creator. If you choose, you may leave the information empty, however none of your exported GEDCOM files will be valid.

The available text entry fields are (by default all fields are blank):
*{{man label|Name:}}
*{{man label|Address:}}
*{{man label|Locality:}}
*{{man label|City:}}
*{{man label|State/County:}}
*{{man label|Country:}}
*{{man label|ZIP/Postal Code:}}
*{{man label|Phone:}}
*{{man label|Email:}}

The information entered under this preference acts as default value for family tree specific values that can be adjusted with the [[Gramps_5.1_Wiki_Manual_-_Tools#Edit_Database_Owner_Information|Edit Database Owner Information]] tool.
{{-}}

=== Warnings ===

[[File:EditPreferences-Warnings-tab-default-51.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menu: "Edit>Preferences..." - "Warnings" - tab - defaults]]

This tab controls the display of warning dialogs, allowing the re-enabling of dialogs that have been disabled.

*{{checkbox|1}}{{man label|Suppress warning when adding parents to a child.}} Checkbox checked by Default (See [[Gramps_5.1_Wiki_Manual_-_Error_and_Warning_Reference#Suppress_warning_when_adding_parents_to_a_child|Dialog]])
*{{checkbox|0}}{{man label|Suppress warning when cancelling with changed data.}} Checkbox unchecked by Default (See [[Gramps_5.1_Wiki_Manual_-_Error_and_Warning_Reference#Suppress_warning_when_cancelling_with_changed_data|Dialog]])
*{{checkbox|0}}{{man label|Suppress warning about missing researcher when exporting to GEDCOM.}} Checkbox unchecked by Default (See [[Gramps_5.1_Wiki_Manual_-_Error_and_Warning_Reference#Suppress_warning_about_missing_researcher_when_exporting_to_GEDCOM|Dialog]])
*{{checkbox|0}}{{man label|Show plugin status dialog on plugin load error.}} Checkbox unchecked by Default (See [[Gramps_5.1_Wiki_Manual_-_Error_and_Warning_Reference#Module_not_loaded_warnings|Dialog]])

See the [[Gramps_5.1_Wiki_Manual_-_Error_and_Warning_Reference|Error and Warning Reference]] page for examples.
{{-}}

=== Colors ===

[[File:EditPreferences-Colors-tab-default-51.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menu: "Edit>Preferences..." - "Colors" - tab - defaults]]

This tab allows you to '''Set the colors used for boxes in the graphical views'''
{{stub}}
{{-}}
==== Pick a Color selector ====

[[File:PickAColor-selector-dialog-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Pick a Color" - selector dialog]]

Select a color from the color pallet area, or select the {{man label|Custom}} {{man button|+}} button to create your own color either via direct 'color Hex color code'; the slider or mouse click.
{{-}}

=== Genealogical Symbols ===

{{man tip|Note|The Genealogical Symbols tab can only be used if the prerequisite program <code>[[Gramps_5.1_Wiki_Manual_-_Settings#Prerequisite_to_use_Genealogical_Symbols|python-fontconfig]]</code> is present that Gramps can use.}}

[[File:EditPreferences-GenealogicalSymbols-tab-activated-51.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Genealogical Symbols" - Preferences tab - activated defaults]]

Allows you to use Genealogical symbols instead of text abbreviations in reports, charts and the Gramps interface.

This tab gives you the possibility to use one font which is able to show all genealogical symbols. (Once configured see: [[Gramps_5.1_Wiki_Manual_-_Settings#Prerequisite_to_use_Genealogical_Symbols|Prerequisite to use Genealogical Symbols]])

If you select the "use symbols" checkbox, Gramps will use the selected font if it exists.

This can be useful if you want to add phonetic in a note to show how to pronounce a name or if you mix multiple languages like Greek and Russian.

You can only configure the death symbol from this tab.

:List of Genealogical Symbols shown (listed in order shown at bottom screenshot):

* Female
* Male
* Asexuality, sexless, genderless
* Lesbianism
* Male homosexuality
* Heterosexuality
* Transgender, hermaphrodite (in entomology)
* Transgender
* Neuter

* Illegitimate
* Birth
* Baptism/Christening
* Engaged
* Marriage
* Divorce
* Unmarried partnership
* Buried
* Cremated/Funeral urn
* Killed in action
* Extinct

* Death

{{-}}

{{-}}
====Prerequisite to use Genealogical Symbols====

[[File:EditPreferences-GenealogicalSymbols-tab-default-51.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Genealogical Symbols" - Preferences tab - defaults]]

=====Initial setup=====

If the fontconfig [[Gramps_5.1_Wiki_Manual_-_Settings#Prerequisite|prerequisite has been installed]], then on the {{man label|Genealogical Symbols}} tab select the {{man button|Try to find}} button, Gramps will attempt to detect any suitable unicode text fonts that can be used.

When the search has completed select one of the fonts from the {{man button|Choose font}} list and then select the checkbox:

{{checkbox|1|Use symbols}}
=====Prerequisite=====
Prerequisite : '''fontconfig''' : Python bindings of fontconfig are required for displaying genealogical symbols
{{man note|Use the [[Addon:Prerequisites_Checker_Gramplet|Prerequisites Checker]]|Do you have <code>fontconfig</code> installed? Run the Prerequisites Checker Addon and look for something similar to the following line:<pre>* python-fontconfig 0.5.0 (Success version 0.5.x is installed.)</pre>}}

See also:
* [[GEPS 039: Genealogical symbols in gramps]]
* Feature request: {{bug|9098}} Gramps should be able to use genealogy symbols everywhere.
* lookup table located in [https://github.com/gramps-project/gramps/blob/maintenance/gramps51/gramps/gen/utils/symbols.py gramps\gen\utils\symbols.py]
{{-}}

== Other settings ==

Besides {{man label|Preferences}} dialog, there are other settings available in Gramps. For various reasons they have been made more readily accessible, as listed below.

===Column Editor===

{{man tip|1=Column Editor|2=The {{man label|Column Editor}} is available and works in the same way for all list views. Specifically, it is available for People View, Family View (children list). Sources View, Citations View, Places View, Media View, Repositories View and the Notes View.}}

[[File:ColumnEditor-dialog-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Column Editor - Dialog - example]]

The columns of the list views may be added, removed, or reordered in a {{man label|Column Editor}} dialog. To use the {{man label|Column Editor }} dialog, choose via the menu {{man menu|View ->Configure View...}} or click on toolbar {{man button|Configure View...}} button. Only checked columns will be shown in the view. You can also change the position of a column in People View by clicking and dragging it to a new position in the Editor ([http://en.wikipedia.org/wiki/Drag-and-drop ''drag and drop'']). Once you have made the changes you want click {{man button|Apply}}, then click {{man button|OK}} to exit the Editor and see your changes in the View.

By default, the View List, displays several columns of information about the respective category. You can add or remove columns to and from the display

The default sort key for the view [always ascending] is the left-most field [i.e. at the top in the Column Editor], so changing which field is in that position affects default sorting.
{{-}}

=== Sorting columns ===

[[File:PeopleCategory-PeopleListView-SortedByBirthDateColumn-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Sorted by "Birth Date" column in People(List)View - People Category - example]]

Clicking once sorts in ascending order, clicking again sorts in descending order. The {{man label|Column Editor}} dialog can be used to add, remove and rearrange the displayed columns, or to change the default sorting of the view [though always ascending].
{{-}}

===Setting Home person===

[[File:MenuEdit-SetHomePerson-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menu showing ''Set Home Person'']]

To set the [[Gramps_Glossary#home_person|Home person]], select the People Category and make the desired person active and then choose via the menu {{man menu|Edit ->Set Home Person}}.

Also, when editting any Person, right-clicking on inactive areas (areas without a text-entry box) of the top section displays a pop-up menu which includes an option to {{man menu|Make Home Person}} of that profile.

The Home person is the default person who becomes active when one of the following occurs:
*the Family tree database is opened (The [[Gramps_5.1_Wiki_Manual_-_Settings#General_Gramps_settings|General]] setting in [[Gramps_5.1_Wiki_Manual_-_Settings#Preferences|Preferences]] can modify this default behavior. The "Remember last view displayed" will return to the last Active Person of the previous session.)
*when the toolbar {{man button|Home}} button is clicked
*the Home menu item is selected from either the {{man button|Go}} menu or the right-click context menu in selected views
*the [[Gramps_5.1_Wiki_Manual_-_Keybindings#15|keybinding]] {{Man key press|ALT|Home}} is used to return to the '''Home Person'''.

The toolbar {{man button|Home}} button is available in the People Category, Relationships Category, and Pedigree Category.

* [[Gramps_5.1_Wiki_Manual_-_Navigation#Setting_the_Home_Person|Setting the Home Person]]
{{-}}

===Adjusting viewing controls===

Whether the toolbar, the sidebar, or the filter (not available on Pedigree and Relationships Views) are displayed in the main window is adjusted through the View menu.

In the different views clicking the {{man menu|[[Gramps_5.1_Wiki_Manual_-_Navigation#View|View]]}} menu will shows for boxes you can click:
*Navigator
*Toolbar
*Sidebar
*Bottombar
*Full Screen {{man key press|F11}}

Additionally, depending on the view you are in, other options will be available on {{man label|Configure}}.

*Gramplets:
**Set Columns to 1
**Set Columns to 2
**Set Columns to 3
*Relationships:
**Show Siblings
**Show Details
*Geography:
**Time period
**Layout

All other Views: the [[Gramps_5.1_Wiki_Manual_-_Settings#Column_Editor|column editor]].

===Export View===

[[File:Menubar-FamilyTrees-overview-example-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menubar - "Family Trees" - overview example showing "Export View" menu entry]]

On most Category List Views, displayed data maybe be exported, choose via the [[Gramps_5.1_Wiki_Manual_-_Navigation#Main_Menus|menu]] {{man menu|Family Trees ->Export View...}}.

Menu only appears on most Views, if the displayed data can be exported. Gramps will export data on screen according your choice: '''CSV''' or '''Open Document''' spreadsheet format.
{{-}}
====Export View as Spreadsheet dialog====

[[File:ExportViewAsSpreadsheet-CSV-file-dialog-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Export View as Spreadsheet" CSV(default) file-dialog - example]]

Gramps will then display the {{man label|Export View as Spreadsheet}} dialog where after choosing a file location to save to and a name for your file; export data on from the Category List View in one of two spreadsheet formats:
* '''CSV''' (default)
* '''OpenDocument Spreadsheet''' - ODS format.

{{-}}
[[File:ExportViewAsSpreadsheet-exampleODS-Displayed-in-LibreOfficeCalc-50.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Example ODS Spreadsheet - Displayed in LibreOffice Calc]]

The example screenshot shows an export to the '''OpenDocument Spreadsheet''' (ODS format) displayed as a Spreadsheet in Libreoffice Calc.

{{-}}

===Modularity and plugins===

See [[Gramps_5.1_Wiki_Manual_-_Plugin_Manager|Plugin Manager]] and [[5.1 Addons|Third-Party Addons]].
{{-}}

===Customize report output formats===
[[File:TextReports-DocumentOptions-PlainText-output-settings-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Document Options - tab defaults for Text Reports (Plain Text - output selected) example]]

What does it do? It allows you to change the fonts, font sizes, font color, background color of the text and alignment of paragraphs on the report.

For most report dialogs in the top part are options related that specific report and in the lower part you will see the {{man label|[[Gramps_5.1_Wiki_Manual_-_Reports_-_part_6#Document_Options|Document Options]]}} section.

From the {{man label|Style:}} drop down list you can choose an existing custom style. Or to make your own {{man label|Style:}} select the {{man button|Style Editor...}} button to show the {{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Document_Styles_dialog|Document Styles]]}} dialog and then select the {{man button|Add a new style}} button to show the {{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Style_editor_dialog|Style editor]]}} dialog.

{{stub}}
{{-}}
====Document Styles dialog====

[[File:DocumentStyles-dialog-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Document Styles - dialog - default]]

The {{man label|Document Styles}} dialog, list the ''default'' style and any custom styles for that report and allows you to edit or delete any custom styles you have created. Select the {{man button|+ (Add a new style)}} button to show the {{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Style_editor_dialog|Style editor]]}} dialog.
{{-}}

====Style editor dialog====

The {{man label|Style editor}} dialog allow you to customize the document style specific to each report.

Change the {{man label|Style sheet name:}} (<code>New Style</code>default) field to a unique name as it will appear in {{man label|Document Options}} {{man label|Style:}} drop down list.

Once changes for your custom style have been finalized select the {{man button|OK}} button to save the changes or {{man button|Cancel}} to exit.

{{-}}
=====Style editor dialog tabs=====
On the left hand side you will see the {{man label|Style}} column that list the paragraph options specific to that report that you may modify. For example the {{man label|Ahnentafel Report}} shows the style options for AHN-Entry, AHN-Generation and AHN-Title.

On the right hand side are three tabs associated with each style listed in the left hand column:
{{-}}
======Description======

[[File:StyleEditor-dialog-Description-tab-example-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Description options tab - Document Styles - dialog (default styles for Ahnentafel Report) (Gramps 4.2.0 Windows 7) ]]

*{{man label|Description}} : The description describes what each paragraph is all about. For example shown here is the style used for the Ahnentafel Report ( AHN-Entry ).
{{-}}

======Font options======

[[File:StyleEditor-dialog-FontOptions-tab-example-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Font options" tab - "Style Editor" dialog for "Document Styles" (default styles for Ahnentafel Report)]]

*{{man label|Font options}} : Here you can set the {{man label|Type face}} Roman or Swiss, the {{man label|Size}} of the font in pt., the {{man label|Color}} of the font and some {{man label|Options}} like Bold, Italic or Underline.
{{-}}

======Paragraph options======

[[File:StyleEditor-dialog-ParagraphOptions-tab-example-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Paragraph options" tab - "Style Editor" dialog for "Document Styles" (default styles for Ahnentafel Report)]]

*{{man label|Paragraph options}} : Here you set the {{man label|Alignment}}, the {{man label|Background color}}, {{man label|Indentation}}, {{man label|Spacing}} and {{man label|Borders}} of your style.
{{-}}

== Customizing ==
Here are some ways that you can customize Gramps.
=== Preferences ===

See [[Gramps_5.1_Wiki_Manual_-_Settings#Preferences|Preferences]]

=== Language ===

Gramps has been translated into a number of [[Portal:Translators|languages]]. Usually Gramps automatically starts in your local language, as chosen for other applications, but sometimes this may not be right for you.

If you want to run Gramps in other language than English, you must select it during installation process.

Otherwise it will not be available.

More information can be found at [[Download]] page.

{{stub}} '''{{man warn|tbd|Describe for each main platform how the normal language is determined and how the user can [[Howto:Change_the_language_of_reports#Run_Gramps_in_a_different_language|choose a different language]].'''}}

==== Linux ====
{{stub}}

If you want to choose a locale 'variant' for sorting that is not the default variant, then you can start Gramps from the terminal (or console) with a different LC_COLLATE environment. For example, the default sorting (collation) variant for Swedish is "reformed", but you can instead choose "standard" by typing:
export LC_COLLATE="sv_SE.UTF-8@collation=standard"
python Gramps.py

==== Mac OS X ====

For Mac OS X see [[Mac_OS_X:Application_package#Advanced_setup|Advanced setup]] for details on how the language is normally chosen, and how to choose a special, non-default setting for the language, the sorting order or the format of such things as day and month names and number separators.

==== MS Windows ====

===Add Windows OS Menu Item===
To make Gramps work in your selected language (See table below for your language code), complete the following:
* Using your mouse right button click on the "GrampsAIOxx 5.x.x" icon on Desktop and from menu choose: Copy.
* Right click anywhere on Desktop and from menu choose: Paste shortcut
* New icon will be created with name: "GrampsAIOxx 5.x.x (2)"
* Right click on that and from menu choose: Properties
* A new window will open, click on first tab called General and change text from "GrampsAIOxx 5.x.x (2)" to something more descriptive like: "GrampsAIO Danish"
** Click on second tab called Shortcut, change text in first entry called Target from (note path will vary depending on Gramps version used):
***<code>"C:\Program Files(xxx)\GrampsAIOxx-5.x.x\grampsw.exe"</code> to:
***<code>%comspec% /c set LANG=da_DK.UTF-8 && start grampsw.exe"</code>
* Click OK and now when you click on that icon Gramps will start in Danish.

===Change the windows LANG variables===
Another option if you want Gramps to always load in say:French Canadian language, you can go to Windows > System Properties, and add the LANG variable in the user section of the environment variables dialog with the appropriate Value.

The value to add is:
<pre>
Name: LANG
Value: fr_CA.UTF-8
</pre>

===Language codes===
Select from the following table of [[Portal:Translators|languages Gramps]] has been translated into:

{| {{prettytable}}
!Language
!ISO code
!Example
!Notes
|-
| Dutch
| nl_BE.UTF-8
|
|
|-
| English (British)
| en_GB.UTF-8
|
|
|-
| Finnish
| fi-UTF-8
|
|
|-
| French Canadian
| fr_CA.UTF-8
|
|
|-
| Russian
| ru_RU.UTF-8
|
|
|-
|}
*The language codes are two-letter lowercase ISO language codes (such as "da") as defined by [https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes ISO 639-1].
*The country codes are two-letter uppercase ISO country codes (such as "BE") as defined by [https://en.wikipedia.org/wiki/ISO_3166-1 ISO 3166-1].

===Advanced manipulation of settings===
{{stub}}

{{man warn| Warning |The contents of this section is outside the scope of interest of a general user of Gramps. If you proceed with tweaking the options on the low level you may damage your Gramps installation. Be careful. '''YOU HAVE BEEN WARNED!'''}}

Beyond the settings in Preferences, you may also wish to explore the advanced settings.

Gramps uses '''INI keys''' for managing user preferences and program settings these are stored in the file ''gramps.ini'' under ''.gramps'' folder in your home or user directory.

The list has following sub-items:
*'''behavior''': typical Key names are: betawarn, enable-autobackup, use-tips...
*'''database''': related to database settings for the Family Tree.
*'''export''': export and import dirs
*'''interface''': a lot of keys regarding height and width of the different Views: e.g. event-height: 450, event-ref-height: 585, event-ref-width: 728, event-width: 712...
*'''paths''': keys related to recent imported files and dirs
*'''preferences''': keys related to preferences: all the common prefixes , todo -colors..
*'''researcher''': all information regarding the researcher

Example contents of the <code>gramps.ini</code> file:

<pre>
;; Gramps key file
;; Automatically created at 2017/12/30 09:54:12

[behavior]
;;addmedia-image-dir=''
;;addmedia-relative-path=0
;;addons-url='https://raw.githubusercontent.com/gramps-project/addons/master/gramps50'
;;autoload=0
;;avg-generation-gap=20
;;betawarn=0
;;check-for-addon-update-types=['new']
;;check-for-addon-updates=0
;;date-about-range=50
;;date-after-range=50
;;date-before-range=50
...
</pre>

{{-}}
{{man index|Gramps 5.1 Wiki Manual - Tools|Gramps 5.1 Wiki Manual - Filters|5.1}}
{{languages|Gramps_5.1_Wiki_Manual_-_Settings}}
{{grampsmanualcopyright}}

[[Category:Documentation]]

Gramps 5.0 Wiki Manual - Settings

2019-12-19T22:43:25Z

Adrian Davey: /* Display */

{{man index|Gramps 5.0 Wiki Manual - Tools|Gramps 5.0 Wiki Manual - Filters|5.0}}
{{languages|Gramps_5.0_Wiki_Manual_-_Settings}}
{{#vardefine:chapter|13}}
{{#vardefine:figure|0}}
This section deals with various settings you can manage within Gramps.

== Preferences ==
[[File:EditPreferencesTabsOnly-overview-50.png|right|thumb|650px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Overview of all Preferences tabs]]

Most of the settings in Gramps are configured in the {{man label|Preferences}} dialog. To invoke it, select the menu {{man menu|Edit ->Preferences...}}.

The tabs on the top display the available option categories as follows:
*{{man label|[[Gramps_5.0_Wiki_Manual_-_Settings#General|General]]}}
*{{man label|[[Gramps_5.0_Wiki_Manual_-_Settings#Family_Tree|Family Tree]]}}
*{{man label|[[Gramps_5.0_Wiki_Manual_-_Settings#Display|Display]]}}
*{{man label|[[Gramps_5.0_Wiki_Manual_-_Settings#Text|Text]]}}
*{{man label|[[Gramps_5.0_Wiki_Manual_-_Settings#ID_Formats|ID Formats]]}}
*{{man label|[[Gramps_5.0_Wiki_Manual_-_Settings#Dates|Dates]]}}
*{{man label|[[Gramps_5.0_Wiki_Manual_-_Settings#Researcher|Researcher]]}}
*{{man label|[[Gramps_5.0_Wiki_Manual_-_Settings#Warnings|Warnings]]}}
*{{man label|[[Gramps_5.0_Wiki_Manual_-_Settings#Colors|Colors]]}}

{{-}}
=== General ===

[[File:EditPreferences-General-tab-example-50.png|Right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} General Preferences (Linux)]]

[[File:Edit-preferences-general-tab-50.png|Right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} General Preferences (Microsoft Windows 10)]]

This tab contains preferences relevant to the general operation of the program. Options are:

*[ ]{{man label|Use alternate Font handler for GUI and Reports}}: This checkbox option is '''only only appears on and effects users on the Microsoft Windows platforms''' it affects the appearance of Unicode characters when those characters are not part of the font in use. The standard Microsoft Windows font handler uses substitute fonts when characters are not available. For some users, the alternate font handler does a better job of substituting the fonts. If you have characters on your screen or report that display incorrectly (typically look like a [https://en.wikipedia.org/wiki/Specials_(Unicode_block)#Replacement_character little box] with numbers in it), try selecting this setting. You must restart Gramps for this setting to take effect. (See Microsoft's help article: '''[https://support.microsoft.com/en-us/help/3083806/why-does-some-text-display-with-square-boxes-in-some-apps-on-windows-1 Why does some text display with square boxes in some apps on Windows 10?]'''
*[ ]{{man label|Add default source on GEDCOM import}}: This checkbox option affects the importing of [[Gramps_5.0_Wiki_Manual_-_Manage_Family_Trees#GEDCOM_import|GEDCOM data]]. If this is set, each item that is imported will contain a source reference to the imported file. '''Note - Adding a default source can significantly slow down the importing of your GEDCOM data.'''
*[ ]{{man label|Add tag on import}}: Checkbox (Default: <code>Imported %Y/%m/%d %H:%M:%S</code> ) '''Note - Adding a tag on import can significantly slow down the importing of your data.'''
*[ ]{{man label|Enable spelling checker}}: This checkbox option controls the enabling and disabling of the spelling checker for notes. The '''gtkspell''' package must be loaded for this to have an effect.
*{{checkbox|0}}{{man label|Display Tip of the Day}}: This checkbox option controls the enabling and disabling of the {{man label|[[Gramps_5.0_Wiki_Manual_-_Settings#Tip_of_the_Day_dialog|Tip of the Day]]}} dialog at startup.
*{{checkbox|0}}{{man label|Remember last view displayed}}: This checkbox option controls the enabling and disabling of the the display of the last view. Enabling will bring you to the view where you stopped the program the last time.
*{{man label|Max generations for relationships:}} You can enter the number of generations used to determine relationships. The default value is '''<code>15</code>'''.
*{{man label|Base path for relative media paths:}} Here you can fill in a base path for the media objects. Selecting the {{man button|Directory}} button gives you a {{man label|Select media directory}} editor where you can fill in the required path.
*{{man label|Check for addon updates:}} Select the frequency that Gramps checks for updates to [[5.0_Addons#Installing_Addons_in_Gramps|Addons]]. Default: ''Never''
*{{man label|What to check:}} Default: ''New addons only''
*{{man label|Where to check:}} Default: <code>https://raw.githubusercontent.com/gramps-project/addons/master/gramps50</code>
*{{checkbox|1}}{{man label|Do not ask about previously notified addons}}: Checkbox selected by default
*{{man button|Check for updated addons now}}: Button to force a check for Addons, if Addons are available you will then be presented the {{man label|[[Gramps_5.0_Wiki_Manual_-_Settings#Available_Gramps_Updates_for_Addons|Available Gramps Updates for Addons]]}} window where you choose and install them from.
{{-}}

=====Available Gramps Updates for Addons=====
[[File:AvailableGrampsUpdatesforAddons-example-listing-50.png|Right|thumb|550px|"Available Gramps Updates for Addons" window showing example listing output for Gramps 5.0]]

The {{man label|Available Gramps Updates for Addons}} window you will be shown a list broken down by '''Type''' that you can view by selecting the "Select" column expand out each "Type".
* You can then select the check box of those Addons you want to install.
* Then select the {{man button|Install Selected Addons}} button to download those Addons from the ''Internet''.
* Once downloaded from the {{man label|Done downloading and installing addons}} dialog select the {{man button|Close}} button
* From the {{man label|Preferences}} dialog select {{man button|Close}} button.
* To use the Addons you need to {{man menu|Family Trees>Quit}} and restart Gramps.

{{-}}

====Tip of the Day dialog====

[[File:TipOfTheDay-dialog--example-keeping-good-records-50.png|Right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Tip of the Day dialog]]

When enabled in {{man menu|Edit > Preferences}} {{man label|General}} tab the {{man label|Tip of the Day}} dialog shows helpful hints.

The following options are available:
*{{checkbox|1}} {{man label|Display on startup}} (check box checked by default - once enabled) - uncheck to stop further tips appearing.
*{{man button|Forward}} - Advance to the next tip.
*{{man button|Close}} - exit for this session until the Gramps program is restarted.
{{-}}

=== Family Tree ===
{{stub}}
[[File:EditPreferences-FamilyTree-tab-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menu: {{man menu|Edit>Preferences...}} - "Family Tree" - tab - example - defaults]]

This tab contains preferences relevant to the Family Tree Database.

*{{man label|Database backend:}} -
** '''BSDDB''' (default) -
** ''SQLite'' - initial test of the [[DB-API Database Backend]] (Please report any issues.)
*{{man label|Host:}} -
*{{man label|Port:}} -
*{{man label|Family Tree Database path:}} The default path where the Databases are stored is '''home directory<code>/.gramps/grampsdb</code>'''. Unless you absolutely want to change this, stay with the default path. This path will be located in the relevant Operating Systems [[Gramps_5.0_Wiki_Manual_-_User_Directory|User Directory]].
*{{checkbox|0}}{{man label|Automatically load last family tree}}: This checkbox option controls the enabling and disabling of the loading on start up of the last used database.
*{{man label|Backup path:}} -
*{{checkbox|1}}{{man label|Backup on exit}}
*{{man label|Autobackup:}} -
** '''Never''' (default)
** ''Every 15 minutes''
** ''Every 30 minutes''
** ''Every hour''
{{-}}

See also:
* Addon [[PostgreSQL]] - this adds support for PostgreSQL databases.

=== Display ===
{{stub}}
[[File:EditPreferences-Display-tab-default-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menu: "Edit>Preferences..." - "Display" - tab - defaults]]

This tab contains preferences relevant to the display of data and names. Options are:

*{{man label|Name format:}} This option controls the display of names in the current database (the setting is saved in the database and is not system wide). In Gramps there are two type of name display formats: the predefined formats, and the user defined custom formats. Several different predefined name formats are available: Given - Prefix Patronymic, Suffix Given - Prefix Surname, Given Patronymic Suffix etc.
** Clicking on the right hand side {{man button|Edit...}} button will bring up a {{man label|[[Gramps_5.0_Wiki_Manual_-_Settings#Display_Name_Editor|Display Name Editor]]}} window where the available list of options is shown. The format is given as well as an example. When predefined formats are not suitable one can define one's own format. You can use the {{man button|Add}} button to add a Name format to the list. Clicking once will give you a '''SURNAME,Given Suffix(call)''' format and as example : '''SMITH, Edwin Jose Sr (Ed)'''. If you added new name formats to the list the {{man button|Remove}} and {{man button|Edit}} buttons become available to change the name format list.
***{{checkbox|0}}{{man label|Consider single pa/matronymic as surname}}: Checkbox unselected by default. If selected enables Gramps to consider patronymic and matronymic names as surnames.

{{man note|1=Note|2=Besides this database-wide setting Gramps allows you to decide the name display format individually for every single name via the {{man label|[[Gramps_5.0_Wiki_Manual_-_Settings#Display_Name_Editor|Display Name Editor]]}} dialog}}

*{{man label|Date format:}} This option controls the display of dates. Several different formats are available, which may be dependent on your locale. {{man menu|Please note once changed it is necessary to restart Gramps to view the new date display format}}
** '''YYYY-MM-DD (ISO)''' (Default)
** Numerical
** Month Day, Year
** MON DAY, YEAR
** Day Month Year
** DAY MON YEAR
{{stub}}
*{{man label|Place format:}} This option controls the display of places.
** Selecting the {{man button|Edit...}} button will show the {{man label|[[Gramps_5.0_Wiki_Manual_-_Settings#Place_Format_Editor|Place format editor]]}}
*{{checkbox|1}} {{man label|Enable automatic place title generation}} (checkbox checked by default)
*{{man label|Age display precision(requires restart):}}
** '''Years'''(default)
** Years, Months
** Years, Months, Days

*{{man label|Calendar on reports:}} '''Gregorian'''(default). This option controls the display of calendar on reports, tools, gramplets, views. Several different calendars are available (see [[Gramps_5.0_Wiki_Manual_-_Entering_and_Editing_Data:_Detailed_-_part_1#Editing_dates|Date Edition]]). Two dates with two different calendars will not properly display timeline or period, (e.g. Using the Gregorian calendar as the default displayed calendar, users will have a better coherency for displaying dates on period).

*{{man label|Surname Guessing:}} This option affects the initial family name of a child when he/she is added to the database. The default {{man label|Father's surname}} will use the family name of the father. Selecting {{man label|None}} means that no surname guessing will be attempted. Selecting {{man label|Combination of mother's and father's surname}} will use the father's name followed by the mother's name. Finally, {{man label|Icelandic style}} will use the father's given name followed by the "sson" suffix (e.g. the son of Edwin will be guessed as Edwin''sson'').

{{man tip|1=Tip |2=The {{man label|Surname Guessing:}} option only affects the initial family name guessed by Gramps when the {{man label|Edit Person}} dialog is launched.
You can modify that name the way you see fit. Set this option to the value that you will most frequently use, as it will save you a lot of typing.}}

*{{man label|Default family relationship:}}
** '''Unknown'''(default)
** Married
** Unmarried
** Civil Union

*{{man label|Height multiple surname box(pixels):}} Default:'''150'''

*{{man label|Status bar:}} This option controls the information displayed in the status bar. This can be either the '''Active person's name and ID'''(default) or '''Relationship to home person'''.

*{{checkbox|1}}{{man label|Show text label beside Navigator buttons (requires restart)}} ''checked'' (default) This checkbox controls whether or not a text description is displayed next to the icon in the [[Gramps_5.0_Wiki_Manual_-_Main_Window#Navigator|Navigator]] in the [[Gramps_5.0_Wiki_Manual_-_Main_Window#Main_Window|Main Window]]. This option takes effect after the program has been restarted.

*{{checkbox|0}}{{man label|Show close button in gramplet bar tabs}} ''unchecked''(default)

====Display Name Editor====

{{man note|1=Note|2=Custom name display formats are stored in the Family Trees, thus before loading any Family Tree the {{man label|Custom format details}} expander is disabled.}}

[[File:EditPreferences-Display-tab-DisplayNameEditor-dialog-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Display Name Editor - dialog (example) from Menu: "Edit>Preferences..." - "Display" - tab]]

The following keywords are replaced with the appropriate name parts:
* Given - given name (first name)
* Title - title (Dr., Mrs.)
* Call - call name
* Initials - first letters of Given
* Primary, Primary[pre] or [sur] or [con]- full primary surname, prefix, surname only, connector
* Patronymic, or [pre] or [sur] or [con] - full pa/matronymic surname, prefix, surname only, connector
* Familynick - family nick name
* Rest - non primary surnames
* Rawsurnames- surnames (no prefixes and connectors)
* Surname - surnames (with prefix and connectors)
* Suffix - suffix (Jr., Sr.)
* Nickname - nick name
* Common - nick name, otherwise first of Given
* Prefix - all prefixes (von, de)
* Notpatronymic- all surnames, except pa/matronymic & primary

{{man menu|UPPERCASE versions of these keywords forces uppercase to be displayed.}} Extra parentheses, commas are removed. Other text appears literally.

Example: 'Dr. Edwin Jose von der Smith and Weston Wilson Sr ("Ed") - Underhills' Edwin Jose is given name, von der is the prefix, Smith and Weston surnames, and a connector, Wilson patronymic surname, Dr. title, Sr suffix, Ed nick name, Underhills family nick name, Jose callname.
{{-}}

{{stub}}

==== Place Format Editor ====
{{stub}}
{{man note|New Feature - introduced in Gramps 4.1|[[Hierarchical Place Structure]]}}

[[File:EditPreferences-Display-tab-PlaceFormatEditor-dialog-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Place Format Editor - dialog (example) from Menu: "Edit>Preferences..." - "Display" - tab]]

Accessed from the [[Gramps_5.0_Wiki_Manual_-_Settings#Display|Display]] tabs Place Format option.

This tab contains preferences relevant to how Places should be shown.

*{{man label|Name:}} A unique name for the place format.
*{{man label|Levels:}} The place names to be displayed.
Each level in the hierarchy is represented by a positive integer, starting with 0 for the selected place and increasing by 1 for each level up the hierarchy. The levels can also be represented by negative integers, starting with -1 for the top level (usually a country) and decreasing by 1 for each level lower in the hierarchy. In addition, the populated place (city, town, village or hamlet) is represented by the letter p; this can be used with an offset (e.g. p+1 or p-2).

The names to be displayed are defined as a comma-separated list of ranges. A range can either be a single level, or a start level and an end level separated by a colon. The start level must be less than the end level in a range. The start and end levels default to 0 and -1 if missing.

*{{man label|Street format:}} "None" (Default), "Number Street" or "Street Number". Option to concatenate the number and street in order to suppress the comma. For this option to work, the street must have the [[Gramps_5.0_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_2#Place_Editor_dialog|'''Type''']] ''Street'' and house number must have the '''Type''' ''Number''.
*{{man label|Language:}} (Empty by Default) A two-digit language code.
*{{checkbox|0}} {{man label|Reverse display order}} (checkbox unchecked by default)

See also:
* [[Gramps_5.0_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_2#Place_Editor_dialog|Place Editor dialog]]
* [[Gramps_5.0_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_2#Place_Name_Editor_dialog|Place Name Editor dialog]]
{{-}}

=== Text ===

[[File:EditPreferences-Text-tab-default-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menu: "Edit>Preferences..." - "Text" - tab - defaults]]

This tab contains preferences relevant to how missing and private names and records should be shown.

*{{man label|Missing surname:}} in the input field you can determine how a missing surname should be displayed. Default value is '''<code>[Missing Surname]</code>'''. You can change this to [--] or whatever is most convenient for you.
*{{man label|Missing given name}} in the input field you can determine how a missing given name should be displayed. Default value is '''<code>[Missing Given Name]</code>'''. You can change this to whatever you want.
*{{man label|Missing record:}} Default: <code>[Missing Record]</code>
*{{man label|Private surname:}} Default: <code>[Living]</code>
*{{man label|Private given name:}} Default: <code>[Living]</code>
*{{man label|Private record:}} Default: <code>[Private Record]</code>
{{-}}

=== ID Formats ===

{{man tip|ID Prefixes |The ID prefixes use formatting conventions common for C, Python, and other programming languages. For example, the <code>%04d</code> expands to an integer, prepended with zeros to have the total width of four digits. If you would like IDs to be 1, 2, 3, etc., simply set the formatting parameter to <code>%d</code>, the 'd' specifies Decimal Integer, outputting the number in base 10. See: Python [https://docs.python.org/3.4/library/string.html#format-specification-mini-language (String) Format Specification Mini-Language]}}

[[File:EditPreferences-IDFormats-tab-default-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menu: "Edit>Preferences..." - "ID Formats" - tab - defaults]]

This tab contains preferences relevant to the automatic generation of Gramps IDs.

*{{man label|Person:}} Provides the template for generating IDs for a Person. Default value: <code>I%04d</code>
*{{man label|Family:}} Provides the template for generating IDs for a Family. Default value: <code>F%04d</code>
*{{man label|Place:}} Provides the template for generating IDs for a Place. Default value: <code>P%04d</code>
*{{man label|Source:}} Provides the template for generating IDs for a Source. Default value: <code>S%04d</code>
*{{man label|Citation:}} Provides the template for generating IDs for a Citation. Default value: <code>C%04d</code>
*{{man label|Media Object:}} Provides the template for generating IDs for a Media Object. Default value: <code>O%04d</code>
*{{man label|Event:}} Provides the template for generating IDs for an Event. Default value: <code>E%04d</code>
*{{man label|Repository:}} Provides the template for generating IDs for a Repository. Default value: <code>R%04d</code>
*{{man label|Note:}} Provides the template for generating IDs for a Note. Default value: <code>N%04d</code>

You can use the [[Gramps_5.0_Wiki_Manual_-_Tools#Reorder_Gramps_ID|Reorder Gramps ID]] tool to change the format.
{{-}}

=== Dates ===

[[File:EditPreferences-Dates-tab-default-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menu: "Edit>Preferences..." - "Dates" - tab - defaults]]

*{{man label|Date about range:}} Default: <code>50</code>
*{{man label|Date after range:}} Default: <code>50</code>
*{{man label|Date before range:}} Default: <code>50</code>
*{{man label|Maximum age probably alive:}} Default: <code>110</code>
*{{man label|Maximum sibling age difference:}} Default: <code>20</code>
*{{man label|Minimum years between generations:}} Default: <code>13</code>
*{{man label|Average years between generations:}} Default: <code>20</code>
*{{man label|Markup for invalid date format:}} Default: <code>%s</code>
** Convenience markups are:
*** Bold (Default)
*** <big><big>Makes font relatively larger</big></big>
*** Italic
*** <s><s>Strikethrough</s></s>
*** Subscript
*** Superscript
*** Makes font relatively smaller
*** <tt><tt>Monospace font</tt></tt>
*** Underline
**** For example: %s will display Underlined bold date.
{{-}}
See also:
* [[Gramps 5.0 Wiki Manual - Probably Alive]]
* [[Gramps_5.0_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_1#Editing_dates|Editing dates]]
{{-}}

=== Researcher ===

[[File:EditPreferences-Researcher-tab-default-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menu: "Edit>Preferences..." - "Researcher" - tab - defaults]]

Allows you to {{man label|Enter your information so people can contact you when you distribute your Family Tree}} in the corresponding text entry fields. Although Gramps requests information about you, this information is used only so that Gramps can create valid GEDCOM output files. A valid GEDCOM file requires information about the file's creator. If you choose, you may leave the information empty, however none of your exported GEDCOM files will be valid.

The available text entry fields are (by default all fields are blank):
*{{man label|Name:}}
*{{man label|Address:}}
*{{man label|Locality:}}
*{{man label|City:}}
*{{man label|State/County:}}
*{{man label|Country:}}
*{{man label|ZIP/Postal Code:}}
*{{man label|Phone:}}
*{{man label|Email:}}

The information entered under this preference acts as default value for family tree specific values that can be adjusted with the [[Gramps_5.0_Wiki_Manual_-_Tools#Edit_Database_Owner_Information|Edit Database Owner Information]] tool.
{{-}}

=== Warnings ===

[[File:EditPreferences-Warnings-tab-default-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menu: "Edit>Preferences..." - "Warnings" - tab - defaults]]

This tab controls the display of warning dialogs, allowing the re-enabling of dialogs that have been disabled.

*{{checkbox|1}}{{man label|Suppress warning when adding parents to a child.}} Checkbox checked by Default (See [[Gramps_5.0_Wiki_Manual_-_Error_and_Warning_Reference#Suppress_warning_when_adding_parents_to_a_child|Dialog]])
*{{checkbox|0}}{{man label|Suppress warning when cancelling with changed data.}} Checkbox unchecked by Default (See [[Gramps_5.0_Wiki_Manual_-_Error_and_Warning_Reference#Suppress_warning_when_cancelling_with_changed_data|Dialog]])
*{{checkbox|0}}{{man label|Suppress warning about missing researcher when exporting to GEDCOM.}} Checkbox unchecked by Default (See [[Gramps_5.0_Wiki_Manual_-_Error_and_Warning_Reference#Suppress_warning_about_missing_researcher_when_exporting_to_GEDCOM|Dialog]])
*{{checkbox|0}}{{man label|Show plugin status dialog on plugin load error.}} Checkbox unchecked by Default (See [[Gramps_5.0_Wiki_Manual_-_Error_and_Warning_Reference#Module_not_loaded_warnings|Dialog]])

See the [[Gramps_5.0_Wiki_Manual_-_Error_and_Warning_Reference|Error and Warning Reference]] page for examples.
{{-}}

=== Colors ===

[[File:EditPreferences-Colors-tab-default-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menu: "Edit>Preferences..." - "Colors" - tab - defaults]]

This tab allows you to ''Set the colors used for boxes in the graphical views''
{{stub}}
{{-}}
==== Pick a Color selector ====

[[File:PickAColor-selector-dialog-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Pick a Color" - selector dialog]]

Select a color from the color pallet area, or select the {{man label|Custom}} {{man button|+}} button to create your own color either via direct 'color Hex color code'; the slider or mouse click.
{{-}}

== Other settings ==

Besides {{man label|Preferences}} dialog, there are other settings available in Gramps. For various reasons they have been made more readily accessible, as listed below.

===Column Editor===

{{man tip|1=Column Editor|2=The {{man label|Column Editor}} is available and works in the same way for all list views. Specifically, it is available for People View, Family View (children list). Sources View, Citations View, Places View, Media View, Repositories View and the Notes View.}}

[[File:ColumnEditor-dialog-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Column Editor - Dialog - example]]

The columns of the list views may be added, removed, or reordered in a {{man label|Column Editor}} dialog. To use the {{man label|Column Editor }} dialog, choose via the menu {{man menu|View ->Configure View...}} or click on toolbar {{man button|Configure View...}} button. Only checked columns will be shown in the view. You can also change the position of a column in People View by clicking and dragging it to a new position in the Editor ([http://en.wikipedia.org/wiki/Drag-and-drop ''drag and drop'']). Once you have made the changes you want click {{man button|Apply}}, then click {{man button|OK}} to exit the Editor and see your changes in the View.

By default, the View List, displays several columns of information about the respective category. You can add or remove columns to and from the display

The default sort key for the view [always ascending] is the left-most field [i.e. at the top in the Column Editor], so changing which field is in that position affects default sorting.
{{-}}

=== Sorting columns ===

[[File:PeopleCategory-PeopleListView-SortedByBirthDateColumn-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Sorted by "Birth Date" column in People(List)View - People Category - example]]

Clicking once sorts in ascending order, clicking again sorts in descending order. The {{man label|Column Editor}} dialog can be used to add, remove and rearrange the displayed columns, or to change the default sorting of the view [though always ascending].
{{-}}

===Setting Home person===

[[File:MenuEdit-SetHomePerson-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menu showing ''Set Home Person'']]

To set the [[Gramps_Glossary#home_person|Home person]], select the People Category and make the desired person active and then choose via the menu {{man menu|Edit ->Set Home Person}}.

Also, when editting any Person, right-clicking on inactive areas (areas without a text-entry box) of the top section displays a pop-up menu which includes an option to {{man menu|Make Home Person}} of that profile.

The Home person is the default person who becomes active when one of the following occurs:
*the Family tree database is opened
*when the toolbar {{man button|Home}} button is clicked
*the Home menu item is selected from either the {{man button|Go}} menu or the right-click context menu in selected views
*the [[Gramps_5.0_Wiki_Manual_-_Keybindings#15|keybinding]] {{Man key press|ALT|Home}} is used to return to the '''Home Person'''.

The toolbar {{man button|Home}} button is available in the People Category, Relationships Category, and Pedigree Category.

* [[Gramps_5.0_Wiki_Manual_-_Navigation#Setting_the_Home_Person|Setting the Home Person]]
{{-}}

===Adjusting viewing controls===

Whether the toolbar, the sidebar, or the filter (not available on Pedigree and Relationships Views) are displayed in the main window is adjusted through the View menu.

In the different views clicking the {{man menu|[[Gramps_5.0_Wiki_Manual_-_Navigation#View|View]]}} menu will shows for boxes you can click:
*Navigator
*Toolbar
*Sidebar
*Bottombar
*Full Screen {{man key press|F11}}

Additionally, depending on the view you are in, other options will be available on {{man label|Configure}}.

*Gramplets:
**Set Columns to 1
**Set Columns to 2
**Set Columns to 3
*Relationships:
**Show Siblings
**Show Details
*Geography:
**Time period
**Layout

All other Views: the [[Gramps_5.0_Wiki_Manual_-_Settings#Column_Editor|column editor]].

===Export View===

[[File:Menubar-FamilyTrees-overview-example-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Menubar - "Family Trees" - overview example showing "Export View" menu entry]]

On most Category List Views, displayed data maybe be exported, choose via the [[Gramps_5.0_Wiki_Manual_-_Navigation#Main_Menus|menu]] {{man menu|Family Trees ->Export View...}}.

Menu only appears on most Views, if the displayed data can be exported. Gramps will export data on screen according your choice: '''CSV''' or '''Open Document''' spreadsheet format.
{{-}}
====Export View as Spreadsheet dialog====

[[File:ExportViewAsSpreadsheet-CSV-file-dialog-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Export View as Spreadsheet" CSV(default) file-dialog - example]]

Gramps will then display the {{man label|Export View as Spreadsheet}} dialog where after choosing a file location to save to and a name for your file; export data on from the Category List View in one of two spreadsheet formats:
* '''CSV''' (default)
* '''OpenDocument Spreadsheet''' - ODS format.

{{-}}
[[File:ExportViewAsSpreadsheet-exampleODS-Displayed-in-LibreOfficeCalc-50.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Example ODS Spreadsheet - Displayed in LibreOffice Calc]]

The example screenshot shows an export to the '''OpenDocument Spreadsheet''' (ODS format) displayed as a Spreadsheet in Libreoffice Calc.

{{-}}

===Modularity and plugins===

See [[Gramps_5.0_Wiki_Manual_-_Plugin_Manager|Plugin Manager]] and [[5.0 Addons|Third-Party Addons]].
{{-}}

===Customize report output formats===
[[File:TextReports-DocumentOptions-PlainText-output-settings-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Document Options - tab defaults for Text Reports (Plain Text - output selected) example]]

What does it do? It allows you to change the fonts, font sizes, font color, background color of the text and alignment of paragraphs on the report.

For most report dialogs in the top part are options related that specific report and in the lower part you will see the {{man label|[[Gramps_5.0_Wiki_Manual_-_Reports_-_part_6#Document_Options|Document Options]]}} section.

From the {{man label|Style:}} drop down list you can choose an existing custom style. Or to make your own {{man label|Style:}} select the {{man button|Style Editor...}} button to show the {{man label|[[Gramps_5.0_Wiki_Manual_-_Settings#Document_Styles_dialog|Document Styles]]}} dialog and then select the {{man button|Add a new style}} button to show the {{man label|[[Gramps_5.0_Wiki_Manual_-_Settings#Style_editor_dialog|Style editor]]}} dialog.

{{stub}}
{{-}}
====Document Styles dialog====

[[File:DocumentStyles-dialog-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Document Styles - dialog - default]]

The {{man label|Document Styles}} dialog, list the ''default'' style and any custom styles for that report and allows you to edit or delete any custom styles you have created. Select the {{man button|+ (Add a new style)}} button to show the {{man label|[[Gramps_5.0_Wiki_Manual_-_Settings#Style_editor_dialog|Style editor]]}} dialog.
{{-}}

====Style editor dialog====

The {{man label|Style editor}} dialog allow you to customize the document style specific to each report.

Change the {{man label|Style sheet name:}} (<code>New Style</code>default) field to a unique name as it will appear in {{man label|Document Options}} {{man label|Style:}} drop down list.

Once changes for your custom style have been finalized select the {{man button|OK}} button to save the changes or {{man button|Cancel}} to exit.

{{-}}
=====Style editor dialog tabs=====
On the left hand side you will see the {{man label|Style}} column that list the paragraph options specific to that report that you may modify. For example the {{man label|Ahnentafel Report}} shows the style options for AHN-Entry, AHN-Generation and AHN-Title.

On the right hand side are three tabs associated with each style listed in the left hand column:
{{-}}
======Description======

[[File:StyleEditor-dialog-Description-tab-example-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Description options tab - Document Styles - dialog (default styles for Ahnentafel Report) (Gramps 4.2.0 Windows 7) ]]

*{{man label|Description}} : The description describes what each paragraph is all about. For example shown here is the style used for the Ahnentafel Report ( AHN-Entry ).
{{-}}

======Font options======

[[File:StyleEditor-dialog-FontOptions-tab-example-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Font options" tab - "Style Editor" dialog for "Document Styles" (default styles for Ahnentafel Report)]]

*{{man label|Font options}} : Here you can set the {{man label|Type face}} Roman or Swiss, the {{man label|Size}} of the font in pt., the {{man label|Color}} of the font and some {{man label|Options}} like Bold, Italic or Underline.
{{-}}

======Paragraph options======

[[File:StyleEditor-dialog-ParagraphOptions-tab-example-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Paragraph options" tab - "Style Editor" dialog for "Document Styles" (default styles for Ahnentafel Report)]]

*{{man label|Paragraph options}} : Here you set the {{man label|Alignment}}, the {{man label|Background color}}, {{man label|Indentation}}, {{man label|Spacing}} and {{man label|Borders}} of your style.
{{-}}

== Customizing ==
Here are some ways that you can customize Gramps.
=== Preferences ===

See [[Gramps_5.0_Wiki_Manual_-_Settings#Preferences|Preferences]]

=== Language ===

Gramps has been translated into a number of [[Portal:Translators|languages]]. Usually Gramps automatically starts in your local language, as chosen for other applications, but sometimes this may not be right for you.

If you want to run Gramps in other language than English, you must select it during installation process.
Otherwise it will not be available.
More information can be found at [[Download]] page.

{{stub}} '''{{man warn|tbd|Describe for each main platform how the normal language is determined and how the user can [[Howto:Change_the_language_of_reports#Run_Gramps_in_a_different_language|choose a different language]].'''}}

==== Linux ====
{{stub}}

If you want to choose a locale 'variant' for sorting that is not the default variant, then you can start Gramps from the terminal (or console) with a different LC_COLLATE environment. For example, the default sorting (collation) variant for Swedish is "reformed", but you can instead choose "standard" by typing:
export LC_COLLATE="sv_SE.UTF-8@collation=standard"
python Gramps.py

==== Mac OS X ====

For Mac OS X see [[Mac_OS_X:Application_package#Advanced_setup|Advanced setup]] for details on how the language is normally chosen, and how to choose a special, non-default setting for the language, the sorting order or the format of such things as day and month names and number separators.

==== MS Windows ====

===Add Windows OS Menu Item===
To make Gramps work in your selected language (See table below for your language code), complete the following:
* Using your mouse right button click on the "GrampsAIOxx 5.x.x" icon on Desktop and from menu choose: Copy.
* Right click anywhere on Desktop and from menu choose: Paste shortcut
* New icon will be created with name: "GrampsAIOxx 5.x.x (2)"
* Right click on that and from menu choose: Properties
* A new window will open, click on first tab called General and change text from "GrampsAIOxx 5.x.x (2)" to something more descriptive like: "GrampsAIO Danish"
** Click on second tab called Shortcut, change text in first entry called Target from (note path will vary depending on Gramps version used):
***<code>"C:\Program Files(xxx)\GrampsAIOxx-5.x.x\grampsw.exe"</code> to:
***<code>%comspec% /c set LANG=da_DK.UTF-8 && start grampsw.exe"</code>
* Click OK and now when you click on that icon Gramps will start in Danish.

===Change the windows LANG variables===
Another option if you want Gramps to always load in say:French Canadian language, you can go to Windows > System Properties, and add the LANG variable in the user section of the environment variables dialog with the appropriate Value.

The value to add is:
<pre>
Name: LANG
Value: fr_CA.UTF-8
</pre>

===Language codes===
Select from the following table of [[Portal:Translators|languages Gramps]] has been translated into:

{| {{prettytable}}
!Language
!ISO code
!Example
!Notes
|-
| Dutch
| nl_BE.UTF-8
|
|
|-
| English (British)
| en_GB.UTF-8
|
|
|-
| Finnish
| fi-UTF-8
|
|
|-
| French Canadian
| fr_CA.UTF-8
|
|
|-
| Russian
| ru_RU.UTF-8
|
|
|-
|}
*The language codes are two-letter lowercase ISO language codes (such as "da") as defined by [https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes ISO 639-1].
*The country codes are two-letter uppercase ISO country codes (such as "BE") as defined by [https://en.wikipedia.org/wiki/ISO_3166-1 ISO 3166-1].

===Advanced manipulation of settings===
{{stub}}

{{man warn| Warning |The contents of this section is outside the scope of interest of a general user of Gramps. If you proceed with tweaking the options on the low level you may damage your Gramps installation. Be careful. '''YOU HAVE BEEN WARNED!'''}}

Beyond the settings in Preferences, you may also wish to explore the advanced settings.

Gramps uses '''INI keys''' for managing user preferences and program settings these are stored in the file ''gramps.ini'' under ''.gramps'' folder in your home or user directory.

The list has following sub-items:
*'''behavior''': typical Key names are: betawarn, enable-autobackup, use-tips...
*'''database''': related to database settings for the Family Tree.
*'''export''': export and import dirs
*'''interface''': a lot of keys regarding height and width of the different Views: e.g. event-height: 450, event-ref-height: 585, event-ref-width: 728, event-width: 712...
*'''paths''': keys related to recent imported files and dirs
*'''preferences''': keys related to preferences: all the common prefixes , todo -colors..
*'''researcher''': all information regarding the researcher

Example contents of the <code>gramps.ini</code> file:

<pre>
;; Gramps key file
;; Automatically created at 2017/12/30 09:54:12

[behavior]
;;addmedia-image-dir=''
;;addmedia-relative-path=0
;;addons-url='https://raw.githubusercontent.com/gramps-project/addons/master/gramps50'
;;autoload=0
;;avg-generation-gap=20
;;betawarn=0
;;check-for-addon-update-types=['new']
;;check-for-addon-updates=0
;;date-about-range=50
;;date-after-range=50
;;date-before-range=50
...
</pre>

{{-}}
{{man index|Gramps 5.0 Wiki Manual - Tools|Gramps 5.0 Wiki Manual - Filters|5.0}}
{{languages|Gramps_5.0_Wiki_Manual_-_Settings}}
{{grampsmanualcopyright}}

[[Category:Documentation]]

Gramps 4.1 Wiki Manual - Main Window

2015-07-24T02:12:13Z

Adrian Davey: /* Sorting columns */

{{grampsmanualcopyright}}

{{man index|Gramps 4.1 Wiki Manual - Getting Started|Gramps 4.1 Wiki Manual - Categories|4.1}}

{{languages|Gramps 4.1 Wiki Manual - Main Window}}

{{#vardefine:chapter|3}}
{{#vardefine:figure|0}}

Elements of Gramps main window.

== Main Window ==

When you open a Family Tree database (either existing or new), the main Gramps window is displayed (Fig. {{#var:chapter}}.{{#expr:{{#var:figure}}+1}}):

[[File:MainWindow-annotated-41.png|800px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramps Main Window]]

{{-}}

The main Gramps window contains the following elements:

===Window Title Bar===
*Window Title Bar shows the name of selected Family Tree, Gramps application name and buttons to minimize, maximize and close Gramps. The window can also be dragged from the Title Bar.

=== Menubar ===
*Menubar: The menubar (Main Menu) is located at the very top of the window (right below the window title) and provides access to all the features of Gramps.

=== Toolbar ===
*Toolbar: The toolbar is located right below the menubar. It gives you access to the most frequently used functions of Gramps. You can set options that control how it appears by going to the menu {{man menu|Edit ->Preferences}}.
The Toolbar can be hidden or revealed by the option in menu {{man menu|View ->Toolbar}}.

=== Navigator ===
*Navigator: The navigator is located at the left of the window and allows selection of the different categories. See [[Gramps_4.1_Wiki_Manual_-_Categories#Categories_of_the_Navigator|Categories of the Navigator]]
The Navigator can be hidden or revealed by the options in menu {{man menu|View ->Navigator}}.

=== Display area ===
*Display area: The area in the center of the Gramps window is the display area. What it displays depends on the currently selected View. We will discuss Views in detail below.

=== Status Bar and Progress Bar ===
*Status Bar and Progress Bar: These are located at the very bottom of the Gramps window.
** The Progress Bar is located in the lower left corner of the Gramps window. It displays the progress of time consuming operations, such as opening and saving large Family Tree databases, importing and exporting to other formats, generating web sites, etc. When you are not doing these types of operations, the Progress Bar is not shown.
** The Status Bar is located to the right of the Progress Bar. It displays information about current Gramps activity and contextual information about the selected items.

=== Bottombar and Sidebar ===
*Bottombar: The bottombar is located below the display area.

*Sidebar: The sidebar is located to the right of the display area.

The Bottombar and the Sidebar allow [[Gramps_4.1_Wiki_Manual_-_Gramplets|gramplets]] and [[Gramps_4.1_Wiki_Manual_-_Main_Window#Filters|filters]] to be displayed alongside a view.

The Sidebar and Bottombar can be individually hidden or revealed by options in menu {{man menu|View}}. If the Sidebar is not displayed, then the {{man label|Search bar}} is displayed instead.

[[File:MainWindowSearchbar-annotated-41.png|750px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramps Main Window showing Search Bar]]

{{-}}

== Switching Navigator modes ==

If there is more than one navigator mode installed, you can choose the navigator mode from the drop down list.

The navigator modes are '''"Category"'''(Default), "Drop-Down" and "Expander"

[[File:Navigator-mode-selection-dropdownlist-41.png|left|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Navigator mode selection drop down list]]

[[Image:Mainwin-40.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Category navigator mode]]
{{-}}
[[Image:Drop-Down.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Drop-Down navigator mode]]

[[Image:Expander.png|left|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Expander navigator mode]]
{{-}}
{{man note|Note|In the Plugin Manager, Navigator modes are called Sidebar plugins, but this is inconsistent,because the {{man menu|View->Sidebar}} menu item removes the ''right-hand'' filter/gramplet sidebar, not the ''left-hand'' category sidebar.}}
{{-}}

== Switching Categories ==

Gramps comes with number of different categories as standard. The built-in categories are described in [[Gramps_4.1_Wiki_Manual_-_Categories#Categories_of_the_Navigator|categories]]. You can [[Plugins4.1|download addon]] 'Gramps View's via the Preferences menu. If the view is a new or updated view for an existing category, then the view is added to that category. However, if the view is a view for a ''new'' category, then the new category is added to the navigator.

The way you change the currently displayed category depends on the navigator mode. Normally (for most navigator modes) you can select the category you want by clicking one of the navigator icons.

Alternatively you can use the keyboard shortcuts {{man key press|CTRL|P}} and {{man key press|CTRL|N}} go to the previous or next category respectively. If you have turned off the [[Gramps_4.1_Wiki_Manual_-_Main_Window#Navigator|navigator]] this will be the only way to change categories (unless you turn the navigator on again).

{{-}}

== Switching Views ==

A category can contain different ways of presenting the data, called a View. If there are several views, you can switch between the views. The way you change between the views depends on the viewing mode. In some viewing modes, there is an icon button on the toolbar to switch to a different view. You can also switch via the menu {{man menu|View}}, or by pressing {{man key press|CTRL|<number>}}, where <number> is the view you want in this category.

{{-}}

== Column Editor ==

{{man note| Column Editor |The Column Editor is available in all Views and works the same way in each.}}

[[Image:Column-editor-40.png|right|thumb|250px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Column Editor Dialog]]

By default, the View List, displays several columns of information about the repective category. You can add or remove columns to and from the display by calling up the {{man label|Column Editor}} dialog from the menu {{man menu|View -> Configure View...}} or click on toolbar {{man button|Configure View...}} button and then checking or unchecking the boxes listed. You can also change the position of a column in People View by clicking and dragging it to a new position in the Editor ([http://en.wikipedia.org/wiki/Drag-and-drop ''drag and drop'']). Once you have made the changes you want, click {{man button|OK}} to exit the Editor and see your changes in the View.

The default sort key for the view [always ascending] is the left-most field [i.e. at the top in the Column Editor], so changing which field is in that position affects default sorting.

{{-}}

== Filters ==

[[Image:SidebarFilter-40.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Filter Controls Displayed]]

Genealogical databases can contain information on many people, families, places, and objects. It is therefore possible for a View to contain a long list of data that is difficult to work with. Gramps gives you two different means for controlling this condition by allowing you to filter a list to a more manageable size.

These methods are '''Search''' and '''Filtering'''.

A search will search the text displayed in list, whereas filters display people whose data match the criteria of the filter.

Search is a simple but fast method of searching the columns displayed on the screen. When the [[Gramps_4.1_Wiki_Manual_-_Main_Window#Bottombar_and_Sidebar|sidebar]] is '''not''' displayed, the {{man label|Search bar}} is displayed. Typing the characters into the {{man label|Search bar}} and clicking the {{man button|Find}} button will display only lines that match the text.

Alternatively, you can enable a filter in either the [[Gramps_4.1_Wiki_Manual_-_Main_Window#Bottombar_and_Sidebar|bottombar or the sidebar]]. When the filter sidebar is displayed, the {{man label|Search bar}} is not displayed. The Filter allows you to interactively build a set of filter rules that can be applied to the display. The filter is applied based on the rules and the data, not on the screen display. Filters of the displayed category can also be constructed by clicking on the corresponding 'editor' button in the {{man menu|Edit}} menu.

Further details of how filters work is given in the [[Gramps_4.1_Wiki_Manual_-_Filters|Filters Chapter]]

{{-}}

{{man tip| Searching vs. Filtering |Searching only searches for exact text matches. If the date displayed is "Jan 1, 2000", a search of "1/1/2000" will fail, but a filter of "1/1/2000" will match.}}

When Gramps opens a database, no filtering is in effect. In People View, for example, all people in the database are listed by default.

== Sorting columns ==

[[Image:Sortpeoplecolumn-40.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Sort Column]]

Clicking once sorts in ascending order, clicking again sorts in descending order. The {{man label|Column Editor}} dialog can be used to add, remove and rearrange the displayed columns, or to change the default sorting of the view [though always ascending].

{{-}}

== When something goes wrong ==

Sometimes something goes wrong, either because you have asked to do something that Gramps doesn't know how to do, or because something has happened that the developers of Gramps did not anticipate, or because there is a mistake in the coding of Gramps.

This section explains what to do when something unexpected happens.

{{man warn| Warning |Sometimes all the errors do not appear on the screen. If something unexpected happens, you may need to [[Gramps_4.1_Wiki_Manual_-_Main_Window#Seeing_all_the_error_messages|see all the error messages]]}}

=== Alerts ===

An alert is a dialog that appears when Gramps needs to give you an important message about an error condition or warn you about potentially hazardous situations or consequences.

Most alerts are self explanatory, and the same type of alerts that you might get with any application. These are not discussed further here.

However, some alerts require more complicated actions, so they are described below.
----
[[Image:Need_to_upgrade_alert.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing DB Upgrade Required Error]]

This dialogue appears if you try to open a Family Tree created with a previous version of Gramps with a newer version of Gramps. If you still have the older version of Gramps available, then you should:
* cancel this dialogue,
* open the Family Tree with the previous version of Gramps,
* export your family tree in Gramps XML database export format or Gramps package export format (see [[Gramps_4.1_Wiki_Manual_-_Manage_Family_Trees#Export_into_Gramps_formats|Export into Gramps formats]]),
* open the Family Tree in the new version of Gramps and click {{man button|Upgrade now}} in this dialogue
{{-}}
----
[[Image:Cannot_open_database.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing DB Environment Error]]

As explained in the dialogue, the Family Tree was probably created with an old version of the Berkeley database program. This is not quite the same thing as an old version of the Gramps program, because the version of the Gramps program and the version of the Berkeley database are independent. However, the effect is somewhat the same. As suggested in the dialogue, if you have the old version of Gramps and its support software, then you should:
* cancel this dialogue,
* open the Family Tree with the previous version of Gramps,
* export your family tree in Gramps XML database export format or Gramps package export format (see [[Gramps_4.1_Wiki_Manual_-_Manage_Family_Trees#Export_into_Gramps_formats|Export into Gramps formats]]),
* start the new version of Gramps,
* open the 'Manage Family Tree' dialogue,
* click on {{man button|new}} and create a new Family Tree,
* load the new Family Tree
* Import the Gramps XML or Gramps package.

Alternatively, it may be possible to use the recovery tools. See 'obtain the bsddb recovery tools' under [[Recover corrupted family tree]]
{{-}}
----
[[Image:Low_level_database_corruption.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing DB Error Dialogue]]

This dialogue appears when a problem is detected with the underlying database that supports Family Trees.
* close the dialogue,
* click on the Family Tree Manager,
* select the Family Tree you were trying to open,
* the {{man button|Repair}} button should be available; click on it,
* once the Family Tree has been repaired it should be possible to open it in the normal way.

If this does not work, try 'obtain the bsddb recovery tools' under [[Recover corrupted family tree]]
{{-}}
----
[[Image:DbDowngradeError.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing DB Downgrade Error]]

Carry out suggested action.
{{-}}
----
[[Image:DbVersionError.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing DB Version Error]]

Carry out suggested action.
{{-}}
----
[[Image:RunDatabaseRepair.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing Run Database Repair]]

Carry out suggested action.
{{-}}

=== Warnings ===

If Gramps detects a minor error, or wishes to notify you about an occurrence within the program, then Gramps may display a warning button, as shown below. This button is only displayed for 180 seconds, so if you see it you should immediately click on it if you want to see the messages.

[[Image:Warning_button.jpg|750px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramps Main Window showing Warning button]]

{{-}}

If you click the warning button, then a dialogue box appears showing the last 20 messages received. [[Logging_system|More details]]
[[Image:Warning_messages.jpg|750px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramps Main Window showing Warning messages]]
{{-}}

Some of the warnings that may appear are described below:

==== Locale warnings ====

Sometimes there is a problem with the language you have chosen.

If you have installed Gramps using your platform's standard installation method (Package manager/AIO installer/Application package) and are using your platform's built-in mechanism (System Setting/Control Panel/System Preferences) to choose the language/sort order/formats you are running in, then these errors should not occur, and may mean there is a problem in Gramps.

However, if you have set the language/sort order/formats manually by setting the 'environment' see [[Gramps_4.1_Wiki_Manual_-_Getting_started#Languages| languages]], particularly if you are running Gramps from the command line, then there may be a problem with what you have typed in. The message (only part of which is shown below) should help you to understand where the error is.

* "Date parser for '%s' not available, using default"
* "Date displayer for '%s' not available, using default"
* "Family relationship translator not available for language '%s'. Using 'english' instead."
* 'Unable to determine your Locale, using English'
* "Localization library libintl not on %PATH%, localization will be incomplete"
* "No translations for %s were found, setting localization to U.S. English"
* "Unable to create collator: %s"
* "No language provided, using US English"
* "No usable languages found in list, using US English"
* "None of the requested languages (%s) were available, using %s instead"

==== Module not loaded warnings ====

The Gramps application contains many different 'modules'. Some of these modules are required for Gramps to run at all; some are 'strongly recommend', and some are optional.

If you have installed Gramps using your platform's standard installation method (Package manager/AIO installer/Application package) then the builder of that package will have decided which modules are present. He must include all the required modules, because otherwise Gramps will not run, but he can choose which of the recommended and optional packages he includes. Consult the documentation for your package (‘Ha Ha Only Kidding’) to determine which modules are included.

If you try to do something that needs a module that is not included, then you will get a warning like the ones below (only the first part of the message is included). What you can do about it depends on your platform:

'''Linux'''
You should be able to install the package using your distribution's standard Package Manager or the GUI interface to the Package Manager. However, in some cases you will need to build the module from source.

'''MS Windows and Mac OS X'''
The MS Windows AIO installer and the Max OS X Application bundle come with certain modules built in. It is not possible for the normal user to add further modules. Therefore, if you find a module that you particularly feel should be included you should post on the Gramps [[Contact#Mailing_lists|mailing list]] (probably the devel list) explaining why you feel its omission is a mistake.

* "WARNING: PIL module not loaded. "
* "ICU not loaded because %s. Localization will be impaired. "
* "OsmGpsMap module not loaded. "
* "GExiv2 module not loaded. "
* "Webkit module not loaded. "
* "PIL (Python Imaging Library) not loaded. "
* "GtkSpell not loaded. "

==== Configuration warnings ====

Sometimes it is worth just deleting the old configuration files. TBD instructions on how to do this.

* "Importing old key file 'keys.ini'..."
* "Done importing old key file 'keys.ini'"
* "Can't find filter %s in the defined custom filters"
* "Number of arguments does not match number of " +
* "Value '%(val)s' not found for option '%(opt)s'"
* "Unable to open recent file %s because %s",
* "WARNING: ignoring old key '%s'"
* "WARNING: ignoring key with wrong type "
* "Failed to parse doc options"
* "Skipped a line in the addon listing: "
* "Failed to load gramplets from %s because %s"

====Other warnings ====

TBD

=== Errors ===

More serious problems cause an error dialogue to appear which will describe the actions you should take. tbd. give example of the program error dialogue. Also explain what to do if Gramps suddenly quits, or if Gramps just won't start.

[[Image:Unexpected_error.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing Unexpected error]]

This dialogue appears whenever something has happened in the Gramps application that the programmers did not expect.

Have a look at [[How to create a good bug report]]. If you think you know how the Gramps developers might reproduce the bug, then by all means click on the 'Report' button. This will take you to the 'Report a bug' dialogue, and you can then follow the instructions.

[[Image:Report_a_bug.png|800px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing reporting wizard]]

{{-}}
==== Seeing all the error messages ====
Sometimes, not all the information needed to understand what has gone wrong will appear on the screen. For example, if you start Gramps with an invalid language setting (and some missing components) then the message that appears in the Warning dialogue is:

[[Image:Warning_message_GExiv2.png|800px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing limited warnings]]
{{-}}
However, the full set of warning messages is:
(process:10929): Gtk-WARNING **: Locale not supported by C library.
Using the fallback 'C' locale.
2013-03-13 18:49:04.376: WARNING: __init__.py: line 69: Date parser for 'xx_XX.UTF-8' not available, using default
2013-03-13 18:49:04.547: WARNING: __init__.py: line 85: Date displayer for 'xx_XX.UTF-8' not available, using default
2013-03-13 18:49:05.949: WARNING: spell.py: line 74: Spelling checker is not installed
2013-03-13 18:49:14.123: WARNING: gramplet.gpr.py: line 400: WARNING: GExiv2 module not loaded. Image metadata functionality will not be available.

Sometimes Gramps just doesn't start and nothing appears on the screen, or Gramps suddenly quits so you don't see anything on the screen. In all these cases you may need to do something special to see all the errors.

===== Linux =====

You can start Gramps from the Command Line, as described in the note [[Gramps_4.1_Wiki_Manual_-_Getting_started#Linux| here]]. You will then see all the diagnostic information on the terminal.

===== MS Windows =====

{{man warn|tbd}}

===== Mac OS X =====

You can look at the messages shown by the Console application, and select Gramps.

For example, one of the early alpha releases of Gramps 4.1.0 just would not start and displayed nothing on the screen. However by opening the Console application, and typing Gramps in the filter at the top right hand corner some diagnostic information appeared. (Actually we typed "gramps[" because there were some other messages that were not relevant, but it wouldn't matter if they were included as well).
[[Image:Console_output.png|1000px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Console output]]
{{-}}
By shift clicking to select all the relevant messages and copying them we get:
01/03/2013 00:08:02 [0x0-0x88088].org.gramps-project.gramps[1867] 2939: ERROR: importer.py: line 51: Could not find any typelib for Gtk
01/03/2013 00:08:05 [0x0-0x88088].org.gramps-project.gramps[1867] Gtk typelib not installed. Install Gnome Introspection, and pygobject version 3.3.2 or later.
01/03/2013 00:08:05 [0x0-0x88088].org.gramps-project.gramps[1867] Gramps will terminate now.

In this particular case, this was enough to help the developer discover the problem.
{{-}}

{{man index|Gramps 4.1 Wiki Manual - Getting Started|Gramps 4.1 Wiki Manual - Categories|4.1}}

{{languages|Gramps 4.1 Wiki Manual - Main Window}}

[[Category:Documentation]]

Gramps 4.2 Wiki Manual - Main Window

2015-07-24T02:12:13Z

Adrian Davey: /* Sorting columns */

{{grampsmanualcopyright}}

{{man index|Gramps 4.2 Wiki Manual - Getting Started|Gramps 4.2 Wiki Manual - Categories|4.2}}

{{languages|Gramps 4.2 Wiki Manual - Main Window}}

{{#vardefine:chapter|3}}
{{#vardefine:figure|0}}

Elements of Gramps main window.

== Main Window ==

When you open a Family Tree database (either existing or new), the main Gramps window is displayed (Fig. {{#var:chapter}}.{{#expr:{{#var:figure}}+1}}):

[[File:MainWindow-annotated-41.png|800px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramps Main Window]]

{{-}}

The main Gramps window contains the following elements:

===Window Title Bar===
*Window Title Bar shows the name of selected Family Tree, Gramps application name and buttons to minimize, maximize and close Gramps. The window can also be dragged from the Title Bar.

=== Menubar ===
*Menubar: The menubar (Main Menu) is located at the very top of the window (right below the window title) and provides access to all the features of Gramps.

=== Toolbar ===
*Toolbar: The toolbar is located right below the menubar. It gives you access to the most frequently used functions of Gramps. You can set options that control how it appears by going to the menu {{man menu|Edit ->Preferences}}.
The Toolbar can be hidden or revealed by the option in menu {{man menu|View ->Toolbar}}.

=== Navigator ===
*Navigator: The navigator is located at the left of the window and allows selection of the different categories. See [[Gramps_4.2_Wiki_Manual_-_Categories#Categories_of_the_Navigator|Categories of the Navigator]]
The Navigator can be hidden or revealed by the options in menu {{man menu|View ->Navigator}}.

=== Display area ===
*Display area: The area in the center of the Gramps window is the display area. What it displays depends on the currently selected View. We will discuss Views in detail below.

=== Status Bar and Progress Bar ===
*Status Bar and Progress Bar: These are located at the very bottom of the Gramps window.
** The Progress Bar is located in the lower left corner of the Gramps window. It displays the progress of time consuming operations, such as opening and saving large Family Tree databases, importing and exporting to other formats, generating web sites, etc. When you are not doing these types of operations, the Progress Bar is not shown.
** The Status Bar is located to the right of the Progress Bar. It displays information about current Gramps activity and contextual information about the selected items.

=== Bottombar and Sidebar ===
*Bottombar: The bottombar is located below the display area.

*Sidebar: The sidebar is located to the right of the display area.

The Bottombar and the Sidebar allow [[Gramps_4.2_Wiki_Manual_-_Gramplets|gramplets]] and [[Gramps_4.2_Wiki_Manual_-_Main_Window#Filters|filters]] to be displayed alongside a view.

The Sidebar and Bottombar can be individually hidden or revealed by options in menu {{man menu|View}}. If the Sidebar is not displayed, then the {{man label|Search bar}} is displayed instead.

[[File:MainWindowSearchbar-annotated-41.png|750px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramps Main Window showing Search Bar]]

{{-}}

== Switching Navigator modes ==

If there is more than one navigator mode installed, you can choose the navigator mode from the drop down list.

The navigator modes are '''"Category"'''(Default), "Drop-Down" and "Expander"

[[File:Navigator-mode-selection-dropdownlist-41.png|left|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Navigator mode selection drop down list]]

[[Image:Mainwin-40.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Category navigator mode]]
{{-}}
[[Image:Drop-Down.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Drop-Down navigator mode]]

[[Image:Expander.png|left|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Expander navigator mode]]
{{-}}
{{man note|Note|In the Plugin Manager, Navigator modes are called Sidebar plugins, but this is inconsistent,because the {{man menu|View->Sidebar}} menu item removes the ''right-hand'' filter/gramplet sidebar, not the ''left-hand'' category sidebar.}}
{{-}}

== Switching Categories ==

Gramps comes with number of different categories as standard. The built-in categories are described in [[Gramps_4.2_Wiki_Manual_-_Categories#Categories_of_the_Navigator|categories]]. You can [[Plugins4.2|download addon]] 'Gramps View's via the Preferences menu. If the view is a new or updated view for an existing category, then the view is added to that category. However, if the view is a view for a ''new'' category, then the new category is added to the navigator.

The way you change the currently displayed category depends on the navigator mode. Normally (for most navigator modes) you can select the category you want by clicking one of the navigator icons.

Alternatively you can use the keyboard shortcuts {{man key press|CTRL|P}} and {{man key press|CTRL|N}} go to the previous or next category respectively. If you have turned off the [[Gramps_4.2_Wiki_Manual_-_Main_Window#Navigator|navigator]] this will be the only way to change categories (unless you turn the navigator on again).

{{-}}

== Switching Views ==

A category can contain different ways of presenting the data, called a View. If there are several views, you can switch between the views. The way you change between the views depends on the viewing mode. In some viewing modes, there is an icon button on the toolbar to switch to a different view. You can also switch via the menu {{man menu|View}}, or by pressing {{man key press|CTRL|<number>}}, where <number> is the view you want in this category.

{{-}}

== Column Editor ==

{{man note| Column Editor |The Column Editor is available in all Views and works the same way in each.}}

[[Image:Column-editor-40.png|right|thumb|250px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Column Editor Dialog]]

By default, the View List, displays several columns of information about the repective category. You can add or remove columns to and from the display by calling up the {{man label|Column Editor}} dialog from the menu {{man menu|View -> Configure View...}} or click on toolbar {{man button|Configure View...}} button and then checking or unchecking the boxes listed. You can also change the position of a column in People View by clicking and dragging it to a new position in the Editor ([http://en.wikipedia.org/wiki/Drag-and-drop ''drag and drop'']). Once you have made the changes you want, click {{man button|OK}} to exit the Editor and see your changes in the View.

The default sort key for the view [always ascending] is the left-most field [i.e. at the top in the Column Editor], so changing which field is in that position affects default sorting.

{{-}}

== Filters ==

[[Image:SidebarFilter-40.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Filter Controls Displayed]]

Genealogical databases can contain information on many people, families, places, and objects. It is therefore possible for a View to contain a long list of data that is difficult to work with. Gramps gives you two different means for controlling this condition by allowing you to filter a list to a more manageable size.

These methods are '''Search''' and '''Filtering'''.

A search will search the text displayed in list, whereas filters display people whose data match the criteria of the filter.

Search is a simple but fast method of searching the columns displayed on the screen. When the [[Gramps_4.2_Wiki_Manual_-_Main_Window#Bottombar_and_Sidebar|sidebar]] is '''not''' displayed, the {{man label|Search bar}} is displayed. Typing the characters into the {{man label|Search bar}} and clicking the {{man button|Find}} button will display only lines that match the text.

Alternatively, you can enable a filter in either the [[Gramps_4.2_Wiki_Manual_-_Main_Window#Bottombar_and_Sidebar|bottombar or the sidebar]]. When the filter sidebar is displayed, the {{man label|Search bar}} is not displayed. The Filter allows you to interactively build a set of filter rules that can be applied to the display. The filter is applied based on the rules and the data, not on the screen display. Filters of the displayed category can also be constructed by clicking on the corresponding 'editor' button in the {{man menu|Edit}} menu.

Further details of how filters work is given in the [[Gramps_4.2_Wiki_Manual_-_Filters|Filters Chapter]]

{{-}}

{{man tip| Searching vs. Filtering |Searching only searches for exact text matches. If the date displayed is "Jan 1, 2000", a search of "1/1/2000" will fail, but a filter of "1/1/2000" will match.}}

When Gramps opens a database, no filtering is in effect. In People View, for example, all people in the database are listed by default.

== Sorting columns ==

[[Image:Sortpeoplecolumn-40.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Sort Column]]

Clicking once sorts in ascending order, clicking again sorts in descending order. The {{man label|Column Editor}} dialog can be used to add, remove and rearrange the displayed columns, or to change the default sorting of the view [though always ascending].

{{-}}

== When something goes wrong ==

Sometimes something goes wrong, either because you have asked to do something that Gramps doesn't know how to do, or because something has happened that the developers of Gramps did not anticipate, or because there is a mistake in the coding of Gramps.

This section explains what to do when something unexpected happens.

{{man warn| Warning |Sometimes all the errors do not appear on the screen. If something unexpected happens, you may need to [[Gramps_4.2_Wiki_Manual_-_Main_Window#Seeing_all_the_error_messages|see all the error messages]]}}

=== Alerts ===

An alert is a dialog that appears when Gramps needs to give you an important message about an error condition or warn you about potentially hazardous situations or consequences.

Most alerts are self explanatory, and the same type of alerts that you might get with any application. These are not discussed further here.

However, some alerts require more complicated actions, so they are described below.
----
[[Image:Need_to_upgrade_alert.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing DB Upgrade Required Error]]

This dialogue appears if you try to open a Family Tree created with a previous version of Gramps with a newer version of Gramps. If you still have the older version of Gramps available, then you should:
* cancel this dialogue,
* open the Family Tree with the previous version of Gramps,
* export your family tree in Gramps XML database export format or Gramps package export format (see [[Gramps_4.2_Wiki_Manual_-_Manage_Family_Trees#Export_into_Gramps_formats|Export into Gramps formats]]),
* open the Family Tree in the new version of Gramps and click {{man button|Upgrade now}} in this dialogue
{{-}}
----
[[Image:Cannot_open_database.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing DB Environment Error]]

As explained in the dialogue, the Family Tree was probably created with an old version of the Berkeley database program. This is not quite the same thing as an old version of the Gramps program, because the version of the Gramps program and the version of the Berkeley database are independent. However, the effect is somewhat the same. As suggested in the dialogue, if you have the old version of Gramps and its support software, then you should:
* cancel this dialogue,
* open the Family Tree with the previous version of Gramps,
* export your family tree in Gramps XML database export format or Gramps package export format (see [[Gramps_4.2_Wiki_Manual_-_Manage_Family_Trees#Export_into_Gramps_formats|Export into Gramps formats]]),
* start the new version of Gramps,
* open the 'Manage Family Tree' dialogue,
* click on {{man button|new}} and create a new Family Tree,
* load the new Family Tree
* Import the Gramps XML or Gramps package.

Alternatively, it may be possible to use the recovery tools. See 'obtain the bsddb recovery tools' under [[Recover corrupted family tree]]
{{-}}
----
[[Image:Low_level_database_corruption.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing DB Error Dialogue]]

This dialogue appears when a problem is detected with the underlying database that supports Family Trees.
* close the dialogue,
* click on the Family Tree Manager,
* select the Family Tree you were trying to open,
* the {{man button|Repair}} button should be available; click on it,
* once the Family Tree has been repaired it should be possible to open it in the normal way.

If this does not work, try 'obtain the bsddb recovery tools' under [[Recover corrupted family tree]]
{{-}}
----
[[Image:DbDowngradeError.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing DB Downgrade Error]]

Carry out suggested action.
{{-}}
----
[[Image:DbVersionError.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing DB Version Error]]

Carry out suggested action.
{{-}}
----
[[Image:RunDatabaseRepair.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing Run Database Repair]]

Carry out suggested action.
{{-}}

=== Warnings ===

If Gramps detects a minor error, or wishes to notify you about an occurrence within the program, then Gramps may display a warning button, as shown below. This button is only displayed for 180 seconds, so if you see it you should immediately click on it if you want to see the messages.

[[Image:Warning_button.jpg|750px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramps Main Window showing Warning button]]

{{-}}

If you click the warning button, then a dialogue box appears showing the last 20 messages received. [[Logging_system|More details]]
[[Image:Warning_messages.jpg|750px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramps Main Window showing Warning messages]]
{{-}}

Some of the warnings that may appear are described below:

==== Locale warnings ====

Sometimes there is a problem with the language you have chosen.

If you have installed Gramps using your platform's standard installation method (Package manager/AIO installer/Application package) and are using your platform's built-in mechanism (System Setting/Control Panel/System Preferences) to choose the language/sort order/formats you are running in, then these errors should not occur, and may mean there is a problem in Gramps.

However, if you have set the language/sort order/formats manually by setting the 'environment' see [[Gramps_4.2_Wiki_Manual_-_Getting_started#Languages| languages]], particularly if you are running Gramps from the command line, then there may be a problem with what you have typed in. The message (only part of which is shown below) should help you to understand where the error is.

* "Date parser for '%s' not available, using default"
* "Date displayer for '%s' not available, using default"
* "Family relationship translator not available for language '%s'. Using 'english' instead."
* 'Unable to determine your Locale, using English'
* "Localization library libintl not on %PATH%, localization will be incomplete"
* "No translations for %s were found, setting localization to U.S. English"
* "Unable to create collator: %s"
* "No language provided, using US English"
* "No usable languages found in list, using US English"
* "None of the requested languages (%s) were available, using %s instead"

==== Module not loaded warnings ====

The Gramps application contains many different 'modules'. Some of these modules are required for Gramps to run at all; some are 'strongly recommend', and some are optional.

If you have installed Gramps using your platform's standard installation method (Package manager/AIO installer/Application package) then the builder of that package will have decided which modules are present. He must include all the required modules, because otherwise Gramps will not run, but he can choose which of the recommended and optional packages he includes. Consult the documentation for your package (‘Ha Ha Only Kidding’) to determine which modules are included.

If you try to do something that needs a module that is not included, then you will get a warning like the ones below (only the first part of the message is included). What you can do about it depends on your platform:

'''Linux'''
You should be able to install the package using your distribution's standard Package Manager or the GUI interface to the Package Manager. However, in some cases you will need to build the module from source.

'''MS Windows and Mac OS X'''
The MS Windows AIO installer and the Max OS X Application bundle come with certain modules built in. It is not possible for the normal user to add further modules. Therefore, if you find a module that you particularly feel should be included you should post on the Gramps [[Contact#Mailing_lists|mailing list]] (probably the devel list) explaining why you feel its omission is a mistake.

* "WARNING: PIL module not loaded. "
* "ICU not loaded because %s. Localization will be impaired. "
* "OsmGpsMap module not loaded. "
* "GExiv2 module not loaded. "
* "Webkit module not loaded. "
* "PIL (Python Imaging Library) not loaded. "
* "GtkSpell not loaded. "

==== Configuration warnings ====

Sometimes it is worth just deleting the old configuration files. TBD instructions on how to do this.

* "Importing old key file 'keys.ini'..."
* "Done importing old key file 'keys.ini'"
* "Can't find filter %s in the defined custom filters"
* "Number of arguments does not match number of " +
* "Value '%(val)s' not found for option '%(opt)s'"
* "Unable to open recent file %s because %s",
* "WARNING: ignoring old key '%s'"
* "WARNING: ignoring key with wrong type "
* "Failed to parse doc options"
* "Skipped a line in the addon listing: "
* "Failed to load gramplets from %s because %s"

====Other warnings ====

TBD

=== Errors ===

More serious problems cause an error dialogue to appear which will describe the actions you should take. tbd. give example of the program error dialogue. Also explain what to do if Gramps suddenly quits, or if Gramps just won't start.

[[Image:Unexpected_error.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing Unexpected error]]

This dialogue appears whenever something has happened in the Gramps application that the programmers did not expect.

Have a look at [[How to create a good bug report]]. If you think you know how the Gramps developers might reproduce the bug, then by all means click on the 'Report' button. This will take you to the 'Report a bug' dialogue, and you can then follow the instructions.

[[Image:Report_a_bug.png|800px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing reporting wizard]]

{{-}}
==== Seeing all the error messages ====
Sometimes, not all the information needed to understand what has gone wrong will appear on the screen. For example, if you start Gramps with an invalid language setting (and some missing components) then the message that appears in the Warning dialogue is:

[[Image:Warning_message_GExiv2.png|800px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing limited warnings]]
{{-}}
However, the full set of warning messages is:
(process:10929): Gtk-WARNING **: Locale not supported by C library.
Using the fallback 'C' locale.
2013-03-13 18:49:04.376: WARNING: __init__.py: line 69: Date parser for 'xx_XX.UTF-8' not available, using default
2013-03-13 18:49:04.547: WARNING: __init__.py: line 85: Date displayer for 'xx_XX.UTF-8' not available, using default
2013-03-13 18:49:05.949: WARNING: spell.py: line 74: Spelling checker is not installed
2013-03-13 18:49:14.223: WARNING: gramplet.gpr.py: line 400: WARNING: GExiv2 module not loaded. Image metadata functionality will not be available.

Sometimes Gramps just doesn't start and nothing appears on the screen, or Gramps suddenly quits so you don't see anything on the screen. In all these cases you may need to do something special to see all the errors.

===== Linux =====

You can start Gramps from the Command Line, as described in the note [[Gramps_4.2_Wiki_Manual_-_Getting_started#Linux| here]]. You will then see all the diagnostic information on the terminal.

===== MS Windows =====

{{man warn|tbd}}

===== Mac OS X =====

You can look at the messages shown by the Console application, and select Gramps.

For example, one of the early alpha releases of Gramps 4.2.0 just would not start and displayed nothing on the screen. However by opening the Console application, and typing Gramps in the filter at the top right hand corner some diagnostic information appeared. (Actually we typed "gramps[" because there were some other messages that were not relevant, but it wouldn't matter if they were included as well).
[[Image:Console_output.png|1000px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Console output]]
{{-}}
By shift clicking to select all the relevant messages and copying them we get:
01/03/2013 00:08:02 [0x0-0x88088].org.gramps-project.gramps[1867] 2939: ERROR: importer.py: line 51: Could not find any typelib for Gtk
01/03/2013 00:08:05 [0x0-0x88088].org.gramps-project.gramps[1867] Gtk typelib not installed. Install Gnome Introspection, and pygobject version 3.3.2 or later.
01/03/2013 00:08:05 [0x0-0x88088].org.gramps-project.gramps[1867] Gramps will terminate now.

In this particular case, this was enough to help the developer discover the problem.
{{-}}

{{man index|Gramps 4.2 Wiki Manual - Getting Started|Gramps 4.2 Wiki Manual - Categories|4.2}}

{{languages|Gramps 4.2 Wiki Manual - Main Window}}

[[Category:Documentation]]

Gramps 4.1 Wiki Manual - Main Window

2015-07-24T02:09:48Z

Adrian Davey: /* Column Editor */

{{grampsmanualcopyright}}

{{man index|Gramps 4.1 Wiki Manual - Getting Started|Gramps 4.1 Wiki Manual - Categories|4.1}}

{{languages|Gramps 4.1 Wiki Manual - Main Window}}

{{#vardefine:chapter|3}}
{{#vardefine:figure|0}}

Elements of Gramps main window.

== Main Window ==

When you open a Family Tree database (either existing or new), the main Gramps window is displayed (Fig. {{#var:chapter}}.{{#expr:{{#var:figure}}+1}}):

[[File:MainWindow-annotated-41.png|800px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramps Main Window]]

{{-}}

The main Gramps window contains the following elements:

===Window Title Bar===
*Window Title Bar shows the name of selected Family Tree, Gramps application name and buttons to minimize, maximize and close Gramps. The window can also be dragged from the Title Bar.

=== Menubar ===
*Menubar: The menubar (Main Menu) is located at the very top of the window (right below the window title) and provides access to all the features of Gramps.

=== Toolbar ===
*Toolbar: The toolbar is located right below the menubar. It gives you access to the most frequently used functions of Gramps. You can set options that control how it appears by going to the menu {{man menu|Edit ->Preferences}}.
The Toolbar can be hidden or revealed by the option in menu {{man menu|View ->Toolbar}}.

=== Navigator ===
*Navigator: The navigator is located at the left of the window and allows selection of the different categories. See [[Gramps_4.1_Wiki_Manual_-_Categories#Categories_of_the_Navigator|Categories of the Navigator]]
The Navigator can be hidden or revealed by the options in menu {{man menu|View ->Navigator}}.

=== Display area ===
*Display area: The area in the center of the Gramps window is the display area. What it displays depends on the currently selected View. We will discuss Views in detail below.

=== Status Bar and Progress Bar ===
*Status Bar and Progress Bar: These are located at the very bottom of the Gramps window.
** The Progress Bar is located in the lower left corner of the Gramps window. It displays the progress of time consuming operations, such as opening and saving large Family Tree databases, importing and exporting to other formats, generating web sites, etc. When you are not doing these types of operations, the Progress Bar is not shown.
** The Status Bar is located to the right of the Progress Bar. It displays information about current Gramps activity and contextual information about the selected items.

=== Bottombar and Sidebar ===
*Bottombar: The bottombar is located below the display area.

*Sidebar: The sidebar is located to the right of the display area.

The Bottombar and the Sidebar allow [[Gramps_4.1_Wiki_Manual_-_Gramplets|gramplets]] and [[Gramps_4.1_Wiki_Manual_-_Main_Window#Filters|filters]] to be displayed alongside a view.

The Sidebar and Bottombar can be individually hidden or revealed by options in menu {{man menu|View}}. If the Sidebar is not displayed, then the {{man label|Search bar}} is displayed instead.

[[File:MainWindowSearchbar-annotated-41.png|750px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramps Main Window showing Search Bar]]

{{-}}

== Switching Navigator modes ==

If there is more than one navigator mode installed, you can choose the navigator mode from the drop down list.

The navigator modes are '''"Category"'''(Default), "Drop-Down" and "Expander"

[[File:Navigator-mode-selection-dropdownlist-41.png|left|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Navigator mode selection drop down list]]

[[Image:Mainwin-40.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Category navigator mode]]
{{-}}
[[Image:Drop-Down.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Drop-Down navigator mode]]

[[Image:Expander.png|left|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Expander navigator mode]]
{{-}}
{{man note|Note|In the Plugin Manager, Navigator modes are called Sidebar plugins, but this is inconsistent,because the {{man menu|View->Sidebar}} menu item removes the ''right-hand'' filter/gramplet sidebar, not the ''left-hand'' category sidebar.}}
{{-}}

== Switching Categories ==

Gramps comes with number of different categories as standard. The built-in categories are described in [[Gramps_4.1_Wiki_Manual_-_Categories#Categories_of_the_Navigator|categories]]. You can [[Plugins4.1|download addon]] 'Gramps View's via the Preferences menu. If the view is a new or updated view for an existing category, then the view is added to that category. However, if the view is a view for a ''new'' category, then the new category is added to the navigator.

The way you change the currently displayed category depends on the navigator mode. Normally (for most navigator modes) you can select the category you want by clicking one of the navigator icons.

Alternatively you can use the keyboard shortcuts {{man key press|CTRL|P}} and {{man key press|CTRL|N}} go to the previous or next category respectively. If you have turned off the [[Gramps_4.1_Wiki_Manual_-_Main_Window#Navigator|navigator]] this will be the only way to change categories (unless you turn the navigator on again).

{{-}}

== Switching Views ==

A category can contain different ways of presenting the data, called a View. If there are several views, you can switch between the views. The way you change between the views depends on the viewing mode. In some viewing modes, there is an icon button on the toolbar to switch to a different view. You can also switch via the menu {{man menu|View}}, or by pressing {{man key press|CTRL|<number>}}, where <number> is the view you want in this category.

{{-}}

== Column Editor ==

{{man note| Column Editor |The Column Editor is available in all Views and works the same way in each.}}

[[Image:Column-editor-40.png|right|thumb|250px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Column Editor Dialog]]

By default, the View List, displays several columns of information about the repective category. You can add or remove columns to and from the display by calling up the {{man label|Column Editor}} dialog from the menu {{man menu|View -> Configure View...}} or click on toolbar {{man button|Configure View...}} button and then checking or unchecking the boxes listed. You can also change the position of a column in People View by clicking and dragging it to a new position in the Editor ([http://en.wikipedia.org/wiki/Drag-and-drop ''drag and drop'']). Once you have made the changes you want, click {{man button|OK}} to exit the Editor and see your changes in the View.

The default sort key for the view [always ascending] is the left-most field [i.e. at the top in the Column Editor], so changing which field is in that position affects default sorting.

{{-}}

== Filters ==

[[Image:SidebarFilter-40.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Filter Controls Displayed]]

Genealogical databases can contain information on many people, families, places, and objects. It is therefore possible for a View to contain a long list of data that is difficult to work with. Gramps gives you two different means for controlling this condition by allowing you to filter a list to a more manageable size.

These methods are '''Search''' and '''Filtering'''.

A search will search the text displayed in list, whereas filters display people whose data match the criteria of the filter.

Search is a simple but fast method of searching the columns displayed on the screen. When the [[Gramps_4.1_Wiki_Manual_-_Main_Window#Bottombar_and_Sidebar|sidebar]] is '''not''' displayed, the {{man label|Search bar}} is displayed. Typing the characters into the {{man label|Search bar}} and clicking the {{man button|Find}} button will display only lines that match the text.

Alternatively, you can enable a filter in either the [[Gramps_4.1_Wiki_Manual_-_Main_Window#Bottombar_and_Sidebar|bottombar or the sidebar]]. When the filter sidebar is displayed, the {{man label|Search bar}} is not displayed. The Filter allows you to interactively build a set of filter rules that can be applied to the display. The filter is applied based on the rules and the data, not on the screen display. Filters of the displayed category can also be constructed by clicking on the corresponding 'editor' button in the {{man menu|Edit}} menu.

Further details of how filters work is given in the [[Gramps_4.1_Wiki_Manual_-_Filters|Filters Chapter]]

{{-}}

{{man tip| Searching vs. Filtering |Searching only searches for exact text matches. If the date displayed is "Jan 1, 2000", a search of "1/1/2000" will fail, but a filter of "1/1/2000" will match.}}

When Gramps opens a database, no filtering is in effect. In People View, for example, all people in the database are listed by default.

== Sorting columns ==

[[Image:Sortpeoplecolumn-40.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Sort Column]]

Clicking once sorts in ascending order, clicking again sorts in descending order. The {{man label|Column Editor}} dialog can be used to add, remove and rearrange the displayed columns.

{{-}}

== When something goes wrong ==

Sometimes something goes wrong, either because you have asked to do something that Gramps doesn't know how to do, or because something has happened that the developers of Gramps did not anticipate, or because there is a mistake in the coding of Gramps.

This section explains what to do when something unexpected happens.

{{man warn| Warning |Sometimes all the errors do not appear on the screen. If something unexpected happens, you may need to [[Gramps_4.1_Wiki_Manual_-_Main_Window#Seeing_all_the_error_messages|see all the error messages]]}}

=== Alerts ===

An alert is a dialog that appears when Gramps needs to give you an important message about an error condition or warn you about potentially hazardous situations or consequences.

Most alerts are self explanatory, and the same type of alerts that you might get with any application. These are not discussed further here.

However, some alerts require more complicated actions, so they are described below.
----
[[Image:Need_to_upgrade_alert.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing DB Upgrade Required Error]]

This dialogue appears if you try to open a Family Tree created with a previous version of Gramps with a newer version of Gramps. If you still have the older version of Gramps available, then you should:
* cancel this dialogue,
* open the Family Tree with the previous version of Gramps,
* export your family tree in Gramps XML database export format or Gramps package export format (see [[Gramps_4.1_Wiki_Manual_-_Manage_Family_Trees#Export_into_Gramps_formats|Export into Gramps formats]]),
* open the Family Tree in the new version of Gramps and click {{man button|Upgrade now}} in this dialogue
{{-}}
----
[[Image:Cannot_open_database.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing DB Environment Error]]

As explained in the dialogue, the Family Tree was probably created with an old version of the Berkeley database program. This is not quite the same thing as an old version of the Gramps program, because the version of the Gramps program and the version of the Berkeley database are independent. However, the effect is somewhat the same. As suggested in the dialogue, if you have the old version of Gramps and its support software, then you should:
* cancel this dialogue,
* open the Family Tree with the previous version of Gramps,
* export your family tree in Gramps XML database export format or Gramps package export format (see [[Gramps_4.1_Wiki_Manual_-_Manage_Family_Trees#Export_into_Gramps_formats|Export into Gramps formats]]),
* start the new version of Gramps,
* open the 'Manage Family Tree' dialogue,
* click on {{man button|new}} and create a new Family Tree,
* load the new Family Tree
* Import the Gramps XML or Gramps package.

Alternatively, it may be possible to use the recovery tools. See 'obtain the bsddb recovery tools' under [[Recover corrupted family tree]]
{{-}}
----
[[Image:Low_level_database_corruption.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing DB Error Dialogue]]

This dialogue appears when a problem is detected with the underlying database that supports Family Trees.
* close the dialogue,
* click on the Family Tree Manager,
* select the Family Tree you were trying to open,
* the {{man button|Repair}} button should be available; click on it,
* once the Family Tree has been repaired it should be possible to open it in the normal way.

If this does not work, try 'obtain the bsddb recovery tools' under [[Recover corrupted family tree]]
{{-}}
----
[[Image:DbDowngradeError.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing DB Downgrade Error]]

Carry out suggested action.
{{-}}
----
[[Image:DbVersionError.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing DB Version Error]]

Carry out suggested action.
{{-}}
----
[[Image:RunDatabaseRepair.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing Run Database Repair]]

Carry out suggested action.
{{-}}

=== Warnings ===

If Gramps detects a minor error, or wishes to notify you about an occurrence within the program, then Gramps may display a warning button, as shown below. This button is only displayed for 180 seconds, so if you see it you should immediately click on it if you want to see the messages.

[[Image:Warning_button.jpg|750px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramps Main Window showing Warning button]]

{{-}}

If you click the warning button, then a dialogue box appears showing the last 20 messages received. [[Logging_system|More details]]
[[Image:Warning_messages.jpg|750px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramps Main Window showing Warning messages]]
{{-}}

Some of the warnings that may appear are described below:

==== Locale warnings ====

Sometimes there is a problem with the language you have chosen.

If you have installed Gramps using your platform's standard installation method (Package manager/AIO installer/Application package) and are using your platform's built-in mechanism (System Setting/Control Panel/System Preferences) to choose the language/sort order/formats you are running in, then these errors should not occur, and may mean there is a problem in Gramps.

However, if you have set the language/sort order/formats manually by setting the 'environment' see [[Gramps_4.1_Wiki_Manual_-_Getting_started#Languages| languages]], particularly if you are running Gramps from the command line, then there may be a problem with what you have typed in. The message (only part of which is shown below) should help you to understand where the error is.

* "Date parser for '%s' not available, using default"
* "Date displayer for '%s' not available, using default"
* "Family relationship translator not available for language '%s'. Using 'english' instead."
* 'Unable to determine your Locale, using English'
* "Localization library libintl not on %PATH%, localization will be incomplete"
* "No translations for %s were found, setting localization to U.S. English"
* "Unable to create collator: %s"
* "No language provided, using US English"
* "No usable languages found in list, using US English"
* "None of the requested languages (%s) were available, using %s instead"

==== Module not loaded warnings ====

The Gramps application contains many different 'modules'. Some of these modules are required for Gramps to run at all; some are 'strongly recommend', and some are optional.

If you have installed Gramps using your platform's standard installation method (Package manager/AIO installer/Application package) then the builder of that package will have decided which modules are present. He must include all the required modules, because otherwise Gramps will not run, but he can choose which of the recommended and optional packages he includes. Consult the documentation for your package (‘Ha Ha Only Kidding’) to determine which modules are included.

If you try to do something that needs a module that is not included, then you will get a warning like the ones below (only the first part of the message is included). What you can do about it depends on your platform:

'''Linux'''
You should be able to install the package using your distribution's standard Package Manager or the GUI interface to the Package Manager. However, in some cases you will need to build the module from source.

'''MS Windows and Mac OS X'''
The MS Windows AIO installer and the Max OS X Application bundle come with certain modules built in. It is not possible for the normal user to add further modules. Therefore, if you find a module that you particularly feel should be included you should post on the Gramps [[Contact#Mailing_lists|mailing list]] (probably the devel list) explaining why you feel its omission is a mistake.

* "WARNING: PIL module not loaded. "
* "ICU not loaded because %s. Localization will be impaired. "
* "OsmGpsMap module not loaded. "
* "GExiv2 module not loaded. "
* "Webkit module not loaded. "
* "PIL (Python Imaging Library) not loaded. "
* "GtkSpell not loaded. "

==== Configuration warnings ====

Sometimes it is worth just deleting the old configuration files. TBD instructions on how to do this.

* "Importing old key file 'keys.ini'..."
* "Done importing old key file 'keys.ini'"
* "Can't find filter %s in the defined custom filters"
* "Number of arguments does not match number of " +
* "Value '%(val)s' not found for option '%(opt)s'"
* "Unable to open recent file %s because %s",
* "WARNING: ignoring old key '%s'"
* "WARNING: ignoring key with wrong type "
* "Failed to parse doc options"
* "Skipped a line in the addon listing: "
* "Failed to load gramplets from %s because %s"

====Other warnings ====

TBD

=== Errors ===

More serious problems cause an error dialogue to appear which will describe the actions you should take. tbd. give example of the program error dialogue. Also explain what to do if Gramps suddenly quits, or if Gramps just won't start.

[[Image:Unexpected_error.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing Unexpected error]]

This dialogue appears whenever something has happened in the Gramps application that the programmers did not expect.

Have a look at [[How to create a good bug report]]. If you think you know how the Gramps developers might reproduce the bug, then by all means click on the 'Report' button. This will take you to the 'Report a bug' dialogue, and you can then follow the instructions.

[[Image:Report_a_bug.png|800px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing reporting wizard]]

{{-}}
==== Seeing all the error messages ====
Sometimes, not all the information needed to understand what has gone wrong will appear on the screen. For example, if you start Gramps with an invalid language setting (and some missing components) then the message that appears in the Warning dialogue is:

[[Image:Warning_message_GExiv2.png|800px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing limited warnings]]
{{-}}
However, the full set of warning messages is:
(process:10929): Gtk-WARNING **: Locale not supported by C library.
Using the fallback 'C' locale.
2013-03-13 18:49:04.376: WARNING: __init__.py: line 69: Date parser for 'xx_XX.UTF-8' not available, using default
2013-03-13 18:49:04.547: WARNING: __init__.py: line 85: Date displayer for 'xx_XX.UTF-8' not available, using default
2013-03-13 18:49:05.949: WARNING: spell.py: line 74: Spelling checker is not installed
2013-03-13 18:49:14.123: WARNING: gramplet.gpr.py: line 400: WARNING: GExiv2 module not loaded. Image metadata functionality will not be available.

Sometimes Gramps just doesn't start and nothing appears on the screen, or Gramps suddenly quits so you don't see anything on the screen. In all these cases you may need to do something special to see all the errors.

===== Linux =====

You can start Gramps from the Command Line, as described in the note [[Gramps_4.1_Wiki_Manual_-_Getting_started#Linux| here]]. You will then see all the diagnostic information on the terminal.

===== MS Windows =====

{{man warn|tbd}}

===== Mac OS X =====

You can look at the messages shown by the Console application, and select Gramps.

For example, one of the early alpha releases of Gramps 4.1.0 just would not start and displayed nothing on the screen. However by opening the Console application, and typing Gramps in the filter at the top right hand corner some diagnostic information appeared. (Actually we typed "gramps[" because there were some other messages that were not relevant, but it wouldn't matter if they were included as well).
[[Image:Console_output.png|1000px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Console output]]
{{-}}
By shift clicking to select all the relevant messages and copying them we get:
01/03/2013 00:08:02 [0x0-0x88088].org.gramps-project.gramps[1867] 2939: ERROR: importer.py: line 51: Could not find any typelib for Gtk
01/03/2013 00:08:05 [0x0-0x88088].org.gramps-project.gramps[1867] Gtk typelib not installed. Install Gnome Introspection, and pygobject version 3.3.2 or later.
01/03/2013 00:08:05 [0x0-0x88088].org.gramps-project.gramps[1867] Gramps will terminate now.

In this particular case, this was enough to help the developer discover the problem.
{{-}}

{{man index|Gramps 4.1 Wiki Manual - Getting Started|Gramps 4.1 Wiki Manual - Categories|4.1}}

{{languages|Gramps 4.1 Wiki Manual - Main Window}}

[[Category:Documentation]]