Changes

Jump to: navigation, search

Gramps 3.0 Wiki Manual - Tools

2,180 bytes added, 09:27, 6 February 2009
no edit summary
{{grampsmanualcopyright}}
{{man index|Gramps 3.0 Wiki Manual - Reports|Gramps 3.0 Wiki Manual - Settings|3.0}}
 
{{languages|Gramps_3.0_Wiki_Manual_-_Tools}}
{{languages}}
== 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 {{man button|Custom Filter Editor}} button. The resulting table produced by this tool can be saved as a spreadsheet.
=== Interactive Descendant Browser ... ===[[Image:interactivedes.png|right|thumb|200px|Fig. z.z Descendant Browser]] 
First you have to select a person or you start with the current Active Person.
Use this tool for a quick glance of a person's descendants.
 
 
{{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.}}
**Filter: in the drop down menu you can select which portion of the database will be processed: you can also select the '''entire database''', '''Descendants''' of the Active Person, '''Descendant families''' of the Active Person, '''Ancestors''' of the Active Person, '''People with common ancestor''' with the Active Person, or any '''custom filter''' (see custom made filters).
**Filter Person: the Active Person is listed in this field, but click on the {{man button|Select a different person}} will bring up a {{man label|Select a person for the report}} window. This window shows a list of people you can choose from. Use the {{man button|down}} arrow or th {{man button|>}} to expand and collpase collapse the nodes. In the table you will see for which persons no birth or death date is available.
In the left hand side lower corner there is a {{man label|Show all}} tickboxtick box. Clicking on this button will show all people in the database.
**Source text: in this {{man label|text field}} you can fill in the text that will be used in the source reference. Default value is: ''Calculated Date Estimates''.
** Average years between generations:
=== Edit Database Owner Information ===[[Image:dataowner.png|right|thumb|200px|Fig. z.z Owner Info]] click '''Tools-->Database Processing-->Calculate Estimated Dates...Edit Database Owner information''' . This brings up a the {{man label|Undo history warningDatabase Owner editor}} window:, where you can fill in the needed info.
{{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 bij 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.}}*Name:*Adress:*City:*State/Province:*Country:*ZIP/Postal Code:*Phone:*Email:
You then choose {{man button|Stop}} or {{man button|Proceed}}.=== Extract Information from Names ===
You will This tool searches the entire database and attempts to extract titles and nicknames that may be presented with the embedded in a person's {{manlabel|button|Calculate Estimated DatesGiven name}} windowfield. If any information could be extracted, the candidates for fixing will be presented in the table. This window has three tabsYou may then decide which to repair as suggested and which not to.
*Options:=== Extract Place Data from a Place Title ===
**Filter: in the drop down menu you can select which portion of the database will be processed: you can also select the '''entire database''', '''Descendants''' of the Active Person, '''Descendent families''' of the Active Person, '''Ancestors''' of the Active Person, '''People with common ancestor''' with the Active Person, or any '''custom filter''' (see custommade filters)This tool attempts to extract city and state/province from a place title.
**Filter Person: the Active Person is listed in this field, but click on the {{man button|Select a different person}} will bring up a {{man label|Select a person for the report}} window. This window shows a list of people you can choose === Extract Event Descriptions from. Use the {{man button|down}} arrow or th {{man button|>}} to expand and collpase the nodes. In the table you will see for which persons no birth or death date is available.Event Data ===
In Extracts event descriptions from the left hand side lower corner there is a {{man label|Sow all}} tickbox. Clicking on this button will show all people in the databaseevent data.
**Source text=== Find Possible Duplicate People... ===[[Image: in this {{man labelduppeople.png|right|thumb|250px|text field}} you can fill in Fig. z.z Duplicate People]]This tool searches the entire database, looking for the text entries that will be used in may represent the source reference. Default value is: ''Calculated Date Estimates''same person.
Four tickboxes are available:You can access this tool via '''Tool->Database Processing...->Find Possible Duplicate People...'''.
** Remove previously added dates** Add estimated birth datesTwo options are available:** Add estimated death dates** Display detailed resultsMatch Threshold: will show details for every date enteredchoose between High, Medium and Low from the drop down menu.
*Options: a check box to enable or disable the use of [[Gramps_3.0_Wiki_Manual_-_Tools#Use_of_SoundEx_module_in_GRAMPS|soundex]] codes.
*ConfigOnly 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.
** Maximum age:** Maximum sibling age difference:** Minimum years between generations:** Average years between generations:If you hit the {{man button|OK}} button, the data will be processes in two passes.
=== Edit Database Owner Information ===Pass 1: building preliminary listsPass 2: calculating potential matches. A progress bar will be shown and depending the speed of the cpu and the amount of people in the database this can take some time.
=== Extract Information from Names ===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.*First Person*Second Person
This tool searches If you select a row you can check the details with the entire database and attempts to extract titles and nicknames that may be embedded in a person's {{man labelbutton|Given nameCompare}} field. If any information could be extracted, the candidates for fixing will be presented in button or you can double-click on the table. You may then decide which to repair as suggested and which not toselected row.
=== Find Possible Duplicate 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_3.0_Wiki_Manual_-_Entering_and_Editing_Data:_Detailed#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. ===
This tool searches Hitting the entire database, looking for {{man button|Cancel}} button brings you back to the entries that may represent the same personlist.
=== Fix Capitalization of Family Names... ===
[[Image:capnames.png|right|thumb|200px|Fig. z.z Fix Capitalization]]
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 '''Tools-->Database 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. If you think you may want to revert running this tool, please stop here and backup your database.}}
This You can choose {{man button|Stop}} or {{man button|Proceed with the tool searches the entire database and attempts }}. If there where changes to fix Capitalization of Names you will be presented with the capitalization {{man label|Capitalization changes}} window. The window shows a list of the family names. The aim is that GRAMPS can convert to have conventional correct capitalization. In the list you will see a three columns: capital first letter {{man button|Select}} check box(es), Original Name and lower case for the rest of the family nameCapitalization Change. If deviations from this rule are detected,  Select the candidates for fixing will names you want to be presented in changed, then hit the table{{man button|Accept changes and close}} button. You may then decide which to repair as suggested and which not Or use the {{man button|Cancel}} button toabort changes.
=== Rename Event Types ===
[[Image:changeventype.png|right|thumb|200px|Fig. z.z Change type]]
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.}}The {{man label|Change Event Types}} window is presented. This tool allows will rename all the events of one type to a certain name different type. *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.  Finally use the {{man button|Cancel}} or the {{man button|OK}} button. {{man warn|1=Renaming events|2=Once completed, this cannot be renamed to a new nameundone by the regular {{man label|Undo}} function.}}
=== Reorder GRAMPS ID ===
This tool reorders will change all the elements in the database to conform to the scheme specified in the database's prefix id's. You can change those settings in the '''Edit-->Preferences...-->ID Formats''' menu. You can use this tool via '''Tools-->Database Processing-->Reorder GRAMPS IDs according '''.{{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 defaults of GRAMPSchanges 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. In different steps following IDs' are reordered: Reordering People IDs', Reordering Family IDs', Reordering Event IDs', Reordering Media Object IDs', Reordering Source IDs', Reordering Place IDs', Reordering Repository IDs' and finally Reordering Note IDs'. 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!}}
== Database Repair ==
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 ===
 
This tool rebuilds reference map tables.
=== Rebuild Secondary Indices ===
 
This tool rebuilds secondary indices.
=== Remove Unused Objects... ===
This tool will search your database for pieces of information which are not connected to anything else, and then remove them.
== Debug ==
=== Reload Plugins ===
 
As the name suggests this unloads and reloads all the plugins. In the GRAMPS system all the Reports and Tools are plugins, so this can help flush unwanted settings and load new plugins which you've added to the system since GRAMPS started.
=== Show uncollected Objects ===
=== Generate SoundEx codes ===
==== SoundeEx SoundEx what is this? ====
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.
** 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 ====
[[Image:Soundexcode.png|thumb|right|200px|Fig. x.y SoundEx code generator]]
Clicking via the Toolbar on '''Tools-->Verify the DataUtilities --> Soundex generator...''' you get the {{man label|SoundEx code generator}} window. 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 should a name from the drop down list.
The name you put in can by any name even a name not present in your Family Tree.
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===
[[Image:cfe-df.png|right|thumb|150px|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.
{{man note|1=Changes on filters |2=The changes made to the filters only take effect when you click the {{man button|Apply and close}} button.}}
Clicking the {{man button|Add...}} button invokes the following {{man label|Define filter}} dialog:  Type the name for your new filter into the {{man label|Name}} field. Enter any comment that would help you identify this filter in the future into the {{man label|Comment}} field. Add as many rules to the {{man label|Rule list}} as you would like to your filter using {{man button|Add...}} button. If the filter has more than one rule, select one of the {{man label|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 {{man label|Return values that do not match the filter rules}} to invert the filter rule. For example, inverting "has a common ancestor with I1" rule will match everyone who does not have a common ancestor with that person). Clicking the {{man button|Add...}} button invokes the following {{man label|Add Rule}} dialog: [[Image:cfe-ar.png|right|thumb|150px|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 {{man button|OK}} to add this rule to the rule list of the currently edited filter. Clicking {{man button|Cancel}} will abort adding the rule to the filter. {{man tip| 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.
{{man index|Gramps 3.0 Wiki Manual - Reports|Gramps 3.0 Wiki Manual - Settings|3.0}} 
[[Category:Documentation]][[Category:Plugins]]
[[Category:Documentation]]{{languages|Gramps_3.0_Wiki_Manual_-_Tools}}

Navigation menu