View source for 5.2 Addons

{{languages|5.2 Addons}}
{{man note|This page list [[Third-party Addons|Third-party Addons]] written by users and developers to work only with Gramps version 5.2.|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.2_Addons#Installing_Addons_in_Gramps|these instructions]]}}. An [[:File:GrampsAddonsUserManual.pdf|Addons Offline Manual]] is available for review.<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.2_Wiki_Manual_-_Navigation#Using_the_Addon_Manager|Addon Manager]] and [[Gramps_5.2_Wiki_Manual_-_Plugin_Manager|'''Plugin Manager''']].}}

Gramps comes with a [[Gramps_5.2_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 {{man label|[[Gramps_5.2_Wiki_Manual_-_Navigation#Settings|Addon Manager...> Scheduled update checks]]}} section, 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 [[Addon_list_legend#Type|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_5.2_Wiki_Manual_-_Plugin_Manager|Plugin Manager]]. 

{{Man tip|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 ==
[[File:AddonManager-Settings-tab-default-52.png|Right|thumb|550px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Addon Manager..." window showing default "Settings..." for Gramps 5.2]] <!--- needs new screenshot highlight the changes needed -->

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|[[Gramps_5.2_Wiki_Manual_-_Navigation#Using_the_Addon_Manager...|Edit -> Addon Manager...]]}}
# Go to the {{man label|[[Gramps_5.2_Wiki_Manual_-_Navigation#Settings|Settings]]}} tab
# In the {{man label|Scheduled update checks}} section:
# Change {{man label|Check for addon updates:}} so when you start Gramps, it checks for updated Addons:
## {{man label|Once a week}} - checks for updates when you start Gramps once a week ('''This is the recommended setting''' but you can choose any of the other time periods.) 
# Change {{man label|What to check}} so when you check for updates, it checks for:
## {{man label|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}} checkbox to:
## {{checkbox|0}} Unchecked as it means that new/updated addons are always shown to you ('''This is the recommended setting''')
# If needed you can verify that in the {{man label|[[Gramps_5.2_Wiki_Manual_-_Navigation#Projects|Project's tab > Where to check]]}} option has the correct URL. To locate the [https://raw.githubusercontent.com/gramps-project/addons/master/gramps52/listings/addons-en.json list of addons] for your current language and version, it should be set to:<br /><code>https&#58;//raw.githubusercontent.com/gramps-project/addons/master/gramps52</code> if not; select the {{man button|Restore project defaults}} button. (Also see the Discourse forum discussion for the URL of the [https://gramps.discourse.group/t/gramps-5-2-after-beta1-isotammi-plugins-available/4067 5.2 beta repository] of Isotammi addons.)
# 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.2_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-52.png|center|thumb|850px|"Available Gramps Updates for Addons" window showing example listing output for Gramps 5.2]]

{{-}}

== Addon List ==
Addons are listed inside of Gramps through the interface described above. The Plug-in Manager list includes the [[Gramps_5.2_Wiki_Manual_-_Gramplets#Built-in_Gramplet_List|built-in Gramplets]] as well as any downloaded third party addons... such as those in the following list.

{{man tip|''See [[Addon list legend]]|for details of on each columns.''}}

{{Addons5.2}} <!-- https://gramps-project.org/wiki/index.php/Template:Addons5.2 -->

== Manually installed Addons ==

A few addons have to be installed manually. Some are scripts and need to be installed as described in the documentation provided with that addon. Some are still in the exploratory stage and have not yet been published to the list used by the [[Gramps_5.2_Wiki_Manual_-_Navigation#Using_the_Addon_Manager|Addon Manager]]. 

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.

# Download the compressed file. (Click on a download link from the list of Addons below; or for unpublished exploratory addons, select the {{man menu|Download ZIP}} option from the {{man button|&lt;> Code}} button's menu in their GitHub repository)
# Open the compressed file ( *.ZIP ; *.gz ; *.tgz / etc ...using [https://www.7-zip.org/download.html 7-<small>ZIP</small>]) and extract the contents to in your [[Gramps_5.2_Wiki_Manual_-_User_Directory|Gramps User Directory]], in the <code>gramps52/plugins</code> folder.
# After manually installing any addons, it may be necessary to restart Gramps to register plug-ins again.

The [[Addon:Isotammi_addons#ZipInstall|'''ZipInstall''' addon from the Isotammi project of the Finland Genealogical Society]] can simplify the install of a downloaded ZIP (or a .tgz) compressed archive from GitHub.

{{man note|Addon/Plugin Errors|Any addons/plugins which failed to load can be identified in the {{man menu|Help > [[Gramps_5.2_Wiki_Manual_-_Plugin_Manager|Plugin Manager]]}}. View the ''Status'' column and  double-click on any entry that shows an error. Some may rely on [[Addon:Prerequisites_Checker_Gramplet|prerequisite modules]] that need to be installed.<br/>You can report any errors to the plugin contact.}}

{| class="wikitable sortable"
|-
! Plugin / Documentation
! Type
! Image
! Description
! Use
! Rating (out of 4)
! Contact
! Download
|-
|<!-- Plugin / Documentation -->[[Addon:InformationGraph|InformationGraph]]
|<!-- Type -->Report
|<!-- Image -->N/A
|<!-- Description -->Generate detailed GraphViz graphs by spidering over the database. {{man label|The InformationGraph plugin only works with Gramps 3.2<br>For a similar report see the: [[Addon:PersonEverything Report]]}}
|<!-- Use -->All
|<!-- Rating (out of 4) -->1
| [mailto:rah@bash.sh Bob Ham]
| [http://pkl.net/~node/software/GVInformationGraph.py GVInformationGraph.py]
|-
|<!-- Plugin / Documentation -->[[Addon:Handle.bash|Handle.bash]]
|<!-- Type -->External utility
|<!-- Image -->[[File:Bashhandle.gif|right|150px]]
|<!-- Description -->A bash script which makes it possible to work with multiple databases merging select branches at will without collisions.
|<!-- Use -->All
|<!-- Rating (out of 4) -->3
| [[User:Lcc]] ([mailto:lcc.mailaddress@gmail.com e-mail])
| [[Media:Handle.bash.tar.gz|Handle.bash.tar.gz]]
|-
|<!-- Plugin / Documentation -->[[Addon:Isotammi addons|Isotammi addons]]
|<!-- Type -->Isotammi project addons
|<!-- Image -->
|<!-- Description -->
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
|<!-- Use -->All
|<!-- Rating (out of 4) -->?
| http://wiki.isotammi.net/wiki/Gramps-laajennukset
| https://github.com/Taapeli/isotammi-addons
|-
|<!-- Plugin / Documentation -->
|<!-- Type -->
|<!-- Image -->
|<!-- Description -->
|<!-- Use -->
|<!-- Rating (out of 4) -->
| 
| 
|-
|}

==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.x_Third-party_Plugins|3.1 Addons]]
*[[3.0.x_Third-party_Plugins|3.0 Addons]]
*[[2.2.x_Third-party_Plugins|2.2 Addons]]

==See also==
* The '''5.2 Addons Offline Manual''' is available for review at ([[:File:GrampsAddonsUserManual5.2.pdf|English 18 MiB PDF]])

* [[Gramps 5.2 Wiki Manual - Command Line]]
** [[Plugins Command Line]] (Needs to be incorporated into user manual)
* [[Gramps_5.2_Wiki_Manual_-_Gramplets|Built-in Gramplets]] - Gramplets
* [[Addon:Rule_expansions|Addon:Rule expansions]] (to supplement [[Gramps_5.2_Wiki_Manual_-_Filters#Which_filter_rules_in_which_Category.3F|built-in rules]])
* Inspect the current updates [https://raw.githubusercontent.com/gramps-project/addons/master/gramps52/listings/addons-en.json /listings/addons-en.json] file in the {{man label|Where to check:}} https://raw.githubusercontent.com/gramps-project/addons/master/gramps52 URL in the [[Gramps_5.2_Wiki_Manual_-_Settings#Third_party_addons_management|Third party addons management]] in the {{man label|General}} tab of the {{man menu|Edit &#x27a1; Preferences}}
* [https://gramps.discourse.group/t/where-is-there-documentation-for-how-addons-txt-lines-are-generated/1252 Discourse forum thread] discussing how the addons.txt (From 5.2 now called "addons-en.json" ) entries are generated
* The [[Addon:Isotammi_addons|Isotammi project addons]] list.
===Writing an Addon/Plugin===
* [[Addons development]] 
* [[Writing a plugin]] for general information on developing addons
* [[Report-writing tutorial]]

{{languages|5.2 Addons}}

[[Category:Addons|*]]
[[Category:Plugins|*]]
[[Category:Developers/General]]
[[Category:Gramplets|*]]
[[Category:Tools|*]]
[[Category:Views|*]]