Open main menu

Gramps β

Gramps 6.0 Wiki Manual - Tools

(Redirected from Gramps 6.0 Wiki Manual - Tools/pl)
Previous Index Next


Fig. 14.1 "Tools >..." Menubar - Tools Overview - default

This chapter describes the various Tools available in Gramps.

Gramps Tools allow you to perform various types of analysis of your genealogical data. Typically, the tools do not produce output in form of printouts or files. Instead, they produce screen output immediately available for the researcher. However, when appropriate, you can save the results of running a tool into a file.

Contents

Tools

 
Fig. 14.2 Toolbar Icon for "Open the tools dialog"

The tools can be accessed by choosing the menu Tools ->Tool Section ->Particular Tool .

Alternatively, you can browse the complete selection of available tools along with their brief descriptions in a Tool Selection dialog invoked by clicking the Open the tools dialog icon on the toolbar from any of the categories.

 
Additional Tools

Gramps allows you to install even more tools. This system is controlled by the Plugin Manager. For additional tools see Addons.

Tool Selection dialog

 
Fig. 14.3 Tool Selection - dialog - default information (and "Debug" tools selection)
 
Fig. 14.4 Tool Selection - dialog - example showing "Check and Repair Database" information (and "Debug" tools selection)


The Tool Selection dialog allows you to browse the complete selection of available tools along with their brief descriptions when invoked by clicking the   Open the tools dialog icon on the toolbar from any of the categories and use the arrows to expand the listings.

Select a tool from those available on the left. Use the arrows to expand the top level listings:

Then select the tool you are interested in to be shown on the right hand side the following:

  • Tool name
  • Tool description
  • Status:
  • Author:
  • Author's email:

You can can then use the buttons below to either find out more about the tool or open and run your tool.

  • Wiki opens the help page if available - needs an internet connection — ⚡new for version 6.0.0
  • Close exits this dialog
  • Run - Run selected tool - opens the tools configuration page.


See also: Report Selection dialog

Analysis and Exploration

This section contains tools which analyze and explore the database, but do not alter it. The following analysis and exploration tools are currently available in Gramps:

Compare Individual Events

 
Fig. 14.5 "Compare Individual Events" - "Event comparison filter selection" - dialog

This tool collates all the event types discovered in a group of people. Arguably, it could be considered to be more a Report than a Tool. It generates a summary comparison table that begins with the Name and ID of each person, then adds columns for the Event types and dates. If there are multiples of the same event type, additional rows are created. The collation ignores the Roles but includes custom Event types.

The resulting table is useful for comparing of suspected duplicates and revealing inconsistencies. The table can become quite wide so the Save As (in the .ods format) will allow analysis in a spreadsheet application.

You can use this tool via menu Tools->Analysis and Exploration > Compare Individual Events... which will open the Event comparison filter selection dialog

Event comparison filter selection dialog

The people for this comparison can be chosen from previously created custom filters by selecting the Filter: drop down list, which defaults to the Entire Database. Or by selecting the Custom Filter Editor button, to create custom filters in the Person Filters editor. To run the report select Apply and the results will be displayed in the Event Comparison Results dialog.


Event Comparison Results dialog

From the Event Comparison Results dialog you can view the results or Save As the resulting table as a spreadsheet (ODS format). Select Close to exit the report.

 
Fig. 14.6 "Compare Individual Events" - "Event Comparison Results" - dialog - expanded example


The spreadsheet (ODS format) shows the following output fields:

  • Person, ID, Birth Date, Birth Place, Death Date, Death Place, LVG Date, LVG Place, Burial Date, Burial Place, Marriage Date, Marriage Place


Family Tree Processing

This section contains tools which may modify your database. The tools from this section are used mostly for finding and correcting errors in the data. The following Family Tree Processing tools are currently available in Gramps:

 
Family Tree Processing tools will only perform modifications upon your explicit consent

Except for the automatic fixes performed by Check and repair Database tool in the Family Tree Repair menu.

Edit Database Owner Information

 
Fig. 14.7 "Database Owner Editor" - dialog - default

The Edit Database Owner Information tool modifies any existing Researcher Information.

Select the menu Tools->Family Tree Processing->Edit Database Owner Information.... This brings up the Database Owner Editor window, where you can fill in the needed information or use one of the buttons to retrieve existing information.

  • Name:
  • Street:
  • Locality:
  • City:
  • State/County:
  • Country:
  • ZIP/Postal Code:
  • Phone:
  • Email:

This information is family tree specific and will be used when exporting your data in GEDCOM format.

Two button choices are available:

  • Copy from DB to Preferences - to the Researcher section.
  • Copy from Preferences to DB - from the Researcher section.

— ⚡new for version 6.0 - Use regular buttons to copy owner information from/to preferences

Extract Event Description

 
The name format in the Event's Description field depends on

the defined name format in Edit->Preferences->Data> Display Options (section) ->Name format:


Extracts event descriptions from the event data by using a model :

{event type} of {Surname}, {Given name}

If event description is missing, then tool will use this event description field model.

