6.0 Builtins

This page list built-in plug-ins Third-party Addons written by users and developers to work only with Gramps version 5.2. Please use carefully on data that is backed up. Help make these Third-party Addons better by reporting any comments or problems to the author, or issues and Feature requests to the bug tracker Unless otherwise stated on this page, you can download these plugin by following these instructions Please note that some Addons have prerequisites that need to be installed before they can be used. These Third-party Addons unless stated are not officially part of Gramps. This Addon/Plugin system is controlled by the Plugin Manager.

Gramps comes with a core set of plugins which provide all of the critical features.

However, you can extend this functionality with additional Third-party Addons. These addons provide reports, filters, View modes, Gramplets, and more.

From Gramps [[Gramps_Template:Version manual_Wiki_Manual_-_Settings#General|Preferences]], you can check for available extra (or updated) addons and select which to download. Then, they will be retrieved from the internet from the Gramps-Project file server and installed locally on your computer.

Once installed, an addon is found in the same place as a built-in feature of the same Type. That is, Tool addons become new menu items on the Tools menu... while addon Gramplets become new choices in the appropriate Category View sidebar, bottombar or Dashboard options.

Installed addons can be enabled or disabled via the [[Gramps_Template:Version manual_Wiki_Manual_-_Plugin_Manager|Plugin Manager]].

Can not find it? The Plugin Manager and Preferences are good places to search when a feature is being elusive. Addons are not typically cross-referenced in the wiki and might not be where you would expect in the interface. What you recalled as a Report might actually be a Quick View... and those are found in entirely different menus. Or you might have installed an Addon for a different machine or in another version of Gramps. So looking through the addons available for download and among those installed can help you rediscover the feature.

Installing Addons in Gramps

This article's content is incomplete or a placeholder stub. Please update or expand this section.

Highlighted section showing recommended settings for Addons to be managed Automatically

You can have Gramps manage the process of checking and downloading Addon updates by changing your settings to match the highlighted section in the screenshot to the right or read the following.

To configure Gramps for Addons:

1. Start Gramps
2. Select Menu Edit -> Preferences...
3. Go to the General tab
4. In the Third party addons management section:
5. Change Check for addon updates: so when you start Gramps, it checks for updated Addons:
   1. Never - never checks for updates when you start Gramps (This is the default setting)
   2. Once a month - checks for updates when you start Gramps once a month
   3. Once a week - checks for updates when you start Gramps once a week (This is the recommended setting)
   4. Once a day - checks for updates when you start Gramps once a day
   5. Always - checks for updates whenever you start Gramps
6. Change What to check so when you check for updates, it checks for:
   1. Updated addons only - does not check for new addons
   2. New addons only - does not check for updated addons (This is the default setting)
   3. New and updated addons - checks for all new and updated addons (This is the recommended setting)
7. Verify that the Where to check has the correct URL. To locate the list of addons for your current language and version, it should be set to:
   https://raw.githubusercontent.com/gramps-project/addons/master/gramps60
8. Change the Do not ask about previously notified addons check box:
   1. Checked: Means that new/updated addons are only asked about once; afterwards it doesn't show them to you (This is the default setting)
   2. Unchecked: Means that new/updated addons are always shown to you (This is the recommended setting)
9. Assuming you have an Internet connection. You can now optionally select the Check for updated addons now button to force a check for Addons using the updated settings.
10. From the Available Gramps Updates for Addons window you will be shown a list broken down by Type that you can view by selecting the "Select" column expand out each "Type".
11. You can then select the check box of those Addons you want to install.
12. Then select the Install Selected Addons button to download those Addons from the Internet.
13. Once downloaded from the Done downloading and installing addons dialog select the Close button
14. From the Preferences dialog select Close button.
15. To use the Addons you need to Family Trees>Quit and restart Gramps.

"Available Gramps Updates for Addons" window showing example listing output for Gramps 5.1

Addon List

Addons are listed inside of Gramps through the interface described above. The Plug-in Manager list includes the built-in Gramplets as well as any downloaded third party addons... such as those in the following list.

See Addon list legend for details of on each columns.

Template:Builins5.2

Manually installed Addons

A few addons have to be installed manually (or are scripts and need to be installed as described in the documentation).

Addons in the exploratory stages tend to be initially posted to the GitHub Gramps-Project repositories and have to be manually installed. Be certain to backup your Tree before installing anything. There is a potential for data loss with such preliminary versions.

1. Click on a download link from the list of Addons below.
2. Open the compressed file ( *.ZIP ; *.gz ; *.tgz / etc ...using 7-zip ) and save the contents to your Gramps User Directory, in the gramps52/plugins folder
3. After manually installing any addons, you need to restart Gramps

Addon/Plugin Errors From the Help > Plugin Manager you can see which addons/plugins failed to load by viewing the Status column, and then double clicking on such an entry shows you the error. You can email this error to the plugin contact.

Plugin / Documentation	Type	Image	Description	Use	Rating (out of 4)	Contact	Download
InformationGraph	Report	N/A	Generate detailed GraphViz graphs by spidering over the database. The InformationGraph plugin only works with Gramps 3.2 For a similar report see the: Addon:PersonEverything Report	All	1	Bob Ham	GVInformationGraph.py
Handle.bash	External utility		A bash script which makes it possible to work with multiple databases merging select branches at will without collisions.	All	3	User:Lcc (e-mail)	Handle.bash.tar.gz
Isotammi addons	Isotammi project addons		Gramplets: Isotammi configuration Dates Position tool Rules: Events with an invalid date Events with a valid date Tool: Generate source references based on more information	All	?	http://wiki.isotammi.net/wiki/Gramps-laajennukset	https://github.com/Taapeli/isotammi-addons

Addons for other versions of Gramps

Addons for other versions of Gramps can be found on the following pages

• 5.1 Addons
• 5.0 Addons
• 4.2 Addons
• 4.1 Addons
• 4.0 Addons
• 3.4 Addons
• 3.3 Addons
• 3.2 Addons
• 3.1 Addons
• 3.0 Addons
• 2.2 Addons

See also

• Gramps 6.0 Wiki Manual - Command Line
  • Plugins Command Line (Needs to be incorporated into user manual)
• Built-in Gramplets - Gramplets
• Rule expansions (3rd party addons to supplement built-in rules)
• Inspect the current updates /listings/addons-en.txt file in the Where to check: https://raw.githubusercontent.com/gramps-project/addons/master/gramps52 URL in the Third party addons management in the General tab of the Edit ➡ Preferences
• Discourse forum thread discussing how the addons.txt entries are generated
• The Isotammi project addons list.

Writing an Addon/Plugin

• Addons development
• Writing a plugin for general information on developing addons
• Report-writing tutorial