Difference between revisions of "Writing a plugin"

From Gramps
Jump to: navigation, search
(Internationalize it (3.1 and prior))
(Share it)
Line 22: Line 22:
 
* Add an entry of your plugin to [[Plugins]]. See [[Plugin List Legend]] for meaning of columns. Please use these meanings and pay attention to details; this page is machine readable.
 
* Add an entry of your plugin to [[Plugins]]. See [[Plugin List Legend]] for meaning of columns. Please use these meanings and pay attention to details; this page is machine readable.
 
* Create a new wiki page, and refer to that page here, with a short description of what the plugin does
 
* Create a new wiki page, and refer to that page here, with a short description of what the plugin does
 
 
Also, have a look at [[Coding_for_translation#Tips_for_writing_a_translatable_report|Coding for translation]].
 
 
==== 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 [[Media:additional.pot.gz|template]] which lists references. (see [http://www.gramps-project.org/bugs/view.php?id=2771 this issue].)
 
Translators may add references to their main translation.
 
  
 
== Internationalize it (3.2 and later) ==
 
== Internationalize it (3.2 and later) ==

Revision as of 10:05, 24 January 2010

Write it

To get started writing a plugin, please see the following tutorials:

For more general GRAMPS development information, see:

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 Plugins. See Plugin List Legend for meaning of columns. Please use these meanings and pay attention to details; this page is machine readable.
  • Create a new wiki page, and refer to that page here, with a short description of what the plugin does

Internationalize it (3.2 and later)

This section describes a method of internationalizing your code for versions of Gramps 3.2 and later. The previous section describes a new method for Gramps 3.1 and earlier.

Please see Addons Development for complete details.