You can access this tool via the menu Tools->Family Tree Processing->Extract Event Description...

The Undo history warning will be shown and you can either Stop or Proceed with the tool.

Once you Proceed with the tool this tool will scan and modify your Family Tree and if not present show you the No modifications made alert otherwise if present you with the:

Modifications made result window
 
Fig. 14.8 Extract Event Description's - "Modifications Made" - window - example result

Modifications made result window listing the total number of event descriptions that have been added.

Extract Information from Names

This tool searches the entire database and attempts to extract titles and nicknames that may be embedded in a person's Given name field. If any information could be extracted, the candidates for fixing will be presented in the table. You may then decide which to repair as suggested and which not to.

You can access this tool via the menu Tools->Family Tree Processing->Extract Information from Names....

The Undo history warning dialog will be shown and you can either Stop or Proceed with the tool.

The Default prefix and connector settings dialog will be shown and you can modify each of the options as required and once you have finished select OK to start the tool.

Once the tool finishes either the No modifications made dialog will be shown as No titles, nicknames or prefixes were found or the Name and title extraction tool window will be shown with results of the search.

Default prefix and connector settings dialog
 
Fig. 14.9 "Default prefix and connector settings" - dialog for the "Extract Information from Names" Tool

The Default prefix and connector settings dialog you can modify each of the options as required:

  • Prefixes to search for: de, van, von, di, le, du, dela, della, des, vande, ten, da, af, den, das, dello, del, en, ein, elet, les, lo, los, un, um, una, uno, der, ter, te, die (default)
  • Connectors splitting surnames: e, y (default)
  • Connectors not splitting surnames: de, van (default)


No modifications made dialog
 
Fig. 14.10 "No modifications made" - dialog for the "Extract Information from Names" Tool

Shown when No titles, nicknames or prefixes were found in the selected family tree.

Select Close to dismiss the dialog.


Name and title extraction tool window

The top section shows information about the tool.

 
Below is a list of the nicknames, titles, prefixes and compound surnames that Gramps can extract from the Family Tree.

If you accept the changes, Gramps will modify the entries that have been selected.

Compound surnames are shown as lists of [prefix, surname, connector].

For example, with the defaults, the name "de Mascarenhas da Silva e Lencastre" shows as:

      [de, Mascarenhas]-[da, Silva, e]-[,Lencastre]
Run this tool several times to correct names that have multiple information that can be extracted.

 
Fig. 14.11 "Name and title extraction tool" - dialog results window for the "Extract Information from Names" Tool

The bottom section displays the results list in a table with the following columns: Select, ID, Type, Value, Current Name

You can un-Select the results you don't want and then Accept and close to apply those results to your family tree or Cancel to do nothing. The Help button brings you to this tools help section.

Extract Place Data from a Place Title

 
This tool was moved to Third-party addons.

When the Place Hierarchy was first added to Gramps, every user needed a tool to Addon:Extract Place Data from a Place Title. Now that that a Hierarchy of Places is well established, the tool is needed infrequently. So installation has been made optional.

Find Possible Duplicate People

 
Fig. 14.12 Find Possible Duplicate People - dialog - default

The Find Possible Duplicate People tool searches the entire Tree database, looking for the entries that may represent the same person.

You can access this tool via the menu Tool -> Family Tree Processing -> Find Possible Duplicate People....

The Find Possible Duplicate People dialog will be shown and you can adjust the following options:

  • Match Threshold : choose between Low (default), Medium and High from the drop down menu.
 
How is the quality of match measured?

This calculates the chances (or 'odds') of matching on a quality scale labeled as low, medium and high. For each piece of information that corresponds, the quality of the match is considered to be marginally increased. The closer the particular pieces of data correlate, the larger the increase. When the chance is greater than the selected Match Threshold then a match will reported. The thresholds are Low=0.25, Medium=1.0 and High=2.0. So, with the filtering threshold set to High, fewer matches are expected.

Options

  • Use soundex codes for matching possible duplicate people. (checkbox checked by default)

The following buttons are present: Help brings you to this page, Cancel to stop processing and an OK button to start processing the data.

Select OK to start the tool and the data will be processed in two passes.

  • Pass 1: Building preliminary lists
  • Pass 2: Calculating potential matches.

A progress bar will be shown and depending the speed of your computer and the amount of people in the database this can take some time.


Potential Merges
 
Fig. 14.13 "Potential Merges" result dialog window for "Find Possible Duplicate People" - dialog - example

Once the report finishes a Potential Merges result list window is presented with the following columns shown:

  • Rating : this gives you an idea of the resemblance between the two people. The higher the ranking, the higher the chance that the people are duplicates.
  • First Person
  • Second Person

You can either double-click on the selected row or select the Compare button to check the details.

Three buttons are present: Help brings you to this page, a Close to close the window which returns you to the Find Possible Duplicate People window and a Compare button to which brings up the Merge People window which was explained in detail in the Merge People dialog. Here you can select with the radio buttons one of the persons and eventually use the OK button to merge the data if you find the two persons are duplicates.

