5,850
edits
Changes
m
Undo revision 118819 by Patsyblefebre (talk)
{{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.
# 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://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 user manual for the URL of the [https://gramps[Gramps_5.discourse.group/t/gramps2_Wiki_Manual_-5-2-after-beta1-isotammi-plugins-available/4067 5.2 beta repository_Navigation#Other_Projects|list of known external projects]] 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".
== Addon List ==
Addons are listed inside of Gramps through the interface described above. The Plug-in Plugin Manager list includes the built-in [[Gramps_5.2_Wiki_Manual_-_Gramplets#BuiltGramplet_List|Gramplets]], [[Gramps_5.2_Wiki_Manual_-in_Gramplet_List_Navigation#Tools|builtTools]] and [[Gramps_5.2_Wiki_Manual_-in Gramplets_Navigation#Reports|Reports]] plug-ins 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.''}}
# 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.}}
==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.1_Wiki_Manual_2_Wiki_Manual_-_Gramplets|Built-in Builtin Gramplets]] - Gramplets* [[Addon:Rule_expansions|Addon:Rule expansions]] (3rd party addons 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 ➡ 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]]