Difference between revisions of "Addon:AddRemoveTagTool"

From Gramps
(Option 2 tab)
m
 
(50 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Third-party plugin}}
+
{{languages|Addon:AddRemoveTagTool}}
[[File:Remove Tag Tool.png|thumb|right|450px|Remove Tag Tool - Options dialog]]
+
{{Third-party addon}}
The {{man label|Remove Tag Tool}} allows you to remove one [[Gramps_{{Version manual}}_Wiki_Manual_-_Filters#Tagging|tag]] from a selected set of filtered objects e.g. people.
+
The {{man label|Add/Remove Tag Tool}} allows you to add or remove one [[Gramps_{{man version}}_Wiki_Manual_-_Filters#Tagging|tag]] from a selected set of filtered objects e.g. people, events, etc.
  
 
==Usage==
 
==Usage==
Once this plugin has been installed:
+
{{man warn|'''Before''' usage of this tool you need to verify the target '''Tag''' exists (or you will need to create it).|So use the menu [[Gramps_{{man version}}_Wiki_Manual_-_Filters#Tagging|{{man menu|Edit ➡ Tags ▶ Organize Tags...}}]] command to invoke a dialog (to create at tag, choose a tag color and re-order the tags) so that the new tag will be higher priority.
* Select Menu {{man menu|Tools > Family Tree Processing -> Remove Tag Tool...}}
+
<hr>
 +
Otherwise if you have no Tags the tool will show an {{man label|ERROR}} tab stating ''The Tool requires at least one tag to execute.'' and if you attempt to {{man button|Execute}} you will be shown the {{man label|WARNING}} dialog stating ''Unable to run the tool. Please check if your database contains tags, filters and objects.''}}
  
{{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 [[How_to_make_a_backup|backup]] your database.}}
+
Select the menu {{man menu|Tools &#x27a1; Family Tree Processing &#x25B6; Add/Remove Tag Tool...}} and you will be shown:
  
* From the '''Undo history warning''' dialogue you can choose {{man button|Stop}} or {{man button|Proceed with the tool}}.
+
* The {{man label|'''Undo history warning'''}} dialog and you can choose either to {{man button|Stop}} or {{man button|Proceed with the tool}} to be shown:
  
Once you have made your choices which tag should be removed from which objects, you can either choose {{man button|Close}} or {{man button|Execute}} to apply the change.
+
* The {{man label|Add/Remove Tag Tool}} dialog where once you have made your choices about which tag you want to add or remove from which objects, you can either choose {{man button|Close}} to exit or {{man button|Execute}} to apply the change.
  
===Option 1 tab===
+
Once the change if any has been made you will be shown an {{man label|INFO}} dialog with the results.
The '''Option 1''' tab is displayed with the following:
+
{{-}}
* '''Category Filter:''' The category from where you want to remove a tag from e.g. people. (always selectable)
 
* '''Remove Tag Filter:''' The name of the tag you choose to remove. (always selectable, when at least one tag exists in the database)
 
* '''Person Filter:''' A generic or custom filter to restrict the amount of people where you want to remove the tag from. (Only selectable when ''person'' is selected in the ''Category Filter'')
 
* '''Center Person Selector:''' The center person which is needed for some generic filters. (Only selectable when ''person'' is selected in the ''Category Filter'' and the chosen person filter requires a center person)
 
* '''Family Filter:''' A generic or custom filter to restrict the amount of families where you want to remove the tag from. (Only selectable when ''family'' is selected in the ''Category Filter'')
 
* '''Center Family Selector:''' The center family which is needed for some generic filters. (Only selectable when ''family'' is selected in the ''Category Filter'' and the chosen family filter requires a center family)
 
  
===Option 2 tab===
+
===Add/Remove Tag Tool dialog===
The '''Option 2''' tab is displayed with the following:
+
The following two option tabs are shown:
* '''Event Filter:''' All events or a custom filter to restrict the amount of events where you want to remove the tag from. (Only selectable when ''event'' is selected in the ''Category Filter'')
+
* [[Addon:AddRemoveTagTool#General_options_tab|General options]]
* '''Place Filter:''' All places or a custom filter to restrict the amount of places where you want to remove the tag from. (Only selectable when ''place'' is selected in the ''Category Filter'')
+
* [[Addon:AddRemoveTagTool#Filter_options_tab|Filter options]]
* '''Source Filter:''' All sources or a custom filter to restrict the amount of sources where you want to remove the tag from. (Only selectable when ''source'' is selected in the ''Category Filter'')
+
====General options tab====
* '''Citation Filter:''' All citations or a custom filter to restrict the amount of citations where you want to remove the tag from. (Only selectable when ''citation'' is selected in the ''Category Filter'')
+
[[File:AddRemoveTagTool-GeneralOptionsDialog-60.png|thumb|right|450px|"Add/Remove Tag Tool" - "General options" dialog]]
* '''Repository Filter:''' All repositories or a custom filter to restrict the amount of repositories where you want to remove the tag from. (Only selectable when ''repository'' is selected in the ''Category Filter'')
+
The {{man label|General options}} tab is displayed with the following:
* '''Media Filter:''' All media or a custom filter to restrict the amount of media where you want to remove the tag from. (Only selectable when ''media'' is selected in the ''Category Filter'')
+
* {{man label|Add/Remove Filter:}} Select if you want to add or remove a tag.
* '''Note Filter:''' All notes or a custom filter to restrict the amount of notes where you want to remove the tag from. (Only selectable when ''note'' is selected in the ''Category Filter'')
+
** '''Add tags''' (default)
 +
** ''Remove tags''
 +
* {{man label|Category Filter:}} The category from where you want to add/remove a tag from e.g. people.
 +
* {{man label|Tag Filter:}} The name of the tag you choose to add/remove. See usage section
 +
{{-}}
 +
 
 +
====Filter options tab====
 +
[[File:AddRemoveTagTool-FilterOptionsDialog-60.png|thumb|right|450px|"Add/Remove Tag Tool" - "Filter options" dialog]]
 +
The {{man label|Filter options}} tab is displayed with the following (Each filter is only selectable when the corresponding category is selected on the General options tab):
 +
* {{man label|Person Filter:}} All persons or a custom filter to restrict the amount of persons where you want to remove the tag from.
 +
* {{man label|Family Filter:}} All families or a custom filter to restrict the amount of families where you want to remove the tag from.
 +
* {{man label|Event Filter:}} All events or a custom filter to restrict the amount of events where you want to remove the tag from.
 +
* {{man label|Place Filter:}} All places or a custom filter to restrict the amount of places where you want to remove the tag from.
 +
* {{man label|Source Filter:}} All sources or a custom filter to restrict the amount of sources where you want to remove the tag from.
 +
* {{man label|Citation Filter:}} All citations or a custom filter to restrict the amount of citations where you want to remove the tag from.
 +
* {{man label|Repository Filter:}} All repositories or a custom filter to restrict the amount of repositories where you want to remove the tag from.
 +
* {{man label|Media Filter:}} All media or a custom filter to restrict the amount of media where you want to remove the tag from.
 +
* {{man label|Note Filter:}} All notes or a custom filter to restrict the amount of notes where you want to remove the tag from.
 +
 
 +
{{-}}
 +
 
 +
==Issues==
 +
* No help link to this page. / Except from the Addon manager entry.
 +
* If no tags are present , it shows a deliberate error message.
 +
 
 +
{{man tip|The original {{man label|Remove Tag Tool}} was enhanced to also Add tag's and renamed to the {{man label|Add/Remove Tag Tool}}}}
  
 
==See also==
 
==See also==
* [[Gramps_{{Version manual}}_Wiki_Manual_-_Filters#Tagging|Tagging]]
+
* [[Gramps_{{man version}}_Wiki_Manual_-_Filters#Tagging|Tagging]]
  
 +
[[Category:Addons]]
 
[[Category:Plugins]]
 
[[Category:Plugins]]
 
[[Category:Developers/General]]
 
[[Category:Developers/General]]
 
[[Category:Tools]]
 
[[Category:Tools]]

Latest revision as of 06:47, 1 November 2025

Gramps-notes.png
This is a Third-party Addon. The Addon/Plugin system is controlled by the Plugin Manager.

Please use carefully on data that is backed up, and help make it better by reporting any 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.

The Add/Remove Tag Tool allows you to add or remove one tag from a selected set of filtered objects e.g. people, events, etc.

Usage

Gnome-important.png
'Before' usage of this tool you need to verify the target Tag exists (or you will need to create it).

So use the menu Edit ➡ Tags ▶ Organize Tags... command to invoke a dialog (to create at tag, choose a tag color and re-order the tags) so that the new tag will be higher priority.


Otherwise if you have no Tags the tool will show an ERROR tab stating The Tool requires at least one tag to execute. and if you attempt to Execute you will be shown the WARNING dialog stating Unable to run the tool. Please check if your database contains tags, filters and objects.

Select the menu Tools ➡ Family Tree Processing ▶ Add/Remove Tag Tool... and you will be shown:

  • The Undo history warning dialog and you can choose either to Stop or Proceed with the tool to be shown:
  • The Add/Remove Tag Tool dialog where once you have made your choices about which tag you want to add or remove from which objects, you can either choose Close to exit or Execute to apply the change.

Once the change if any has been made you will be shown an INFO dialog with the results.

Add/Remove Tag Tool dialog

The following two option tabs are shown:

General options tab

"Add/Remove Tag Tool" - "General options" dialog

The General options tab is displayed with the following:

  • Add/Remove Filter: Select if you want to add or remove a tag.
    • Add tags (default)
    • Remove tags
  • Category Filter: The category from where you want to add/remove a tag from e.g. people.
  • Tag Filter: The name of the tag you choose to add/remove. See usage section


Filter options tab

"Add/Remove Tag Tool" - "Filter options" dialog

The Filter options tab is displayed with the following (Each filter is only selectable when the corresponding category is selected on the General options tab):

  • Person Filter: All persons or a custom filter to restrict the amount of persons where you want to remove the tag from.
  • Family Filter: All families or a custom filter to restrict the amount of families where you want to remove the tag from.
  • Event Filter: All events or a custom filter to restrict the amount of events where you want to remove the tag from.
  • Place Filter: All places or a custom filter to restrict the amount of places where you want to remove the tag from.
  • Source Filter: All sources or a custom filter to restrict the amount of sources where you want to remove the tag from.
  • Citation Filter: All citations or a custom filter to restrict the amount of citations where you want to remove the tag from.
  • Repository Filter: All repositories or a custom filter to restrict the amount of repositories where you want to remove the tag from.
  • Media Filter: All media or a custom filter to restrict the amount of media where you want to remove the tag from.
  • Note Filter: All notes or a custom filter to restrict the amount of notes where you want to remove the tag from.


Issues

  • No help link to this page. / Except from the Addon manager entry.
  • If no tags are present , it shows a deliberate error message.
Tango-Dialog-information.png
The original Remove Tag Tool was enhanced to also Add tag's and renamed to the Add/Remove Tag Tool


See also