Selecting the Cancel button brings you back to the Potential Merges result list window.

Fix Capitalization of Family Names

This tool searches the entire database and attempts to fix the capitalization of family names.

The aim is to have conventional capitalization: capital first letter and lower case for the rest of the family name. If deviations from this rule are detected, the candidates for fixing will be presented in the table.

You may then decide which to repair as suggested and which not to.

You can use this tool via menu Tools->Family Tree Processing->Fix Capitalization of Family Names....

 
Undo history

Proceeding with this tool will erase the undo history for this session. In particular, you will not be able to revert the changes made by this tool or any changes made prior to it. It is recommended that you please stop here and backup your database; so that you can revert the process of running this tool.

The Undo history warning will be shown and you can either Stop or Proceed with the tool.


 
Fig. 14.14 "Capitalization changes" - dialog - results example for "Fix Capitalization of Family Names" tool

If there where changes to the capitalization of any names you will be presented with the Capitalization changes results window. The window shows a list of the family names that Gramps can convert to (according to Gramps) correct capitalization (please check that it is correct for you.). In the Capitalization changes results window list the following columns are available:

  • Select - Check or uncheck these on a "by name" basis if you choose not to accept the recommendation (checkbox checked by default)
  • Original Name - The name as currently recorded.
  • Capitalization Change - The name with change if applied.

Select the names you want to be changed, then select the Accept changes and close button. Or use the Cancel button to abort changes.

You can also install the "Addon:Fix Capitalization of Given Names" tool Addon that once installed works almost identically to this tool but works for "Given Names"

Merge citations

 
The Merge Citations tool

works by combining notes, media objects and data-items of matching citations.


You can select this via menu Tools > Family Tree Processing > Merge Citations... .

 
Undo history

Proceeding with this tool will erase the undo history for this session. In particular, you will not be able to revert the changes made by this tool or any changes made prior to it. It is recommended that you please stop here and backup your database; so that you can revert the process of running this tool.

The Undo history warning will be shown and you can either Stop or Proceed with the tool.

 
Fig. 14.15 "Merge Citations" - dialog - default

Then the Merge Citations dialog (Title of dialog shows:Notes, media objects and data-items of matching citations will be combined.)will be shown

The following options are available:

  • Match Threshold drop down list:
    • Match on Page/Volume, Date and Confidence
    • Ignore Date (default)
    • Ignore Confidence
    • Ignore Date and Confidence
  • Options
    • Don't merge if citation has notes (checkbox unchecked by default)


 
Fig. 14.16 "Number of merges done" result dialog for "Merge Citations" - dialog - Tool - example

Select OK to run the tool and once complete it will report back the total with the Number of merges done result dialog.
See also the Merge Citations option available from the Citations Category list view

Rename Event Types

This tool will rename all events of one type to a different type.

You can access this tool via the menu Tools->Family Tree Processing->Rename Event Types....

The Undo history warning will be shown and you can either Stop or Proceed with the tool.

 
Undo history

Proceeding with this tool will erase the undo history for this session. In particular, you will not be able to revert the changes made by this tool or any changes made prior to it. If you think you may want to revert running this tool, please stop here and backup your database.


 
Fig. 14.17 "Change Event Types" - dialog - example for "Rename Event Types" Tool

The Change Event Types dialog is presented.

  • Original event type: fill in the text field or use the drop down menu and select an original event type
  • New event type: fill in the text field (you can create a complete new type here) or use the drop down menu and select a new type

The example shows a renaming of the Birth event to a Baptism event.

 
Custom types

While the custom types do not show in the drop down list, you can over type or paste into either of the selection boxes and convert from one to another.



 
Fig. 14.18 "Change types" - result dialog - example for "Rename Event Types" Tool

Finally use the Cancel to exit or select OK to run the tool and once complete it will report back the total events modified with the Change types result dialog.

 
Renaming events

Once completed, this cannot be undone by the regular Undo function.

See also:

Reorder Gramps IDs

This tool can be used to reorder your Gramps object IDs.

 
Fig. 14.19 "Reorder Gramps IDs" tool window - example

You can use this tool via menu Tools->Family Tree Processing->Reorder Gramps IDs....

Initialy the Undo history warning will be shown and you can either Stop or Proceed with the tool.

Then the Reorder Gramps IDs tool window will be shown where you can modify the column options as needed then select OK to start the process.

The tool will then show various progress dialogs during the different progress stages; as the following object IDs' are reordered: 'Reordering People IDs', 'Reordering Family IDs', 'Reordering Event IDs', 'Reordering Place IDs', 'Reordering Source IDs', 'Reordering Citation IDs', 'Reordering Repository IDs', 'Reordering Media Object IDs' and finally 'Reordering Note IDs'.

In the final step 'unused IDs' are searched for and assigned.

