Difference between revisions of "6.0 Builtins"

From Gramps
m (Gioto moved page 5.2 Built-ins to 5.2 Builtins: move to common spelling of builtin used by Gramps project not built-in with hypen)
m
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
{{languages|5.2 Built-ins}}
+
{{languages|6.0 Builtins}}
  
−
{{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 =
 
= 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 addon) 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 "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 {{man version}}.<br /><br />All plugins (whether builtin or addon) can be enabled, hidden or disabled with the [[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.
 
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 =
 
= 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]]
+
[[File:PluginManager-LoadedPlugins-60.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]]
 
[[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.  
 
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_{{man 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 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.
+
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 manual}}_Wiki_Manual_-_Plugin_Manager|Plugin Manager]].  
+
Installed addons can be enabled or disabled via the [[Gramps_{{man 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.}}
 
{{Man tip|Can not find it?|The Plugin Manager is good place to search when a feature is being elusive.}}
  
 
= Plugin List =
 
= Plugin List =
−
Addons are listed inside of Gramps through the interface described above. The Plug-in Manager list includes the [[Gramps_{{man version}}_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.
+
Addons are listed inside of Gramps through the interface described above. The Plug-in Manager list includes the [[Gramps_{{man version}}_Wiki_Manual_-_Gramplets#Built-in_Gramplet_List|builtin 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.''}}
 
{{man tip|''See [[Addon list legend]]|for details of on each columns.''}}
Line 27: Line 26:
 
{{Builtins5.2}} <!-- https://gramps-project.org/wiki/index.php/Template:Builtins5.2 -->
 
{{Builtins5.2}} <!-- https://gramps-project.org/wiki/index.php/Template:Builtins5.2 -->
  
−
=Addons for other version 5 of Gramps=
+
=Addons for other versions of Gramps=
 
Addons for other versions of Gramps can be found on the following pages
 
Addons for other versions of Gramps can be found on the following pages
 +
*[[6.0 Addons]]
 
*[[5.2 Addons]]
 
*[[5.2 Addons]]
 
*[[5.1 Addons]]
 
*[[5.1 Addons]]
Line 36: Line 36:
 
* [[Gramps {{man version}} Wiki Manual - Command Line]]
 
* [[Gramps {{man version}} Wiki Manual - Command Line]]
 
** [[Plugins Command Line]] (Needs to be incorporated into user manual)
 
** [[Plugins Command Line]] (Needs to be incorporated into user manual)
−
* [[Gramps_{{man version}}_Wiki_Manual_-_Gramplets|Built-in Gramplets]] - Gramplets
+
* [[Gramps_{{man version}}_Wiki_Manual_-_Gramplets|Builtin Gramplets]] - Gramplets
−
* [[Addon:Rule expansions]] (3rd party addons to supplement [[Gramps_{{man version}}_Wiki_Manual_-_Filters#Which_filter_rules_in_which_Category.3F|built-in rules]])
+
* [[Addon:Rule expansions]] (3rd party addons to supplement [[Gramps_{{man version}}_Wiki_Manual_-_Filters#Which_filter_rules_in_which_Category.3F|builtin rules]])
 
* Inspect the current updates [https://raw.githubusercontent.com/gramps-project/addons/master/gramps52/listings/addons-en.txt /listings/addons-en.txt] 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_-_Settings#Third_party_addons_management|Third party addons management]] in the {{man label|General}} tab of the {{man menu|Edit &#x27a1; Preferences}}
 
* Inspect the current updates [https://raw.githubusercontent.com/gramps-project/addons/master/gramps52/listings/addons-en.txt /listings/addons-en.txt] 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_-_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 entries are generated
 
* [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.
 
* The [[Addon:Isotammi_addons|Isotammi project addons]] list.
 +
 
==Writing an Addon/Plugin==
 
==Writing an Addon/Plugin==
 
* [[Addons development]]  
 
* [[Addons development]]  
Line 46: Line 47:
 
* [[Report-writing tutorial]]
 
* [[Report-writing tutorial]]
  
−
{{languages|5.2 Addons}}
+
{{languages|6.0 Builtins}}
  
 
[[Category:Plugins|*]]
 
[[Category:Plugins|*]]

Latest revision as of 21:56, 9 July 2026

Gramps-config-language.png Languages: 

English

The Plugin Framework

Gramps-notes.png
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, written by users and developers to work only with Gramps version 6.0.

All plugins (whether builtin or addon) 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 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 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 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 builtin 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 versions of Gramps

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

See also

Writing an Addon/Plugin

Gramps-config-language.png Languages: 

English

Retrieved from "https://www.gramps-project.org/wiki/index.php?title=6.0_Builtins&oldid=131472"