{{man note|This page list [[Third-party Addons|Third-party Addons]] written by users and developers to work only with Gramps version 5.1.|Please use carefully on data that is [[How_to_make_a_backup|backed up.]]<br />Help make these Third-party Addons better by reporting any comments or problems to the author, or issues and Feature requests to the [[Using_the_bug_tracker|bug tracker]]<br>Unless otherwise stated on this page, you can download these plugin by following {{man tooltip|[[5.1_Addons#Installing_Addons_in_Gramps|these instructions]]}}<br>{{man menu|Please note that some Addons have prerequisites that need to be installed before they can be used.}}<br />These Third-party Addons unless stated are not officially part of Gramps.<br>This Addon/Plugin system is controlled by the [[Gramps_5.1_Wiki_Manual_-_Plugin_Manager|'''Plugin Manager''']].}}
Gramps comes with a [[Gramps_{{man version}}_Wiki_Manual_-_Gramplets|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, [[Gramps_Glossary#viewmode|View modes]], Gramplets, and more.
From Gramps [[Gramps_{{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 [[Plugin_list_legend#Type|Type]]. That is, Tool addons become new menu items on the Tools menu... while add-on Gramplets become new choices in the appropriate Category View sidebar, bottombar or Dashboard options.
Installed addons can be enabled or disabled via the [[Gramps_{{Version manual}}_Wiki_Manual_-_Plugin_Manager|Plugin Manager]].
{{Man tip|Can't find it?|The Plugin Manager and Preferences are good places to search when a feature is being elusive.
Addons aren't typically cross-referenced in the wiki and might not be where you'd 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've 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 =
[[File:EditPreferences-General-tab-recomeded-settings-for-addons-51.png|Right|thumb|550px|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:
# Start Gramps
# Select Menu {{man menu|Edit -> Preferences...}}
# Go to the {{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#General|General]]}} tab
# In the '''Third party addons management''' section:
# Change {{man label|Check for addon updates:}} so when you start Gramps, it checks for updated Addons:
## ''Never'' - never checks for updates when you start Gramps (''This is the default setting'')
## ''Once a month'' - checks for updates when you start Gramps once a month
## '''Once a week''' - checks for updates when you start Gramps once a week ('''This is the recommended setting''')
## ''Once a day'' - checks for updates when you start Gramps once a day
## ''Always'' - checks for updates whenever you start Gramps
# Change {{man label|What to check}} so when you check for updates, it checks for:
## ''Updated addons only'' - does not check for new addons
## ''New addons only'' - does not check for updated addons (''This is the default setting'')
## '''New and updated addons''' - checks for all new and updated addons ('''This is the recommended setting''')
# Verify that the {{man label|Where to check}} has the correct URL. To locate the [https://raw.githubusercontent.com/gramps-project/addons/master/gramps{{Stable branch}}/listings/addons-en.txt list of add-ons] for your current language and version, it should be set to:<br /><code>https://raw.githubusercontent.com/gramps-project/addons/master/gramps{{Stable branch}}</code>
# Change the {{man label|Do not ask about previously notified addons}} check box:
## {{checkbox|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'')
## {{checkbox|0}} Unchecked: Means that new/updated addons are always shown to you ('''This is the recommended setting''')
# Assuming you have an '''Internet''' connection. You can now optionally select the {{man button|Check for updated addons now}} button to force a check for Addons using the updated settings.
# From the {{man label|[[Gramps_5.1_Wiki_Manual_-_Settings#Available_Gramps_Updates_for_Addons|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".
# You can then select the check box of those Addons you want to install.
# Then select the {{man button|Install Selected Addons}} button to download those Addons from the ''Internet''.
# Once downloaded from the {{man label|Done downloading and installing addons}} dialog select the {{man button|Close}} button
# From the {{man label|Preferences}} dialog select {{man button|Close}} button.
# To use the Addons you need to {{man menu|Family Trees>Quit}} and restart Gramps.
[[File:AvailableGrampsUpdatesforAddons-example-listing-51.png|center|thumb|850px|"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 [[Gramps_{{man version}}_Wiki_Manual_-_Gramplets#Built-in_Gramplet_List|built-in Gramplets]] as well as any downloaded 3rd party add-ons... such as those in the following list.
{{man tip|''See [[Plugin list legend]]|for details of on each columns.''}}
{| class="wikitable sortable"
|-
! Plugin / Documentation
! Type
! Image
! Description
! Use
! Rating (out of 4)
! Contact
! Download
|-
|<!-- Plugin / Documentation -->[[Addon:All Names Quickview|All Names of All People]]
|<!-- Description -->A quickview similar to the [[Gramps_5.1_Wiki_Manual_-_Reports_-_part_6#Number_of_Ancestors_Report|Number of Ancestors text report]].
|<!-- Description -->A text report for images, which allows custom headings and custom notes as well as image data like notes, citations, tags, attributes and people references.
|<!-- Description -->A Relationships category [[Gramps_Glossary#viewmode|View Mode]] showing relationships and events for a person. Like the built-in [[Gramps_5.1_Wiki_Manual_-_Categories#Relationships_Category|Relationships View]] but on steroids.
|<!-- Use -->All
|<!-- Rating (out of 4) -->1
|<!-- Contact -->[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]<br>Nick Hall
|<!-- Plugin / Documentation -->Command Line Merge
|<!-- Type -->Tool
|<!-- Image -->N/A
|<!-- Description -->Merge primary object via the command line. (Note: Used by Gramps project to test its code you can see an example of how it used programmatically [https://github.com/gramps-project/gramps/blob/master/gramps/gen/merge/test/merge_ref_test.py here])
|<!-- Use -->Developer
|<!-- Rating (out of 4) -->3
|<!-- Contact -->[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]<br>Michiel D. Nauta
|<!-- Description -->Forms gramplet that allows users to create and edit structured source data in a single form, such as birth, marriage and death certificates and parish register entries.
|<!-- Description -->Uses LaTeX genealogytree (the Pedigree and genealogical tree diagrams package) to create professional looking trees for the active person. Four report are available. '''Requires: texlive/texlive-pictures and texlive-fontsextra'''
|<!-- Use -->Developer<br />Expert user<br />Intermediate user
|<!-- Rating (out of 4) -->3
|<!-- Contact -->[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]<br>Nick Hall
|<!-- Description -->A tool that allows you to import Geneanet ascendants and descendants of a selected person into Gramps. Requires both the <code>Request</code> and <code>lxml</code> prerequisites to work.
|<!-- Description -->A Graph category [[Gramps_Glossary#viewmode|View Mode]] that can display the active persons ancestor tree and descendant tree. '''Requires PyGoocanvas and Goocanvas.'''
|<!-- Use -->All
|<!-- Rating (out of 4) -->3
|<!-- Contact -->[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]<br>[mailto:[email protected] Gary Burton]
|<!-- Description -->Opens an interactive tree in the browser. This tool uses the [https://pewu.github.io/topola-viewer/ Topola Genealogy Viewer] to display the family tree.
|<!-- Description -->A gramplet and report to display the last ten records changed in the open family tree. The gramplet only displays persons, while the report can display changed families, places, and events too.
|<!-- Plugin / Documentation -->[[Libaccess|Generic DB Access lib]]
|<!-- Type -->Library
|<!-- Image -->[[File:Libaccess.jpg|right|150px]]
|<!-- Description -->The Generic DB Access lib (AKA libaccess) is an experimental library that provides generic access to the database and the gen.lib interface.
|<!-- Description -->A Graph category [[Gramps_Glossary#viewmode|View Mode]] which shows individuals as lines in an ancestor or descendant chart along a time span.
|<!-- Description -->Verify a one-to-one relationship between media objects and files in the media directory. The main purpose of the tool is to locate files that have been moved and fix the paths.
|<!-- Description -->Show absolutely everything about one person, including all events, notes, citations, sources, attributes, media and the family information about the families they are involved in.
|<!-- Description -->Enables tagging people in photographs, i.e. associating regions of images with Gramps persons. (Requires: OpenCV(for automatic face detection)& Numpy )
|<!-- Description -->Gramplet simplifies setting the coordinates of a place and also provides an additional Geography category [[Gramps_Glossary#viewmode|View Mode]] .
|<!-- Description -->Provides a compact way of describing the main surnames found in a family genealogy, which can be read by humans and matched by computers using a Tafel Matching System.
|<!-- Description -->A set of Text reports to list repositories and their related sources information, useful when going to a repository (like an archive).
|<!-- Description -->Tag notes as ToDo (or anything else) and you can generate a report with the notes and the records they are attached to. Another way of maintaining a to-do list within Gramps.
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 [https://github.com/gramps-project?tab=repositories 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.
# Click on a download link from the list of Addons below.
# Open the compressed file ( *.ZIP ; *.gz ; *.tgz / etc ...using [https://www.7-zip.org/ 7-zip] ) and save the contents to your [[Gramps_5.1_Wiki_Manual_-_User_Directory|Gramps User Directory]], in the <code>gramps51/plugins</code> folder
# After manually installing any addons, you need to restart Gramps
{{man note|Addon/Plugin Errors|From the {{man menu|Help > [[Gramps_5.1_Wiki_Manual_-_Plugin_Manager|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.}}