During this process the tool will examine each ID to see if it looks like it has been 'customized', if it doesn't look like the previous object ID format or the default object ID format. This might be the case if the user has manually entered their own text in the ID field for the object when editing it. It might also occur if the third-party GeoName Addon has been used or the GetGOV Addon that stores the GOV ID in the Place ID field. If a customized ID is found, the tool will show the Reorder Gramps IDs replace dialog that ask the user if they really wants to replace the ID and also optionally allows the user to use the same answer for same found customized object IDs.

 
Custom IDs'

If you customized your object IDs', all those can be replaced by this tool. So take care by backing up before you use this tool!

Reorder Gramps IDs tool window
 
Fig. 14.20 "Reorder Gramps IDs" tool window - default on new empty family tree

The Reorder Gramps IDs tool window shows each of Gramps objects (Person, Family, Event, Place, Source, Citation, Repository, Media, Note) and the following option columns (Object, 'Actual, Quantity, Format, Change, Start, Stop, Keep) that can be applied to changing the object ID's.

The Help button will show this section. The Cancel button will exit the tool. The Ok start the tool.

Most of the column labels also double as hidden toggles buttons and perform various actions as described below.

Object
This column lists the type of Gramps ID. Immediately to the left of this column are checkboxes that allow the enabling of changes to individual object types. When checked, the type can be reordered. The Object label is actually a hidden button that can be used to toggle all of the checkboxes at once.
Actual
This column shows an example of the current objects ID.
Quantity
This column show the current number of objects in the family tree.
Format
This column can be used to change the ID format for each object type. Note that the default ID formats consists of a one letter prefix (I, F, E, P, S, C, R, O, N) representing each of the objects, and then a suffix '%04d'. There MUST be at least a prefix or a suffix, both are allowed. It is recommended to keep these relatively short. The '%04d' defines the length of the numeric portion of the ID, the '4' can be changed, anything from '3' (allowing numbers from 000-999) to '9' (000000000-999999999) is allowed (If your family tree needs more than "nine hundred ninety-nine million, nine hundred ninety-nine thousand, nine hundred ninety-nine" please raise a feature request!). Changes made here are the same as made in the menu Edit->Preferences... and then select the ID Formats tab. The 'Format' label is actually a hidden button that can be used to reset all the formats to the last used value.
Change
This column contains checkboxes for each object type. When checked, the IDs for that object will be replaced with new IDs of the Format style, unless Keep is also checked. If there is no checkmark, the ID formats are NOT updated, but the number field within the format is renumbered. The Change label is actually a hidden button that can be used to toggle all of the check boxes at once.
Start
This field indicates the starting number used during the renumber operation. The Start label is actually a hidden button that can be used to toggle between start at 0, and start after last current number.
Step
This field indicates the interval between numbers during the renumber, 1 is a simple increment, 2 will increment by 2 etc. The Step label is actually a hidden button that can be used to toggle between 1, 2, 5, and 10.
Keep
This column contains check boxes for each object type. If both the Keep and Change check boxes are checked, the ID formats for that object will be retained, and the number field within the format is renumbered. The Keep label is actually a hidden button that can be used to toggle all of the check boxes at once.
Reorder Gramps IDs replace dialog
 
Fig. 14.21 "Reorder Gramps IDs" replace dialog - example

The Reorder Gramps IDs replace dialog that ask the user if they really wants to replace the ID and also optionally allows the user to use the same answer for same found customized object IDs.

  • [ ] Use this answer for the rest of the items

Select Yes or No.

Sort Events

Events appearing on the Event tab on a Person or Family Editor are not sorted in any particular order other than the order that the events were added. The reason for not enforcing any particular ordering, particularly ordering by date, is to allow for the situation where an event was known to have happened but the exact chronology is not. Importing or merging data from an external source can lead to extra events being added to, but out of sequence with, the existing set of events of a person or family.

Events can be manually re-ordered by drag & drop or by use of the re-order buttons on the Events tab. Either way, an event can be moved up or down in the list of events and Gramps will remember the new order when the changes are saved. The new ordering will be used wherever events are shown elsewhere in Gramps, such as on a report.

The order of all events on a tab can also be changed by clicking a column title. For example, clicking the Date column header will sort all the events in date order. However this way of sorting events is temporary and changes to the event order are not preserved when the window is closed.

The drag and drop approach to sorting events is fine for moving a small number of events but is not practical for large scale changes. The Sort Events tool has been designed specifically for this purpose, re-sorting all events in the database or just those associated with a targeted selection of people chosen by using a filter.

Sort Events tool

You can use this tool via menu Tools->Family Tree Processing->Sort events....

The Undo history warning will be shown and you can either Stop or Proceed with the tool.

 
Undo history

Proceeding with this tool will erase the undo history for this session. In particular, you will not be able to revert the changes made by this tool or any changes made prior to it. If you think you may want to revert running this tool, please stop here and backup your database.


Tool Options tab
 
Fig. 14.22 "Sort Events" Tool - dialog - showing "Tool Options" tab

On the Tool Options tab for the Sort Events dialog window the first option is used to define the range of people who's events are to be sorted. The first choice in the list is to apply the sorting to all people in the database. Alternative choices are to apply sorting to ancestors and descendants of a chosen person or to a range of people selected by a custom built person filter. After choosing who the sort should apply to, the next thing to consider is how the events should be sorted. The first option is to sort by date. This is probably the most likely choice, but other event attributes can be chosen too. The final choices are whether to make the events sorted ascending or descending and whether to apply the sort to family events that the selected people belong to as well.

 

This article's content is incomplete or a placeholder stub.
Please update or expand this section.



 
Sorting events

Once completed, this cannot be undone by the regular Undo function.

Family Tree Repair

The following Family Tree Repair tools are available:


Check and Repair Database

 
Warning: The Check and repair Database tool performs automatic fixes.

Once completed, this cannot be undone by the regular Undo History function.

The Check and repair Database tool checks the selected database/Family Tree for integrity problems, fixing the problems it can. Specifically, the tool is checking for:

  • Broken family links. These are the cases when a person's record refers to a family while the family's record does not refer to that person, and vice versa.
  • Missing media objects. The missing media object is the object whose file is referenced in the database but does not exist. This can happen when the file is accidentally deleted, renamed, or moved to another location.
  • Empty families. These are the family entries which have no reference to any person as their member.
  • Parent relationship. This checks all families to ensure that father and mother are not mixed up. The check is also made that parents have different gender. If they have common gender then their relationship is renamed to "Partners".

You can use this tool via menu Tools->Family Tree Repair->Check and Repair Database....

 
Undo history

Proceeding with this tool will erase the undo history for this session. In particular, you will not be able to revert the changes made by this tool or any changes made prior to it. It is recommended that you please stop here and backup your database; so that you can revert the process of running this tool.

The Undo history warning will be shown and you can either Stop or Proceed with the tool.


Integrity Check Results dialog
 
Fig. 14.23 "Integrity Check Results" - example result dialog - for the "Check and Repair Database" tool

Any issues found are automatically fixed and the Integrity Check Results dialog will be shown with a summary actions taken.

No errors were found dialog

Otherwise you will see the No errors were found dialog stating that The database has passed internal checks.

Gramps had a problem the last time it was run - dialog
 
Fig. 14.24 Gramps had a problem the last time it was run - dialog

After Gramps crashes on restart, Gramps will offer to run Check & Repair tool. (Introduced in Gramps 5.1.x)


Rebuild Gender Statistics

 
Fig. 14.25 "Gender statistics rebuilt" - result dialog for "Rebuild Gender Statistics" tool

Rebuilds gender statistics for name gender guessing based on the accumulated statistics of genders for given names within the tree. If a gender is common to more than half the in the Tree with a particular first word in their Given name, then Gramps will guess that Gender for that name will be the same.

The statistics can also be cleared (if the Tools ➡ Debug menu has been enabled) with the Dump Gender Statistics Tool.

You can use this tool via menu Tools ➡ Family Tree Repair ▶ Rebuild Gender Statistics....

Once completed the Gender statistics rebuilt result dialog will be shown.

 
Rebuild Gender Statistics needed after converting database

Issue 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 Gender entry.


Rebuild Reference Maps

 
Fig. 14.26 "Reference maps rebuilt" - result dialog for "Rebuild Reference Maps" tool

This tool rebuilds reference map tables. This drives the list of References items in editors.

You can use this tool via menu Tools ➡ Family Tree Repair ▶ Rebuild Reference Maps....

Once completed the Reference maps rebuilt result dialog will be shown.

See also


Rebuild Secondary Indexes

 
Fig. 14.27 "Secondary indexes rebuilt" - result dialog for "Rebuild Secondary Indexes" tool

This tool rebuilds secondary indices.

You can use this tool via menu Tools ➡ Family Tree Repair ▶ Rebuild Secondary Indexes....

Once completed the Secondary indexes rebuilt result dialog will be shown.

The Rebuild Secondary indexes... re-constructs the secondary tables in the Tree db. These tables include things like gender statistics (Given Name versus gender) to allow guessing the gender of names as they are entered, surnames (for faster lookup of possible surname and to make the person tree view work), the various IDs for objects (to facilitate lookup by ID), place enclosure tables, to make the place tree view work, and a few others.

In theory, these tables are kept constantly up-to-date when anything changes. So rebuilding the Reference Maps and Secondary Indices should not be necessary. But, especially early on in the Gramps history, bugs sometimes interfered with updates completing correctly. So the tools remain available... ‘just in case’.

See also


Remove Unused Objects

This tool will search your database for pieces of information which are not connected to anything else, and then allow you to edit and attach the information or remove them.

You can use this tool via menu Tools->Family Tree Repair->Remove Unused Objects....


 
Fig. 14.28 "Unused Objects" - dialog example results for "Remove Unused Objects" tool

The Unused Objects dialog is presented.

You can choose from the search option you want to use from the top section of the Unused Objects dialog:

  • Search for events (checkbox checked by default)
  • Search for sources (checkbox checked by default)
  • Search for citations (checkbox checked by default)
  • Search for places (checkbox checked by default)
  • Search for media (checkbox checked by default)
  • Search for repositories (checkbox checked by default)
  • Search for notes (checkbox checked by default)

Select the Find button to run the tool, and once completed the results if any will show in the bottom section of the Unused Objects dialog with the following columns shown:

  • Mark Select the row if you want to delete the object (unchecked by default)
  • - Icon representing the type of object.
  • ID - Gramps internal name for the object.
  • Name - of the object.

To examine the object you must double-click on the row and it will show the appropriate editor for the object allowing you to edit if required.

Mark the objects you want to delete either using the individual checkboxes or using the associated buttons:

  • Mark all
  • Unmark all
  • Invert marks

Once your deletion choices have been made select the Delete button to delete the objects.

When finished you may then use the Close button to exit the tool.

 
Multiple runs of the Remove Unused Objects tool maybe needed in order to actually clean the database.

See: Feature Requests 3249 "Remove Unused Objects" tool is misleading as Multiple runs of the tool are needed.

Utilities

This section contains tools allowing you to perform a simple operation on a portion of data. The results can be saved in your database, but they will not modify your existing data. The following utilities are currently available in Gramps:


Clean input data

Remove leading and trailing spaces

 
Fig. 14.29 Clean input data

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.

Leading and trailing spaces are automatically removed during name data being committed to the tree.

The tool can be triggered from the 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 5.0.2 with PR811)
  • New tool to suppress leading and trailing spaces. - (added in Gramps 5.1.0)
  • Feature request 4566 : Please remove trailing spaces on items on input (2016)
  • Feature request 4619 : Trailing blanks are removed from queries in the preset filters (2011)


