Difference between revisions of "Writing a plugin"
(→Share it) |
m (→Considerations) |
||
(7 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
− | {{ | + | {{languages|Writing a plugin}} |
+ | {{man tip|Writing a plugin|for Gramps version 3.2 and earlier}} | ||
+ | {{stub}}<!--test it - instructions need updating--> | ||
== Write it== | == Write it== | ||
Line 58: | Line 60: | ||
* 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]] | * 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 | * Create a filename.tar.gz or filename.zip file of your plugin code | ||
− | * Upload the code to Github | + | * Upload the code to Github (Fork https://github.com/gramps-project/addons-source ) and submit a Pull Request. |
− | * Add an entry of your plugin to [[Third-party | + | * Add an entry of your plugin to [[Third-party Addons]]. See [[Addon 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 73: | Line 75: | ||
==== Considerations ==== | ==== Considerations ==== | ||
− | * | + | * Gramps supports right to left (RTL) languages such as Arabic. So never construct text strings by concatenation of parts. Always use full sentences/paragraphs with variable substitution, so that a RTL language can translate it correctly. |
[[Category:Developers/General]] | [[Category:Developers/General]] | ||
+ | [[Category:Developers/Tutorials]] | ||
[[Category:Plugins]] | [[Category:Plugins]] | ||
− | |||
[[Category:Addons]] | [[Category:Addons]] |
Latest revision as of 15:02, 15 December 2023
Writing a plugin for Gramps version 3.2 and earlier |
This article's content is incomplete or a placeholder stub. |
Write it
To get started writing a plugin, please see the following tutorials:
- Addons development - for Gramps version 3.2 and later
- Gramplets
- Quick Views
- Report-writing tutorial
For more general Gramps development information, see:
- Simple Access API
- Using database API
- Getting started with Gramps development
- Report API
- Report Generation
Test it
- See Unit Test Quickstart
- Check syntax issues with Pylint
There is some samples of tests for localized Relationships calculators or Date handlers:
if __name__ == "__main__": # Test function. Call it as follows from the command line (so as to find # imported modules): # export PYTHONPATH=/path/to/gramps/src # python src/plugins/rel/rel_it.py """TRANSLATORS, copy this if statement at the bottom of your rel_xx.py module, and test your work with: python src/plugins/rel/rel_xx.py """ from Relationship import test RC = RelationshipCalculator() test(RC, True) def _test(rc, onlybirth, inlawa, inlawb, printrelstr): """ this is a generic test suite for the singular relationship TRANSLATORS: do NOT translate, use __main__ ! """ import sys import random ...
cd /home/me/grampssvn export PYTHONPATH=/home/me/grampssvn/src python src/plugins/rel/rel_it.py
cd /home/me/grampssvn export PYTHONPATH=/home/me/grampssvn/src pylint src/plugins/rel/rel_it.py > /home/me/grampssvn/src/plugins/rel/it.txt
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 Github (Fork https://github.com/gramps-project/addons-source ) and submit a Pull Request.
- Add an entry of your plugin to Third-party Addons. See Addon 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)
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.
Please see Addons development for complete details.
Also, have a look at Coding for translation.
Considerations
- Gramps supports right to left (RTL) languages such as Arabic. So never construct text strings by concatenation of parts. Always use full sentences/paragraphs with variable substitution, so that a RTL language can translate it correctly.