Difference between revisions of "Addon list legend"

From Gramps
Jump to: navigation, search
(New page: Every plugin listed below should have a '''Version number''' (so one can tell if and when it changes in the future), and also specify what version of GRAMPS it was written for. The '''Rati...)
 
(Type)
(27 intermediate revisions by 9 users not shown)
Line 1: Line 1:
Every plugin listed below should have a '''Version number''' (so one can tell if and when it changes in the future), and also specify what version of GRAMPS it was written for. The '''Rating''' should give an indication of the state of the plugin:
+
{{man note|Legend information|about each column in the Gramps [[Third-party Addons|Third-party Addons]] List.}}
 +
== Plugin / Documentation ==
 +
This is a link to documentation on this plugin. Users should read the documentation before installing any plugin.
  
* 0 Stars - initial version, basic framework defined, doesn't work correctly, please help
+
== Type ==
* 1 Star - partially working with some functionality, but much more work is needed; needs testing
+
There are a variety of [[Gramps_{{Version manual}}_Wiki_Manual_-_Plugin_Manager#Plugin_types|types of plugins]], including:
* 2 Stars - about half done, works, but more work is needed for it to be complete; needs more testing
+
* '''Database''' - add support for another database backend.
* 3 Stars - some known issues, but mostly complete
+
* '''Exporter''' - adds additional file format export options to Gramps
* 4 Stars - complete, works well, fully tested
+
* '''Gramplet''' - adds a new Gramplet to Gramps, which can be activated by right-clicking on the Gramplet View
 +
* '''Gramps View''' - adds a new view to the list of views available
 +
* '''Importer''' - adds additional file format import options to Gramps
 +
* '''Map Service''' - adds new mapping options to Gramps
 +
* '''Plugin lib''' - libraries that are present giving extra functionality. Can add, replace and or modifies  builtin 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
 +
* '''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.
 +
* '''Tool''' - adds a utility that helps process data from your family tree.
 +
 
 +
== Image ==
 +
An image of the plugin.
 +
 
 +
<!--
 +
== Version ==
 +
Every plugin listed below should have a '''Version number''' (so one can tell if and when it changes in the future).
  
The '''Use''' indicates who might make the most out of the plugin. Common categories of users:
+
== Written for Gramps ==
 +
The version of Gramps the plugin was written for.
 +
-->
 +
== Description ==
 +
A brief description of the plugin.
  
 +
== Use ==
 +
The '''Use''' column indicates who might receive the most benefit out of the plugin. Common categories of users:
 
* All
 
* All
 
* Developer
 
* Developer
 
* Beginning user
 
* Beginning user
 +
* Normal user
 +
* Intermediate user
 
* Expert user
 
* Expert user
* Example
 
  
[[Category:Plugins]]
+
== Rating (out of 4) ==
 +
The '''Rating''' should give an indication of the state of the plugin:
 +
* 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 [[Using the bug tracker|report issues or request features]], or provide feedback to the author.
 +
 
 +
== Download ==
 +
Use this link to download the plugin 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.
 +
 
 +
[[Category:Plugins|L]]
 +
[[Category:Reports|L]]

Revision as of 22:03, 20 September 2020

Gramps-notes.png
Legend information

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

Plugin / Documentation

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

Type

There are a variety of types of plugins, including:

  • Database - add support for another database backend.
  • Exporter - adds additional file format export options to Gramps
  • Gramplet - adds a new Gramplet to Gramps, which can be activated by right-clicking on the Gramplet View
  • Gramps View - adds a new view to the list of views available
  • Importer - adds additional file format import options to Gramps
  • Map Service - adds new mapping options to Gramps
  • Plugin lib - libraries that are present giving extra functionality. Can add, replace and or modifies builtin 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
  • 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.
  • Tool - adds a utility that helps process data from your family tree.

Image

An image of the plugin.

Description

A brief description of the plugin.

Use

The Use column indicates who might receive the most benefit out of the plugin. 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 state of the plugin:

  • 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 plugin for manual installation if you do not have an Internet connection.