Find database loop

 
Fig. 14.30 Pedigree chart showing loop - example

The Find database loop utility allows you to verify if you have ancestral loops in the database. Loops in your family tree may for example show a person as both the child and ancestor of another person in Family Tree. Loops can happen accidentally during data entry, for example, when a son is linked into the family tree as his own grandfather!

Other valid loops also happen and should be kept in the family tree if verified:

  • An inbreeding loop because the parents are related.
  • A mating loop caused by a male who has children to genetically related females.
  • An incest mating loop caused by full siblings.


 
Fig. 14.31 Find database loop - dialog - results from example family tree case

Use the menu Tools->Utilities->Find database loop... and you will get a Find database loop window that will display the results in a list with six columns: Loop Group unlabeled (Gramps ID, Parent), (Gramps ID, Child), Family ID.

  • Loop Group unlabeled column - a number related to which loop the entries are about.
  • First Gramps ID is a reference to the Parent.
  • Parent (Ancestor on the image) is the person we are looking for a loop.
  • Second Gramps ID is a reference to the Child.
  • Child (Descendant) is the origin of the loop.
  • Family ID is a reference to the associated family

Double clicking on a selection will open the related Families entry.

To fix a pedigree loop in your family tree.

  • Locate the person page of the individual whose relationship needs to be adjusted.
  • First, verify that a name or vital event date was not accidentally entered incorrectly.
  • If you are sure that deleting the incorrect parent-child relationship will fix the loop, proceed with the steps.

