Open main menu

Gramps β

Changes

Gramps 5.2 Wiki Manual - Tools

5,159 bytes added, 21:38, 1 November 2025
no edit summary
{{#vardefine:chapter|14}}
{{#vardefine:figure|0}}
[[File:MenuOverview-Tools-5052.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}}
"{{man menu|Tools >...}}" Menubar - Tools Overview]]
This chapter describes the various {{man label|Tools}} available in Gramps.
== Tools ==
[[File:ToolbarIcon-OpenTheToolsDialog-5052.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Toolbar Icon for "Open the tools dialog"]]
The tools can be accessed by choosing the menu {{man menu|Tools ->''Tool Section'' ->''Particular Tool''}} .
=== Tool Selection dialog ===
[[File:ToolSelection-dialog-example-5052.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Tool Selection - dialog - example showing "Find Possible Duplicate PeopleCheck and Repair Database" information(and "Debug" tools selection)]]
The {{man label|Tool Selection}} dialog allows you to browse the complete selection of available tools along with their brief descriptions when invoked by clicking the {{man button|Open the tools dialog}} icon on the toolbar from any of the categories and use the {{man button|▶}} arrows to expand the listings.
====<u>Compare Individual Events</u>====
[[File:CompareIndividualEvents-EventComparisonFilterSelection-dialog-default-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Compare Individual Events" - "Event comparison filter selection" - dialog]]
{{stub}}
This tool compares events across the selected group of people.
Once the report finishes the {{man label|Name and title extraction tool}} dialog results window will be shown.
{{stub}}<!-- mention how to use-->
{{-}}
{{-}}
 
=====<u>Potential Merges</u>=====
[[File:FindPossibleDuplicatePeople-PotentialMerges-result-dialog-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Potential Merges" result dialog window for "Find Possible Duplicate People" - dialog - example]]
Once completed the {{man label|Gender statistics rebuilt}} result dialog will be shown.
 
{{man warn|Rebuild Gender Statistics needed after converting database|Issue {{bug|11314}} notes that gender statistics are swapped after database conversion to SQLite. If your gender guessing is suggesting the opposite gender for particular given names, use the Rebuilt Gender Statistics tool to fix the guessing.}}
 
See [[Gramps_5.2_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_1#Gender|Gender]] entry.
 
{{-}}
[[File:CleanInputData-dialog-tool-example-dialog-51.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Clean input data]]
{{stub}}Tool to clean leading and trailing spaces from imported or old data.  The tool searches for place names with leading or/and trailing spaces. It also looks in the first name and surname.
Tool to suppress leading and trailing spacesAs of version 5.0.  The tool searches for place names with 2, Gramps automatically strips such leading or/and trailing spaces. It also looks in space during name data being committed to the first name and surnametree.
You The tool can access it be triggered from the menu {{man menu|Tools > Utilities > Clean input data...}}or Tools selector dialog
See also:
* Avoid invalid characters and leading or trailing spaces in the entry field - (added in Gramps [[Template:Releases/5.0.2|5.0.2]] with [https://github.com/gramps-project/gramps/pull/811 PR811])* [https://github.com/gramps-project/gramps/pull/783 New tool to suppress leading and trailing spaces.] - (added in Gramps [[Template:Releases/5.1.0|5.21.0]])* Feature request {{bug|4566}} : Please remove trailing spaces on items on input (2016)* Feature request {{bug|4619}} : Trailing blanks are removed from queries in the preset filters (2011)
====<u>Find database loop</u>====
====<u>Media Manager</u>====
{{stub}}
[[File:Introduction-page-MediaManager-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Introduction - page for "Gramps Media Manager" - Tool wizard]]
=====Convert paths from relative to absolute=====
 
[[File:ConvertPathsFromRelativeToAbsolute-FinalConfirmation-page-MediaManager-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 'Convert paths from relative to absolute':"Final Confirmation" page for "Gramps Media Manager" - Tool wizard - example]]
This tool allows converting relative media paths to the absolute ones. It does this by prepending the {{man label|Base media path for relative media paths:}} as given in the {{man label|Family Tree}} tab of {{man menu|Edit->Preferences}} in the {{man label|[[Gramps_5.2_Wiki_Manual_-_Settings#GeneralFamily_Tree.27s_Media_path|Edit > Preferences > General Family Tree's Media path]] tab}} section, or if that is not set, it prepends the default [[Gramps_5.2_Wiki_Manual_-_User_Directory|User's Directory]]. 
* [https://en.wikipedia.org/wiki/Path_(computing)#Absolute_and_relative_paths Absolute and relative paths], From Wikipedia.
=====Convert paths from absolute to relative=====
 
[[File:ConvertPathsFromAbsoluteToRelative-FinalConfirmation-page-MediaManager-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 'Convert paths from absolute to relative':"Final Confirmation" page for "Gramps Media Manager" - Tool wizard - example]]
This tool allows converting absolute media paths to a relative path. The relative path is relative to the given base path in the setting {{man label|Base media path for relative media paths:}} as from given in the {{man label|Family Tree}} tab of {{man menu|Edit->Preferences}} in the {{man label|[[Gramps_5.2_Wiki_Manual_-_Settings#GeneralFamily_Tree.27s_Media_path|Edit > Preferences > General Family Tree's Media path]] tab}} section, or if that is not set, the user's directory is used. A relative path allows to tie connects the file location to a the base media path that can change be changed according to your needs.
* [https://en.wikipedia.org/wiki/Path_(computing)#Absolute_and_relative_paths Absolute and relative paths], From Wikipedia.
[[File:NotRelatedTo-dialog-NotRelated-Tool-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}}. "Not related to '...'" - dialog - showing results for "Not Related" Tool]]
This tool will list people who are not connected to the selected active person. Connections may include linked in a chain of [[References|references]] or linkages created with the [[Gramps_{{Version manual}}_Wiki_Manual_Gramps_5.2_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_2#Link_Editor|link editor in Notes]].
You can use this tool via menu {{man menu|Tools->Utilities->Not Related...}}.
[[File:RelationshipTo-dialog-RelationshipCalculator-Tool-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Relationship to '...' " - dialog - showing results for "Relationship Calculator" Tool]]
You can use this tool via menu {{man menu|Tools->&#x27a1; Utilities->&#x25B6; Relationship Calculator...}}.
Selecting the Relationship Calculator tool will open a list filtered to all people connected, '''but not necessarily related''', to the [[Gramps_Glossary#active_person|Active Person]]. To calculate relationship to different person, close the window, make that person Active and select the tool from the menu again.
Select the individual from the filtered list to report if a relationship exists. The exact relationship will be shown in the lower panel ... along the with the common ancesors of ancestors in that's reported relationship. Only blood relationships will display (except for husband-wife and step relationships). Note that "in-law" relationships are not displayed.
The filtered list will grouped and alphabetically sorted by surname. (Regardless of whether the View menu setting of the Person category has been set to '''Grouped'''.) The list columns cannot be re-sorted.
The degree of separation (generation distance) that will be recognized is controlled by the the ''{{man label|Max generations for relationships'' }} value in the [[Gramps_5.2_Wiki_Manual_-_Settings#GeneralLimits|GeneralLimits]] tab under the {{man menu|Edit->&#x27a1; Preferences...}} menu. Moved from the [[Gramps_5.1_Wiki_Manual_-_Settings#General|5.1 General]] tab {{New|5.2}} (The default of 15 generations will report a 12th great-grandparent relationship but not their parentsthe 13th great-grandparents. The active person is counted as one of the generations. So, self generation plus parent plus grandparents are the other 3 generations.)
Essentially, any two people are directly related by blood if they have an ancestor in common. One of these individuals may actually be an ancestor of the other - such as a great grandparent. Even in the cases of aunts and uncles, you still can calculate the relationship by searching for the common ancestor. In this case, the father or mother of the aunt or uncle will be a grandparent to the nephew or niece.
====<u>Verify the Data</u>====
{{man tip|Verify the Data tool enhanced{{new|5.2.0}}|Tool performance improved, results reorganized into a Tree rather than a flat list, additional tests.<br /> 8 New rules ([[Gramps_5.2_Wiki_Manual_-_Tools#Data_Verification_Results_window|marked below]]) to find additional irregularities.
<!-- see: verify tool: convert the ListStore to a TreeStore https://github.com/gramps-project/gramps/pull/1550 and 8 more rules https://github.com/gramps-project/gramps/pull/1574 -->}}
[[File:VerifyTheData-DataVerifyTool-dialog-General-tab-defaults-50.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Verify the Data..." - "Data Verify tool" dialog - "General" tab - defaults]]
Select this via the menu {{man menu|Tools->Utilities->Verify the Data...}} you will get a {{man label|Data Verify Tool}} window. The window has four tabs; {{man label|General}}, {{man label|Women}}, {{man label|Men}}, {{man label|Families}}. Those tabs show a list with criteria and a input field where you can alter the criteria value. In the lists below I show some ''workable'' values.
=====Verify the Data tab pages=====
Select the criteria you want to run the tool with from the following tabs. If you are OK with the criteria click the {{man button|Run}} button (or hit {{man key press|Alt|R}} and you will be presented with a {{man label|[[Gramps_5.2_Wiki_Manual_-_Tools#Data_Verification_Results_window|Data Verification Results]]}} window.
Depending on your criteria and your data a list will be shown. Some possibilities of findings are listed below. But there are others.
* Disconnected individuals =====Verify the Data tab pages===== Select the criteria you want to run the tool with from the following tabs. If you are OK with the criteria click the {{man button|Run}} button (ones with no parent or spouse or child or siblinghit the {{man key press|Alt|R}} keybinding)* old/dead father* marriage after death/ before birth* large year span for all children* early/late marriage* young/unborn mother* husband and wife you will be presented with the same surname* same sex marriage/ female husband* .a {{man label|[[Gramps_5.2_Wiki_Manual_-_Tools#Data_Verification_Results_window|Data Verification Results]]}} window.
======General======
=====Data Verification Results window=====
[[File:DataVerificationResults-window-example-5052.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Data Verification Results window.]]
After you run the tool you will be presented with the {{man label|Data Verification Results}} window.
 
Depending on your criteria and your data, a list will be shown. The possibilities of findings are listed below. (But others may be added.) Each match will be grouped with similar findings.
 
* Baptism before birth
* '''Baptism too late according to family tradition''' {{new|5.2.0}}
: This rule determines the median of days between birth and baptism over all children of a family. It then compares the days between the birth and the baptism of the person in question with also allowing some grace period of deviation. Currently, that grace period is hard-coded with 120 days.
* Birth equals death
* Birth equals marriage
* Burial before baptism
* Burial before birth
* Burial before death
* '''Burial too late''' {{new|5.2.0}}
: A Burial is considered “too late” when its more than 14 days after the date of death. Should this be a parameter or might this confuse the user?
* '''Children are not ordered chronological''' {{new|5.2.0}}
: Birth dates (if no date exists and estimation is on, Baptism dates are used) are checked for each child of a family. Verifies that dates ascend through the list of children. Children without any of those dates are ignored
* Dead father
* Dead mother
* Death before baptism
* Death before birth
* Death equals marriage
* Disconnected individual
: ones with no parent or spouse or child or sibling
* Early marriage
: ( General tab, default = 17 )
* '''Families are not ordered chronological''' {{new|5.2.0}}
: This Rule uses the marriage date and evaluates that the families are ordered in a chronological order for a person. If no marriage date is available a divorce date or even the birth date of the oldes child of each family is used. The birth date as last possible fallback is used to account for non-married families with illegitimate children.
* '''Family events not ordered chronological''' {{new|5.2.0}}
* '''Family has events with role Unknown''' {{new|5.2.0}}
* Female husband
* Husband and wife with the same surname
* Invalid birth date
: ( General tab, default = True )
* Invalid death date
: ( General tab, default = True )
* Large age difference between spouses
: ( Families tab, default = 30 )
* Large age differences between children
: ( Families tab, default = 8 )
* '''Large year span for all children''' {{new|5.2.0}}
: ( Families tab, default = 25 )
* Late marriage
: ( General tab, default = 50 )
* Male wife
* Marriage after death
* Marriage before birth
* Marriage date but not married
* Married often
: ( General tab, default = 3 )
* Multiple parents
* Old age at death
* Old age but no death
: ( General tab, default = 90 )
* Old and unmarried
: ( General tab, default = 50 )
* Old father
: ( Men tab, default = 65 )
* Old mother
: ( Women tab, default = 48 )
* '''Person events not ordered chronological''' {{new|5.2.0}}
* '''Person has events with role Unknown''' {{new|5.2.0}}
* Same sex marriage
* Too many children
: ( Men tab, default = 15; Women tab, default = 12 )
* Unborn father
* Unborn mother
* Unknown gender
* Young father
: ( Men tab, default = 18 )
* Young mother
: ( Women tab, default = 17 )
 
On the bottom of the window four buttons are available to make a selection easier. Those are {{man button|Mark all}}, {{man button|Unmark all}}, {{man button|Invert marks}}, and {{man button|Hide marked}}.
*:The warning showed 'late marriage': checking the data: male person °1738 female person °1756 : marriage X 1804 [Gregorian Calendar] : Everything seemed to be OK: so they (re)married at the age of 66 and 48 years! The warning showed up because the '''General criteria''' was set to '''60'''.
=====See Also=====* Development discussion on Gramps community support Discourse forum:: [https://gramps.discourse.group/t/interest-in-enhancing-verify-py/4075/23 Interest in enhancing verify.py]
{{man tip|Difference between {{man label|Verify the Data}} tool and the [[Gramps_5.2_Wiki_Manual_-_Tools#Check_and_Repair_Database|Check and Repair Database tool]] |The Check and Repair Database tool detects inconsistencies in the database structure. The {{man label|Verify the Data}} tool, however, is detecting the records that do not satisfy your particular criteria.}}
{{-}}
When the python <code>-O</code> optimise flag is not turned on, an additional {{man menu|Debug}} entry appears in the {{man menu|[[Gramps_5.2_Wiki_Manual_-_Tools|Tools]]}} menu.
Also See :* [[Gramps_5.2 Wiki Manual - Command Line#Python options|Command Line: Python options]]* [[Gramps_5.2_Wiki_Manual_-_Gramplets#Uncollected_Objects|Uncollected Objects]] Gramplet* [[Gramps_5.2_Wiki_Manual_-_Gramplets#Python_Evaluation|Python Evaluation]] Gramplet
{{-}}
====Check Localized Date Displayer and Parser====
This test tool will create many people showing all different date variants as birth. The death date is created by parsing the result of the date displayer for the birth date. This way you can ensure that dates printed can be parsed back in correctly.
{{stub}}<!-- add keybindings etc -->
{{-}}
[[File:GenderStatisticsTool-dialog-DumpGenderStatistics-Tool-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Gender Statistics tool" dialog results example - for "Dump Gender Statistics" - Tool]]
Will dump the statistics for the gender guessing from based on the persons first name.{{stub}} See [[Gramps_5.2_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_1#Gender|Gender]] entry.
{{-}}
The {{man label|[[Gramps_5.2_Wiki_Manual_-_Error_and_Warning_Reference#Undo_history_warning|Undo history warning]]}} dialog will be shown and you can either {{man button|Stop}} or {{man button|Proceed with the tool}}.
{{stub}}* Command line usage see: [[Plugins_Command_Line#Generate_Testcases_for_Persons_and_Families]]
{{-}}
This tool generates sources and citations for each source in order to populate the database for testing with significant numbers of sources and citations.
{{stub}}
{{-}}
15,091
edits