5,862
edits
Changes
m
{{man warn|1=🚧 Work In Progress|2=This wikipage is an outline from a template being roughed in. Please don't edit '''''just yet'''''. Instead, contribute suggestions on the Discussion page. <br /><br />This page is not planned be linked to a public page until about {{safesubst<noinclude/>:CURRENTDAY}} {{safesubst<noinclude/>:CURRENTMONTHNAMEGEN}} {{safesubst<noinclude/>:CURRENTYEAR}}. <br /><br />If this notice remains after that date, please feel welcome to remove this notice and consider the content 'fair game' for unlimited editing.}}
no edit summary
{{languages|56.2 0 Builtins}}
= The Plugin Framework =
{{man note|This page lists plug-ins packaged with each release of Gramps... the "builtins".|There are also dozens of plug-ins that are [[Third-party Addons|Third-party Addons]], written by users and developers to work only with Gramps version 5.2{{man version}}.<br /><br />All plugins (whether builtin or addon) can be enabled, hidden or disabled with the [[Gramps_5.2_Wiki_Manual_Gramps_{{man version}}_Wiki_Manual_-_Plugin_Manager|Plugin Manager]] or the [[Addon:Plugin_ManagerV2|Plugin Manager Enhanced version2]].}}
Gramps comes with a [[Gramps_{{man version}}_Wiki_Manual_-_Gramplets|core set of plugins]] which provide the primary features in a framework that allows expansion.
= Customizing the core set of plugins =
[[File:PluginManager-LoadedPlugins-5060.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Loaded plugins]]
[[File:PlugInManager-addon-example-52.png|thumb|right|450px|Plugin Manager Enhanced (version 2) - showing example plugins listing]]
However, you can also customize this core set. These plugins include reports, filters, [[Gramps_Glossary#viewmode|View modes]], Gramplets, support for various import/export file formats, and more.
From Gramps [[Gramps_{{Version manualman version}}_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 builtin 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 manualman version}}_Wiki_Manual_-_Plugin_Manager|Plugin Manager]].
{{Man tip|Can not find it?|The Plugin Manager is good place to search when a feature is being elusive.}}
{{Builtins5.2}} <!-- https://gramps-project.org/wiki/index.php/Template:Builtins5.2 -->
=Addons for other version 5 versions of Gramps=
Addons for other versions of Gramps can be found on the following pages
*[[6.0 Addons]]
*[[5.2 Addons]]
*[[5.1 Addons]]
* [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 entries are generated
* The [[Addon:Isotammi_addons|Isotammi project addons]] list.
==Writing an Addon/Plugin==
* [[Addons development]]
* [[Report-writing tutorial]]
{{languages|56.2 Addons0 Builtins}}
[[Category:Plugins|*]]