Once you have resolved any loops select Close to exit.


To read more about ancestral loops see:

Also see:

Example ancestral loops
 

This article's content is incomplete or a placeholder stub.
Please update or expand this section.


 
Fig. 14.32 Find possible loop in a complex example
 
Fig. 14.33 chart showing complex example


In the following complex example, we have multiple ancestral loops indicated by the number in the first unlabeled column a "Loop Group" :

If we look at the second line, we have :

  1. First Gramps_ID : I0002
  2. Parent is : Father, Child2
  3. Second Gramps_ID : I0001
  4. Child is : Father, Father
  5. Family_ID is : F0000


 
Fig. 14.34 Find possible loop in a complex example

To understand what happens :

  1. we start at [I0002] Father, Child2.
  2. We continue with his son [I0003] Father, Child3.
  3. We continue with his son : [I0000] Child, Child.
  4. We continue with his son : [I0001] Father, Father.
  5. We continue with his son : [I0002] Father, Child2 ==> HERE, we have a ancestral loop.


Media Manager

 

This article's content is incomplete or a placeholder stub.
Please update or expand this section.


The Gramps Media Manager is a group of four separate tools accessed via a wizard like dialog that you can access via the menu Tools->Utilities->Media Manager... which will show the first Introduction dialog page.

Introduction
 
Fig. 14.35 Introduction - page for "Gramps Media Manager" - Tool wizard


A brief information on the tools abilities is shown.

From the Introduction page selecting the Next button (or using the keyboard shortcut Alt+N) you will be shown the Selection page window.

 
Introduction

This tool allows batch operations on media objects stored in Gramps. An important distinction must be made between a Gramps media object and its file.

The Gramps media object is a collection of data about the media object file: its filename and/or path, its description, its ID, notes, source references, etc. These data do not include the file itself.

The files containing image, sound, video, etc. exist separately on your hard drive. These files are not managed by Gramps and are not included in the Gramps database. The Gramps database only stores the path and file names.

