Difference between revisions of "Addon:SetPrivacyTool"

From Gramps
Jump to: navigation, search
m (Missed version update on roll-over)
m (Version 1.0.9: the Years parameter is an exclusion range rather inclusion. Revised description.)
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{Third-party plugin}}
 
{{Third-party plugin}}
 +
The {{man label|Set Privacy Tool}} allows you to manage the privacy status of people, events and media from the year range that you select.
  
The '''Set Privacy Tool''' allows you to manage privacy status of people, events and media.
+
Items marked as [[Gramps_{{man version}}_Wiki_Manual_-_Getting_started#Privacy|private]] can be hidden in Gramps e.g. in report generation or ignored e.g. when exporting the database.
 
 
Items marked as [[Gramps_5.1_Wiki_Manual_-_Getting_started#Privacy|private]] can be hidden in Gramps e.g. in report generation or ignored e.g. when exporting the database.
 
 
{{-}}
 
{{-}}
 
==Usage==
 
==Usage==
Line 13: Line 12:
 
* From the '''Undo history warning''' dialogue you can choose {{man button|Stop}} or {{man button|Proceed with the tool}}.
 
* From the '''Undo history warning''' dialogue you can choose {{man button|Stop}} or {{man button|Proceed with the tool}}.
  
 +
 +
== Version 1.0.8 ==
 +
Available through the [[Gramps_{{man version}}_Wiki_Manual_-_Settings#Third_party_addons_management|Third party addons management]] section of the [[Gramps_{{man version}}_Wiki_Manual_-_Settings#General|General Tab in Preferences]].
 +
 +
* The {{man label|Option}} tab is displayed with the following:
 +
** {{man label|[ ] Persons:}} If checked, all persons with a birth date in the given time range (Years) will be set private
 +
** {{man label|[ ] Events:}} If checked, all events with a date in the given time range (Years) will be set private
 +
** {{man label|[ ] Media:}} If checked, all media with a date in the given time range (Years) will be set private
 +
** {{man label|[ ] Always private if no date:}} Checkbox option, if checked all objects without a valid date will also be set private
 +
** {{man label|Years:}} The number of years back from today which should be considered as private
 +
 +
Once you have made your choices,  you can either choose {{man button|Close}} or {{man button|Execute}} to apply the change.
 +
{{-}}
 +
== Version 1.0.9 ==
 +
Posted 6 July 2021 and only [https://github.com/gramps-project/addons-source/pull/511 available through the Pull Request system on GitHub]. Currently queued for code review and release via the Plugin Manager.
 +
<!--
 +
Icons
 +
: {{icon|gram}} Dashboard
 +
: {{icon|peop}} People
 +
: {{icon|rela}} Relationships
 +
: {{icon|fami}} Family Families
 +
: {{icon|ance}} Charts
 +
: {{icon|even}} Events
 +
: {{icon|plac}} Places
 +
: {{icon|geog}} Geography
 +
: {{icon|sour34}} Sources
 +
: {{icon|cite}} Citations
 +
: {{icon|repo}} Repositories
 +
: {{icon|medi}} Media
 +
: {{icon|note}} Notes
 +
:[[Template:Icon/doc|more of the standard icons]]
 +
-->
 +
 +
{{man warn|Ambiguity is subject to penalties with automated mass updates|This tool is selective but not intelligent. It does exactly what it is told to do... even when that is a really bad choice.<br />Also it does not use the [[Gramps_{{man version}}_Wiki_Manual_-_Probably_Alive|Probably Alive]] Proxy calculation. It uses the '''Birth year''' when filtering Person records.<br />So the dates of any other items in the Person's timeline (other Events, defining life events of offspring, siblings, or parents) are not considered. You may want to provide some better direction by using the [[Calculate_Estimated_Dates|Calculate Estimated Dates Tool]] addon to estimate a Birth year.]}}
 
[[File:SetPrivacyTool.png|thumb|right|450px|Set Privacy Tool - Option dialog]]
 
[[File:SetPrivacyTool.png|thumb|right|450px|Set Privacy Tool - Option dialog]]
 +
The {{man label|Option}} tab is displayed with the following:
 +
* {{man label|Years:}}
 +
** numeric text box with {{Man key press|-}}{{Man key press|+}} buttons <br />The number of years (counted backwards from today) which should be excluded from being updated.
 +
** {{checkbox|0|Always private if no date.}}<br />If selected, any objects without a valid date will also be updated.
 +
* {{icon|peop}}{{man label|Person Filter:}}
 +
** {{man button|Entire Database &#x25BC;}} <small><i>(default)</i></small><br />Pull down menu to select any Person [[Gramps_{{man version}}_Wiki_Manual_-_Filters#Custom_Filters|custom filter]].
 +
** {{checkbox|0|Persons}}<br />If selected, only [[Gramps_Glossary#person|Person objects]] with a birth date in the given time range (Years) will be updated.
 +
* {{icon|even}} {{man label|Event Filter:}}
 +
** {{man button|Entire Database &#x25BC;}} <small><i>(default)</i></small><br />Pull down menu to select any Event [[Gramps_{{man version}}_Wiki_Manual_-_Filters#Custom_Filters|custom filter]].
 +
** {{checkbox|0|Events}}<br />If selected, only [[Gramps_Glossary#event|Event objects]] within the Years range will be updated.
 +
* {{icon|medi}}{{man label|Media Filter:}}
 +
** {{man button|Entire Database &#x25BC;}} <small><i>(default)</i></small><br />Pull down menu to select any Media [[Gramps_{{man version}}_Wiki_Manual_-_Filters#Custom_Filters|custom filter]].
 +
** {{checkbox|0|Media}}<br />If selected, only [[Gramps_Glossary#media|Media objects]] within the Years range will be updated.
 +
* {{man label|Internet type filter:}}
 +
** {{man button|Entire Database &#x25BC;}} <small><i>(default)</i></small><br />Pull down menu to select a specific Type of Internet record:
 +
*** {{man label|All}} <small><i>(default)</i></small>
 +
*** {{man label|Unknown}}
 +
*** {{man label|E-Mail}}
 +
*** {{man label|Web Home}}
 +
*** {{man label|Web Search}}
 +
*** {{man label|FTP}}
 +
** {{checkbox|0|Internet}}<br />If selected, only [[Gramps_{{man version}}_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_1#Internet|Internet records]] of the selected Type will be updated.
 +
* Addresses
 +
** {{checkbox|0|Address}}<br />If selected, any [[Gramps_{{man version}}_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_3#Addresses|Address records]] within the Years range will be updated.
  
* The '''Options''' tab is displayed with the following:
 
** Persons: If checked, all persons with a birth date in the given time range (Years) will be set private
 
** Events: If checked, all events with a date in the given time range (Years) will be set private
 
** Media: If checked, all media with a date in the given time range (Years) will be set private
 
** Always private if no date: Checkbox option, if checked all objects without a valid date will also be set private
 
** Years: The number of years back from today which should be considered as private
 
  
 
Once you have made your choices,  you can either choose {{man button|Close}} or {{man button|Execute}} to apply the change.
 
Once you have made your choices,  you can either choose {{man button|Close}} or {{man button|Execute}} to apply the change.
 
 
[[Category:Plugins]]
 
[[Category:Plugins]]
[[Category:Developers/General]]
 
 
[[Category:Tools]]
 
[[Category:Tools]]

Latest revision as of 17:02, 9 July 2021

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

The Set Privacy Tool allows you to manage the privacy status of people, events and media from the year range that you select.

Items marked as private can be hidden in Gramps e.g. in report generation or ignored e.g. when exporting the database.

Usage

Once this plugin has been installed:

  • Select Menu Tools > Family Tree Processing -> Set Privacy Tool...
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 dialogue you can choose Stop or Proceed with the tool.


Version 1.0.8

Available through the Third party addons management section of the General Tab in Preferences.

  • The Option tab is displayed with the following:
    • [ ] Persons: If checked, all persons with a birth date in the given time range (Years) will be set private
    • [ ] Events: If checked, all events with a date in the given time range (Years) will be set private
    • [ ] Media: If checked, all media with a date in the given time range (Years) will be set private
    • [ ] Always private if no date: Checkbox option, if checked all objects without a valid date will also be set private
    • Years: The number of years back from today which should be considered as private

Once you have made your choices, you can either choose Close or Execute to apply the change.

Version 1.0.9

Posted 6 July 2021 and only available through the Pull Request system on GitHub. Currently queued for code review and release via the Plugin Manager.

Gnome-important.png
Ambiguity is subject to penalties with automated mass updates

This tool is selective but not intelligent. It does exactly what it is told to do... even when that is a really bad choice.
Also it does not use the Probably Alive Proxy calculation. It uses the Birth year when filtering Person records.
So the dates of any other items in the Person's timeline (other Events, defining life events of offspring, siblings, or parents) are not considered. You may want to provide some better direction by using the Calculate Estimated Dates Tool addon to estimate a Birth year.]

Set Privacy Tool - Option dialog

The Option tab is displayed with the following:

  • Years:
    • numeric text box with -+ buttons
      The number of years (counted backwards from today) which should be excluded from being updated.
    • Always private if no date.
      If selected, any objects without a valid date will also be updated.
  • PeoplePerson Filter:
    • Entire Database ▼ (default)
      Pull down menu to select any Person custom filter.
    • Persons
      If selected, only Person objects with a birth date in the given time range (Years) will be updated.
  • Events Event Filter:
    • Entire Database ▼ (default)
      Pull down menu to select any Event custom filter.
    • Events
      If selected, only Event objects within the Years range will be updated.
  • MediaMedia Filter:
    • Entire Database ▼ (default)
      Pull down menu to select any Media custom filter.
    • Media
      If selected, only Media objects within the Years range will be updated.
  • Internet type filter:
    • Entire Database ▼ (default)
      Pull down menu to select a specific Type of Internet record:
      • All (default)
      • Unknown
      • E-Mail
      • Web Home
      • Web Search
      • FTP
    • Internet
      If selected, only Internet records of the selected Type will be updated.
  • Addresses
    • Address
      If selected, any Address records within the Years range will be updated.


Once you have made your choices, you can either choose Close or Execute to apply the change.