Difference between revisions of "Addon:AttachSourceTool"

From Gramps
Jump to: navigation, search
m
m (Bamaustin moved page AttachSourceTool to Addon:AttachSourceTool: Standardize filename in preparation for new installer tools)
(24 intermediate revisions by 2 users not shown)
Line 1: Line 1:
The Attach Source Tool allows you to add a new or existing Source to a set of filtered people.
+
{{Third-party plugin}}
 +
[[File:AttachSource-Tool-Options-dialog-addon-example-50.png|thumb|right|450px|Attach Source Tool - Options (defaults) - dialog]]
 +
The {{man label|Attach Source}} Tool allows you to add a new or existing sources to the entire database or selected set of filtered people.
 +
__TOC__
 +
==Usage==
 +
* Once this addon has been installed
 +
* Select Menu {{man menu|Tools > Family Tree Processing -> Attach Source...}}
  
==Future plans==
+
{{man warn|Undo history warning|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.}}
 +
 
 +
* From the '''Undo history warning''' dialog you can choose {{man button|Stop}} or {{man button|Proceed with the tool}}.
 +
 
 +
* The {{man label|Options}} tab is displayed with the following:
 +
**{{man label|Person Filter:}} '''Entire Database'''(default)
 +
**{{man label|Filter Person:}} defaults to the Active Person.
 +
**{{man label|Source type:}} '''New source'''(default), or '''Existing source'''.
 +
**{{man label|New Source Title:}} Empty textbox by default, that you can type your source details into.
 +
**{{man label|Existing Source ID:}} Empty textbox by default, that you can type in the number of an existing source.
 +
 
 +
Once you have made your choices for the source to be attached you can either choose {{man button|Close}} or {{man button|Execute}} to apply the change.
 +
 
 +
After the change has been made the {{man label|Results}} tab will become available where you can change and examine the final results.
 +
 
 +
Once finished select {{man button|Close}}.
 +
{{-}}
 +
 
 +
==Issues==
 +
* Missing a Help button pointing to this page {{bug|???}}
 +
* Fixed "Results" tab that does not expand as dialog is maximized.{{bug|???}}
 +
* Selecting "Execute" a second time with no changes creates a duplicate source for "New Source" , probably should give a warning. {{bug|???}}
 +
 
 +
===Future plans===
 +
* Add attach source to multiple events using the AttachSourceTool {{bug|4257}}
 +
* Add sources to types of objects other than people (media, events, etc) {{bug|???}}
 +
* Be able to reverse/undo a run or provide a dry run option that shows the results of what would be changed {{bug|???}}
 
* Add a method to select the source ID from a popup dialog {{bug|???}}
 
* Add a method to select the source ID from a popup dialog {{bug|???}}
* Add sources to types of objects other than people (media, events, etc)  {{bug|???}}
 
  
 
[[Category:Plugins]]
 
[[Category:Plugins]]
 
[[Category:Developers/General]]
 
[[Category:Developers/General]]
 
[[Category:Tools]]
 
[[Category:Tools]]

Revision as of 21:30, 4 January 2022

Gramps-notes.png

Please use carefully on data that is backed up, and help make it better by reporting any comments or problems to the author, or issues to the bug tracker
Unless otherwise stated on this page, you can download this addon by following these instructions.
Please note that some Addons have prerequisites that need to be installed before they can be used.
This Addon/Plugin system is controlled by the Plugin Manager.

Attach Source Tool - Options (defaults) - dialog

The Attach Source Tool allows you to add a new or existing sources to the entire database or selected set of filtered people.

Usage

  • Once this addon has been installed
  • Select Menu Tools > Family Tree Processing -> Attach Source...
Gnome-important.png
Undo history warning

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.

  • From the Undo history warning dialog you can choose Stop or Proceed with the tool.
  • The Options tab is displayed with the following:
    • Person Filter: Entire Database(default)
    • Filter Person: defaults to the Active Person.
    • Source type: New source(default), or Existing source.
    • New Source Title: Empty textbox by default, that you can type your source details into.
    • Existing Source ID: Empty textbox by default, that you can type in the number of an existing source.

Once you have made your choices for the source to be attached you can either choose Close or Execute to apply the change.

After the change has been made the Results tab will become available where you can change and examine the final results.

Once finished select Close.

Issues

  • Missing a Help button pointing to this page ???
  • Fixed "Results" tab that does not expand as dialog is maximized.???
  • Selecting "Execute" a second time with no changes creates a duplicate source for "New Source" , probably should give a warning. ???

Future plans

  • Add attach source to multiple events using the AttachSourceTool 4257
  • Add sources to types of objects other than people (media, events, etc) ???
  • Be able to reverse/undo a run or provide a dry run option that shows the results of what would be changed ???
  • Add a method to select the source ID from a popup dialog ???