This tool allows you to only modify the records within your Gramps database. If you want to move or rename the files then you need to do it on your own, outside of Gramps. Then you can adjust the paths using this tool so that the media objects store the correct file locations.



Selection
 
Fig. 14.36 Selection - page for "Gramps Media Manager" - Tool wizard - default

From the Selection page window select from one the four options the actions you want to take and then select the Next button:


Replace substrings in the path
 
Fig. 14.37 Replace substring settings - page for "Gramps Media Manager" - Tool wizard - default

This tool allows replacing specified substring in the path of media objects with another substring. This can be useful when you move your media files from one directory to another.

Selecting this radio button will bring up a Replace substring settings window where you can type in any string in the Replace text field and the With text field. At any time you can click on the Cancel button or the Back button. Clicking the Forward button will bring up the Final confirmation window.


Convert paths from relative to absolute
 
Fig. 14.38 '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 Base media path: as given in the Family Tree tab of Edit->Preferences in the Family Tree's Media path section, or if that is not set, it prepends the default User's Directory.


Convert paths from absolute to relative
 
Fig. 14.39 '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 Base media path: as given in the Family Tree tab of Edit->Preferences in the Family Tree's Media path section, or if that is not set, the user's directory is used. A relative path connects the file location to the base media path that can be changed according to your needs.


Add images not included in database
 
Fig. 14.40 'Add images not included in database':"Final Confirmation" page for "Gramps Media Manager" - Tool wizard - example

Check directories for images not included in database, this tool adds images in directories that are referenced by existing images in the database. You will have to import one media item from each sub directory manually. Media Manager does not include sub-directories automatically. All the directory paths shown in the tool will be searched through.

Not Related

 
Fig. 14.41. "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 or linkages created with the link editor in Notes.

You can use this tool via menu Tools->Utilities->Not Related....

You will get a Not related to '...' results dialog which shows a list of all the people that are NOT related to the selected person.

This list gives you:

  • Name
  • ID
  • Parents
  • Tags

From the Name column you can use the ▶ right arrow button and ↓ down arrow buttons to collapse or expand the grouped Name list. Double clicking on a person will bring up the person edit dialog or family edit dialog.

If you select a person, you can use the Tag text field (you can fill in whatever custom tag name you want to use) or use the drop down list to choose an existing tag eg TODO, NotRelated. Use the Apply to add the selected tag to the person(s). This tag will then show up in the Tags column.

Relationship Calculator

 
Fig. 14.42 "Relationship to '...' " - dialog - showing results for "Relationship Calculator" Tool

You can use this tool via menu Tools ➡ Utilities ▶ Relationship Calculator....

