5,850
edits
Changes
m
A few addons have Addons in the exploratory stages tend to be installed manually (or are scripts initially posted to the [https://github.com/gramps-project?tab=repositories GitHub Gramps-Project repositories] and need have to be manually installed as described in the documentation). Be certain to backup your Tree before installing anything. There is a potential for data loss with such preliminary versions.
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_{{man version}}_Wiki_Manual_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_{{Version manual}}_Wiki_Manual_Gramps_5.2_Wiki_Manual_-_Settings_Navigation#GeneralSettings|PreferencesAddon 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_{{Version manual}}_Wiki_Manual_Gramps_5.2_Wiki_Manual_-_Plugin_Manager|Plugin Manager]].
{{Man tip|Can't not find it?|The Plugin Manager and Preferences are good places to search when a feature is being elusive.
Addons aren't are not typically cross-referenced in the wiki and might not be where you'd 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've 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:EditPreferencesAddonManager-GeneralSettings-tab-recomeded-settings-for-addonsdefault-52.png|Right|thumb|550px|Highlighted section Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Addon Manager..." window showing recommended settings default "Settings..." for Addons to be managed AutomaticallyGramps 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.
# Start Gramps
# Select Menu {{man menu|[[Gramps_5.2_Wiki_Manual_-_Navigation#Using_the_Addon_Manager...|Edit -> PreferencesAddon Manager...]]}}# Go to the {{man label|[[Gramps_5.2_Wiki_Manual_-_Settings_Navigation#GeneralSettings|GeneralSettings]]}} tab# In the '''Third party addons management''' {{man label|Scheduled update checks}} 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## '''{{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.)## ''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 {{man label|New and updated addons only'' }} - does not check checks for all new addons## ''New addons only'' - does not check for and updated addons ('''This is the default recommended setting''')# Change the {{man label|Do not ask about previously notified addons}} checkbox to:## '''New and updated addons''' - checks for all {{checkbox|0}} Unchecked as it means that new and /updated addons are always shown to you ('''This is the recommended setting''')# Verify 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/gramps{{Stable branch}}gramps52/listings/addons-en.txt 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/gramps{{Stable branch}}gramps52</code># Change if not; select the {{man labelbutton|Do not ask about previously notified addonsRestore project defaults}} check box:## {{checkbox|1}} Checked: Means that new/updated addons are only asked about once; afterwards it doesn't show them to you button. (''This is Also see the user manual for the default setting'')[[Gramps_5.2_Wiki_Manual_-_Navigation## {{checkboxOther_Projects|0}} Unchecked: Means that new/updated addons are always shown to you ('''This is the recommended setting'''list of known external projects]] .)
# 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_{{man version}}_Wiki_Manual_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 [[Plugin 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]].
# 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|<> Code}} button's menu in their GitHub repository)# Open the exploratory stages tend to be initially posted to the compressed file ( *.ZIP ; *.gz ; *.tgz / etc ...using [https://githubwww.7-zip.comorg/grampsdownload.html 7-project?tab=repositories GitHub Gramps-Project repositories<small>ZIP</small>] ) and have 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 manually installed. Be certain necessary to restart Gramps to backup your Tree before installing anything. There is a potential for data loss with such preliminary versionsregister plug-ins again.
The [[Addon:Isotammi_addons# Click on a download link ZipInstall|'''ZipInstall''' addon from the list Isotammi project of Addons below.# Open the compressed file Finland Genealogical Society]] can simplify the install of a downloaded ZIP ( *.ZIP ; *.gz ; *or a .tgz / etc ...using [https://www.7-zip.org/ 7-zip] ) and save the contents to your [[Gramps_5compressed archive from GitHub.2_Wiki_Manual_-_User_Directory|Gramps User Directory]], in the <code>gramps52/plugins</code> folder# After manually installing any addons, you need to restart Gramps
{{man note|Addon/Plugin Errors|From Any addons/plugins which failed to load can be identified in the {{man menu|Help > [[Gramps_5.2_Wiki_Manual_-_Plugin_Manager|Plugin Manager]]}} you can see which addons/plugins failed to load by viewing . View the ''Status'' column, and then double clicking -click on such an any entry that shows you the an error. Some may rely on [[Addon:Prerequisites_Checker_Gramplet|prerequisite modules]] that need to be installed.<br/>You can email this error report any errors to the plugin contact.}}
{| class="wikitable sortable"
|}
=Plugins =Addons for other versions of Gramps==Plugins Addons for other versions of Gramps can be found on the following pages
*[[5.1 Addons]]
*[[5.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 {{man version}} 5.2 Wiki Manual - Command Line]]
** [[Plugins Command Line]] (Needs to be incorporated into user manual)
* [[Gramps_{{man version}}_Wiki_Manual_Gramps_5.2_Wiki_Manual_-_Gramplets|Built-in Builtin Gramplets]] - Gramplets* [[Addon:Rule_expansions|Addon:Rule expansions]] (3rd party addons to supplement [[Gramps_{{man version}}_Wiki_Manual_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.txt json /listings/addons-en.txtjson] file in the {{man label|Where to check:}} https://raw.githubusercontent.com/gramps-project/addons/master/gramps52 URL in the [[Gramps_{{man version}}_Wiki_Manual_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]]
* [[Writing a plugin]] for general information on developing addons