4,191
edits
Changes
no edit summary
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, listingsfilters, views, grampletsGramplets, 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 add-ons 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 add-ons addons can be enabled or disabled via the [[Gramps_{{Version manual}}_Wiki_Manual_-_Plugin_Manager|Plugin Manager]].
{{Man tip|Can't find it?|The Plug-in Plugin Manager and Preferences are good places to search when a feature is being elusive.
''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 addons available for download and among those installed can help you rediscover the feature.}}
= Installing Addons in Gramps =
[[File:EditPreferences-General-tab-examplerecomeded-settings-for-addons-51.png|Right|thumb|550px|General PreferencesHighlighted section showing recommended settings for Addons to be managed Automatically]]You can have Gramps manage the process of checking and downloading Addon updatesby changing your settings to match the highlighted section in the screenshot to the right or read the following.
To configure Gramps for Addons:
# 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''')
## '''New and updated addons''' - checks for all new and updated addons ('''This is the recommended setting''')
# Change the {{man label|Do not ask about previously notified addons}} check box:
## {{checkbox|1}} Check it so Checked: Means that new/updated addons are only asked about once; afterwards it doesn't show them to you ('''This is the recommended default setting''')## {{checkbox|0}} Uncheck it so Unchecked: Means that new/updated addons are always shown to you ('''This is the default 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".
# To use the Addons you need to {{man menu|Family Trees>Quit}} and restart Gramps.
[[File:AvailableGrampsUpdatesforAddons-example-listing-5051.png|Rightcenter|thumb|550px850px|"Available Gramps Updates for Addons" window showing example listing output for Gramps 5.01]]
{{-}}
|<!-- Use -->All
|<!-- Rating (out of 4) -->1
|<!-- Contact -->[httphttps://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]<br>Serge Noiraud
|<!-- Download -->[https://github.com/gramps-project/addons/blob/master/gramps51/download/GeoAncestor.addon.tgz?raw=true GeoAncestor.addon.tgz]
|-
|<!-- Download -->[https://github.com/gramps-project/addons/blob/master/gramps51/download/AttachSourceTool.addon.tgz?raw=true AttachSourceTool.addon.tgz]
|-
|<!-- Plugin / Documentation -->[[Addon:AvatarGenerator|Avatar Generator]]
|<!-- Type -->Tool
|<!-- Image -->[[File:AvatarGeneratorTool-Before-and-After-example.gif|right|150px]]
|<!-- Contact -->[mailto:[email protected] Matthias Kemmer]
|<!-- Download -->[https://github.com/gramps-project/addons/blob/master/gramps51/download/AvatarGenerator.addon.tgz?raw=true AvatarGenerator.addon.tgz]
|-
|<!-- Plugin / Documentation -->[[Addon:EventDescriptionEditor|Event Description Editor]]
|<!-- Type -->Tool
|<!-- Image -->[[File:EventDescriptionEditor-defaults-51.png|right|150px]]
|<!-- Description -->A tool that allows you to find and replace a text string in the event description of multiple events.
|<!-- Use -->All
|<!-- Rating (out of 4) -->4
|<!-- Contact -->[mailto:[email protected] Matthias Kemmer]
|<!-- Download -->[https://github.com/gramps-project/addons/blob/master/gramps51/download/EventDescriptionEditor.addon.tgz?raw=true EventDescriptionEditor.addon.tgz]
|-
|<!-- Plugin / Documentation -->Number of Ancestors
|<!-- Type -->Quickview
|<!-- Image -->[[File:NumberOfAncestors-QuickView-example-51.png|right|150px]]
|<!-- Description -->A quickview similar to the [[Gramps_5.1_Wiki_Manual_-_Reports_-_part_6#Number_of_Ancestors_Report|Number of Ancestors text report]].
|<!-- Use -->All
|<!-- Rating (out of 4) -->4
|<!-- Contact -->[mailto:[email protected] Matthias Kemmer]
|<!-- Download -->[https://github.com/gramps-project/addons/blob/master/gramps51/download/NumberOfAncestorsQuickview.addon.tgz?raw=true NumberOfAncestorsQuickview.addon.tgz]
|-
|<!-- Plugin / Documentation -->Family Relationship
|<!-- Type -->Tool
|<!-- Image -->N/A
|<!-- Description -->A tool that allows editing family relationships of multiple families.
|<!-- Use -->All
|<!-- Rating (out of 4) -->4
|<!-- Contact -->[mailto:[email protected] Matthias Kemmer]
|<!-- Download -->[https://github.com/gramps-project/addons/blob/master/gramps51/download/FamilyRelationshipTool.addon.tgz?raw=true FamilyRelationshipTool.addon.tgz]
|-
|<!-- Plugin / Documentation -->[[Addon:MediaReport|Media Report]]
|<!-- Contact -->[mailto:[email protected] Paul Culley]
|<!-- Download -->[https://github.com/gramps-project/addons/blob/master/gramps51/download/BirthOrder.addon.tgz?raw=true BirthOrder.addon.tgz]
|-
|<!-- Plugin / Documentation -->[[Addon:MediaBrowserGramplet|Browser Gramplet]]
|<!-- Type -->Gramplet
|<!-- Image -->[[File:MediaBrowserGramplet-detached-example-51.png|150px]]
|<!-- Description -->Display shows details of a person linked media objects.
|<!-- Use -->All
|<!-- Rating (out of 4) -->4
|<!-- Contact -->[https://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]
|<!-- Download -->[https://github.com/gramps-project/addons/blob/master/gramps51/download/MediaBrowser.addon.tgz?raw=true MediaBrowser.addon.tgz]
|-
|<!-- Plugin / Documentation -->[[Gramplets#GUI_Interface|Cairo Clock Gramplet]]
|<!-- Plugin / Documentation -->[[Addon:CombinedView|Combined View]]
|<!-- Type -->View
|<!-- Image --><!--[[File:CombinedView-Relationships-tab-example-51.png|right|150px]]-->|<!-- Description -->A view 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
|<!-- Download -->[https://github.com/gramps-project/addons/blob/master/gramps51/download/CombinedView.addon.tgz?raw=true CombinedView.addon.tgz]
|-
|<!-- Plugin / Documentation -->[[CollectionsClipboardGrampletCollections_Clipboard_Gramplet|Collections Clipboard Gramplet]]
|<!-- Type -->Gramplet
|<!-- Image -->[[File:ClipboardGramplet-Addon-example-50.png|right|150px]]
|<!-- Plugin / Documentation -->[[DescendantsLines|Descendants Lines]]
|<!-- Type -->Report
|<!-- Image -->[[File:JohnShakespeare-DescendantsLinesDescendantsLines_GalileoGenealogy.png|150px]]
|<!-- Description -->Generates a graphical descendants tree using orthogonal edges and routing ("square edges").
|<!-- Use -->Developer<br />Expert user<br />Intermediate userAll
|<!-- Rating (out of 4) -->3
|<!-- Contact -->[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]<br>[[User:Lcc]]<br>Adam Sampson<br>[mailto:[email protected] Giansalvo Gusinu]
|<!-- Download -->[https://github.com/gramps-project/addons/blob/master/gramps51/download/DescendantsLines.addon.tgz?raw=true DescendantsLines.addon.tgz]
|-
|<!-- Description -->Lists the Residents of an Address by Timeline
|<!-- Use -->All
|<!-- Rating (out of 4) --> 4
|<!-- Contact -->[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]
|<!-- Download -->[https://github.com/gramps-project/addons/tree/master/gramps51/download/HouseTimelineGramplet.addon.tgz?raw=true HouseTimelineGramplet.addon.tgz]
|<!-- Type -->HtmlView
|<!-- Image -->[[File:Html View category.png|right|150px|Html View]]
|<!-- Description -->A view showing html pages embedded in Gramps. Requires the <code>gir-webkit</code> prerequisite to work.
|<!-- Use -->All
|<!-- Rating (out of 4) -->3
|<!-- Description -->Compares a Gramps XML database with the current one, and allows merging of the differences.
|<!-- Use -->All
|<!-- Rating (out of 4) -->?4
|<!-- Contact -->[mailto:[email protected] Paul Culley]
|<!-- Download -->[https://github.com/gramps-project/addons/blob/master/gramps51/download/ImportMerge.addon.tgz?raw=true ImportMerge.addon.tgz]
|<!-- Plugin / Documentation -->[[LastChange|Last Change]]
|<!-- Type -->Gramplet and Report
|<!-- Image -->[[File:LatestChangeGrampletLatestChangesGramplet-addon-example-5051.png|right|150px]]
|<!-- 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.
|<!-- Use -->All
|<!-- Download -->[https://github.com/gramps-project/addons/blob/master/gramps51/download/LastChange.addon.tgz?raw=true LastChange.addon.tgz]
|-
|<!-- Plugin / Documentation -->[https://gramps-project.org/blog/2010/01/alternative-interfaces/ libaccess[Libaccess]]
|<!-- Type -->Library
|<!-- Image -->N/A<!--[[File:libaccessLibaccess.jpg|right|150px]]-->|<!-- Description -->An The Generic DB Access lib (AKA libaccess) is an experimental library that provides generic access to the database and the gen.lib interface.
|<!-- Use -->Developer
|<!-- Rating (out of 4) -->1
|<!-- Contact -->[mailto:[email protected] Doug Blank]
|<!-- Download -->[https://github.com/gramps-project/addons/blob/master/gramps51/download/libaccess.addon.tgz?raw=true libaccess.addon.tgz]
|-
|<!-- Plugin / Documentation -->[[Life Line Chart View]]
|<!-- Type -->View
|<!-- Image -->[[File:LifeLineChartViewScreenshot1-51.png|right|150px]]
|<!-- Description -->A view which shows individuals as lines in an ancestor or descendant chart along a time span.
|<!-- Use -->All
|<!-- Rating (out of 4) -->3
|<!-- Contact -->[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]<br>[[User:CWSchulze|CWSchulze]]
|<!-- Download -->
|-
|<!-- Plugin / Documentation -->[[Lines of Descendency Report]]
|<!-- Plugin / Documentation -->[[Media Verify Tool]]
|<!-- Type -->Tool
|<!-- Image -->[[File:MediaVerifyTool-default-51.png|right|150px]]
|<!-- 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.
|<!-- Use -->All
|<!-- Contact -->[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]<br>Reinhard Müller
|<!-- Download -->[https://github.com/gramps-project/addons/blob/master/gramps51/download/NumberOfDescendantsQuickview.addon.tgz?raw=true NumberOfDescendantsQuickview.addon.tgz]
|-
|<!-- Plugin / Documentation -->[[Addon:ParticipantsGramplet|Participants Gramplet]]
|<!-- Type -->Gramplet
|<!-- Image -->[[File:ParticipantsGramplet-detached-example-51.png|150px]]
|<!-- Description -->Display the participants in an event.
|<!-- Use -->All
|<!-- Rating (out of 4) -->4
|<!-- Contact -->[https://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]
|<!-- Download -->[https://github.com/gramps-project/addons/blob/master/gramps51/download/Participants.addon.tgz?raw=true Participants.addon.tgz]
|-
|<!-- Plugin / Documentation -->[[PedigreeChart|Pedigree Chart]]
|<!-- Contact -->[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]
|<!-- Download -->[https://github.com/gramps-project/addons/blob/master/gramps51/download/PlaceCompletion.addon.tgz?raw=true PlaceCompletion.addon.tgz]
|-
|<!-- Plugin / Documentation -->[[PlaceUpdate Gramplet]]
|<!-- Type -->Gramplet
|<!-- Image -->[[File:PlaceUpdate-Gramplet-Addon-103.png|right|150px]]
|<!-- Description -->Gramplet to manipulate multiple places.
|<!-- Use -->All
|<!-- Rating (out of 4) -->3
|<!-- Contact -->Kari Kujansuu<br />[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]
|<!-- Download -->[https://github.com/gramps-project/addons/blob/master/gramps51/download/PlaceCompletion.addon.tgz?raw=true PlaceUpdate.py]
|-
|<!-- Plugin / Documentation -->[[PostgreSQL]]
|<!-- Contact -->[mailto:[email protected] Paul Culley]
|<!-- Download -->[https://github.com/gramps-project/addons/blob/master/gramps51/download/PluginManager.addon.tgz?raw=true PluginManager.addon.tgz]
|-
|<!-- Plugin / Documentation -->[[Addon:SourcesCitationsReport|Sources and Citations Report]]
|<!-- Type -->Report
|<!-- Image -->[[File:SourcesCitationsReport-ReportOptions-tab-defaults-51.png|right|150px]]
|<!-- Description -->A text report for source and citations with notes.
|<!-- Use -->All
|<!-- Rating (out of 4) -->4
|<!-- Contact -->[https://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]
|<!-- Download -->[https://github.com/gramps-project/addons/blob/master/gramps51/download/SourcesCitationsReport.addon.tgz?raw=true SourcesCitationsReport.addon.tgz]
|-
|<!-- Plugin / Documentation -->[[Addon:SyncAssociation|Sync Associations]]
|<!-- Type --> Tool
|<!-- Image --> N/A
|<!-- Description -->Add reciprocal Associations if missing.
|<!-- Use --> All
|<!-- Rating (out of 4) --> 2
|<!-- Contact -->[mailto:[email protected] Gary Griffin]
|<!-- Download -->[https://github.com/gramps-project/addons/blob/master/gramps51/download/SyncAssociations.addon.tgz?raw=true SyncAssociations.addon.tgz]
|-
|<!-- Plugin / Documentation -->[[Addon:TinyTafel|Tiny Tafel(ListeEclair)]]
|<!-- Type -->Report
|<!-- Image -->[[File:TinyTafel-ReportOptions-defaults-51.png|right|150px]]
|<!-- 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.
|<!-- Use -->All
|<!-- Rating (out of 4) -->4
|<!-- Contact -->[http://gramps-project.org/bugs/my_view_page.php Gramps Bugtracker]<br>Eric doutreleau
|<!-- Download -->[https://github.com/gramps-project/addons/blob/master/gramps51/download/Query.addon.tgz?raw=true ListeEclair.addon.tgz]
|-
|<!-- Plugin / Documentation -->[[QueryGramplet|Query Gramplet]]
|<!-- Download -->[https://github.com/gramps-project/addons/blob/master/gramps51/download/RelatedRelativesGramplet.addon.tgz?raw=true RelatedRelativesGramplet.addon.tgz]
|-
|<!-- Plugin / Documentation -->[[Addon:RemoveTagToolAddRemoveTagTool|Add/Remove Tag Tool]]
|<!-- Type -->Tool
|<!-- Image -->[[File:Remove Tag ToolAddRemoveTagTool-GeneralOptionsDialog-51.png|right|150px]]|<!-- Description -->The Add/Remove Tag Tool allows you to add or remove one tag from a selected set of filtered objects e.g. people.
|<!-- Use -->All
|<!-- Rating (out of 4) -->4
|<!-- Description -->A tool to Remove unneeded custom Types.
|<!-- Use -->All
|<!-- Rating (out of 4) -->?4
|<!-- Contact -->[mailto:[email protected] Paul Culley]
|<!-- Download -->[https://github.com/gramps-project/addons/blob/master/gramps51/download/TypeCleanup.addon.tgzz?raw=true TypeCleanup.addon.tgz]
*[[2.2.x_Third-party_Plugins|2.2 Addons]]
=Writing a Addon/Plugin=* See [[Addons development]] and [[Writing a plugin|Writing a Plugin]] for information on developing your own addon.'s
=See also=
* [[Plugins Command Line]]
[[Category:Addons|*]]
