|
This page list Third-party Addons written by users and developers to work only with Gramps version 5.1. Please use carefully on data that is backed up. |
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, listings, views, gramplets, and more.
From Gramps 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 add-ons 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 add-ons can be enabled or disabled via the Plugin Manager.
|
Can't find it? The Plug-in Manager and Preferences are good places to search when a feature is being elusive. Add-ons 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 add-ons available for download and among those installed can help you rediscover the feature. |
Contents
Installing Addons in Gramps
You can have Gramps manage the process of checking and downloading Addon updates.
To configure Gramps for Addons:
- Start Gramps
- Select Menu Edit -> Preferences...
- Go to the General tab
- In the Third party addons management section:
- Change 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 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)
- Change the Do not ask about previously notified addons check box:
- Check it so that new/updated addons are only asked about once; afterwards it doesn't show them to you (This is the recommended setting)
- Uncheck it so that new/updated addons are always shown to you (This is the default setting)
- 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.
- 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".
- You can then select the check box of those Addons you want to install.
- Then select the Install Selected Addons button to download those Addons from the Internet.
- Once downloaded from the Done downloading and installing addons dialog select the Close button
- From the Preferences dialog select Close button.
- To use the Addons you need to Family Trees>Quit and restart Gramps.
Addon List
Addons are listed inside of Gramps through the interface described above.
|
|
for details of on each columns. |
| Plugin / Documentation | Type | Image | Description | Use | Rating (out of 4) | Contact | Download |
|---|---|---|---|---|---|---|---|
| All Names of All People - Quickview | Quickview |  |
Shows all names for all people | All | 4 | Doug Blank | AllNamesQuickview.addon.tgz |
| Attach Source Tool | Tool |  |
A tool to attach a source to a group of people. | All | 1 | Doug Blank | AttachSourceTool.addon.tgz |
| Avatar Generator | Tool |  |
A tool that allows you to add and remove one or several images for a selected set of filtered people. | All | 4 | Matthias Kemmer | AvatarGenerator.addon.tgz |
| Media Report | Report |  |
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. | All | 4 | Matthias Kemmer | MediaReport.addon.tgz |
| Set Privacy Tool | Tool |  |
The Set Privacy Tool allows you to manage privacy status of people, events and media | All | 4 | Matthias Kemmer | SetPrivacyTool.addon.tgz |
| Birthdays Gramplet | Gramplet | 
|
Display the upcoming birthdays | All | 1 | Peter Potrowl | BirthdaysGramplet.addon.tgz |
| Birth Order Tool | Tool | 
|
Sort children in families in their birth order | All | 3 | Paul Culley | BirthOrder.addon.tgz |
| Cairo Clock Gramplet | Gramplet |  |
A sample Cairo clock gramplet. | Developer | 1 | Doug Blank | ClockGramplet.addon.tgz |
| Calculate Estimated Dates | Tool |  |
A tool to set estimated birth and death dates. | All | 2 | Doug Blank | CalculateEstimatedDates.addon.tgz |
| Collections Clipboard Gramplet | Gramplet |  |
Allows one to group items together for quick access. | All | 2 | Doug Blank | ClipboardGramplet.addon.tgz |
| Command Line Merge | Tool | N/A | 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 here) | Developer | 3 | Gramps Bugtracker Michiel D. Nauta |
CliMerge.addon.tgz |
| D3 Ancestral/Descendant Charts | Web Report | 
|
Create ancestral/descendant web based interactive D3 charts. | All | 3 | Matt Keenan | D3Charts.addon.tgz |
| Database Differences Report | Report | 
|
Allows a mostly complete comparison between the current database and a Gramps XML file | All | 2 | Gramps Bugtracker | Differences.addon.tgz |
| Data Entry Gramplet | Gramplet |  |
Quick Data Entry for People data | Expert user | 4 | Gramps Bugtracker | DataEntryGramplet.addon.tgz |
| Date Calculator Gramplet | Gramplet |  |
Allows you to do date math. | Normal user | 3 | Gramps Bugtracker | DateCalculator.addon.tgz |
| Deep Connections Gramplet | Gramplet |  |
Finds deep relationships between home and active people | All | 3 | Gramps Bugtracker | DeepConnectionsGramplet.addon.tgz |
| Denomino Viso | Web report |  |
Creates interactive graphical ancestor/descendant tree on a webpage. | All | 3 | Gramps Bugtracker Michiel Nauta |
DenominoViso.addon.tgz |
| Descendant and Detailed Descendant Book Reports | Report | 
|
Create a book of descendant or detailed descendant reports using a filter. | All | 4 | Matt Keenan Giansalvo Gusinu |
DescendantBooks.addon.tgz |
| Descendant Count Gramplet | Gramplet and Quickview |  |
Gives a count of descendants for each person | All | 4 | Doug Blank | DescendantCount.addon.tgz |
| Descendants Lines | Report | 
|
Generates a graphical descendants tree using orthogonal edges and routing ("square edges"). | Developer Expert user Intermediate user |
3 | Gramps Bugtracker User:Lcc Adam Sampson |
DescendantsLines.addon.tgz |
| Download Media | Tool |  |
Download media from web pages | All | 1 | Gramps Bugtracker | DownloadMedia.addon.tgz |
| DynamicWeb report | Report | 
|
Exports the Family Tree as Web pages that are generated dynamically by client-side Javascript (no server required). | All | 3 | Gramps Bugtracker Pierre Bélissent |
DynamicWeb.addon.tgz |
| ExportRaw | Exporter |  |
A Gramps exporter that will dump your BSDDB database into a flat text version (.raw) of the Python objects. | Developer | 4 | Doug Blank | ExportRaw.addon.tgz |
| Extract Place Data from a Place Title | Tool |  |
Attempts to extract city and state/province from a place title | All | 3 | Gramps Bugtracker | ExtractCity.addon.tgz |
| Family Sheet | Report |  |
Generates a form with all information about a person, its spouses and its children. (Requires: PIL (Python Imaging Library).) | All | 4 | Gramps Bugtracker Reinhard Müller |
FamilySheet.addon.tgz |
| Family Tree | Report |  |
Generates a graphical tree of a family with its ancestors and/or descendants. | All | 3 | Gramps Bugtracker Reinhard Müller |
FamilyTree.addon.tgz |
| Fix Capitalization of Given Names | Tool |  |
Fix Capitalization of Given Names | All | 2 | Donald N. Allingham Doug Blank |
ChangeGivenNames.addon.tgz |
| Form Addons | Gramplet | 
|
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. | All | 1 | Nick Hall | Form.addon.tgz |
| GEDCOM Extensions | Exporter |  |
Collection of unofficial GEDCOM extensions which extend Gramps GedcomWriter to include common non-compliant GEDCOM additions.. | Expert user | 2 | Gramps Bugtracker Doug Blank |
GedcomExtensions.addon.tgz |
| GenealogyTree | Report | 
|
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 | Developer Expert user Intermediate user |
3 | Gramps Bugtracker Nick Hall |
GenealogyTree.addon.tgz |
| GetGOV | Gramplet |  |
Download places from the GOV genealogical gazetteer. | Expert user | 2 | Gary Griffin | GetGOV.addon.tgz |
| Google Earth | Mapservice |  |
Show places with GoogleEarth.. | All | 3 | Peter Landgren | GoogleEarthWriteKML.addon.tgz |
| Gramps SQLite Export Import | Exporter/Importer |  |
A Gramps exporter and importer that will export/import your Family Tree as a fully-relational SQLite database. | Expert users | 3 | Doug Blank | Sqlite.addon.tgz |
| Graph View | View |  |
A view that can display the active persons ancestor tree and descendant tree. Requires PyGoocanvas and Goocanvas. | Expert users | 3 | Gramps Bugtracker Gary Burton |
GraphView.addon.tgz |
| 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 |
| Headline News Gramplet | Gramplet |  |
Shows Gramps breaking news, once per hour | All | 4 | Gramps Bugtracker | HeadlineNewsGramplet.addon.tgz |
| Htree Pedigree View | View |  |
The H-tree based layout can be used to display ancestral trees. | All | 3 | Gramps Bugtracker | HtreePedigreeView.addon.tgz |
| Html View | HtmlView |  |
A view showing html pages embedded in Gramps | All | 3 | Gramps Bugtracker | HtmlView.addon.tgz |
| Import Text Gramplet | Gramplet |  |
Interface to import text directly in the following formats: CSV (spreadsheet input), Gramps XML, VCard. | Developers | 2 | Doug Blank | ImportGramplet.addon.tgz |
| Import Merge Tool | Tool |  |
Compares a Gramps XML database with the current one, and allows merging of the differences. | All | ? | Paul Culley | ImportMerge.addon.tgz |
| Information Graph | Report | N/A | Generate detailed GraphViz graphs by spidering over the database. | All | 0 | Bob Ham | GVInformationGraph.py |
| Last Change | Gramplet and Report |  |
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. | All | 1 | Jakim Friant | LastChange.addon.tgz |
| libaccess | Library | N/A | An experimental gen.lib interface. | Developer | 1 | Doug Blank | libaccess.addon.tgz |
| Lines of Descendency Report | Report |  |
Prints out all descendency lines from a given ancestor to a given descendant in text. | All | 2.5 | User:Lcc (e-mail) | LinesOfDescendency.addon.tgz |
| Merge Media | Tool |  |
Searches for Media entries that point to the same media file and merges them together. | All | 4 | Paul Culley | MediaMerge.addon.tgz |
| Media Verify Tool | Tool |  |
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. | All | 4 | Gramps Bugtracker | MediaVerify.addon.tgz |
| MongoDB | Database | N/A | MongoDB database backend support. | Developer | 2 | Gramps Bugtracker | MongoDB.addon.tgz |
| Network Chart | Website |  |
Generate a single graph showing connectivity between individuals | Expert user | 3 | Mark B. | NetworkChart.addon.tgz |
| Note Gramplet | Gramplet |  |
A data entry gramplet for notes. | All | 3 | Doug Blank | NoteGramplet.addon.tgz |
| Note Cleanup Tool | Tool |  |
A tool to clean up html and convert to Styled Text in notes. Also converts Web links to Styled text. | All | 3 | Paul Culley | NoteCleanup.addon.tgz |
| Number Of Descendants Quickview | Quickview |  |
Shows the number of descendants of the current active person | All | 4 | Gramps Bugtracker Reinhard Müller |
NumberOfDescendantsQuickview.addon.tgz |
| Pedigree Chart | Report |  |
A version of the classic pedigree chart that is suitable for printing. (Can optionally use - numpy if installed) | All | 1 | Jakim Friant | PedigreeChart.addon.tgz |
| Person Everything Report | Report |  |
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. | All | 4 | Gramps Bugtracker | PersonEverything.addon.tgz |
| Photo Tagging Gramplet | Gramplet |  |
Enables tagging people in photographs, i.e. associating regions of images with Gramps persons. (Requires: OpenCV(for automatic face detection)& Numpy ) | All | 4 | Gramps Bugtracker | PhotoTaggingGramplet.addon.tgz |
| Place Cleanup Gramplet | Gramplet |  |
Place Cleanup Gramplet assists in merging places, as well as completing places from the GeoNames web database. | All | 3 | Paul Culley | PlaceCleanup.addon.tgz |
| Place completion tool | Tool |  |
A tool to fill in places. | All | 3 | Gramps Bugtracker | PlaceCompletion.addon.tgz |
| PostgreSQL | Database | N/A | PostgreSQL database backend support. | Expert User | 2 | Gramps Bugtracker | PostgreSQL.addon.tgz |
| Prerequisites Checker Gramplet | Gramplet | 
|
Diagnostic tool to help work out if users have the required prerequisites installed as well as the latest version of Gramps. | Expert user | 1 | Gramps Bugtracker | PrerequisitesCheckerGramplet.addon.tgz |
| Python Shell Gramplet | Gramplet |  |
Interactive Python Shell | Developer | 4 | Gramps Bugtracker | PythonGramplet.addon.tgz |
| Plugin Manager Plugin | Plugin lib and Gramplet |  |
A Plugin manager with additional capabilities | All | 4 | Paul Culley | PluginManager.addon.tgz |
| Query Gramplet | Gramplet and Report |  |
A SQL-like query system. | All | 1 | Doug Blank | Query.addon.tgz |
| Quilt Chart | View |  |
A view that presents your family tree in the form of a grid. | Expert users | 3 | Gramps Bugtracker Serge Noiraud, Nick Hall |
QuiltView.addon.tgz |
| Related Relatives Gramplet | Gramplet | 
|
Display all persons in the database with a relation to a relative. | All | 1 | Heinz Brinker | RelatedRelativesGramplet.addon.tgz |
| Remove Tag Tool | Tool |  |
The Remove Tag Tool allows you to remove one tag from a selected set of filtered objects e.g. people. | All | 4 | Matthias Kemmer | RemoveTagTool.addon.tgz |
| Repositories Report | Report |  |
All | 3 | Gramps Bugtracker Jérôme Rapinat |
RepositoriesReport.addon.tgz | |
| Set Attribute Tool | Tool |  |
A tool for setting attributes and their values on people. | All | 2 | Doug Blank | SetAttributeTool.addon.tgz |
| Themes | Settings |  |
An addition to Preferences for simple Theme and Font adjustment. Especially useful for Windows users. | All | 3 | Paul Culley | Themes.addon.tgz |
| This Day In Family History | Gramplet | 
|
Display the upcoming a concise report of the user defined list of events that happened on this day and month. | All | 1 | Stephen Adams | ThisDayInFamilyHistory.addon.tgz |
| Thumbnail Generator | Tool | N/A | Generates thumbnails for media files. | All | 3 | Nick Hall | ThumbnailGenerator.addon.tgz |
| Types Cleanup Tool | Tool |  |
A tool to Remove unneeded custom Types. | All | ? | Paul Culley | TypeCleanup.addon.tgz |
| Timeline Quickview | Quickview |  |
Shows timeline of events in immediate family members' lives | All | 4 | Doug Blank | TimelineQuickview.addon.tgz |
| Timeline Pedigree View | View |  |
Pedigree showing timeline and relationships. | All | 3 | Doug Blank | TimelinePedigreeView.addon.tgz |
| ToDo Report | Report |  |
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. | All | 1 | Jakim Friant | ToDoReport.addon.tgz |
| Web Connect Pack | Library |  |
Collection of Web sites for various countries (DE/FR/UK/US) Only install the country you need. (* Requires libwebconnect) | All | 4 | Gramps Bugtracker | libwebconnect.addon.tgz DEWebConnectPack.addon.tgz FRWebConnectPack.addon.tgz UKWebConnectPack.addon.tgz USWebConnectPack.addon.tgz |
Manually installed Addons
A few addons have to be installed manually (or are scripts and need to be installed as described in the documentation).
- Click on a download link from the list of Addons below.
- Open the .ZIP or .gz file and save the contents to your Gramps User Directory, in the
gramps51/pluginsfolder - For all 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. | 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 |
Plugins for other versions of Gramps
Plugins for other versions of Gramps can be found on the following pages
Writing a Plugin
- See Writing a Plugin for information on developing your own addon.
See also
- Plugins Command Line
- Addons Status - General issues and compatibility status of above addons.