Difference between revisions of "Addon list legend"

From Gramps
Jump to: navigation, search
m
m (Type)
 
(15 intermediate revisions by the same user not shown)
Line 6: Line 6:
 
== Type ==
 
== Type ==
 
There are a variety of [[Gramps_{{man version}}_Wiki_Manual_-_Plugin_Manager#Plugin_types|types of plugins/addons]], including:
 
There are a variety of [[Gramps_{{man version}}_Wiki_Manual_-_Plugin_Manager#Plugin_types|types of plugins/addons]], including:
* '''[[Database_Backends|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
+
* <span id="cite">'''[[Plugin:Citation_Formatter#Citation_Formatter|Citation formatter]]''' (CITE) - add support for another {{man label|Citation Formatter}} layout. Selected from the {{man label|[[Gramps_{{man_version}}_Wiki_Manual_-_Settings#Display_Options|Display Options]]}} tab in {{man menu|Edit &#x27a1; Preferences}}. {{new|5.2.0}}</span>
* '''[[Gramps_Glossary#gramplet|Gramplet]]''' - adds a new Gramplet to Gramps, which can be activated by right-clicking on the Gramplet View
+
* <span id="database">'''[[Database_Backends|Database]]''' (DATABASE) - add support for another database backend. {{new|5.0}} </span>
* '''Gramps [[Gramps_Glossary#viewmode|View ''(mode)]]''''' - adds a new view mode to the list of views available within a [[Gramps_Glossary#view|View Category]]
+
* <span id="docgen">'''Doc creator''' (DOCGEN)</span>
* '''Importer''' - adds additional file format import options to Gramps
+
* <span id="export">'''Exporter''' (EXPORT) - adds additional file format export options to Gramps</span>
* '''[[Map_Services|Map Service]]''' - adds new mapping options to Gramps
+
* <span id="general">'''General Plugin lib''' (GENERAL) - libraries that are present giving extra functionality. Can add, replace and or modifies built-in Gramps options.</span>
* '''Plugin lib''' - libraries that are present giving extra functionality. Can add, replace and or modifies built-in Gramps options.
+
* <span id="gramplet">'''[[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. </span>
* '''[[Gramps_{{man version}}_Wiki_Manual_-_Reports_-_part_8#Quick_Views|Quickreport'''/'''Quickview]]''' - a view that you can run by right-clicking on object, or if a person quickview, then through the Quick View Gramplet
+
* <span id="import">'''Importer''' (IMPORT) - adds additional file format import options to Gramps</span>
* '''[[Gramps_{{man version}}_Wiki_Manual_-_Reports_-_part_1|Report]]''' - adds a new output report / includes '''Website''' - output a static genealogy website based on your Gramps Family Tree data.
+
* <span id="mapservice">'''[[Map_Services|Map Service]]''' (MAPSERVICE) - adds new mapping options to Gramps</span>
* '''[[Gramps_{{man version}}_Wiki_Manual_-_Filters#Add_Rule_dialog|Rule]]''' - adds new [[Gramps_Glossary#filter|filter]] rules.
+
* <span id="quickreport">'''[[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</span>
* '''[[Gramps_{{man version}}_Wiki_Manual_-_Tools|Tool]]''' - adds a utility that helps process data from your family tree.
+
* <span id="recalc">'''Relationships''' (RECALC)</span> - relationship calculator for specific locales
 +
* <span id="report">'''[[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.</span>
 +
* <span id="rule">'''[[Gramps_{{man version}}_Wiki_Manual_-_Filters#Add_Rule_dialog|Rule]]''' (RULE) - adds new [[Gramps_Glossary#filter|filter]] rules. {{new|5.1}}</span>
 +
* <span id="sidebar">'''Sidebar''' (SIDEBAR)</span>
 +
* <span id="thumbnailer">'''Thumbnailer''' (THUMBNAILER) {{new|5.2.0}}</span>
 +
* <span id="tool">'''[[Gramps_{{man version}}_Wiki_Manual_-_Tools|Tool]]''' (TOOL) - adds a utility that helps process data from your family tree.</span>
 +
* <span id="view">'''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]]</span>
  
 
== Image ==
 
== Image ==
Line 55: Line 61:
 
Use this link to download the addon 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 ==
 +
* 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:Addons|*]]
 
[[Category:Addons|*]]
 
[[Category:Plugins|*]]
 
[[Category:Plugins|*]]
 
[[Category:Reports|*]]
 
[[Category:Reports|*]]

Latest revision as of 20:26, 12 April 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:

  • Citation formatter (CITE) - add support for another Citation Formatter layout. Selected from the Display Options tab in Edit ➡ Preferences. — ⚡new for version 5.2.0
  • Database (DATABASE) - add support for another database backend. — ⚡new for version 5.0
  • Doc creator (DOCGEN)
  • Exporter (EXPORT) - adds additional file format export options to Gramps
  • General Plugin lib (GENERAL) - libraries that are present giving extra functionality. Can add, replace and or modifies built-in Gramps options.
  • 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 (IMPORT) - adds additional file format import options to Gramps
  • Map Service (MAPSERVICE) - adds new mapping options to Gramps
  • 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
  • Relationships (RECALC) - relationship calculator for specific locales
  • 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
  • Sidebar (SIDEBAR)
  • Thumbnailer (THUMBNAILER) — ⚡new for version 5.2.0
  • Tool (TOOL) - adds a utility that helps process data from your family tree.
  • Gramps View (mode) (VIEW) - adds a new view mode to the list of views available within a View Category

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