Difference between revisions of "6.0 Builtins"

From Gramps
m (Undo revision 97928 by Gioto (talk) This is a placeholder that will not be public until the 5.2 rollover. So the "man version" template is right)
(Tag: Undo)
m
Line 2: Line 2:
  
 
{{man warn|1=&#x1F6A7; 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.}}
 
{{man warn|1=&#x1F6A7; 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.}}
 +
= The Plugin Framework =
 +
{{man note|This page lists plug-ins packaged with each release of Gramps... the "built-ins".|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.<br /><br />All plugins (whether built-in or add-on) can be enabled, hidden or disabled with the [[Gramps_5.2_Wiki_Manual_-_Plugin_Manager|Plugin Manager]] or the [[Addon:Plugin_ManagerV2|Plugin Manager Enhanced version2]].}}
  
{{man note|This page lists plug-ins packaged with each release of Gramps... the "built-ins".|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.<br /><br />All plugins (whether built-in or add-on) can be enabled, hidden or disabled with the [[Gramps_5.2_Wiki_Manual_-_Plugin_Manager|Plugin Manager]].}}
+
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.
  
Gramps comes with a [[Gramps_{{man version}}_Wiki_Manual_-_Gramplets|core set of plugins]] which provide all of the critical features.
+
= Customizing the core set of plugins =
 
+
[[File:PluginManager-LoadedPlugins-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Loaded plugins]]
However, you can extend this functionality with additional Third-party Addons. These addons provide reports, filters, [[Gramps_Glossary#viewmode|View modes]], Gramplets, and more.  
+
[[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 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.
 
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.
Line 15: Line 18:
 
Installed addons can be enabled or disabled via the [[Gramps_{{Version manual}}_Wiki_Manual_-_Plugin_Manager|Plugin Manager]].  
 
Installed addons can be enabled or disabled via the [[Gramps_{{Version manual}}_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.
+
{{Man tip|Can not find it?|The Plugin Manager is good place 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.}}
 
  
 
= Plugin List =
 
= Plugin List =

Revision as of 05:36, 14 September 2023

Gnome-important.png
🚧 Work In Progress

This wikipage is an outline from a template being roughed in. Please don't edit just yet. Instead, contribute suggestions on the Discussion page.

This page is not planned be linked to a public page until about 11 July 2026.

If this notice remains after that date, please feel welcome to remove this notice and consider the content 'fair game' for unlimited editing.

The Plugin Framework

Gramps-notes.png
This page lists plug-ins packaged with each release of Gramps... the "built-ins".

There are also dozens of plug-ins that are Third-party Addons, written by users and developers to work only with Gramps version 5.2.

All plugins (whether built-in or add-on) can be enabled, hidden or disabled with the Plugin Manager or the Plugin Manager Enhanced version2.

Gramps comes with a core set of plugins which provide the primary features in a framework that allows expansion.

Customizing the core set of plugins

Fig. .1 Loaded plugins
Plugin Manager Enhanced (version 2) - showing example plugins listing

However, you can also customize this core set. These plugins include reports, filters, View modes, Gramplets, support for various import/export file formats, and more.

From Gramps [[Gramps_Template: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 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_Template:Version manual_Wiki_Manual_-_Plugin_Manager|Plugin Manager]].

Tango-Dialog-information.png
Can not find it?

The Plugin Manager is good place to search when a feature is being elusive.


Plugin List

Addons are listed inside of Gramps through the interface described above. The Plug-in Manager list includes the built-in Gramplets as well as any downloaded third party addons... such as those in the following list.

Tango-Dialog-information.png

for details of on each columns.


Plugin / Documentation Type Image Description Use Rating (out of 4) Contact Download
Legacy Citation Plugin to replicate Citations in Gramps v1.0 to v5.1

Addons for other version 5 of Gramps

Addons for other versions of Gramps can be found on the following pages

See also

Writing an Addon/Plugin