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.

Installing Plugins in GRAMPS

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

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:

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")

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.