Difference between revisions of "Gramps 5.0 Wiki Manual - Tools"

From Gramps
Jump to: navigation, search
(Find possible loop in the database)
m (Clear stub template from locked old user manual page in support of https://gramps.discourse.group/t/gramps-5-1-wiki-manual-stub-eradication/2938)
 
(133 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{grampsmanualcopyright}}
 
 
 
{{man index|Gramps 5.0 Wiki Manual - Reports|Gramps 5.0 Wiki Manual - Settings|5.0}}
 
{{man index|Gramps 5.0 Wiki Manual - Reports|Gramps 5.0 Wiki Manual - Settings|5.0}}
 
 
{{languages|Gramps_5.0_Wiki_Manual_-_Tools}}
 
{{languages|Gramps_5.0_Wiki_Manual_-_Tools}}
 
 
{{#vardefine:chapter|12}}
 
{{#vardefine:chapter|12}}
 
{{#vardefine:figure|0}}
 
{{#vardefine:figure|0}}
 +
[[File:MenuOverview-Tools-50.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.
  
This chapter describes the various tools available in Gramps.
+
Gramps {{man label|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.
  
== Introduction ==
+
= Tools =
  
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.  Tools present one of the major strengths of Gramps compared to the most genealogical software.
+
[[File:ToolbarIcon-OpenTheToolsDialog-50.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''}} . Alternatively, you can browse the complete selection of available tools along with their brief descriptions in a '''Tool Selection''' dialog invoked by clicking the {{man button|Tools}} icon on the toolbar.
+
The tools can be accessed by choosing the menu {{man menu|Tools ->''Tool Section'' ->''Particular Tool''}} .  
 +
 
 +
Alternatively, you can browse the complete selection of available tools along with their brief descriptions in a {{man label|[[Gramps_5.0_Wiki_Manual_-_Tools#Tool_Selection_dialog|Tool Selection]]}} dialog invoked by clicking the {{man button|Open the tools dialog}} icon on the toolbar from any of the categories.
 +
{{-}}
 +
{{man note|Additional Tools |Gramps allows you to install even more tools. This system is controlled by the [[Gramps_5.0_Wiki_Manual_-_Plugin_Manager|'''Plugin Manager''']]. For additional tools see [[5.0 Addons|'''Addons''']].}}
  
{{man note|Additional Tools |Starting with Gramps version 3.2 a new system was implemented to have even more tools available. This system is controlled by the [[Gramps_5.0_Wiki_Manual_-_Plugin_Manager|'''Plugin Manager''']]. The Plugin Manager can get additional [[5.0_Addons|'''Addons''']] for you.}}
+
== Tool Selection dialog ==
  
==Common Options==
+
[[File:ToolSelection-dialog-example-50.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Tool Selection - dialog - example showing "Find Possible Duplicate People" information]]
  
* id: = ID
+
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.
Gramps ID of a central person.
+
{{-}}
  
 
== Analysis and Exploration ==
 
== Analysis and Exploration ==
Line 27: Line 30:
 
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:
 
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:
  
===<u>Compare Individual Events...</u>===
+
===<u>Compare Individual Events</u>===
  
This tool compares events across the selected group of people. The people for this comparison are chosen with the use of custom filters. The custom filters can be created in the Custom Filter Editor (see ''tools-util-cfe'' ) that can be invoked by clicking the {{man button|Custom Filter Editor}} button. The resulting table produced by this tool can be saved as a spreadsheet.
+
[[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]]
  
===<u>Interactive Descendant Browser...</u>===
+
This tool compares events across the selected group of people.  
  
[[Image:InteractiveDescendantBrowser-40.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Descendant Browser]]
+
You can use this tool via menu {{man menu|Tools->Analysis and Exploration > Compare Individual Events...}} which will open the {{man label|Event comparison filter selection}} dialog
  
First you have to select a person or you start with the current Active Person.
+
The people for this comparison can be chosen from previously created custom filters by selecting the {{man label|Filter:}} drop down list, which defaults to the ''Entire Database''. Or by selecting the {{man button|Custom Filter Editor}} button, to create custom filters in the {{man label|Person Filters}} editor. To run the report select {{man button|Apply}} and the results will be displayed in the {{man label|Event Comparison Results}} dialog.
  
Select from the menu {{man menu|Tools->Analysis and Exploration->Interactive Descendant Browser...}}.
+
{{-}}
 +
From the {{man label|Event Comparison Results}} dialog you can view the results or {{man button|Save as}} the resulting table as a spreadsheet (ODS format). Select {{man button|Close}} to exit the report.
 +
{{-}}
 +
[[File:CompareIndividualEvents-EventComparisonResults-dialog-expanded-example-50.png|center|thumb|800px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Compare Individual Events" - "Event Comparison Results" - dialog - expanded example]]
 +
{{-}}
  
This tool builds a tree with the Active Person being the root. Children branch from their parents in the usual manner.
+
==Family Tree Processing==
  
You can click the {{man button|down}} or {{man button|>}} buttons to expand or collapse the nodes.
+
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:
  
Use this tool for a quick glance of a person's descendants.
+
{{man note|1=Note |2=The modifications will only be performed upon your explicit consent, except for the automatic fixes performed by {{man label|Check and repair Database}} tool.}}
 +
 
 +
===<u>Edit Database Owner Information</u>===
 +
 
 +
[[File:DatabaseOwnerEditor-dialog-example-context-menu-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Database Owner Editor" - dialog - showing context menu]]
  
{{-}}
+
This tool modifies any existing [[Gramps_5.0_Wiki_Manual_-_Settings#Researcher|Researcher Information]].
  
{{man tip|1=Tip|2=Double-clicking on tree node will bring up the {{man label|Edit Person}} dialog allowing to view or modify the personal data.}}
+
Select the menu {{man menu|Tools->Family Tree Processing->Edit Database Owner Information...}}. This brings up the {{man label|Database Owner Editor}} window, where you can fill in the needed info.
  
The {{man button|Help}} button will bring you to this page and with the {{man button|Close}} you close the Descendant Browser window.
+
*{{man label|Name:}}
 +
*{{man label|Street:}}
 +
*{{man label|Locality:}}
 +
*{{man label|City:}}
 +
*{{man label|State/County:}}
 +
*{{man label|Country:}}
 +
*{{man label|ZIP/Postal Code:}}
 +
*{{man label|Phone:}}
 +
*{{man label|Email:}}
  
==Family Tree Processing==
+
This information is family tree specific and will be used when exporting your data in GEDCOM format.
  
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:
+
Two choices are available from the context menu(right click):
 +
* {{man label|Copy from DB to Preferences}} -
 +
* {{man label|Copy from Preferences to DB}} -
 +
{{-}}
  
{{man note|1=Note |2=The modifications will only be performed upon your explicit consent, except for the automatic fixes performed by {{man label|Check and repair Database}} tool.}}
+
===<u>Extract Event Description</u>===
  
===<u>Edit Database Owner Information...</u>===
+
{{man note|Note|The name format in the Event's Description field depends on the defined name format in {{man menu|Edit->Preferences->Display->[[Gramps_5.0_Wiki_Manual_-_Settings#Display|Name format]]}}}}
  
[[Image:DatabOwnerInformationEditor-40.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Database Owner Information]]
+
[[File:ModificationsMade-window-example-50.png|right|thumb|300px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Extract Event Description's - Modifications Made - window - example result]]
  
Select the menu {{man menu|Tools->Family Tree Processing->Edit Database Owner information}}. This brings up the {{man label|Database Owner Editor}} window, where you can fill in the needed info.
+
Extracts event descriptions from the event data by using a model :
  
*Name:
+
<code>{event type} of {Surname}, {Given name}</code>
*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.
+
If event description is missing, then tool will use this event description field model.
 +
 
 +
You can access this tool via the menu {{man menu|Tools->Family Tree Processing->Extract Event Description...}}
 +
 
 +
The '''Undo history warning''' will be shown and you can either {{man button|Stop}} or {{man button|Proceed with the tool}}.
  
 +
Once you {{man button|Proceed with the tool}} this tool will scan and modify your Family Tree and present you with the {{man label|Modifications made}} result window listing the total number of event descriptions that have been added.
 
{{-}}
 
{{-}}
  
Line 81: Line 100:
 
This tool searches the entire database and attempts to extract titles and nicknames that may be embedded in a person's {{man label|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.
 
This tool searches the entire database and attempts to extract titles and nicknames that may be embedded in a person's {{man label|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.
  
===<u>Extract Place Data from a Place Title</u>===
+
You can access this tool via the menu {{man menu|Tools->Family Tree Processing->Extract Information from Names....}}
  
[[Image:ExtractPlaceData.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Extract Place Data]]
+
The {{man label|[[Gramps_5.0_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}}.
  
This tool attempts to extract city, state/province and zip code from a place title.
+
[[File:ExtractInformationFromNames-DefaultPrefixAndConnectorSettings-dialog-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Default prefix and connector settings" - dialog for the "Extract Information from Names" Tool]]
  
The tools operates on places where all fields in the main location are empty.
+
The {{man label|Default prefix and connector settings}} dialog will be shown and you can modify each of the options as required:
 +
* {{man label|Prefixes to search for:}} <code>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</code> (default)
 +
* {{man label|Connectors splitting surnames:}} <code>e, y</code> (default)
 +
* {{man label|Connectors not splitting surnames:}} <code>de, van</code> (default)
  
 +
Once you have finished select {{man button|OK}} to start the tool.
 
{{-}}
 
{{-}}
  
The description must match the following categories:
+
[[File:ExtractInformationFromNames-NameAndTitleExtractionTool-dialog-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Name and title extraction tool" - dialog results window for the "Extract Information from Names" Tool]]
New York, NY 10000
 
  
Only available for :
+
Once the report finishes the {{man label|Name and title extraction tool}} dialog results window will be shown.
* USA
+
<!-- mention how to use-->
* Canada
+
{{-}}
* Sweden
 
Stockholm (A)
 
* France
 
Paris, IDF 75000, FRA or Paris, ILE DE FRANCE 75000, FRA
 
  
The dialog allows you to preview and confirm individual changes.
+
===<u>Extract Place Data from a Place Title</u>===
  
===<u>Extract Event Descriptions from Event Data</u>===
+
{{man warn|No longer part of Gramps you can download this tool from the third party addons<br>See: [[Extract Place Data from a Place Title]]}}
  
Extracts event descriptions from the event data by using a model :
+
===<u>Find Possible Duplicate People</u>===
{event type} of {Surname}, {Given name}
 
  
If event description is missing, then tool will use this event description field model.
+
[[File:FindPossibleDuplicatePeople-dialog-default-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Find Possible Duplicate People - dialog - default]]
 
 
===<u>Find Possible Duplicate People...</u>===
 
 
 
[[Image:FindPossibleDuplicatePeople-PotentialMergesWindow-40.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Duplicate People]]
 
  
 
This tool searches the entire database, looking for the entries that may represent the same person.
 
This tool searches the entire database, looking for the entries that may represent the same person.
Line 119: Line 132:
 
You can access this tool via the menu {{man menu|Tool->Family Tree Processing->Find Possible Duplicate People...}}.
 
You can access this tool via the menu {{man menu|Tool->Family Tree Processing->Find Possible Duplicate People...}}.
  
Two options are available:
+
The {{man label|Find Possible Duplicate People}} dialog will be shown and you can adjust the following options:
*Match Threshold: choose between High, Medium and Low from the drop down menu.
+
*{{man label|Match Threshold}} : choose between '''Low'''(default), Medium and High from the drop down menu. (Note:This calculates a chance of matching as a floating point number. For each piece of information that matches the chance is increased. If the chance is greater than the threshold then a match is reported. The thresholds are Low=0.25, Medium=1.0 and High=2.0. So with the threshold set to High less matches are expected.)
  
*Options: a check box to enable or disable the use of [[Gramps_5.0_Wiki_Manual_-_Tools#Use_of_SoundEx_module_in_GRAMPS|soundex]] codes for matching possible duplicate people.
+
{{man label|Options}}
 +
*{{checkbox|1}} {{man label|Use [[Gramps_5.0_Wiki_Manual_-_Gramplets#SoundEx_Gramplet|soundex]] codes}} for matching possible duplicate people. (checkbox checked by default)
  
Only three buttons are present: {{man button|Help}} brings you to this page, a {{man button|Cancel}} to stop processing and an {{man button|OK}} button to start processing the data.
+
The following buttons are present: {{man button|Help}} brings you to this page, {{man button|Cancel}} to stop processing and an {{man button|OK}} button to start processing the data.
  
If you select the {{man button|OK}} button, the data will be processes in two passes.
+
Select {{man button|OK}} to start the tool and the data will be processed in two passes.
  
 
*Pass 1: Building preliminary lists
 
*Pass 1: Building preliminary lists
Line 133: Line 147:
 
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.
 
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.
  
Finally a {{man label|Potential Merges}} window is presented. This window shows a list with three columns:
+
{{-}}
*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.
+
[[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]]
*First Person
 
*Second Person
 
  
If you select a row you can check the details with the {{man button|Compare}} button or you can double-click on the selected row.
+
Once the report finishes a {{man label|Potential Merges}} result list window is presented with the following columns shown:
 +
*{{man label|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.
 +
*{{man label|First Person}}
 +
*{{man label|Second Person}}
  
Three buttons are present: {{man button|Help}} brings you to this page, a {{man button|Close}} to close the window and a {{man button|Compare}} button to which brings up a {{man label|Compare People}} window which was explain in detail in the [[Gramps_5.0_Wiki_Manual_-_Entering_and_Editing_Data:_Detailed_-_part_3#Merge_People|Merge People Dialog]]. Here you can select with the radio buttons one of the persons and eventually use the {{man button|Merge and close}} button to merge the data if you find the two persons are duplicates.
+
You can either double-click on the selected row or select the {{man button|Compare}} button to check the details.
  
Selecting the {{man button|Cancel}} button brings you back to the list.
+
Three buttons are present: {{man button|Help}} brings you to this page, a {{man button|Close}} to close the window which returns you to the {{man label|Find Possible Duplicate People}} window and a {{man button|Compare}} button to which brings up the {{man label|Merge People}} window which was explained in detail in the [[Gramps_5.0_Wiki_Manual_-_Entering_and_Editing_Data:_Detailed_-_part_3#Merge_People|Merge People]] Dialog. Here you can select with the radio buttons one of the persons and eventually use the {{man button|OK}} button to merge the data if you find the two persons are duplicates.
  
 +
Selecting the {{man button|Cancel}} button brings you back to the {{man label|Potential Merges}} result list window.
 
{{-}}
 
{{-}}
  
===<u>Fix Capitalization of Family Names...</u>===
+
===<u>Fix Capitalization of Family Names</u>===
 
 
[[Image:FixCapitalizationofFamilyNames-CapitalizationChangesWindow-40.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Fix Capitalization]]
 
  
 
This tool searches the entire database and attempts to fix the capitalization of family names.  
 
This tool searches the entire database and attempts to fix the capitalization of family names.  
Line 158: Line 172:
 
You can use this tool via menu {{man menu|Tools->Family Tree Processing->Fix Capitalization of Family Names...}}.
 
You can use this tool via menu {{man menu|Tools->Family Tree Processing->Fix Capitalization of Family Names...}}.
  
{{man warn|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 recomended that you please stop here and backup your database; so that you can revert the process of running this tool.}}
+
{{man warn|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.}}
  
You can choose {{man button|Stop}} or {{man button|Proceed with the tool}}.
+
The '''Undo history warning''' will be shown and you can either {{man button|Stop}} or {{man button|Proceed with the tool}}.
 +
 
 +
{{-}}
 +
[[File:FixCapitalizationofFamilyNames-CapitalizationChanges-dialog-results-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Capitalization changes" - dialog - results example for "Fix Capitalization of Family Names" tool]]
  
If there where changes to Capitalization of Names you will be presented with the {{man label|Capitalization changes}} window. The window shows a list of the family names that Gramps can convert to correct capitalization. In the list you will see a three columns: {{man button|Select}} check box(es), Original Name and Capitalization Change.
+
If there where changes to the capitalization of any names you will be presented with the {{man label|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 {{man label|Capitalization changes}} results window list the following columns are available:
 +
* {{man label|Select}} - Check or uncheck these on a by name bases if you choose not to accept the recommendation (checkbox checked by default)
 +
* {{man label|Original Name}} - The name as currently recorded.
 +
* {{man label|Capitalization Change}} - The name with change if applied.
  
Select the names you want to be changed, then hit the {{man button|Accept changes and close}} button. Or use the {{man button|Cancel}} button to abort changes.
+
Select the names you want to be changed, then select the {{man button|Accept changes and close}} button. Or use the {{man button|Cancel}} button to abort changes.
 +
{{-}}
  
 +
You can also install the "[[Fix Capitalization of Given Names]]" tool Addon that once installed works almost identically to this tool but works for "Given Names"
 
{{-}}
 
{{-}}
  
===<u>Fix Capitalization of Given Names...</u>===
+
===<u>Merge citations</u>===
  
This option is a Addon tool and works almost identically to the above Surname tool.
+
{{man tip|The {{man label|Merge Citations}} tool|works by combining notes, media objects and data-items of matching citations.}}
  
===<u>Merge citations...</u>===
+
You can select this via menu {{man menu|Tools > Family Tree Processing > Merge Citations...}} .
  
 +
The '''Undo history warning''' will be shown and you can either {{man button|Stop}} or {{man button|Proceed with the tool}}.
 +
{{-}}
 +
[[File:MergeCitations-dialog-default-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Merge Citations" - dialog - default]]
 +
 +
Then the {{man label|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:
 +
* {{man label|Match Threshold}} drop down list:
 +
** Match on Page/Volume, Date and Confidence
 +
** '''Ignore Date''' (default)
 +
** Ignore Confidence
 +
** Ignore Date and Confidence
 +
* {{man label|Options}}
 +
** {{checkbox|0}} {{man label|Don't merge if citation has notes}} (checkbox unchecked by default)
 +
 +
{{-}}
 +
[[File:NumberOfMergesDone-dialog-result-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Number of merges done" result dialog for "Merge Citations" - dialog - Tool - example]]
 +
 +
Select {{man button|OK}} to run the tool and once complete it will report back the total with the {{man label|Number of merges done}} result dialog.
 +
{{-}}
 +
See also the [[Gramps_5.0_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_3#Merge_Citations|Merge Citations]] option available from the Citations Category list view
 +
{{-}}
  
 
===<u>Rename Event Types</u>===
 
===<u>Rename Event Types</u>===
  
[[Image:RenameEventTypes-ChangeEventTypesWindow-40.png|right|thumb|300px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Change type]]
+
This tool will rename all events of one type to a different type.
 +
 
 +
You can access this tool via the menu {{man menu|Tools->Family Tree Processing->Rename Event Types....}}
 +
 
 +
The '''Undo history warning''' will be shown and you can either {{man button|Stop}} or {{man button|Proceed with the tool}}.
  
This tool allows all the events of a certain name to be renamed to a new name.
+
{{man warn|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.}}
  
 
{{-}}
 
{{-}}
 +
[[File:RenameEventTypes-Tool-ChangeEventTypes-dialog-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Change Event Types" - dialog - example for "Rename Event Types" Tool]]
  
{{man warn|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.}}
+
The {{man label|Change Event Types}} dialog is presented.  
The {{man label|Change Event Types}} window is presented. This tool will rename all events of one type to a different type.
 
  
*Original event type: fill in the text field or use the drop down menu and select an original event type
+
* {{man label|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
+
* {{man label|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.  
 
The example shows a renaming of the '''Birth''' event to a '''Baptism''' event.  
  
Finally use the {{man button|Cancel}} or the {{man button|OK}} button.
+
{{man note|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.}}
 +
 
 +
 
 +
{{-}}
 +
[[File:RenameEventTypes-Tool-ChangeTypes-result-dialog-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Change types" - result dialog - example for "Rename Event Types" Tool]]
 +
 
 +
Finally use the {{man button|Cancel}} to exit or select {{man button|OK}} to run the tool and once complete it will report back the total events modified with the {{man label|Change types}} result dialog.
 +
{{-}}
  
 
{{man warn|1=Renaming events|2=Once completed, this cannot be undone by the regular {{man label|Undo}} function.}}
 
{{man warn|1=Renaming events|2=Once completed, this cannot be undone by the regular {{man label|Undo}} function.}}
  
===<u>Reorder GRAMPS ID</u>===
+
See also:
 +
* [[Gramps_5.0_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_2#Editing_information_about_events|Editing information about events]]
  
 +
===<u>Reorder Gramps ID</u>===
  
 +
This tool can be used to Reorder your Gramps IDs.  Several options are available.
  
This tool '''Reorder GRAMPS ID''' will change all the elements in the database to conform to the scheme specified in the database's prefix id's.
+
{{man warn|Custom IDs'|If you customized your IDs', all those can be replaced by this tool. So take care before you use this tool!}}
  
You can change those settings in the menu {{man menu|Edit->Preferences...}} and then select the '''ID Formats''' tab.
+
[[File:ReorderGrampsIDs-dialog-example-50.jpg|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Reorder IDs]]
  
You can use this tool via menu {{man menu|Tools->Family Tree Processing->Reorder Gramps IDs'''}}.
+
You can use this tool via menu {{man menu|Tools->Family Tree Processing->Reorder Gramps IDs...}}.
 +
 
 +
The 'Object' column lists the type of 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 button that can be used to toggle all of the check boxes at once.
 +
 
 +
The 'Actual' column shows an example of the current ID.  The 'Quantity' column show the number of objects.
 +
 
 +
The 'Format' column can be used to change the ID format for each object type.  Note that the format consists of a prefix, the '%04d' and suffix.  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.  Changes made here are the same as made in the menu {{man menu|Edit->Preferences...}} and then select the '''[[Gramps_5.0_Wiki_Manual_-_Settings#ID_Formats|ID Formats]]''' tab.  The 'Format' label is actually a button that can be used to reset all the formats to the last used value.
 +
 
 +
The 'Change' column contains checkboxes for each object type.  If this is 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 check, the ID formats are NOT updated, but the number field within the format is renumbered.  The 'Change' label is actually a button that can be used to toggle all of the check boxes at once.
 +
 
 +
The 'Start' field indicates the starting number used during the renumber operation.  The 'Start' label is actually a button that can be used to toggle between start at 0, and start after last current number.
 +
 
 +
The 'Step' 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 button that can be used to toggle between '1', '2', '5', and '10'.
 +
 
 +
The 'Keep' column contains checkboxes for each object type.  If this and 'Change' is 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 button that can be used to toggle all of the check boxes at once.
 +
 
 +
The '''Undo history warning''' will be shown and you can either {{man button|Stop}} or {{man button|Proceed with the tool}}.
  
 
{{man warn|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.}}
 
{{man warn|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.}}
  
The window will show a progress bar.
+
When you click 'OK', the tool will show a progress bar.
  
In different steps following IDs' are reordered: Reordering People IDs', Reordering Family IDs', Reordering Event IDs', Reordering Media Object IDs', Reordering Source IDs', Reordering Citation IDs', Reordering Place IDs', Reordering Repository IDs' and finally Reordering Note IDs'.
+
In different stages the following IDs' are reordered: Reordering People IDs', Reordering Family IDs', Reordering Event IDs', Reordering Media Object IDs', Reordering Source IDs', Reordering Citation IDs', Reordering Place IDs', Reordering Repository IDs' and finally Reordering Note IDs'.
  
 
In a next step unused IDs' are searched for and assigned.
 
In a next step unused IDs' are searched for and assigned.
  
{{man warn|Custom IDs'|If you customized your IDs', all those setting are replaced by the default setting. So take care before you use this tool!}}
+
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 ID format or the default ID format.  This might be the case if the user had entered his own text in the ID field for the object when editing it.  It might also occur if the third party [[Addon:GetGOV|GetGOV Addon]] or [[Addon:GeoName|GeoName Addon]] has been used, as that tool stores the GOV ID in the ID field.  If a 'customized' ID is found, it will ask the user if he really wants to replace the ID. The dialog also allows the user to use the same answer for other customized IDs found.
  
 
===<u>Sort Events</u>===
 
===<u>Sort Events</u>===
 
[[Image:SortEventsWindow-40.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 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 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 [http://en.wikipedia.org/wiki/Drag-and-drop ''drag & drop''] or by use of the re-order buttons on the {{man label|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.  
+
Events can be manually re-ordered by [http://en.wikipedia.org/wiki/Drag-and-drop ''drag & drop''] or by use of the re-order buttons on the {{man label|[[Gramps_5.0_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_1#Events|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 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.
Line 227: Line 299:
 
The [http://en.wikipedia.org/wiki/Drag-and-drop ''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.
 
The [http://en.wikipedia.org/wiki/Drag-and-drop ''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.
  
The first option on the Sort Events dialog window 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.
+
You can use this tool via menu {{man menu|Tools->Family Tree Processing->Sort events...}}.
 +
 
 +
The '''Undo history warning''' will be shown and you can either {{man button|Stop}} or {{man button|Proceed with the tool}}.
 +
 
 +
{{man warn|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.}}
  
 
{{-}}
 
{{-}}
 +
[[File:SortEvents-dialog-ToolOptions-tab-default-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Sort Events" - dialog - showing "Tool Options" tab for "Sort Events" Tool]]
  
{{man warn|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.}}
+
The first option on the {{man label|Sort Events}} dialog window 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.
  
 +
{{-}}
 
{{man warn|1=Sorting events|2=Once completed, this cannot be undone by the regular {{man label|Undo}} function.}}
 
{{man warn|1=Sorting events|2=Once completed, this cannot be undone by the regular {{man label|Undo}} function.}}
  
== Database Repair ==
+
== Family Tree Repair ==
  
===<u>Check and repair database</u>===
+
===<u>Check and Repair Database</u>===
 +
 
 +
{{man warn|1=Warning|2=The {{man label|Check and repair Database}} tool performs automatic fixes. Once completed, this cannot be undone by the regular {{man label|Undo}} function.}}
  
 
This tool checks the database for integrity problems, fixing the problems it can. Specifically, the tool is checking for:
 
This tool checks the database for integrity problems, fixing the problems it can. Specifically, the tool is checking for:
Line 248: Line 328:
  
 
*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".
 
*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 {{man menu|Tools->Family Tree Repair->Check and Repair Database...}}.
 +
 +
{{man warn|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 {{man button|Stop}} or {{man button|Proceed with the tool}}.
 +
 +
{{-}}
 +
[[File:IntegrityCheckResults-dialog-CheckAndRepairDatabase-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Integrity Check Results" - example result dialog - for the "Check and Repair Database" tool]]
 +
 +
Any issues found are automatically fixed and the {{man label|Integrity Check Results}} dialog will be shown with a summary actions taken.
 +
{{-}}
 +
Otherwise you will see the {{man label|No errors were found}} dialog stating that ''The database has passed internal checks''.
 +
{{-}}
 +
 +
===<u>Rebuild Gender Statistics</u>===
 +
 +
[[File:GenderStatisticsRebuilt-dialog-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Gender statistics rebuilt" - result dialog for "Rebuild Gender Statistics" tool]]
 +
 +
Rebuilds gender statistics for name gender guessing...
 +
 +
You can use this tool via menu {{man menu|Tools->Family Tree Repair->Rebuild Gender Statistics...}}.
 +
 +
Once completed the {{man label|Gender statistics rebuilt}} result dialog will be shown.
 +
{{-}}
  
 
===<u>Rebuild Reference Maps</u>===
 
===<u>Rebuild Reference Maps</u>===
 +
 +
[[File:ReferenceMapsRebuilt-dialog-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Reference maps rebuilt" - result dialog for "Rebuild Reference Maps" tool]]
  
 
This tool rebuilds reference map tables (''References'' items on editors).
 
This tool rebuilds reference map tables (''References'' items on editors).
  
===<u>Rebuild Secondary Indices</u>===
+
You can use this tool via menu {{man menu|Tools->Family Tree Repair->Rebuild Reference Maps...}}.
 +
 
 +
Once completed the {{man label|Reference maps rebuilt}} result dialog will be shown.
 +
{{-}}
 +
 
 +
===<u>Rebuild Secondary Indexes</u>===
 +
 
 +
[[File:SecondaryIndexesRebuilt-dialog-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Secondary indexes rebuilt" - result dialog for "Rebuild Secondary Indexes" tool]]
  
 
This tool rebuilds secondary indices.
 
This tool rebuilds secondary indices.
  
===<u>Remove Unused Objects...</u>===
+
You can use this tool via menu {{man menu|Tools->Family Tree Repair->Rebuild Secondary Indexes...}}.
 +
 
 +
Once completed the {{man label|Secondary indexes rebuilt}} result dialog will be shown.
 +
{{-}}
 +
 
 +
===<u>Remove Unused Objects</u>===
 +
 
 +
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 {{man menu|Tools->Family Tree Repair->Remove Unused Objects...}}.
 +
 
 +
{{-}}
 +
[[File:UnusedObjects-dialog-example-results-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Unused Objects" - dialog example results for "Remove Unused Objects" tool]]
 +
 
 +
The {{man label|Unused Objects}} dialog is presented.
 +
 
 +
You can choose from the search option you want to use from the top section of the {{man label|Unused Objects}} dialog:
 +
*{{checkbox|1}} {{man label|Search for events}} (checkbox checked by default)
 +
*{{checkbox|1}} {{man label|Search for sources}} (checkbox checked by default)
 +
*{{checkbox|1}} {{man label|Search for citations}} (checkbox checked by default)
 +
*{{checkbox|1}} {{man label|Search for places}} (checkbox checked by default)
 +
*{{checkbox|1}} {{man label|Search for media}} (checkbox checked by default)
 +
*{{checkbox|1}} {{man label|Search for repositories}} (checkbox checked by default)
 +
*{{checkbox|1}} {{man label|Search for notes}} (checkbox checked by default)
 +
 
 +
Select the {{man button|Find}} button to run the report, and once completed the results if any will show in the bottom section of the {{man label|Unused Objects}} dialog with the following columns shown:
 +
* {{man label|Mark}} Select the row if you want to delete the object (checkbox unchecked by default)
 +
* {{man label|}} - Icon representing the type of object.
 +
* {{man label|ID}} - Gramps internal name for the object.
 +
* {{man label|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.
  
This tool will search your database for pieces of information which are not connected to anything else, and then remove them.
+
{{man label|Mark}} the objects you want to delete either using the individual checkboxes or using the associated buttons:
 +
* {{man button|Mark all}}
 +
* {{man button|Unmark all}}
 +
* {{man button|Invert marks}}
 +
 
 +
Once your deletion choices have been made select the {{man button|Delete}} button to delete the objects.
 +
 
 +
When finished you may then use the {{man button|Close}} button to exit the tool.
 +
{{-}}
  
 
== Utilities ==
 
== 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:
 
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:
 +
* [[Gramps_5.0_Wiki_Manual_-_Tools#Find_database_loop|Find database loop]] -
 +
* [[Gramps_5.0_Wiki_Manual_-_Tools#Media_Manager|Media Manager]] -
 +
* [[Gramps_5.0_Wiki_Manual_-_Tools#Not_Related|Not Related]] -
 +
* [[Gramps_5.0_Wiki_Manual_-_Tools#Relationship_Calculator|Relationship Calculator]] -
 +
* [[Gramps_5.0_Wiki_Manual_-_Tools#Verify_the_Data|Verify the Data]] -
  
===<u>Generate SoundEx codes</u>===
+
===<u>Find database loop</u>===
  
This utility generates Soundex codes for the names of people in the database. Please visit the [http://www.archives.gov/research/census/soundex.html NARA Soundex Indexing page] to learn more about Soundex Indexing System.
+
[[File:FindDatabaseLoop-dialog-example1-50.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Find possible loop]]
  
==== Soundex what is this? ====
+
The {{man label|Find database loop}} utility allows you to verify if you have ancestral loops in the database.
  
Soundex is the most widely known of all [http://en.wikipedia.org/wiki/Phonetic_algorithm phonetic algorithms] which allow indexing of words by their sound, as pronounced in English.  
+
Select this via the menu {{man menu|Tools->Utilities->Find database loop...}} you will get a {{man label|Find database loop}} window. The window has five tabs; {{man label|Gramps_ID}},{{man label|Parent}}, {{man label|Gramps_ID}}, {{man label|Child}}, {{man label|Family ID}}.
  
The Soundex is a coded surname (last name) index based on the way a surname sounds rather than the way it is spelled. Surnames that sound the same, but are spelled differently, like SMITH and SMYTH, have the same code and are filed together. The Soundex coding system was developed so that you can find a surname even though it may have been recorded under various spellings.
+
# 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
  
First applied to the 1880 census, Soundex is a phonetic index, not a strictly alphabetical one. Its key feature is that it codes surnames (last names) based on the way a name sounds rather than on how it is spelled. It was to help researchers find a surname quickly even though it may have received different spellings.
+
{{-}}
  
Those doing census lookups must use the same method to encode surnames as the census takers did when they generated the database.  
+
[[File:FindDatabaseLoop-dialog-example2-50.png|right|thumb|600px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Find possible loop in a complex example]]
  
To search for a particular surname, you must first work out its code.
+
In the following complex example, we have multiple ancestral loops :
  
*'''Basic Soundex Coding Rule:'''
+
If we look at the second line, we have :
 +
# First Gramps_ID : I0002
 +
# Parent is : Father, Child2
 +
# Second Gramps_ID : I0001
 +
# Child is : Father, Father
 +
# Family_ID is : F0000
  
Every Soundex code consists of a letter and three numbers, such as W-252. The letter is always the first letter of the surname. The numbers are assigned to the remaining letters of the surname according to the Soundex guide shown below. Zeroes are added at the end if necessary to produce a four-character code. Additional letters are disregarded. Examples:
+
To understand what happens :
Washington is coded W-252 (W, 2 for the S, 5 for the N, 2 for the G, remaining letters disregarded).
+
#we start at [I0002] Father, Child2.
Lee is coded L-000 (L, 000 added).
+
#We continue with his son [I0003] Father, Child3.
 +
#We continue with his son : [I0000] Child, Child.
 +
#We continue with his son : [I0001] Father, Father.
 +
#We continue with his son : [I0002] Father, Child2 ==> '''HERE, we have a ancestral loop'''.
 +
 
 +
{{-}}
 +
To read more about ancestral loops see:
 +
* [https://www.tamurajones.net/FindingAncestralLoops.xhtml Finding Ancestral Loops : Modern Software Experience]
 +
* [http://www.beholdgenealogy.com/blog/?p=1309 Ancestral Loops : Louis Kessler's Behold Blog]
 +
 
 +
===<u>Media Manager</u>===
 +
 
 +
 
 +
 
 +
[[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]]
 +
 
 +
The {{man label|Gramps Media Manager}} is a group of four separate tools accessed via a wizard like dialog that you can access via the menu {{man menu|Tools->Utilities->Media Manager...}} which will show the first '''Introduction''' dialog page with the following information on the tools abilities.
 +
 
 +
{{man note|Introduction|This tool allows [http://en.wikipedia.org/wiki/Batch_processing 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.
  
{|{{prettytable}} 
+
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.}}
!Number
 
!Represents the Letters
 
|-
 
|1
 
|B, F, P, V
 
|-
 
|2
 
|C, G, J, K, Q, S, X, Z
 
|-
 
|3
 
|D, T
 
|-
 
|4
 
|L
 
|-
 
|5
 
|M, N
 
|-
 
|6
 
|R
 
|}
 
  
Disregard the letters A, E, I, O, U, H, W, and Y.
+
{{-}}
  
*'''Additional Soundex Coding Rules:'''
+
From the '''Introduction''' page selecting the {{man button|Next}} button (or using the keyboard shortcut {{man key press|Alt|N}}) you will be shown the '''Selection''' page window.
** Names With Double Letters: If the surname has any double letters, they should be treated as one letter. For example:
 
***Gutierrez is coded G-362 (G, 3 for the T, 6 for the first R, second R ignored, 2 for the Z).
 
** Names with Letters Side-by-Side that have the Same Soundex Code Number: If the surname has different letters side-by-side that have the same number in the Soundex coding guide, they should be treated as one letter. Examples:
 
*** Pfister is coded as P-236 (P, F ignored, 2 for the S, 3 for the T, 6 for the R).
 
*** Jackson is coded as J-250 (J, 2 for the C, K ignored, S ignored, 5 for the N, 0 added).
 
*** Tymczak is coded as T-522 (T, 5 for the M, 2 for the C, Z ignored, 2 for the K). Since the vowel "A" separates the Z and K, the K is coded.
 
** Names with Prefixes: If a surname has a prefix, such as Van, Con, De, Di, La, or Le, code both with and without the prefix because the surname might be listed under either code. Note, however, that Mc and Mac are not considered prefixes.For example, VanDeusen might be coded two ways:V-532 (V, 5 for N, 3 for D, 2 for S) or D-250 (D, 2 for the S, 5 for the N, 0 added).
 
** Consonant Separators: If a vowel (A, E, I, O, U) separates two consonants that have the same Soundex code, the consonant to the right of the vowel is coded. Example:Tymczak is coded as T-522 (T, 5 for the M, 2 for the C, Z ignored (see "Side-by-Side" rule above), 2 for the K). Since the vowel "A" separates the Z and K, the K is coded. If "H" or "W" separate two consonants that have the same Soundex code, the consonant to the right of the vowel is not coded. Example: Ashcraft is coded A-261 (A, 2 for the S, C ignored, 6 for the R, 1 for the F). It is not coded A-226.
 
  
==== Use of SoundEx module in GRAMPS ====
+
[[File:Selection-page-MediaManager-default-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Selection - page for "Gramps Media Manager" - Tool wizard - default]]
  
[[Image:GenerateSoundExCodes-SoundExCodeGeneratorWindow-40.png|thumb|right|300px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} SoundEx code generator]]
+
From the '''Selection''' page window select from one the four options the actions you want to take and then select the {{man button|Next}} button:
 +
* {{man label|[[Gramps_5.0_Wiki_Manual_-_Tools#Replace_substrings_in_the_path|Replace substrings in the path]]}} (default)
 +
* {{man label|[[Gramps_5.0_Wiki_Manual_-_Tools#Convert_paths_from_relative_to_absolute|Convert paths from relative to absolute]]}}
 +
* {{man label|[[Gramps_5.0_Wiki_Manual_-_Tools#Convert_paths_from_absolute_to_relative|Convert paths from absolute to relative]]}}
 +
* {{man label|[[Gramps_5.0_Wiki_Manual_-_Tools#Add_images_not_included_in_database|Add images not included in database]]}}
 +
{{-}}
  
Select via the menu {{man menu|Tools->Utilities->Generate SoundEx Codes...}} the dialog for the {{man label|SoundEx code generator}} window opens. In the {{man label|Name}} text field you can type in a name or you could use the {{man button|down}} arrow where you can choose a name from the drop down list.
+
====Replace substrings in the path====
  
The name you type in can be any name even a name not present in your Family Tree.
+
[[File:ReplaceSubstringSettings-page-MediaManager-default-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Replace substring settings - page for "Gramps Media Manager" - Tool wizard - default]]
  
The result is shown automatically eg:The soundex code for '''James''' is J520
+
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.
  
A {{man button|Help}} button is available which brings you to this page. With the {{man button|Close}} button (or using the keyboard shortcut {{man key press|Alt|C}}) you close the {{man label|SoundEx code generator}} window.
+
Selecting this radio button will bring up a {{man label|Replace substring settings}} window where you can type in any string in the {{man label|Replace}} text field and the {{man label|With}} text field. At any time you can click on the {{man button|Cancel}} button or the {{man button|Back}} button. Clicking the {{man button|Forward}} button will bring up the {{man label|Final confirmation}} window.
  
 
{{-}}
 
{{-}}
  
===<u>Media Manager...</u>===
+
====Convert paths from relative to absolute====
  
[[Image:MediaManager-FinalConfirmationWindow-40.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Final confirmation window]]
+
[[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 [http://en.wikipedia.org/wiki/Batch_processing batch operations] on media objects stored in Gramps. An important distinction must be made between a Gramps media object and its file.
+
This tool allows converting relative media paths to the absolute ones. It does this by prepending the {{man label|Base path for relative media paths:}} as given in the [[Gramps_5.0_Wiki_Manual_-_Settings#General|Edit > Preferences > General ]] tab, or if that is not set, it prepends the default [[Gramps_5.0_Wiki_Manual_-_User_Directory|User's Directory]].
 +
{{-}}
  
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'''.
+
====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]]
  
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 converting absolute media paths to a relative path. The relative path is relative viz-a-viz the base path as given in the Preferences, or if that is not set, user's directory. A relative path allows to tie the file location to a base path that can change to your needs.
 +
{{-}}
  
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.
+
====Add images not included in database====
  
If you click the {{man button|Forward}} button (or using the keyboard shortcut {{man key press|Alt|F}}) you will get a window with three radio buttons:
+
[[File:AddImagesNotIncludedInDatabase-FinalConfirmation-page-MediaManager-example-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 'Add images not included in database':"Final Confirmation" page for "Gramps Media Manager" - Tool wizard - example]]
* Replace substrings in the path: Selecting this radio button will bring up a {{man label|Replace substring settings}} window where you can type in any string in the {{man label|Replace}} text field and the {{man label|With}} text field. At any time you can click on the {{man button|Cancel}} button or the {{man button|Back}} button. Clicking the {{man button|Forward}} button will bring up the {{man label|Final confirmation}} window.
 
* Convert paths from relative to absolute
 
* Convert paths from absolute to relative
 
  
 +
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.
 
{{-}}
 
{{-}}
  
 
===<u>Not Related</u>===
 
===<u>Not Related</u>===
  
[[Image:NotRelated-NotRelatedToWindow-40.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}}. Not related]]
+
[[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 report will find people who are not related to the selected person.  
+
This report will find people who are not related to the selected active person.  
  
You will get a {{man label|Not related to '...'}} window which shows a list of all the people that are NOT related to the selected person.
+
You can use this tool via menu {{man menu|Tools->Utilities->Not Related...}}.
 +
 
 +
You will get a {{man label|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:
 
This list gives you:
* Name
+
* ''Name''
* ID
+
* ''ID''
* Parents
+
* ''Parents''
* Marker
+
* ''Tags''
 +
 
 +
From the ''Name'' column you can use the {{man button|right arrow}} button and {{man button|down arrow}} buttons to collapse or expand the grouped ''Name'' list. Double clicking on a person will bring up the {{man label|person edit}} dialog or {{man label|family edit}} dialog.
  
With the {{man button|right arrow}} button and {{man button|down arrow}} button you can collapse or expand the list. Double clicking on a person will bring up the detailed person edit window or family edit window.
+
If you select a person you can use the {{man label|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 {{man button|Apply}} to add the selected tag to the person(s). This tag will then show up in the ''Tags'' column.
 +
{{-}}
  
If you select a person you can use the {{man label|Marker}} text field: 3 choices are possible: blank (you can fill in whatever suits you), TODO, and NotRelated. With the {{man button|Apply}} you can apply the selected marker to the  person. This marker will then show up in the right hand side column.
+
===<u>Relationship Calculator</u>===
  
{{-}}
+
[[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]]
  
===<u>Relationship calculator</u>===
+
The Relationship Calculator when opened will list all people connected, '''but not necessarily related''', to the active person. Select the individual to check if an relationship exist it will be shown in the lower panel. Only blood relationships will display (except for husband-wife relationships). Note "in-law" relationships cannot be displayed.
[[Image:RelationshipCalculatorWindow-40.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Relationship calculator]]
 
  
The Relationship Calculator when opened will list all people connected, but not necessarily related, to the person selected in the PEOPLE view. You simply select the individual you wish to relate and the relationship will be shown in the lower panel. Only blood relationships will display (except for husband-wife relationships). Currently "in-law" relationships cannot be displayed.
+
You can use this tool via menu {{man menu|Tools->Utilities->Relationship Calculator...}}.
  
 
Basically, any two people are related 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.
 
Basically, any two people are related 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.
Line 387: Line 558:
  
 
A full text list of all blood relations and their spouses can be viewed using a [[Gramps 5.0 Wiki Manual - Reports - part 6#Kinship Report|Kinship Report]].
 
A full text list of all blood relations and their spouses can be viewed using a [[Gramps 5.0 Wiki Manual - Reports - part 6#Kinship Report|Kinship Report]].
 
 
{{-}}
 
{{-}}
  
===<u>Verify the Data...</u>===
+
===<u>Verify the Data</u>===
  
[[Image:VerifyTheData-DataVerifyToolWindow-40.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Verify the Data]]
+
[[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]]
  
 
This utility allows you to verify the database based on the set of criteria specified by you.
 
This utility allows you to verify the database based on the set of criteria specified by you.
Line 400: Line 570:
 
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.
 
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.
  
*'''General''':
+
====Verify the Data tab pages====
** maximum age: 95
 
** minimum age to marry: 16
 
** maximum age to marry: 60
 
** maximum spouses for a person: 4
 
** maximum number of consecutive years of widowhood before next marriage: 30
 
** maximum age for an unmarried person: 99
 
 
 
There is a check box: ''estimate missing dates''.
 
This 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.  In addition, starting in Gramps version 4.0.0, 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)).
 
 
 
*'''Women''':
 
** minimum age to bear a child 16
 
** maximum age to bear a child 51
 
** maximum number of children 15
 
 
 
*'''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 41
 
** maximum number of years between children 11
 
** maximum span of years for all children 32
 
  
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|Data Verification Results}} window.
+
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.0_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.
 
Depending on your criteria and your data a list will be shown. Some possibilities of findings are listed below. But there are others.
Line 440: Line 586:
 
* ...
 
* ...
  
To show how handy this {{man label|Utility}} is, here two examples from real data:
+
=====General=====
 +
* {{man label|Maximum age}}: 90
 +
* {{man label|Minimum age to marry}}: 17
 +
* {{man label|Maximum age to marry}}: 50
 +
* {{man label|Maximum number of spouses for a person}}: 3
 +
* {{man label|Maximum number of consecutive years of widowhood before next marriage}}: 30
 +
* {{man label|Maximum age for an unmarried person}}: 99
 +
 
 +
The first check box: {{man label|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.  In addition, starting in Gramps version 3.3, 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: {{man label|Identify invalid dates}} will check if the dates are invalid.
 +
 
 +
=====Women=====
 +
* {{man label|Minimum age to bear a child}}: 17
 +
* {{man label|Maximum age to bear a child}}: 48
 +
* {{man label|Maximum number of children}}: 12
  
:The warning showed 'female husband': checking the data I found a family with father : Anna Roelants. Luckily in the {{man label|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.
+
=====Men=====
 +
* {{man label|Minimum age to father a child}}: 18
 +
* {{man label|Maximum age to father a child}}: 65
 +
* {{man label|Maximum number of children}}: 15
  
:The warning showed 'late marriage': checking the data: male person °1738 female person °1756 : marriage X 1804 [Gregorian Calender] : 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'''.  
+
=====Families=====
+
* {{man label|Maximum husband-wife age difference}}: 30
On the bottom of the window four {{man label|check boxes}} are available to make a selection easier. Those are {{man label|Mark All}}, {{man label|Unmark All}}, {{man label|Invert Marks}}, and {{man label|Hide Marked}}.  
+
* {{man label|Maximum number of years between children}}: 8
 +
* {{man label|Maximum span of years for all children}}: 25
 +
{{-}}
 +
 
 +
====Data Verification Results window====
 +
 
 +
[[File:DataVerificationResults-window-example-50.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.
 +
 
 +
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}}.  
  
 
Double-clicking on a row will give you a possibility to view and or edit the data.
 
Double-clicking on a row will give you a possibility to view and or edit the data.
  
 
With the {{man button|Close}} button (or select the keyboard shortcut {{man key press|Alt|C}}) you close the {{man label|Results}} window.
 
With the {{man button|Close}} button (or select the keyboard shortcut {{man key press|Alt|C}}) you close the {{man label|Results}} window.
 +
{{-}}
  
With the {{man button|Help}} button (or select the keyboard shortcut {{man key press|Alt|H}}) you will get to this page.
+
====Examples====
 +
Two examples from using real data with this tool:
  
{{man tip|Difference between Verify tool and previously described Check tool |The Check tool detects inconsistencies in the database structure. The Verify tool,however, is detecting the records that do not satisfy your particular criteria.}}
+
*:The warning showed 'female husband': checking the data I found a family with father : Anna Roelants. Luckily in the {{man label|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'''.
 +
 +
{{man tip|Difference between {{man label|Verify the Data}} tool and the [[Gramps_5.0_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.}}
 
{{-}}
 
{{-}}
  
===<u>Find possible loop in the database</u>===
+
== Debug ==
  
{{man tip|Work in progress |Work in progress. Need to create a case in the example.gramps to make the image.}}
+
{{man warn|{{man menu|Warning do not use the '''Debug''' tools on your working Family Tree}}|{{man menu|Always create a new empty Family Tree or a copy of your exiting Family Tree for testing.}}<br>The tools available in this advanced menu are used for testing only.}}
  
[[Image:FindPossibleLoop-50.1.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Find possible loop]]
+
[[File:MenuOverview-Tools-debug-menu-shown-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "{{man menu|Tools >Debug>...}}" Menubar - Tools - Debug menu Overview]]
  
This utility allows you to verify if you have loops in the database.
+
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.0_Wiki_Manual_-_Tools|Tools]]}} menu.
  
Select this via the menu {{man menu|Tools->Utilities->Find possible loop...}} you will get a {{man label|Find possible loop}} window. The window has five tabs; {{man label|Gramps_ID}},{{man label|Ancestor}}, {{man label|Gramps_ID}}, {{man label|Descendant}}, {{man label|Family ID}}.
+
See [[Gramps_5.0 Wiki Manual - Command Line#Python options|Command Line: Python options]]
 +
{{-}}
 +
===Check Localized Date Displayer and Parser===
 +
 
 +
[[File:StartDateTest-dialog-CheckLocalizedDateDisplayerAndParser-Tool-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "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.
 +
 
 +
<!-- add keybindings etc -->
 +
{{-}}
 +
 
 +
===Dump Gender Statistics===
 +
 
 +
[[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 the first name.
 +
 
 +
{{-}}
 +
 
 +
===Generate Testcases for Persons and Families===
 +
 
 +
[[File:GenerateTestcases-dialog-GenerateTestcasesForPersonsAndFamilies-Tool-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "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 {{man label|[[Gramps_5.0_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}}.
  
# First Gramps_ID is a reference to the ancestor.
 
# Ancestor is the person we are looking for a loop.
 
# Second Gramps_ID is a reference to the descendant.
 
# Descendant is the origin of the loop.
 
# Family_ID is a reference to the associated family
 
  
 
{{-}}
 
{{-}}
  
[[Image:FindPossibleLoop-50.2.png|right|thumb|600px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Find possible loop in a complex example]]
+
===Populate Sources and Citations===
  
In the following complex example, we have multiple loops :
+
[[File:PopulateSourcesAndCitationsTool-dialog-default-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "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.
  
If we look at the second line, we have :
 
# First Gramps_ID : I0002
 
# Ancestor is : Father, Child2
 
# Second Gramps_ID : I0001
 
# Descendant is : Father, Father
 
# Family_ID is : F0000
 
  
To understand what happens :
 
#we start at [I0002] Father, Child2.
 
#We continue with his son [I0003] Father, Child3.
 
#We continue with his son : [I0000] Child, Child.
 
#We continue with his son : [I0001] Father, Father.
 
#We continue with his son : [I0002] Father, Child2 ==> HERE, we have a loop.
 
  
 +
{{-}}
 
{{man index|Gramps 5.0 Wiki Manual - Reports|Gramps 5.0 Wiki Manual - Settings|5.0}}
 
{{man index|Gramps 5.0 Wiki Manual - Reports|Gramps 5.0 Wiki Manual - Settings|5.0}}
 
 
{{languages|Gramps_5.0_Wiki_Manual_-_Tools}}
 
{{languages|Gramps_5.0_Wiki_Manual_-_Tools}}
 +
{{grampsmanualcopyright}}
  
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Plugins]]
 
[[Category:Plugins]]

Latest revision as of 23:37, 27 October 2022

Previous Index Next


Fig. 12.1 "Tools >..." Menubar - Tools Overview

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.

Tools

Fig. 12.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.

Gramps-notes.png
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. 12.3 Tool Selection - dialog - example showing "Find Possible Duplicate People" information

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.

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. 12.4 "Compare Individual Events" - "Event comparison filter selection" - dialog

This tool compares events across the selected group of people.

You can use this tool via menu Tools->Analysis and Exploration > Compare Individual Events... which will open the 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.


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. 12.5 "Compare Individual Events" - "Event Comparison Results" - dialog - expanded example


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:

Gramps-notes.png
Note

The modifications will only be performed upon your explicit consent, except for the automatic fixes performed by Check and repair Database tool.

Edit Database Owner Information

Fig. 12.6 "Database Owner Editor" - dialog - showing context menu

This 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 info.

  • 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 choices are available from the context menu(right click):

  • Copy from DB to Preferences -
  • Copy from Preferences to DB -


Extract Event Description

Gramps-notes.png
Note

The name format in the Event's Description field depends on the defined name format in Edit->Preferences->Display->Name format

Fig. 12.7 Extract Event Description's - Modifications Made - window - example result

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 present you with the 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.

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

The Default prefix and connector settings dialog will be shown and 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)

Once you have finished select OK to start the tool.

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

Once the report finishes the Name and title extraction tool dialog results window will be shown.

Extract Place Data from a Place Title

Gnome-important.png
No longer part of Gramps you can download this tool from the third party addons
See: Extract Place Data from a Place Title

Find Possible Duplicate People

Fig. 12.10 Find Possible Duplicate People - dialog - default

This tool searches the entire 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. (Note:This calculates a chance of matching as a floating point number. For each piece of information that matches the chance is increased. If the chance is greater than the threshold then a match is reported. The thresholds are Low=0.25, Medium=1.0 and High=2.0. So with the threshold set to High less 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.


Fig. 12.11 "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....

Gnome-important.png
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. 12.12 "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 bases 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 "Fix Capitalization of Given Names" tool Addon that once installed works almost identically to this tool but works for "Given Names"

Merge citations

Tango-Dialog-information.png
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... .

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

Fig. 12.13 "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. 12.14 "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.

Gnome-important.png
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. 12.15 "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.

Gramps-notes.png
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. 12.16 "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.

Gnome-important.png
Renaming events

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

See also:

Reorder Gramps ID

This tool can be used to Reorder your Gramps IDs. Several options are available.

Gnome-important.png
Custom IDs'

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

Fig. 12.17 Reorder IDs

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

The 'Object' column lists the type of 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 button that can be used to toggle all of the check boxes at once.

The 'Actual' column shows an example of the current ID. The 'Quantity' column show the number of objects.

The 'Format' column can be used to change the ID format for each object type. Note that the format consists of a prefix, the '%04d' and suffix. 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. 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 button that can be used to reset all the formats to the last used value.

The 'Change' column contains checkboxes for each object type. If this is 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 check, the ID formats are NOT updated, but the number field within the format is renumbered. The 'Change' label is actually a button that can be used to toggle all of the check boxes at once.

The 'Start' field indicates the starting number used during the renumber operation. The 'Start' label is actually a button that can be used to toggle between start at 0, and start after last current number.

The 'Step' 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 button that can be used to toggle between '1', '2', '5', and '10'.

The 'Keep' column contains checkboxes for each object type. If this and 'Change' is 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 button that can be used to toggle all of the check boxes at once.

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

Gnome-important.png
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.

When you click 'OK', the tool will show a progress bar.

In different stages the following IDs' are reordered: Reordering People IDs', Reordering Family IDs', Reordering Event IDs', Reordering Media Object IDs', Reordering Source IDs', Reordering Citation IDs', Reordering Place IDs', Reordering Repository IDs' and finally Reordering Note IDs'.

In a next 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 ID format or the default ID format. This might be the case if the user had entered his own text in the ID field for the object when editing it. It might also occur if the third party GetGOV Addon or GeoName Addon has been used, as that tool stores the GOV ID in the ID field. If a 'customized' ID is found, it will ask the user if he really wants to replace the ID. The dialog also allows the user to use the same answer for other customized IDs found.

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.

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.

Gnome-important.png
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. 12.18 "Sort Events" - dialog - showing "Tool Options" tab for "Sort Events" Tool

The first option on the Sort Events dialog window 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.


Gnome-important.png
Sorting events

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

Family Tree Repair

Check and Repair Database

Gnome-important.png
Warning

The Check and repair Database tool performs automatic fixes. Once completed, this cannot be undone by the regular Undo function.

This tool checks the database 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....

Gnome-important.png
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. 12.19 "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.
Otherwise you will see the No errors were found dialog stating that The database has passed internal checks.

Rebuild Gender Statistics

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

Rebuilds gender statistics for name gender guessing...

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 Reference Maps

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

This tool rebuilds reference map tables (References items on 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.

Rebuild Secondary Indexes

Fig. 12.22 "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.

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. 12.23 "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 report, 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 (checkbox 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.

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:

Find database loop

Fig. 12.24 Find possible loop

The Find database loop utility allows you to verify if you have ancestral loops in the database.

Select this via the menu Tools->Utilities->Find database loop... you will get a Find database loop window. The window has five tabs; Gramps_ID,Parent, Gramps_ID, Child, Family ID.

  1. First Gramps_ID is a reference to the Parent.
  2. Parent (Ancestor on the image) is the person we are looking for a loop.
  3. Second Gramps_ID is a reference to the Child.
  4. Child (Descendant) is the origin of the loop.
  5. Family_ID is a reference to the associated family


Fig. 12.25 Find possible loop in a complex example

In the following complex example, we have multiple ancestral loops :

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

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.


To read more about ancestral loops see:

Media Manager

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

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 with the following information on the tools abilities.

Gramps-notes.png
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.


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

Fig. 12.27 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. 12.28 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. 12.29 '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 path for relative media paths: as given in the Edit > Preferences > General tab, or if that is not set, it prepends the default User's Directory.

Convert paths from absolute to relative

Fig. 12.30 '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 viz-a-viz the base path as given in the Preferences, or if that is not set, user's directory. A relative path allows to tie the file location to a base path that can change to your needs.

Add images not included in database

Fig. 12.31 '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. 12.32. "Not related to '...'" - dialog - showing results for "Not Related" Tool

This report will find people who are not related to the selected active person.

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. 12.33 "Relationship to '...' " - dialog - showing results for "Relationship Calculator" Tool

The Relationship Calculator when opened will list all people connected, but not necessarily related, to the active person. Select the individual to check if an relationship exist it will be shown in the lower panel. Only blood relationships will display (except for husband-wife relationships). Note "in-law" relationships cannot be displayed.

You can use this tool via menu Tools->Utilities->Relationship Calculator....

Basically, any two people are related 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.

Basically, siblings (brothers and sisters) are only one generation down from the common ancestor. Cousins (also called "first" cousins) are two generations down from the common ancestor. "Second" cousins are thus, three generations down from the common ancestor - and so on. But when the two people are in different generations, the relationship becomes an aunt or uncle, if that person is only one generation down from the common ancestor. The reverse of an aunt and uncle is a nephew and niece.

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.

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

Verify the Data

Fig. 12.34 "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 Alt+R and you will be presented with a 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 (ones with no parent or spouse or child or sibling)
  • old/dead father
  • marriage after death/ before birth
  • large year span for all children
  • early/late marriage
  • young/unborn mother
  • husband and wife with the same surname
  • same sex marriage/ female husband
  • ...
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. In addition, starting in Gramps version 3.3, 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. 12.35 Data Verification Results window.

After you run the tool you will be presented with the Data Verification Results window.

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.
Tango-Dialog-information.png
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

Gnome-important.png
Warning do not use the Debug tools on your working Family Tree

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

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

When the python -O optimise flag is not turned on, an additional Debug entry appears in the Tools menu.

See Command Line: Python options

Check Localized Date Displayer and Parser

Fig. 12.37 "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.


Dump Gender Statistics

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

Will dump the statistics for the gender guessing from the first name.


Generate Testcases for Persons and Families

Fig. 12.39 "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.



Populate Sources and Citations

Fig. 12.40 "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.



Previous Index Next
Gnome-important.png 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