Difference between revisions of "Addon:AvatarGenerator"

From Gramps
Jump to: navigation, search
m (Note themed avatar enhancement)
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{Third-party plugin}}
 
{{Third-party plugin}}
[[File:AvatarGeneratorTool-Before-and-After-example.gif|thumb|right|450px|Before and After Example from Avatar Generator Tool]]
+
[[File:AvatarGeneratorTool-Before-and-After-example.gif|thumb|right|450px|Before and After Example from [[Graph View|Graph View addon]] after using Avatar Generator Tool]]
 
+
The {{man label|Avatar Generator Tool}} allows you to add and remove one or several images for a selected set of filtered people.
The '''Avatar Generator Tool''' allows you to add and remove one or several images for a selected set of filtered people.
 
 
{{-}}
 
{{-}}
 
==Usage==
 
==Usage==
Once this plugin has been installed:
+
Once this addon has been installed:
 
* Select Menu {{man menu|Tools > Family Tree Processing -> Avatar Generator Tool...}}
 
* Select Menu {{man menu|Tools > Family Tree Processing -> Avatar Generator Tool...}}
  
Line 14: Line 13:
 
[[File:AvatarGeneratorTool.PNG|thumb|right|450px|Avatar Generator Tool - Options dialogue]]
 
[[File:AvatarGeneratorTool.PNG|thumb|right|450px|Avatar Generator Tool - Options dialogue]]
  
* The '''Options''' tab is displayed with the following:
+
* The {{man label|Options}} tab is displayed with the following:
** Category Filter: '''single image mode''' or '''male/female/unknown'''
+
** {{man label|Category:}} - Filter '''single image mode''' or '''male/female/unknown'''
** Unknown Image Selection: image used for all people with option '''single image mode''' or people with unknown gender with option '''male/female/unknown'''
+
** {{man label|Unknown:}} - Image selection used for all people with option '''single image mode''' or people with unknown gender with option '''male/female/unknown'''
** Male Image Selection: image for males (only used with option '''male/female/unknown''')
+
** {{man label|Male:}} - Image selection for males (only used with option '''male/female/unknown''')
** Female Image Selection: image for females (only used with option '''male/female/unknown''')
+
** {{man label|Female:}} - Image selection for females (only used with option '''male/female/unknown''')
** Person Filter: '''Entire Database'''(default)
+
** {{man label|Person Filter:}} - '''Entire Database'''(default)
** Filter Person: defaults to the Active Person.
+
** {{man label|Center Person:}} defaults to the Active Person.
** Remove images from people: False (default)
+
*** {{man label|[ ] Remove images from people:}} False (default) checkbox.
  
 
Once you have made your choices the image or images that should be attached as avatar images, you can either choose {{man button|Close}} or {{man button|Execute}} to apply the change.
 
Once you have made your choices the image or images that should be attached as avatar images, you can either choose {{man button|Close}} or {{man button|Execute}} to apply the change.
Line 30: Line 29:
  
 
Furthermore, it is possible to remove images from a group of filtered persons. In order to do so, the Avatar Generator Tool searches through the selected list of filtered people and removes the chosen image or images.
 
Furthermore, it is possible to remove images from a group of filtered persons. In order to do so, the Avatar Generator Tool searches through the selected list of filtered people and removes the chosen image or images.
 
+
==See also==
 +
* [https://github.com/gramps-project/addons-source/pull/459 &#91;GraphView&#93; add custom avatars #459]<br />[https://gramps.discourse.group/t/customizable-avatars-for-graphview/696 Themed avatar discussion]
 
[[Category:Plugins]]
 
[[Category:Plugins]]
 
[[Category:Developers/General]]
 
[[Category:Developers/General]]
 
[[Category:Tools]]
 
[[Category:Tools]]
 +
[[Category:Media]]

Revision as of 13:13, 5 April 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.

Before and After Example from Graph View addon after using Avatar Generator Tool

The Avatar Generator Tool allows you to add and remove one or several images for a selected set of filtered people.

Usage

Once this addon has been installed:

  • Select Menu Tools > Family Tree Processing -> Avatar Generator 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.
Avatar Generator Tool - Options dialogue
  • The Options tab is displayed with the following:
    • Category: - Filter single image mode or male/female/unknown
    • Unknown: - Image selection used for all people with option single image mode or people with unknown gender with option male/female/unknown
    • Male: - Image selection for males (only used with option male/female/unknown)
    • Female: - Image selection for females (only used with option male/female/unknown)
    • Person Filter: - Entire Database(default)
    • Center Person: defaults to the Active Person.
      • [ ] Remove images from people: False (default) checkbox.

Once you have made your choices the image or images that should be attached as avatar images, you can either choose Close or Execute to apply the change.

Tips

Predefined person filters like 'whole database' or 'ancestors of person X' as well as custom person filters like 'persons with tag Y' are used for filtering. By filtering different person groups or ancestor lines via person filters, it is possible to add different images to different lines of your ancestor tree. Please note that the Avatar Generator Tool only adds images to persons without media references within a selected group of people. Persons who already have media references are ignored.

Furthermore, it is possible to remove images from a group of filtered persons. In order to do so, the Avatar Generator Tool searches through the selected list of filtered people and removes the chosen image or images.

See also