15,534
edits
Changes
→Share it: so you don't have to change the page all the time
{{out of date|test it - instructions need updating}}
== Write it==
To get started writing a plugin, please see the following tutorials:
* [[Addons development]] - for Gramps version 3.2/3.3and later
* [[Gramplets]]
* [[Quick Views]]
* [[Report-writing tutorial]]
For more general GRAMPS Gramps development information, see:
* [[Simple Access API]]
* [[Using database API]]
* [[Getting started with GRAMPS Gramps development]]* [[Report_API|Report API]]* [[Report_Generation|Report Generation]]
== Test it ==
* See [[Unit_Test_Quickstart|Unit Test Quickstart]]
* Check syntax issues with [http://gramps-project.org/wiki/index.php?title=[Programming_Guidelines#Pylint pylint|Pylint]]
There is some samples of tests for localized [[Relationship_Calculator#Tests|Relationships calculators]] or [[Date_Handler#How_to_test_a_date_handler_for_your_locale|Date handlers]]:
== Share it==
Have you written a plugin for GRAMPS Gramps you want to share with the world? Here's how you do it:
* Add the correct license. GRAMPS Gramps is GPLv2, you use the GRAMPS Gramps plugin system, so make sure you have the correct license at the top of your file. See [[Howto: Contribute to GRAMPSGramps]]
* 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.2Third-party 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) ==
Please see [[Addons development]] for complete details.
Also, have a look at [[Coding_for_translation#Tips_for_writing_a_translatable_report|Coding for translation]].
==== Pitfalls Considerations ====
* 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.
[[Category:Developers/General]] [[Category:Plugins]] [[Category:Developers/Tutorials]][[Category:Addons]]
