Difference between revisions of "Third-party Plugins"

From Gramps
Jump to: navigation, search
(→‎Plugin List)
Line 41: Line 41:
 
The plugins:
 
The plugins:
  
−
{{Template:Plugin}}
+
{{Template:Plugins}}
  
 
= Information for Plugin writers =
 
= Information for Plugin writers =

Revision as of 07:16, 11 March 2009

Third-party plugins give you more tools to work with your genealogy data in GRAMPS. This page lists plugins written by users to work with the 3.1.x series version of GRAMPS, to be released in March 2009.

Plugins for the previous version: 3.0.x Third-party Plugins page.

Gnome-important.png
Please Note:

These plugins may not be officially part of GRAMPS. Feature requests and bugs with these plugins should be directed to the contact information below.

Contents

Installing Plugins in GRAMPS

To install a GRAMPS Plugin:

  1. click on the download link below
  2. if the download is a file that ends in .py, save it in your GRAMPS User Directory, in the plugins folder
  3. if the download is a file that ends in .zip or .gz, save the contents of the file in your GRAMPS User Directory, in the plugins folder
  4. restart gramps, OR reload the plugins from the Help -> Plugin Status -> Reload button.

Note: If you are attempting to override an older plugin, the .py filename should be different from the original. For example, if you have an older FilePlugin.py save the newer FilePlugin.py as FilePlugin101.py where 101 might be the version number.

The Plugin Status window will show you which plugins failed to load, double click on such an entry shows you the error. You can mail this error to the plugin contact.

Plugin List

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:

  • 0 Stars - initial version, basic framework defined, doesn't 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

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

  • All
  • Developer
  • Beginning user
  • Expert user
  • Example

The plugins:

Plugin / Documentation Type Version Description Written for GRAMPS Use Rating (out of 4) Contact Download
GeoView Experimental View NA An extra view in GRAMPS which shows places, events, info of active person, ... embedded in GRAMPS on a map using different backends (OpenStreetMaps, Google Maps, ...) NA Testing NA Gramps Bugtracker GeoView
RelatedPersons Filter for Rules/persons 1.1.0 People with related home-person (v1.1 : Without "Numeric", not a standard module) 3.1.0 All  ? Jean-Francois Chassé _RelatedPersons.py
Cairo Clock Gramplet Gramplet 1.0.0 Example of how to use the Cairo drawing canvas in a gramplet 3.1.0 Developer 4 Stars Doug Blank ClockGramplet.zip
Data Entry Gramplet Gramplet 1.0.0 Quick Data Entry for People data 3.1.0 Expert user 4 Stars Gramps Bugtracker DataEntryGramplet.py
Descendant Count Gramplet Gramplet 1.0.0 Gives a count of descendants for each person 3.1.0 All 4 Stars Doug Blank DescendantCountGramplet.zip
FAQ Gramplet Gramplet 1.0.0 GRAMPS Frequently Asked Questions 3.1.0 Beginner user 0 Stars Gramps Bugtracker FaqGramplet.py
Headline News Gramplet Gramplet 1.0.2 Shows GRAMPS breaking news, once per hour 3.1.0 All 4 Stars Gramps Bugtracker HeadlineNewsGramplet.py
Note Gramplet Gramplet 1.0.0 Quick Data Entry for Notes 3.1.0 Expert user 4 Stars Gramps Bugtracker NoteGramplet.py
Plugin Manager Gramplet Gramplet 1.0.0 Lists plugins available for GRAMPS 3.1.0 All 2 Stars Gramps Bugtracker PluginManagerGramplet.py
Python Gramplet Gramplet 1.0.0 Interactive Python Shell 3.1.0 Developer 4 Stars Gramps Bugtracker PythonGramplet.py
GoogleEarth, Show places with Google Earth Map sevice 1.0.1 Shows one or more places by creating a kml/kmz file for use by Google Earth 3.1.0 All 3 Stars Peter G. Landgren GoogleEarthWriteKML.py
Descendant Count Quickview Quickview 3.1.1 Shows the number of descendants per generation of the current person 3.1.x All 4 Stars Reinhard Müller Descendant_count_3.1.1.tar.gz
Timeline Quickview Quickview 1.0.2 Shows timeline of events in immediate family members' lives 3.1.0 All 4 Stars Doug Blank TimelineQuickview.zip
Ancestoral, Personal Descendant, and Familial Descendant Reports Report 0.4.5
very stable but recoding 		Updated versions of the standard Graphical Ancestor and Descendant reports 3.1.0 All  ? Craig J. Anderson Graphical.zip
Family Groups and/or attributes Report 1.1.0 Lists FamilyGroups and display Identification Number attributes (v1.1 : Without "Numeric", not a standard module) 3.1.0 All  ? Jean-Francois Chassé FamilyGroups_1_1.py
Family Sheet Report 3.1.2 Generates a form with all information about a person, its spouses and its children. 3.1.x All 4 Stars Reinhard Müller FamilySheet_3.1.2.tar.gz
Family Tree Report 3.1.2 Generates a graphical tree of a family with its ancestors and descendants. 3.1.x All 3 Stars Reinhard Müller FamilyTree_3.1.2.tar.gz
Locations Report Report N/A Lists individuals with their locations. Use to clean up locations. 3.1.0 All  ? Jerome Rapinat Locations.py
Repositories Report Report N/A List sources related to repositories 3.1.0 All  ? Jerome Rapinat RepositoriesReport.py
Place completion tool Tool 1.2 Work on your places (add latitude, country, ...) 3.1.0 All  ? see file placecompletion_1_2.tar.gz
DenominoViso Website 2.1 Creates interactive graphical ancestor/descendant tree on a webpage. 3.1.3 All 3 Stars Michiel Nauta DenominoViso.py

Information for Plugin writers

Share it

Have you written a plugin for GRAMPS you want to share with the world? Here's how you do it:

  • Add the correct license. GRAMPS is GPLv2, you use the GRAMPS plugin system, so make sure you have the correct license at the top of your file. See Howto: Contribute to GRAMPS
  • Create a filename.tar.gz or filename.zip file of your plugin code
  • Upload the code to this wiki
  • Add an entry of your plugin to the list above.
  • Create a new wiki page, and refer to that page here, with a short description of what the plugin does

Internationalize it

There is a big possibility that you are not a native English speaker and want your report in your mother tongue. To enable others to use your report, and make it easy to include your report later in GRAMPS without large changes, do the following for text:

Translation function

  • Suppose you have a string Name, which you want for your own use in French, so Nom. Then write a translation function with the name _.
  • For every string, pass it through your translation function: _("Name")
  • Your translation function should then look like this: 
mytranslation = {
   'Name' : "Nom"
   }

from gettext import gettext
import locale
lang = locale.getlocale()[0]
if lang:
    lang = lang.split('_')[0]
def _(string):
    if lang == 'fr':
        return mytranslation.get(string, gettext(string))
    else:
        return gettext(string)

Change here 'fr' by the language code of your language

  • If the report becomes part of GRAMPS, it will suffice to delete this code and replace it by 
from gettext import gettext as _
  • Note that you only need to include strings that are not yet a part of GRAMPS, as those will be translated automatically by the gettext routine

Pitfalls

  • We support right to left languages like Arabic, so never constructs text parts by concatenation of pieces. Always use full sentences/paragraphs with variable substitution, so that a right to left language can translate it correctly.

Template

  • There is a possible template which lists references.

Translators may add references to their main translation.

Retrieved from "http://www.gramps-project.org/wiki/index.php?title=Third-party_Plugins&oldid=14804"
Personal tools