Open main menu

Gramps β

Difference between revisions of "6.0 Builtins"

(Created page with "{{languages|5.2 Built-ins}} {{man note|This page list built-in plug-ins Third-party Addons written by users and developers to work only with Gramps vers...")
 
m
 
(23 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
{{languages|5.2 Built-ins}}
+
{{languages|6.0 Builtins}}
−
{{man note|This page list built-in plug-ins
 
−
[[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]]}}<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_-_Plugin_Manager|'''Plugin Manager''']].}}
 
  
−
Gramps comes with a [[Gramps_{{man version}}_Wiki_Manual_-_Gramplets|core set of plugins]] which provide all of the critical features.
+
= 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 {{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]].}}
  
−
However, you can extend this functionality with additional Third-party Addons. These addons provide reports, filters, [[Gramps_Glossary#viewmode|View modes]], Gramplets, and more.  
+
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.
  
−
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.
+
= Customizing the core set of 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]]
 +
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.  
  
−
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.
+
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.
  
−
Installed addons can be enabled or disabled via the [[Gramps_{{Version manual}}_Wiki_Manual_-_Plugin_Manager|Plugin Manager]].  
+
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.
  
−
{{Man tip|Can not find it?|The Plugin Manager and Preferences are good places to search when a feature is being elusive.
+
Installed addons can be enabled or disabled via the [[Gramps_{{man version}}_Wiki_Manual_-_Plugin_Manager|Plugin Manager]].  
  
−
Addons are not typically cross-referenced in the wiki and might not be where you would expect in the interface.  
+
{{Man tip|Can not find it?|The Plugin Manager is good place to search when a feature is being elusive.}}
  
−
''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.''
+
= 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|builtin Gramplets]] as well as any downloaded third party addons... such as those in the following list.
−
So looking through the addons available for download and among those installed can help you rediscover the feature.}}
 
−
 
 
−
= Installing Addons in Gramps =
 
−
{{stub}}
 
−
[[File:EditPreferences-General-tab-recomeded-settings-for-addons-51.png|Right|thumb|550px|Highlighted section showing recommended settings for Addons to be managed Automatically]]
 
−
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.
 
−
 
 
−
To configure Gramps for Addons:
 
−
 
 
−
# Start Gramps
 
−
# Select Menu {{man menu|Edit -> Preferences...}}
 
−
# Go to the {{man label|[[Gramps_5.2_Wiki_Manual_-_Settings#General|General]]}} tab
 
−
# In the '''Third party addons management''' 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
 
−
## '''Once a week''' - checks for updates when you start Gramps once a week ('''This is the recommended setting''')
 
−
## ''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 addons only'' - does not check for new addons
 
−
## ''New addons only'' - does not check for updated addons (''This is the default setting'')
 
−
## '''New and updated addons''' - checks for all new and updated addons ('''This is the recommended setting''')
 
−
# Verify that the {{man label|Where to check}} has the correct URL. To locate the [https://raw.githubusercontent.com/gramps-project/addons/master/gramps{{Stable branch}}/listings/addons-en.txt list of addons] for your current language and version, it should be set to:<br /><code>https&#58;//raw.githubusercontent.com/gramps-project/addons/master/gramps{{Stable branch}}</code>
 
−
# Change the {{man label|Do not ask about previously notified addons}} check box:
 
−
## {{checkbox|1}} Checked: Means that new/updated addons are only asked about once; afterwards it doesn't show them to you (''This is the default setting'')
 
−
## {{checkbox|0}} Unchecked: Means that new/updated addons are always shown to you ('''This is the recommended setting''')
 
−
# 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".
 
−
# You can then select the check box of those Addons you want to install.
 
−
# Then select the {{man button|Install Selected Addons}} button to download those Addons from the ''Internet''.
 
−
# Once downloaded from the {{man label|Done downloading and installing addons}} dialog select the {{man button|Close}} button
 
−
# From the {{man label|Preferences}} dialog select {{man button|Close}} button.
 
−
# To use the Addons you need to {{man menu|Family Trees>Quit}} and restart Gramps.
 
−
 
 
−
[[File:AvailableGrampsUpdatesforAddons-example-listing-51.png|center|thumb|850px|"Available Gramps Updates for Addons" window showing example listing output for Gramps 5.1]]
 
−
 
 
−
{{-}}
 
−
 
 
−
= Addon 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.
 
  
 
{{man tip|''See [[Addon list legend]]|for details of on each columns.''}}
 
{{man tip|''See [[Addon list legend]]|for details of on each columns.''}}
  
