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

From Gramps
Jump to: navigation, search
(Verify the Data...)
(Generate SoundEx codes)
Line 92: Line 92:
  
 
This utility generates SoundEx codes for the names of people in the database. Please visit the NARA Soundex Indexing page to learn more about Soundex Indexing System.
 
This utility generates SoundEx codes for the names of people in the database. Please visit the NARA Soundex Indexing page to learn more about Soundex Indexing System.
 +
 +
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 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.
 +
 +
To search for a particular surname, you must first work out its code.
 +
 +
*'''Basic Soundex Coding Rule:'''
 +
 +
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:
 +
Washington is coded W-252 (W, 2 for the S, 5 for the N, 2 for the G, remaining letters disregarded).
 +
Lee is coded L-000 (L, 000 added).
 +
 +
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:'''
 +
 +
** 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.
  
 
=== Media Manager... ===
 
=== Media Manager... ===

Revision as of 10:17, 28 February 2008

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 present one of the major strengths of GRAMPS compared to the most genealogical software.

The tools can be accessed through the menu by choosing 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 Tools icon on the toolbar.

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


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

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 Custom Filter Editor button. The resulting table produced by this tool can be saved as a spreadsheet.

Interactive Descendant Browser

This tool builds a tree with the Active Person being the root. Children branch from their parents in the usual manner. Use this tool for a quick glance of a person's descendants.

Tango-Dialog-information.png
Tip

Double-clicking on tree node will bring up the Edit Person dialog allowing to view or modify the personal data.


Database 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 database 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.

Calculate Estimated Dates

Edit Database Owner Information

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.

Find Possible Duplicate People...

This tool searches the entire database, looking for the entries that may represent the same person.

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.

Rename Event Types

This tool allows all the events of a certain name to be renamed to a new name.

Reorder GRAMPS ID

This tool reorders the GRAMPS IDs according to the defaults of GRAMPS.

Database Repair

Check and repair database

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

Rebuild Reference Maps

Rebuild Secondary Indices

Remove Unused Objects...

Debug

Python Evaluation window...

Reload Plugins

Show uncollected Objects

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:

Generate SoundEx codes

This utility generates SoundEx codes for the names of people in the database. Please visit the NARA Soundex Indexing page to learn more about Soundex Indexing System.

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

To search for a particular surname, you must first work out its code.

  • Basic Soundex Coding Rule:

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: Washington is coded W-252 (W, 2 for the S, 5 for the N, 2 for the G, remaining letters disregarded). Lee is coded L-000 (L, 000 added).

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:
    • 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.

Media Manager...

Relationship calculator

This utility calculates and displays the relationship of any person to the Active Person.

Verify the Data...

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.


Clicking on Tools-->Utilities-->Verify the Data... you will get a Database Verify Tool window. The window has four tabs. 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:
    • 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.

  • 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 Run button and you will be presented with a Database 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 : TODO further explain what how
  • 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
  • ...

To show how handy this Utility is, here two live examples from real data:

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 [French Republican 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.

On the bottom of the window four check boxes 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 you close the Results window.




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


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.




TODO this must be relocated

Custom Filter Editor

Fig.3.x Define filter

The Custom Filter Editor builds custom filters that can be used to select people included in reports, exports, and other tools and utilities. This is in fact a very powerful tool in genealogical analysis.

When you launch it, the User defined filters dialog appears that lists all the filters (if any) previously defined by you. Click the Add... button to define a new filter. Once you have designed your filters, you can edit, test, and delete selected filters using the Edit... , Test... , and Delete buttons, respectively. All the filters displayed in the list will be automatically saved along with your database and will be available with subsequent sessions of GRAMPS.

Gramps-notes.png
Changes on filters

The changes made to the filters only take effect when you click the Apply and close button.

Clicking the Add... button invokes the following Define filter dialog:


Type the name for your new filter into the Name field.

Enter any comment that would help you identify this filter in the future into the Comment field. Add as many rules to the Rule list as you would like to your filter using Add... button. If the filter has more than one rule, select one of the Rule operations . This allows you to choose whether all rules must apply, only one (either) rule must apply, or exactly one (either) rule must apply, in order for the filter to generate a match. If your filter has only one rule, this selection has no effect.

Check Return values that do not match the filter rules to invert the filter rule. For example, inverting "has a common ancestor with I1" rule will match everyone who does not have a common ancestor with that person).

Clicking the Add... button invokes the following Add Rule dialog:

Fig.3.x Add rule

The pane on the left-hand side displays available filter rules arranged by their categories in an expandable tree. For detailed filter rule reference, see append-filtref . Click on the arrows to fold/unfold the appropriate category. Select the rule from the tree by clicking on its name. The right-hand side displays the name, the description, and the values for the currently selected rule. Once you are satisfied with your rule selection and its values, click OK to add this rule to the rule list of the currently edited filter. Clicking Cancel will abort adding the rule to the filter.

Tango-Dialog-information.png
Tip

A filter you have already designed may be used as a rule for another filter. This gives you nearly infinite flexibility in custom-tailoring your selection criteria that can be later used in most of the exports, reports, and some of the tools (such as comparing individual events).


Scratch Pad

This tool provides a temporary note pad to store database records for easy reuse. In short, this is a sort of the copy-and-paste functionality extended from textual objects to other types of records used in GRAMPS.

Tango-Dialog-information.png
Tip

Scratch Pad makes extensive use of drag-and-drop technique.


To invoke Scratch Pad, either choose Tools ->Utilities ->Scratch Pad or click the ScratchPad button on the toolbar. The following window will appear:

Fig.3.xx Scratch pad

Scratch Pad supports addresses, attributes (both personal and family), events (both personal and family), names, media objects references, source references, URLs, and of course textual information of notes and comments. To store any type of these records, simply drag the existing record on to the Scratch Pad from the corresponding editor dialog. To reuse the record, drag it from the Scratch Pad on to the corresponding place in the editor, e.g. Address tab, Attribute tab, etc.

Tango-Dialog-information.png
Tip

Some objects are showing the link icon on the left. This indicates that dragging such selection will produce a reference to an existing object, not copy the object itself.


For example, the media object file will not be duplicated. Instead, the reference will be made to an existing media object, which will result in the local gallery entry.

Tango-Dialog-information.png
Tip

Scratch Pad storage is persistent within a single GRAMPS session. Closing the window will not lose the stored records. However, exiting GRAMPS will.


Previous [[Gramps {{{3}}} Wiki Manual| Index]] Next