Selecting the Relationship Calculator tool will open a list filtered to all people connected, but not necessarily related, to the 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 with the common ancestors in that 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 Max generations for relationships value in the Limits tab under the Edit ➡ Preferences... menu. Moved from the 5.1 General tab — ⚡new for version 5.2 (The default of 15 generations will report a 12th great-grandparent relationship but not the 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.

The most basic blood relationship through common ancestors is that of siblings (brothers and sisters) who are only one generation down from the common ancestor. Another special relationship is that of one of those siblings to the descendants of the other siblings. If the Active Person is a grandchild of the common ancestor, the sibling would be an aunt or uncle. Beyond that generation of descendants, there are two equivalent ways of describing the relationship. The daughter of great grandparents might be called either a grandaunt or a great aunt. (The Relationship Calculator uses the 'grand' variant.) That person is a great grandaunt to the second great grandchildren, who are four generations distant from the common ancestor. (She may also be called a second great aunt.) The reverse relationship of an aunt or uncle is a nephew or niece.

Cousins (also called "first" cousins) are two generations down from the common ancestor through different siblings. "Second" cousins are thus, three generations down from the common ancestor - and so on.

After that, everyone is considered a "cousin", but to indicate that they are not in the same generation we use the word "removed" to indicate the number of generations different between the two. For example, my father's "first" cousin is also my "first" cousin but "once removed" (one generation difference between us). My fathers "first" cousin is my own child's "first cousin twice removed" - two generations different.

If multiple blood relationships exist due to pedigree Collapse, all will be reported.

A full text list of all blood relations and their spouses can be viewed using a Kinship Report.

See also:
  • The Relationship to home person Display Preferences option for the Status bar
  • Relation to Home Person quick view.
  • The Deep Connections gramplet: If this third party addon is installed, it will list the intervening generations through the sibling offspring of a common ancestor. (But it does not list the common ancestor or if both person a connected through the same spouse.) The Gramplet also details the indirect relationships.
  • Relationship Calculator Localization - create meaningful relation descriptions in your region.


Verify the Data

 
Verify the Data tool enhanced— ⚡new for version 5.2

Tool performance improved, results reorganized into a Tree rather than a flat list, additional tests.
8 New rules (marked below) to find additional irregularities.


 
Fig. 14.43 "Verify the Data..." - "Data Verify tool" dialog - "General" tab - defaults

This utility allows you to verify the database based on the set of criteria specified by you.

For example, you may want to make sure that nobody in your database had children at the age of 98. Based on common sense, such a record would indicate an error. However, it is not a consistency error in the database. Besides, someone might have a child at the age of 98 (although this rarely happens). The Verify tool will display everything that violates your criteria so that you can check whether the record is erroneous or not. The ultimate decision is yours.

Select this via the menu Tools->Utilities->Verify the Data... you will get a Data Verify Tool window. The window has four tabs; General, Women, Men, 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 Run button (or hit the Alt+R keybinding) and you will be presented with a Data Verification Results window.

General
  • Maximum age: 90
  • Minimum age to marry: 17
  • Maximum age to marry: 50
  • Maximum number of spouses for a person: 3
  • Maximum number of consecutive years of widowhood before next marriage: 30
  • Maximum age for an unmarried person: 99

The first check box: Estimate missing or inexact dates causes the tool to accept a baptism date if a birth date is not known, and to accept a burial date if a death date is not known. It also causes the tool to accept "inexact" dates (i.e., any "legal" Gramps date which is not a fully-specified one (with an explicit day and month and year)).

The second check box: Identify invalid dates will check if the dates are invalid.

Women
  • Minimum age to bear a child: 17
  • Maximum age to bear a child: 48
  • Maximum number of children: 12
Men
  • Minimum age to father a child: 18
  • Maximum age to father a child: 65
  • Maximum number of children: 15
Families
  • Maximum husband-wife age difference: 30
  • Maximum number of years between children: 8
  • Maximum span of years for all children: 25


Data Verification Results window
 
Fig. 14.44 Data Verification Results window.

After you run the tool you will be presented with the 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
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
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 in chronological order
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 in chronological order
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 in chronological order
  • Family has events with role Unknown
  • 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
( 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 in chronological order
  • Person has events with role Unknown
  • 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 Mark all, Unmark all, Invert marks, and Hide marked.

Double-clicking on a row will give you a possibility to view and or edit the data.

With the Close button (or select the keyboard shortcut Alt+C) you close the Results window.

Examples

Two examples from using real data with this tool:

  • The warning showed 'female husband': checking the data I found a family with father : Anna Roelants. Luckily in the Description I read: The marriage of Adam Roelants and Cornelia Crabbe. It was clearly a typo: Anna i.s.o. Adam. Without this Tool it would be very hard to find.
  • 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:
Interest in enhancing verify.py
 
Difference between Verify the Data tool and the Check and Repair Database tool

The Check and Repair Database tool detects inconsistencies in the database structure. The Verify the Data tool, however, is detecting the records that do not satisfy your particular criteria.


Debug

 
Warning do not use the Debug tools on your working Family Tree

Always create a new empty Family Tree or a copy of your existing Family Tree for testing.
The tools available in this advanced menu are used for testing only.

 
Fig. 14.45 "Tools >Debug>..." Menubar - Tools - Debug menu Overview

When the command line: Python option -O optimise flag is not turned on, an additional Debug entry appears in the Tools menu and the following tools are available:

Also See:


Check Localized Date Displayer and Parser

 
Fig. 14.46 "Start date test?" dialog - for "Check Localized Date Displayer and Parser" - Tool

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.

You will be shown the Start date test? dialog to select either Cancel to exit or Run test to start the tool.

Dump Gender Statistics

 
Fig. 14.47 "Gender Statistics tool" dialog results example - for "Dump Gender Statistics" - Tool

The "Gender Statistics tool" dialog will show the results in list about the statistics for the gender guessing based on the persons first name.

See Gender entry.

Generate Testcases for Persons and Families

 
Fig. 14.48 "Generate testcases" dialog - for "Generate Testcases for Persons and Families" - Tool - default

The testcase generator will generate some persons and families that have broken links in the database or data that is in conflict to a relation.

The Undo history warning dialog will be shown and you can either Stop or Proceed with the tool.

You can generate testcases that cause the following:

  • Generate low level database errors Correction needs database reload
  • Generate database errors
  • Generate dummy data
  • Generate long names
  • Add special characters
  • Add serial number
  • Add line break
  • Number of people to generate (Number is approximate because families are generated) 2000(default)

Select Cancel to exit or OK to start the tool.

Help will bring you here.


Populate Sources and Citations

 
Fig. 14.49 "Populate sources and citations tool" dialog - default

This tool generates sources and citations for each source in order to populate the database for testing with significant numbers of sources and citations.

Enter the required number and then select OK to run the tool:

  • Number of sources: 2 (default)
  • Number of citations: 2 (default)

Once the tool is complete you will be shown the Data generated alert dialog.



Previous Index Next
  Special copyright notice: All edits to this page need to be under two different copyright licenses:

These licenses allow the Gramps project to maximally use this wiki manual as free content in future Gramps versions. If you do not agree with this dual license, then do not edit this page. You may only link to other pages within the wiki which fall only under the GFDL license via external links (using the syntax: [https://www.gramps-project.org/...]), not via internal links.
Also, only use the known Typographical conventions