Difference between revisions of "Writing a plugin"

From Gramps
Jump to: navigation, search
Line 3: Line 3:
 
To get started writing a plugin, please see the following tutorials:
 
To get started writing a plugin, please see the following tutorials:
  
* [[Addons Development]] - for Gramps version 3.2
+
* [[Addons development]] - for Gramps version 3.2
 
* [[Gramplets]]
 
* [[Gramplets]]
 
* [[Quick Views]]
 
* [[Quick Views]]
Line 12: Line 12:
 
* [[Simple Access API]]
 
* [[Simple Access API]]
 
* [[Using database API]]
 
* [[Using database API]]
* [[Getting Started with GRAMPS development]]
+
* [[Getting started with GRAMPS development]]
  
 
== Share it==
 
== Share it==
Line 20: Line 20:
 
* Create a filename.tar.gz or filename.zip file of your plugin code
 
* Create a filename.tar.gz or filename.zip file of your plugin code
 
* Upload the code to this wiki
 
* Upload the code to this wiki
* Add an entry of your plugin to [[Plugins3.2]]. 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 [[Plugins3.2]]. 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
  
Line 27: Line 27:
 
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.
 
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.
+
Please see [[Addons development]] for complete details.
  
 
Also, have a look at [[Coding_for_translation#Tips_for_writing_a_translatable_report|Coding for translation]].
 
Also, have a look at [[Coding_for_translation#Tips_for_writing_a_translatable_report|Coding for translation]].

Revision as of 04:55, 30 March 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 Plugins3.2. 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.

Also, have a look at 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.