Difference between revisions of "Plugin list legend"

From Gramps
Jump to: navigation, search
m
(9 intermediate revisions by 4 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:
+
== Plugin / Documentation ==
  
* 0 Stars - initial version, basic framework defined, doesn't work correctly, please help
+
This is a link to documentation on this plugin. Users should read the documentation before installing any plugin.
* 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
+
  
The '''Use''' indicates who might make the most out of the plugin. Common categories of users:
+
== Type ==
 +
 
 +
There are a variety of types of plugins, including:
 +
 
 +
* Report - adds a new output report
 +
* View - adds a new view to the list of views available
 +
* Gramplet - adds a new Gramplet to Gramps, which can be activated by right-clicking on the Gramplet View
 +
* Quickview - a view that you can run by right-clicking on object, or if a person quickview, then through the Quick View Gramplet
 +
* Website - output a static genealogy website based on your Gramps data
 +
 
 +
== 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).
 +
 
 +
== Written for GRAMPS ==
 +
 
 +
The version of GRAMPS the plugin was written for.
 +
-->
 +
== Description ==
 +
 
 +
A brief description of the plugin.
 +
 
 +
== Use ==
 +
 
 +
The '''Use''' indicates who might receive the most benifit out of the plugin. Common categories of users:
  
 
* All
 
* All
Line 13: Line 38:
 
* Beginning user
 
* Beginning user
 
* Expert user
 
* Expert user
* Example
 
  
[[Third-party_Plugins|Back to Third-party 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 this link to report issues, or provide feedback to the author.
 +
 
 +
== Download ==
 +
 
 +
Use this link to download the plugin. See [[Third-party Plugins]] for more details on installing a plugin.
  
[[Category:Plugins]]
+
[[Category:Plugins|L]][[Category:Reports|L]]

Revision as of 02:51, 3 March 2012

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:

  • Report - adds a new output report
  • View - adds a new view to the list of views available
  • Gramplet - adds a new Gramplet to Gramps, which can be activated by right-clicking on the Gramplet View
  • Quickview - a view that you can run by right-clicking on object, or if a person quickview, then through the Quick View Gramplet
  • Website - output a static genealogy website based on your Gramps data

Image

An image of the plugin.

Description

A brief description of the plugin.

Use

The Use indicates who might receive the most benifit out of the plugin. Common categories of users:

  • All
  • Developer
  • Beginning 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 this link to report issues, or provide feedback to the author.

Download

Use this link to download the plugin. See Third-party Plugins for more details on installing a plugin.