Changes

Jump to: navigation, search

Addon:Types Cleanup Tool

997 bytes added, 5 January
m
Bamaustin moved page Types Cleanup Tool to Addon:Types Cleanup Tool: Standardize filename in preparation for new installer tools
The '''Type Cleanup Tool''' searches your database for records that contain "custom" Types, provides a filtered list allowing those records to be edited, and an option to delete or rename the custom type. Custom Types are recognized by Gramps but the various reports that Gramps can generate and other applications may not recognize or handle them.
==What causes the extra (Custom) Types?==
Custom types are created automatically by some importers, or other addons ([[Addon:Forms_Gramplet|FormsGramplet]], for example) to supplement the standard Gramps types.  They are also created directly manually by the user if he types . Typing directly in into the type Type selector combo box with allows the pattern matching to select from the built-in list. But entering a value not already presentin that list will create a Custom Type and insert it into the Custom submenu
==Usage==
{{man warn|Warning|Proceeding with this tool may make unexpected changes to your data. While it is possible to '''Undo''' the changes made by this tool, it may be easier to recover from a backup.}}
The left pane has the list of various groupings of Types. Any grouping which has custom values will also have the [[image:RightwardsTriangleArrowhead20x20.png]] expansion button at the left. Clicking the button will [[image:DownwardsTriangleArrowhead20x20.png]] expand the submenu to list any existing Custom types. Select one of those custom types and the right pane will show the list of references that utilize the custom type. If the list is empty, the Custom Type can be removed without affecting any records.
The left pane has the list of various types, and any which have custom values will have the drop-down arrow. If you select one of the custom types, the right pane will show the list of references that utilize the custom type. You can edit any of the references in the right pane by double-clicking, using the enter key etc, et cetera. Use this feature to correct the Type of any record with an accidental Custom Type.The reference will continue to be listed even if the Type has been changed. It is a best practice to re-run the Tool to verify all the Custom Types have been resolved before Removing that Custom Type.{{-}}[[File:Types-cleanup-tool-remove-warning-dialog-51.png|thumb|right|350px|"Remove" buttons Warning dialog]]When a custom type is selected in the left pane , the {{man button|Remove}} is enabled. If you want to remove this custom type from your drop-down lists in the type selectors when editing, you can use this button. However , if there are references using the type, you will get a warning that the references will not be changed. If you elect to remove the custom type anyway, it will disappear from your drop-down lists in the type selectors when editing. But if you ever edit and save an object that still uses the custom type, it will reappear in re-added to your drop-down lists in of the type selectors when editing.{{-}}
You can also rename a custom type by changing its value in the combo entry at the bottom of the tool. You can select a standard name, or just modify the name by typing. When a different name has been selected, the {{man button|Rename}} will become enabled. Activating this button will actually make changes to your database, modifying all of the referenced objects at once to the new name. This also causes the tool to re-scan the database, to allow the changes to be properly reflected in the panes.
It is possible to undo changes to the database objects via the usual usual Edit/Undo menu item. But note that undoing a rename which caused a custom type to be modified, will not cause that custom type to reappear in the drop-down lists in the type selectors when editing. This is a limitation of the undo function.
The {{man button|Close}} simple simply closes the tool.
The {{man button|Help}} brings up this web page.
==Issues==
==See also==
* [[Gramps_{{Version manual}}_Wiki_Manual_-_Tools#Rename_Event_Types|Renaming Event Types]]
[[Category:Plugins]]
[[Category:Developers/General]]
[[Category:Tools]]
3,171
edits

Navigation menu