Difference between revisions of "Gramps 3.2 Wiki Manual - Plugin Manager"

From Gramps
Jump to: navigation, search
(Registered Plugins)
Line 46: Line 46:
 
[[Image:loaded_plugins.png]]
 
[[Image:loaded_plugins.png]]
  
Here you see a list of all plugins that have been loaded. Normally, all views (such as the Relationship View) will be loaded, and all gramplets/reports/tools you have used will be loaded automatically.  
+
Here you see a list of all plugins that have been attempted to be loaded. Normally, all views (such as the Relationship View) will be loaded, and all gramplets/reports/tools you have used will be loaded automatically.  
  
 
If there was an error during the loading of a plugin, then the staus will be shown in this tab. Double clicking a row showing a failure opens a dialog showing the error in detail. You can use this to contact the plugin author or the gramps bug list.
 
If there was an error during the loading of a plugin, then the staus will be shown in this tab. Double clicking a row showing a failure opens a dialog showing the error in detail. You can use this to contact the plugin author or the gramps bug list.
Line 54: Line 54:
 
[[Image:install_addons.png]]
 
[[Image:install_addons.png]]
  
Here you will initially see an empty list. By clicking the "Refresh Addon List" button, Gramps will fetch the listed third-party plugins (known as Addons) listed at [[3.2 Addons]]. You may wish to refersh this list every once in a while to see the latest Addons.
+
Here you will initially see an empty list. By clicking the "Refresh Addon List" button, Gramps will fetch the listed third-party plugins (known as Addons) listed at [[3.2 Addons]]. You may wish to refresh this list every once in a while to see the latest Addons.
  
 
Also, you can enter an Addon's URL or path to a filename in the "Path to addon" to load the Addon.
 
Also, you can enter an Addon's URL or path to a filename in the "Path to addon" to load the Addon.

Revision as of 15:22, 14 March 2010

Gnome-important.png Special copyright notice: All edits to this page need to be under two different copyright licenses:

These licenses allow the Gramps project to maximally use this wiki manual as free content in future Gramps versions. If you do not agree with this dual license, then do not edit this page. You may only link to other pages within the wiki which fall only under the GFDL license via external links (using the syntax: [https://www.gramps-project.org/...]), not via internal links.
Also, only use the known Typographical conventions


Previous Index Next


The Plugin Manager allows you to control and extend certain features in Gramps. Plugins in Gramps are only loaded when needed and can be hidden by you if they are not wanted. So unused plugins will not use your resources, such as loading time and computer memory.

Plugin types

There are two main categories of plugins in Gramps: "user plugins" and "system plugins". User plugins are those that you use and control to provide different functionality for you. The system plugins are used by Gramps.

The following types of User Plugins are present in Gramps:

  1. gramps views: the views visisble in the main window of Gramps
  2. gramplets: small programs you can embed in the GrampletView, or detach and use as a normal window
  3. reports: Textual or graphical reports Gramps can produce
  4. quickreport: small reports that are available in the context menu on the listviews, or via the Quickreport gramplet
  5. tools: Tools you can start via the Tools menu
  6. doc creators: Backends for which Gramps can write reports (pdf, odf, ascii text, ...)
  7. exporters: export formats you can export your data too via Family Tree->Export
  8. importers: import formats from which Gramps can import data Family Tree->Import
  9. map service: targets that can be used on the place view to go to an internet map service (Go toolbar button)

The following types of System Plugins are present in Gramps:

  1. plugin libs: libraries that are present giving extra functionality.
  2. relationships: relationship calculators for different languages

There are many plugins that come with Gramps. However, anyone can also write a plugin and share it. These third-party plugins are called "addons". We highly encourage users and developers to share their creations with other Gramps users.

Actions

The Plugin Manager can be found in the Menu under Help. There are three tabs of the Plugin Manager: Registered Plugins, Loaded Plugins, and Install Addons.

Registered Plugins

Registered plugins.png

Here you see a list of all plugins that Gramps has found. These are the plugins which are part of Gramps, as well as the addons found in the GRAMPS User Directory in the plugins folder. The type of plugin is shown in the first column.

A plugin can be made hidden or unhidden. This is only useful for the User Plugins.

Loaded Plugins

Loaded plugins.png

Here you see a list of all plugins that have been attempted to be loaded. Normally, all views (such as the Relationship View) will be loaded, and all gramplets/reports/tools you have used will be loaded automatically.

If there was an error during the loading of a plugin, then the staus will be shown in this tab. Double clicking a row showing a failure opens a dialog showing the error in detail. You can use this to contact the plugin author or the gramps bug list.

Install Addons

Install addons.png

Here you will initially see an empty list. By clicking the "Refresh Addon List" button, Gramps will fetch the listed third-party plugins (known as Addons) listed at 3.2 Addons. You may wish to refresh this list every once in a while to see the latest Addons.

Also, you can enter an Addon's URL or path to a filename in the "Path to addon" to load the Addon.

Install addons full.png

After refreshing the addon list you may also click on a specific Addon listed. This will place the URL of the add in the "Path to addon". Then you can select "Install Addon" to download and install the selected Addon.

You may also select "Install All Addons". This will go through the list and download (or update) all of the listed Addons.

Later if you decide that you do not like an Addon, you can mark it "hidden" and it will no longer show.

Previous Index Next