−
{{Builins5.2}} <!-- https://gramps-project.org/wiki/index.php/Template:Builtins5.2 -->
+
{{Builtins5.2}} <!-- https://gramps-project.org/wiki/index.php/Template:Builtins5.2 -->
−
 
 
−
= Manually installed Addons =
 
−
 
 
−
A few addons have to be installed manually (or are scripts and need to be installed as described in the documentation).
 
−
 
 
−
Addons in the exploratory stages tend to be  initially posted to the [https://github.com/gramps-project?tab=repositories GitHub Gramps-Project repositories] and have to be manually installed. Be certain to backup your Tree before installing anything. There is a potential for data loss with such preliminary versions.
 
−
 
 
−
# Click on a download link from the list of Addons below.
 
−
# Open the compressed file ( *.ZIP ; *.gz ; *.tgz / etc ...using [https://www.7-zip.org/ 7-zip] ) and save the contents to your [[Gramps_5.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 the {{man menu|Help > [[Gramps_5.2_Wiki_Manual_-_Plugin_Manager|Plugin Manager]]}} you can see which addons/plugins failed to load by viewing the ''Status'' column, and then double clicking on such an entry shows you the error. You can email this error to the plugin contact.}}
 
−
 
 
−
{| class="wikitable sortable"
 
−
|-
 
−
! Plugin / Documentation
 
−
! Type
 
−
! Image
 
−
! Description
 
−
! Use
 
−
! Rating (out of 4)
 
−
! Contact
 
−
! Download
 
−
|-
 
−
|<!-- Plugin / Documentation -->[[Addon:InformationGraph|InformationGraph]]
 
−
|<!-- Type -->Report
 
−
|<!-- Image -->N/A
 
−
|<!-- Description -->Generate detailed GraphViz graphs by spidering over the database. {{man label|The InformationGraph plugin only works with Gramps 3.2<br>For a similar report see the: [[Addon:PersonEverything Report]]}}
 
−
|<!-- Use -->All
 
−
|<!-- Rating (out of 4) -->1
 
−
| [mailto:[email protected] Bob Ham]
 
−
| [http://pkl.net/~node/software/GVInformationGraph.py GVInformationGraph.py]
 
−
|-
 
−
|<!-- Plugin / Documentation -->[[Addon:Handle.bash|Handle.bash]]
 
−
|<!-- Type -->External utility
 
−
|<!-- Image -->[[File:Bashhandle.gif|right|150px]]
 
−
|<!-- Description -->A bash script which makes it possible to work with multiple databases merging select branches at will without collisions.
 
−
|<!-- Use -->All
 
−
|<!-- Rating (out of 4) -->3
 
−
| [[User:Lcc]] ([mailto:[email protected] e-mail])
 
−
| [[Media:Handle.bash.tar.gz|Handle.bash.tar.gz]]
 
−
|-
 
−
|<!-- Plugin / Documentation -->[[Addon:Isotammi addons|Isotammi addons]]
 
−
|<!-- Type -->Isotammi project addons
 
−
|<!-- Image -->
 
−
|<!-- Description -->
 
−
Gramplets:
 
−
* Isotammi configuration
 
−
* Dates
 
−
* Position tool
 
−
 
 
−
Rules:
 
−
* Events with an invalid date
 
−
* Events with a valid date 
 
−
 
 
−
Tool:
 
−
* Generate source references based on more information
 
−
|<!-- Use -->All
 
−
|<!-- Rating (out of 4) -->?
 
−
| http://wiki.isotammi.net/wiki/Gramps-laajennukset
 
−
| https://github.com/Taapeli/isotammi-addons
 
−
|-
 
−
|<!-- Plugin / Documentation -->
 
−
|<!-- Type -->
 
−
|<!-- Image -->
 
−
|<!-- Description -->
 
−
|<!-- Use -->
 
−
|<!-- Rating (out of 4) -->
 
−
|
 
−
|
 
−
|-
 
−
|}
 
  
 
=Addons for other versions 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.1 Addons]]
 
*[[5.1 Addons]]
 
*[[5.0 Addons]]
 
*[[5.0 Addons]]
−
*[[4.2 Addons]]
 
−
*[[4.1 Addons]]
 
−
*[[4.0 Addons]]
 
−
*[[3.4 Addons]]
 
−
*[[3.3 Addons]]
 
−
*[[3.2 Addons]]
 
−
*[[3.1.x_Third-party_Plugins|3.1 Addons]]
 
−
*[[3.0.x_Third-party_Plugins|3.0 Addons]]
 
−
*[[2.2.x_Third-party_Plugins|2.2 Addons]]
 
  
 
=See also=
 
=See also=
 
* [[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
−
* [[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 164: 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

Contents

The Plugin Framework

 
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.

 
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.

 

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

  Languages: 

English

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