Difference between revisions of "Addon list legend"

From Gramps
Jump to: navigation, search
(Type)
m ({{new|5.2.0}})
 
(28 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
{{languages|Addon_list_legend}}
 
{{man note|Legend information|about each column in the Gramps [[Third-party Addons|Third-party Addons]] List.}}
 
{{man note|Legend information|about each column in the Gramps [[Third-party Addons|Third-party Addons]] List.}}
== Plugin / Documentation ==
+
== Addon / Documentation ==
This is a link to documentation on this plugin. Users should read the documentation before installing any plugin.
+
This is a link to documentation on this Addon. Users should read the documentation before installing any Addons.
  
 
== Type ==
 
== Type ==
There are a variety of [[Gramps_{{Version manual}}_Wiki_Manual_-_Plugin_Manager#Plugin_types|types of plugins]], including:
+
There are a variety of [[Gramps_{{man version}}_Wiki_Manual_-_Plugin_Manager#Plugin_types|types of plugins/addons]], including:
* '''Database''' - add support for another database backend.
+
<!-- sync with https://gramps-project.org/wiki/index.php?title=Addons_development&action=edit&section=1 -->
* '''Exporter''' - adds additional file format export options to Gramps
+
* '''Importer''' (IMPORT) - adds additional file format import options to Gramps
* '''Gramplet''' - adds a new Gramplet to Gramps, which can be activated by right-clicking on the Gramplet View
+
* '''Exporter''' (EXPORT) - adds additional file format export options to Gramps
* '''Gramps View''' - adds a new view to the list of views available
+
* '''[[Gramps_Glossary#gramplet|Gramplet]]''' (GRAMPLET) - adds a new interactive interface section to a Gramps view mode, which can be activated by right-clicking on the dashboard View or from the menu of the Sidebar/Bottombar in the other view categories.
* '''Importer''' - adds additional file format import options to Gramps
+
* '''Gramps [[Gramps_Glossary#viewmode|View ''(mode)'']]''' (VIEW) - adds a new view mode to the list of views available within a [[Gramps_Glossary#view|View Category]]
* '''Map Service''' - adds new mapping options to Gramps
+
* '''[[Map_Services|Map Service]]''' (MAPSERVICE) - adds new mapping options to Gramps
* '''Plugin lib''' - libraries that are present giving extra functionality. Can add, replace and or modifies builtin Gramps options.
+
* '''Plugin lib''' (GENERAL) - libraries that are present giving extra functionality. Can add, replace and or modifies built-in Gramps options.
* '''Quickreport'''/'''Quickview''' - a view that you can run by right-clicking on object, or if a person quickview, then through the Quick View Gramplet
+
* '''[[Gramps_{{man version}}_Wiki_Manual_-_Reports_-_part_8#Quick_Views|Quickreport'''/'''Quickview]]''' (QUICKREPORT) - a view that you can run by right-clicking on object, or if a person quickview, then through the Quick View Gramplet
* '''Report''' - adds a new output report / includes '''Website''' - output a static genealogy website based on your Gramps Family Tree data.
+
* '''[[Gramps_{{man version}}_Wiki_Manual_-_Reports_-_part_1|Report]]''' (REPORT) - adds a new output report / includes '''Website''' - output a static genealogy website based on your Gramps Family Tree data.
* '''Rule''' - adds new filter rules.
+
* '''[[Gramps_{{man version}}_Wiki_Manual_-_Filters#Add_Rule_dialog|Rule]]''' (RULE) - adds new [[Gramps_Glossary#filter|filter]] rules. {{new|5.1}}
* '''Tool''' - adds a utility that helps process data from your family tree.
+
* '''[[Gramps_{{man version}}_Wiki_Manual_-_Tools|Tool]]''' (TOOL) - adds a utility that helps process data from your family tree.
 +
* '''Doc creator''' (DOCGEN)
 +
* '''Relationships''' (RECALC)
 +
* '''Sidebar''' (SIDEBAR)
 +
* '''[[Database_Backends|Database]]''' (DATABASE) - add support for another database backend. {{new|5.0}}
 +
* '''Thumbnailer''' (THUMBNAILER) {{new|5.2.0}}
 +
* '''Citation formatter''' (CITE) {{new|5.2.0}}
  
 
== Image ==
 
== Image ==
An image of the plugin.
+
An image of the addon.
  
 
<!--
 
<!--
Line 27: Line 34:
 
The version of Gramps the plugin was written for.  
 
The version of Gramps the plugin was written for.  
 
-->
 
-->
 +
 
== Description ==
 
== Description ==
A brief description of the plugin.
+
A brief description of the addon.
  
 
== Use ==
 
== Use ==
The '''Use''' column indicates who might receive the most benefit out of the plugin. Common categories of users:
+
The '''Use''' column indicates who might receive the most benefit out of the addon. Common categories of users:
 
* All
 
* All
 
* Developer
 
* Developer
Line 40: Line 48:
  
 
== Rating (out of 4) ==
 
== Rating (out of 4) ==
The '''Rating''' should give an indication of the state of the plugin:
+
The '''Rating''' should give an indication of the software development state of the addon:
 
* 0 Star  - initial version, basic framework defined, does not work correctly, please help  
 
* 0 Star  - initial version, basic framework defined, does not work correctly, please help  
 
* 1 Star  - partially working with some functionality, but much more work is needed; needs testing
 
* 1 Star  - partially working with some functionality, but much more work is needed; needs testing
Line 51: Line 59:
  
 
== Download ==
 
== Download ==
Use this link to download the plugin for manual installation if you do not have an ''Internet'' connection.  
+
Use this link to download the addon for manual installation if you do not have an ''Internet'' connection.  
 
* See the '''[[Third-party Addons#Manually_installed_Addons|Manually installed Addons]]''' section of [[Third-party Addons]] page for more details.
 
* See the '''[[Third-party Addons#Manually_installed_Addons|Manually installed Addons]]''' section of [[Third-party Addons]] page for more details.
 
+
== See Also ==
[[Category:Plugins|L]]
+
* the [https://github.com/gramps-project/gramps/blob/master/gramps/gen/plug/_pluginreg.py#L114 _pluginreg.py] module has the current list of plugin types that Gramps can register
[[Category:Reports|L]]
+
[[Category:Addons|*]]
 +
[[Category:Plugins|*]]
 +
[[Category:Reports|*]]

Latest revision as of 05:06, 18 February 2024

Gramps-notes.png
Legend information

about each column in the Gramps Third-party Addons List.

Addon / Documentation

This is a link to documentation on this Addon. Users should read the documentation before installing any Addons.

Type

There are a variety of types of plugins/addons, including:

  • Importer (IMPORT) - adds additional file format import options to Gramps
  • Exporter (EXPORT) - adds additional file format export options to Gramps
  • Gramplet (GRAMPLET) - adds a new interactive interface section to a Gramps view mode, which can be activated by right-clicking on the dashboard View or from the menu of the Sidebar/Bottombar in the other view categories.
  • Gramps View (mode) (VIEW) - adds a new view mode to the list of views available within a View Category
  • Map Service (MAPSERVICE) - adds new mapping options to Gramps
  • Plugin lib (GENERAL) - libraries that are present giving extra functionality. Can add, replace and or modifies built-in Gramps options.
  • Quickreport/Quickview (QUICKREPORT) - a view that you can run by right-clicking on object, or if a person quickview, then through the Quick View Gramplet
  • Report (REPORT) - adds a new output report / includes Website - output a static genealogy website based on your Gramps Family Tree data.
  • Rule (RULE) - adds new filter rules. — ⚡new for version 5.1
  • Tool (TOOL) - adds a utility that helps process data from your family tree.
  • Doc creator (DOCGEN)
  • Relationships (RECALC)
  • Sidebar (SIDEBAR)
  • Database (DATABASE) - add support for another database backend. — ⚡new for version 5.0
  • Thumbnailer (THUMBNAILER) — ⚡new for version 5.2.0
  • Citation formatter (CITE) — ⚡new for version 5.2.0

Image

An image of the addon.


Description

A brief description of the addon.

Use

The Use column indicates who might receive the most benefit out of the addon. Common categories of users:

  • All
  • Developer
  • Beginning user
  • Normal user
  • Intermediate user
  • Expert user

Rating (out of 4)

The Rating should give an indication of the software development state of the addon:

  • 0 Star - initial version, basic framework defined, does not work correctly, please help
  • 1 Star - partially working with some functionality, but much more work is needed; needs testing
  • 2 Stars - about half done, works, but more work is needed for it to be complete; needs more testing
  • 3 Stars - some known issues, but mostly complete
  • 4 Stars - complete, works well, fully tested

Contact

Use the shown link to report issues or request features, or provide feedback to the author.

Download

Use this link to download the addon for manual installation if you do not have an Internet connection.

See Also

  • the _pluginreg.py module has the current list of plugin types that Gramps can register