Open main menu

Gramps β

Changes

Addons development

17,031 bytes added, 10 March
→‎Get a local copy of Gramps and its addons
{{man tip|Information on developing Gramps addons|If you are looking for addons to install, visit: [[Third-party Addons]]}}{{man warn|WarningNote that this article anticipates that most addons will be developed under Linux.|([[Getting started with Gramps development|Linux is the principal development platform.]]) While it is possible to do so under Windows or MacOS, some of the steps will differ and the documented processes have not been as thoroughly reviewed. So developer beware.<br>See [[Portal:Developers]]}}If you are developing a [[Third-party Addons|This Third-party Addon]]; this page documents the API, methods, and best practices for developing a 3rd-party addon for Gramps 34.2 and later }}.
==What can addons extend?==Addons for Gramps can extend the program in many different ways. You can add any of the following [https://github.com/gramps-project/gramps/blob/master/gramps/gen/plug/_pluginreg.py types ] of addons:
# Doc creator<!-- sync with https://gramps-project.org/wiki/index.php?title=Addon_list_legend&action=edit&section=2 --> * '''Importer''' (IMPORT) - adds additional file format import options to Gramps# * '''Exporter''' (EXPORT) - adds additional file format export options to Gramps* '''[[Gramps_Glossary# gramplet|Gramplet]]''' (GRAMPLET) - adds a new interactive interface section to a Gramps view mode, which can be activated by right-clicking on the dashboard View or from the menu of the Sidebar/Bottombar in the other view categories. * '''Gramps [[Gramps_Glossary#viewmode|View ''(mode)'']]''' (VIEW) - adds a new view mode to the list of views available within a [[Gramps_Glossary# Importerview|View Category]]# * '''[[Map_Services|Map serviceService]]''' (MAPSERVICE) - adds new mapping options to Gramps# * '''Plugin lib''' (GENERAL) - libraries that are present giving extra functionality. Can add, replace and or modifies built-in Gramps options.* '''[[Gramps_{{man version}}_Wiki_Manual_-_Reports_-_part_8# Quick_Views|Quickreport'''/'''Quickview]]''' (QUICKREPORT) - a view that you can run by right-clicking on object, or if a person quickview, then through the Quick View Gramplet* '''[[Gramps_{{man version}}_Wiki_Manual_-_Reports_-_part_1|Report]]''' (REPORT) - adds a new output report / includes '''Website''' - output a static genealogy website based on your Gramps Family Tree data.* '''[[Gramps_{{man version}}_Wiki_Manual_-_Filters#Add_Rule_dialog|Rule]]''' (RULE) - adds new [[Gramps_Glossary# filter|filter]] rules. {{new|5.1}}* '''[[Gramps_{{man version}}_Wiki_Manual_-_Tools|Tool]]''' (TOOL) - adds a utility that helps process data from your family tree.* '''Doc creator''' (DOCGEN)* '''Relationships''' (RECALC)# Report* '''Sidebar''' (SIDEBAR)* '''[[Database_Backends|Database]]''' (DATABASE) - add support for another database backend. {{new|5.0}}# Tool* '''Thumbnailer''' (THUMBNAILER) {{new|5.2}}# View* '''Citation formatter''' (CITE) {{new|5.2}}
==Writing an addon==
Writing an addon is fairly straightforward if you have just a little bit of Python experience. And sharing your addon is the right thing to do. The general steps to writing an addon and sharing your own addons are:
# [[#Develop_your_addon|Develop your addon]]# [[#Create_a_Gramps_Plugin_Registration_file|Create a Gramps Plugin Registration file (.gpr.py)]]# Get translators to translate [[#internationalization|Invite translation of your addon ]] into multiple natural languages# [[#Package_your_addon|Package your addon]]# List [[#List_and_document_your_addon_on_the_wiki|Document your addon]] and document publish it to the addon list# [[#List_your_addon_in_the_Gramps_Plugin_Manager|Register your addonwith the Plugin Manager]]# [[#Announce_the_addon|Announce it on the Gramps Forum]] - Let users know it exist and how to use it.# [[#Support_it_through_issue_tracker|Support it through the issue tracker]]# [[#Maintain_the_code_as_Gramps_continues_to_evolve|Maintain the code ]] as Gramps continues to evolve
We'll now look at expand upon each of these steps in detailindividually.
== Develop your addon ==
The [http://svngithub.code.sf.net/pcom/gramps-project/addons/code/ gramps-source addons-source] subversion repository has holds the source code for the following structure:addons with branches holding the version for different gramps. If you are working on an addon for gramps for the current Gramps {{man version}} public release, be sure to use the maintenance/gramps52 git branch, as the default is master branch for the developmental pre-release. (Currently gramps 5.3, which is not the typical target for addons.)
* Example commands are shown below referring to the public release rather than the master branch. The developers are currently merging changes to the most recent maintenance branch into master as necessary, so you don't have to do anything for that unless you are in a hurry.  The [http://github.com/gramps-project/addons-source addons-source] git repository has the following structure, with the code for each addon in its own folder: * /addons-source** /trunk''IndividualNameOfAddon1''** /''IndividualNameOfAddon2''** ... The [http://github.com/gramps-project/addons addons] git repository holds built versions of the addons for each release of Gramps, and has the following structure: * /addons** [https://github.com/gramps-project/addons/tree/master/gramps42 /contribgramps42]
*** /download
*** /listings** [https://github.com/gramps-project/addons/tree/master/gramps50 /gramps50]*** /branchesdownload*** /listings** [https://github.com/gramps{{stable_branch}}-project/addons/tree/master/gramps51 /gramps51]*** /gramps32download*** /listings** [https://github.com/gramps-project/addons/tree/master/gramps52 /contribgramps52]*** /download*** /downloadlistings
The contrib subdirectories hold the source code for the addons for === Get a particular version. If you are working on a addon for gramps{{stable_branch}} then you should be working in gramps-addons/branches/gramps{{stable_branch}}/contrib. If you are working in gramps/trunk then you should use gramps-local copy of Gramps and its addons/trunk/contrib.===
These steps show how to download and work with the addon development toolssources.
# Checkout the gramps-addons files from the [Get an https://sourceforgegithub.netcom/projects/gramps-addons/ gramps-addons] project:join account if you don't already have one.## cd into gramps trunk, Request GIT write access for examplethe https:### cd ~//github.com/gramps-project/trunkaddons-source project by emailing the [[Contact## Checkout Mailing_lists|gramps-addons:devel mailing list]]### svn co See also [[Brief_introduction_to_Git|git introduction]] for instructions on installing git and getting basic settings configured. Also [https://svnhelp.codegithub.sf.netcom/particles/grampsgenerating-addons/code grampsan-addons## Change to trunk or branches/gramps{{stable_branch}} directory:### cd grampsssh-addonskey/branches/gramps{{stable_branch}}/contrib Connecting to GitHub with SSH] will help with setting up credentials for GitHub.# Make To fully build and advertise a new project directory in grampsaddon will require local copies of the three repositories, the 'addons-addon/branches/source', 'addons' and the main Gramps source 'gramps{{stable_branch}}/contrib:## mkdir NewProjectName# Initialize the addon:## ./make'.py init NewProjectName
NOTE: to use This wiki assumes that all three git repositories local locations are put into the same base directory and named with the repository names in order for the make.py script commands to work as shown throughout this document. From the base directory, run the following commands to create a copy of each repository. If you may have want to use:SSH;
GRAMPSPATH= git clone [email protected]:gramps-project/pathaddons-source.git addons-source git clone [email protected]:gramps-project/toaddons.git addons git clone [email protected]:gramps-project/gramps python make.py ...git gramps
or if the default ("../../..") is not correct.you want to use a web url:
Follow the development API for your tool, [[Report git clone https://github.com/gramps-writing_tutorial|report]], view, or [[Gramplets]]project/addons-source. Place all of your associated git addons-source git clone https://github.py, com/gramps-project/addons.glade, etcgit addons git clone https://github. files in this directory. For general information on Gramps development see [[Portal:Developers]] and [[Writing a Plugin]] specificallycom/gramps-project/gramps.git gramps
To test your addon as you develop it it is suggested that you replace your Gramps user plugin directory with switch to a link to your addon development directory, like solocal copy of the gramps52 maintenance branch:
cd ~/.gramps/gramps{{stable_branch}}/ mv plugins/* /wherever/trunk/gramps-addons/branches/gramps{{stable_branch}}/contrib/ rm -rf pluginssource ln git checkout -s /wherever/trunk/gramps-addons/branchesb gramps52 origin/gramps{{stable_branch}}maintenance/contrib pluginsgramps52
Gramps will search this folder (and subdirectories) for .grp.py files, and add them or to work in the plugin list.master branch:
If you have code that you want to share between cd addons, you don't need to do anything special. Currently, Gramps adds each directory in which a .gpr.py is found onto the PYTHONPATH which is searched when you perform an import. Thus "import NewProjectName" will work from another addon. You should always make sure you name your addons with a name appropriate for Python imports.-source git checkout -b gramps53 origin/master
To commit === Other prerequisites ==={{man warn|These instructions, the make.py script etc.|are designed to operate in a Linux environment. {{man menu|They won't work on Windows without modifications.}}}}* Gramps uses Python version 3.2 or higher. You must have at least that version installed. If you have installed Gramps 4.2 or higher on your changes Linux system already, then a sufficient version of Python will be present. If you have more than one version of Python installed, then you must use the correct version for these scripts. On some systems, both Python 2.x and 3.x are installed. It is possible that the normal invocation of <code>python</code> starts up Python 2.x, and that to start up Python 3.x requires invoking with <code>python3</code> or <code>python3.4</code> etc. You can test the version by <code>python –version</code> or <code>python3 –version</code>. If this is so , replace any usage of 'python' in the examples below with the appropriate invocation.* The make.py used in construction of the addons requires that the LANGUAGE environment variable be set to 'en_US.UTF-8'. * The make.py used in construction of the addons requires that others can use the GRAMPSPATH environment variable be set to your addon, follow these stepspath to the Gramps source tree.* intltool must be installed;:<code>sudo apt-get install intltool</code>
# Get an http:For example if your home directory is '/home/sourceforge.net account if name' and you don't already have one.use the suggested path names, use# Request SVN write access for the gramps-addon project from https:<code>GRAMPSPATH=/home/name/sourceforgegramps LANGUAGE='en_US.UTF-8' python3 make.py .net/project/memberlist.php?group_id=285429 [http://sourceforge.net/p/allura/tickets/5481</]code># Remove to replace the files that should not be added to SVN:## <code>./make.py clean NewProjectName# Add </code> in the project to the repository:## svn add NewProjectName## svn commit -m "A message describing what this addon is"examples below.
Before making additional edits to === Create your addon, you shouldsubdirectory ===* Make a new project directory in addons-source:: <code>mkdir NewProjectName</code>
# svn update===Follow the development API for your tool===Create your NewProjectName.py and NewProjectName.gpr.py files. Follow the development API for your tool, [[Report-writing_tutorial|report]], view, or [[Gramplets]]. Place all of your associated .py, .glade, etc. files in this directory. For general information on Gramps development see [[Portal:Developers]] and [[Writing a plugin|Writing a Plugin]] specifically. === Test your addon as you develop === {{man warn|{{bug|10436}} Symlinks to folders in gramps plugin dir are not scanned}} To test your addon as you develop it is suggested that you copy your NewProjectName plugin into your Gramps user plugin directory from your addon development directory, prior to testing. Or just edit in the Gramps user plugin directory until it is ready to publish, then copy back to your addon development directory. Your installed Gramps will search this folder (and subdirectories) for .gpr.py files, and add them to the plugin list. If you have code that you want to share between addons, you don't need to do anything special. Gramps adds each directory in which a .gpr.py is found onto the PYTHONPATH which is searched when you perform an import. Thus "import NewProjectName" will work from another addon. You should always make sure you name your addons with a name appropriate for Python imports. === Commit your changes ===To commit your changes so that others can see your addon source. * Remove the files using the ''clean'' command that should not be added to GitHub (eg files(template.pot/ locale etc)):: <code>./make.py gramps52 clean NewProjectName</code>* Add the project to the repository:: <code>git add NewProjectName</code>* Commit it with an appropriate message: <code>git commit -m "A message describing what this addon is"</code> Before committing additional edits to your addon, you should: * to make sure that outside changes do not affect your commit: <code>git pull --rebase</code>* only the files you changed should be in this list# svn : <code>git status</code>* Commit it with an appropriate message# svn : <code>git commit -m "A message describing the changes"</code> If you have been given 'push' rights to GitHub 'gramps-project/addons-source', and when you are sure you are done and want to publish to the repository: * to make sure that outside changes do not affect your commit: <code>git pull --rebase</code>: <code>git push origin gramps52</code> Also you may want to [[Addons_development#Package_your_addon |Package your addon]] so it can be downloaded via the plugin manager.
=== Config ===
Some addons may want to have persistent data (data settings that remain between sessions). You can handle this yourself, or you can use Gramps' built-in configure system.
In At the top of the source file that defines the settingsof your addon, you would do this:
from config import configas configman cm config = configconfigman.register_manager("view_placetreeview_0grampletname") cm# register the values to save: config.register("section.variable1option-name1", value1) cmconfig.register("section.variable2option-name2", value2)
...
cm# load an existing file, if one: config.initload() # save it, it case it didn't exist: config.save()
This will create the file "view_placetreeview_0grampletname.ini" and put in the same directory as the addon. In If the addonconfig file already exists, you can then:it remains intact.
In the addon, you can then:  x = cmconfig.get("section.variable1option-name1") cmconfig.set("section.variable1option-name1", 3)
and when this code is exiting, you might want to save the config. In a Gramplet that would be:
def on_save(self):
cmconfig.save()
If your code is a system-level file, then you might want to save the config in the Gramps system folder:
cm config = configconfigman.register_manager("system", use_config_path=True)
This, however, would be rare; most .ini files would go into the plugins directory.
In other code that might use this config file, you would do this:
from config import configas configman cm config = configconfigman.get_manager("view_placetreeview_0grampletname") x = cmconfig.get("section.variable1option-name1")
=== Localization ===
For general help on translations in Gramps, see [[Coding for translation]]. However, that will only use translations that come with Gramps, or allows you to contribute translations to the Gramps core. To have your own managed translations that will be packaged with your addon, read the rest of this page.
Note that these instructions will only work for Python strings, if you have a glade file, it will not get translated.
For any addon which you have translations into other languages, you will need to add a way to retrieve the translation. You need to add this to the top of your NewProjectName.py file:
==== For Gramps 3: ====
from TransUtils import get_addon_translator
_ = get_addon_translator(__file__).gettext
 
==== For Gramps 4: ====
from gramps.gen.const import GRAMPS_LOCALE as glocale
_ = glocale.get_addon_translator(__file__).gettext
# lngettext
# sgettext
 
Gramps 3 also provides:
 
# ugettext
# ungettext
These have become obsolete in Gramps 4; gettext, ngettext, and sgettext always return translated strings in unicode for consistent portability between Python 2 and Python3.
'''sgettext''' is a Gramps extension that filters out clarifying comments for translators, such as
_("Remaining names | rest")Where "rest" is the English string that we want to present and "remaining Remaining names" is a hint for translators which let them know that we mean "what's left" rather than "take a nap". ==== Commands to compile translations ==== To build and compile translations for all projects to their download/Addon.addon.tgz files: : <code>python3 make.py gramps52 build all</code> To compile translations for all projects : : <code>python3 make.py gramps52 compile all</code>
== Create a Gramps Plugin Registration file ==
<pre>
register(PTYPE,
gramps_target_version = "35.42",
version = "1.0.0",
ATTR = value,
</pre>
[https://github.com/gramps-project/gramps/blob/master/gramps/gen/plug/_pluginreg.py#L76 PTYPE ] is TOOL, GRAMPLET, REPORT, QUICKREPORTQUICKVIEW, IMPORT, EXPORT, DOCGEN, GENERAL, MAPSERVICE, VIEW, or RELCALC. 
ATTR depends on the PTYPE. But you must have '''gramps_target_version''' and '''version'''. '''gramps_target_version ''' should be a string of the form "X.Y" version number matching Gramps X major, Y minor integer. '''version ''' is a string of the form "X.Y.Z" representing the version of your addon. X, Y, and Z should all be integers.
Here is a sample Tool GPR file:
description = _("Attaches a shared source to multiple objects."),
version = '1.0.0',
gramps_target_version = '35.42',
status = STABLE,
fname = 'AttachSourceTool.py',
</pre>
You can see examples of the kinds of addons [httphttps://svngithub.code.sf.net/pcom/gramps/code/trunk-project/gramps/plugins/ here] (for example, see [httphttps://svn.codegithub.sf.net/pcom/gramps/code/trunk-project/gramps/plugins/drawreport/drawplugins.gpr.py trunk/gramps/plugins/drawreport/drawplugins.gpr.py]) and see the full documentation in the [httphttps://svngithub.code.sf.netcom/gramps-project/gramps/blob/p3f0db9303f29811b43325c30149c8844c7ce24b6/gramps/codegen/trunkplug/_pluginreg.py#L23 master/gramps/gen/plug/_pluginreg.py here] in the comments and docstrings.
Note that this .gpr.py will automatically use translations if you have them (see below). That is, the function "_" is predefined to use your locale translations; you only need to mark the text with _("TEXT") and include a translation of "TEXT" in your translation file. For example, in the above example, _("Attach Source") is marked for translation. If you have developed and packaged your addon with translation support, then that phrase will be converted into the user's language.
=== Report plugins ===
The possible report categories are ([https://github.com/gramps-project/gramps/blob/892fc270592095192947097d22a72834d5c70447/gramps/gen/plug/_pluginreg.py#L141-L149 gen/plug/_pluginreg.py]):
<pre>
#possible report categories
CATEGORY_BOOK = 4
CATEGORY_GRAPHVIZ = 5
CATEGORY_TREE = 6
REPORT_CAT = [ CATEGORY_TEXT, CATEGORY_DRAW, CATEGORY_CODE,
CATEGORY_WEB, CATEGORY_BOOK, CATEGORY_GRAPHVIZ, CATEGORY_TREE]
</pre>
Each report category has a set of standards and interface. The categories CATEGORY_TEXT and CATEGORY_DRAW use the Document interface of Gramps. See also [[Report API]] for a draft view on this.
 The application programming interface or API for reports is treated at [[Report-writing_tutorial]]. For general information on Gramps development see [[Portal:Developers]] and [[Writing a plugin|Writing a Plugin]] specifically.
=== General plugins ===
description = _("Provides a library for doing something."),
version = '1.0',
gramps_target_version = '35.42',
status = STABLE,
fname = 'library.py',
Runs when plugin is registered.
"""
print ("Hello World!")
</pre>
category = "WEBSTUFF",
version = '1.0',
gramps_target_version = '35.42',
data = ["a", "b", "c"],
)
description = _("Provides a collection of stylesheets for the web"),
version = '1.0',
gramps_target_version = '35.42',
fname = "stylesheet.py",
load_on_reg = True,
def filters(namespace):
print ("Ok...", plugin.category, namespace, uistate)
# return a Filter object here
return filters
</pre>
 
<span id=internationalization>
 
== List the Prerequistes your addon depends on ==
 
''In your gpr file, you can have a line like:
 
<code>depends_on = ["libwebconnect"]</code>
 
which is a list of id's from other gpr files. This example will ensure that [[Addon:Web_Connect_Pack#Prerequisites|libwebconnect]] is loaded before your addon. If it can't be found, or you have a cycle, then your addons won't be loaded.
 
example code used in the Addon:Web_Connect_Pack that references libwebconnect Prerequistes [https://github.com/gramps-project/addons-source/blob/1304b65a7d758bfe17339c26260473ac3e9c4061/RUWebConnectPack/RUWebPack.gpr.py#L17 RUWebPack.gpr.py#L17 ]
 
This means that common Prerequistes can be shared between addons and that code sits in its own gpr/addon file.
 
<!--
 
[] for addon prerequistes have a look at converting them to use "depends_on = " like in the following addons
https://github.com/gramps-project/addons-source/search?utf8=%E2%9C%93&q=depends_on&type=
https://github.com/gramps-project/gramps/search?utf8=%E2%9C%93&q=depends_on&type=
 
which can be a comma separated list for multiple dependencies/prerequisites (so that addons that share prerequisites import the same library?) (maybe move spell check into an addon etc? tip of the day... possibilities...)
 
depends_on = ["libwebconnect"]
 
mentioned in the following
https://sourceforge.net/p/gramps/mailman/message/27070037/
''In your gpr file, you can have a line like:
 
depends_on = ["libwebconnect"]
 
which is a list of id's from other gpr files. This example will ensure
that libwebconnect is loaded before your plugin. If it can't be found,
or you have a cycle, then your plugin won't be loaded.
 
If it is a common function, perhaps libhtml is the right place to put
it, and you can put a depends_on on that.
 
-Doug''
 
 
example output is on terminal only:
 
Cannot resolve the following plugin dependencies:
Plugin 'UK Web Connect Pack' requires: ['libwebconnect']
 
[](feature) For plugins/addons if prerequisites not available display a page stating why/what is missing that includes the addon description and a url to the support page.
 
[] Gramps CLI info "gramps -v" needs a section that list third-party addons with version numbers and if prerequisites have been met.
 
[]update the Addon:Prerequisites Checker Gramplet to test for your Prerequisites.
 
-->
== Get translators to translate your addon into multiple languages ==
</span>If you [[# Localization|designed for localization]], the addon will begin supporting a single language. Make your addon inviting for volunteers to translate it into their native language.* Initialize and update the <code>template.pot </code> for your addon:## : <code>cd ~/addons-source</code>: <code>./make.py gramps52 init NewProjectName</code># * You should edit the header of <code>template.pot</code> with your information, so it gets copied to individual language files.* Initialize a language for your addon (say French, fr):## : <code>./make.py gramps52 init NewProjectName fr</code># * Update it from gramps and other addons:## : <code>./make.py gramps52 update NewProjectName fr</code># * Edit contribthe translations file manually:: <code>/NewProjectName/po/fr-local.po</code># * Compile the language:## : <code>./make.py gramps52 compile NewProjectName</code># * Add or update your local language file, and commit changes:## svn : <code>git add NewProjectName/po/fr-local.po</code>## svn : <code>git commit NewProjectName/po/fr-local.po -m "Added fr po file"</code>* If you have been given 'push' rights to GitHub 'gramps-project/addons-source', then;: <code>git push origin gramps52</code>
== Package your addon ==
To create a downloadable package:
: <code>./make.py gramps52 build NewProjectName</code> python or: <code>./make.py gramps53 build NewProjectName</code> for the master branch. This will automatically include the following files in your build:
That will build and copy your addon to * *.py* *.glade* *.xml* *.txt* locale/download*/LC_MESSAGES/*.mo
NOTE: Running the '''makeStarting with Gramp 5.py build''' will increment 0, if you have additional files beyond those listed above, you should create a MANIFEST file in the third number in root of your dotted version number of all addons in addon folder listing the gpr.py files (or pattern) one per line, like this sample MANIFEST file. Consider this number to be a "build number".:
''New for Gramps 3<pre>README.4'': You need to then make your addon available in listings of various languagesmdextra_dir/*help_files/docs/help. To do that:html</pre>
python {{man note|Note:|Running the command <code>make.py listingxxx build</code> will increment the third number in your dotted version number of all addons in the <code>*.gpr.py</code> file. Consider this number to be a "build number".}}
That This will create a series of files in leave your 'addons-source' with untracked changes according to git. You should delete the 'NewProjectName/locale' directory. The updated 'NewProjectName/NewProjectName.gpr.py ' is ready to add and commit the next time you make other changes.: <code>rm –rf –v 'NewProjectName/listingslocale'</ code>
Then add the package to SVNGitHub:
svn <pre> cd '~/addons' git add ..gramps52/download/NewProjectName.addon.tgz .. git commit -m "Added new plugin: NewProjectName"</listingspre>or (for the master branch);<pre> cd '~/*addons' cd git add gramps53/download/NewProjectName.addon.tgz svn git commit -m "Message describing changesAdded new plugin: NewProjectName"</pre>
== Miscellaneous commands List your addon in the Gramps Plugin Manager==
To {{man warn|Gramps needs to have been built|Make sure you have already built gramps52 or master. Change to the appropriate git branch in your gramps directory, and run <code>python3 setup.py build all projects</code> See [[Linux:Build_from_source]]}}
python make.py build allTo create a listing:
To compile all projects : <code>cd '~/gramps-addons'</code> or wherever you have built your addon: <code>GRAMPSPATH=path/to their download/Addonyour/gramps/install ./make.py gramps52 listing NewProjectName</code>or (for the master branch);: <code>cd '~/gramps-addons'</code> or wherever you have built your addon: <code>GRAMPSPATH=path/to/your/gramps/install ./make.tgz files:py gramps53 listing NewProjectName</code>
python makeThat will create a series of files in the <tt>../listings/</tt> directory.py compile all
== List and document your addon ==Then add the updated listing to GitHub:
Edit [[Plugins3.4]] <pre> cd '~/addons' git add gramps52/listings/* git commit -m "Added new plugin to listings: NewProjectName"</pre>or [[Plugins4.0]] and describe your addon. You can point (for the master branch);<pre> cd '~/addons' git add gramps53/listings/* git commit -m " Added new plugin to the addon.tgz in SVN as the downloadable file. listings: NewProjectName"</pre>
== List and document your addon on the wiki== ===List your addon===Add a short description of your addon to the Addons list by editing the current release listing eg: [[5.2_Addons]] or if the addon is meant for a future release [[5.3_Addons]] when available. ==== Example addon template ====Examine the listing for other addons and refer to the [[Addon list legend]] for details of on the meaning of each columns.<pre>|- <!-- Copy this section and list your Addon -->|<!-- Plugin / Documentation -->|<!-- Type -->|<!-- Image -->|<!-- Description -->|<!-- Use -->|<!-- Rating (out of 4) -->|<!-- Contact -->|<!-- Download -->|-</pre> ===Document your addon===Document the addon in the wiki using the page name '''"format of {{man menu|Addon:NewProjectName"''}} examine the other addon support pages for the general format to use.{{man tip|Hint on creating a new wiki page.|To create a new wiki page use the search box to search for the name of your page that doesn't exist then on the search results page you will be provided with a link to create the new page, by selecting and you can add your content}} ====Example addon article====Consider including the following information: <pre><!-- Copy this section to your Addon support page-->{{Third-party plugin}}<!-- This is a mediawiki template that expands out to display the standard addon message you see at the top of each addon page--> <!--sections only add if needed-->== Usage == === Configure Options === ==Features== == Prerequisites == == Issues == <!--default categories-->[[Category:Addons]][[Category:Plugins]][[Category:Developers/General]]</pre> == Announce the addon ==Join the [[Contact#Forum|Gramps Forum]] and announce it to the users with general information on why you created and how to use it.
== Support it through issue tracker ==
Visit httpBecome a user on the [https://www.gramps-project.org/bugs/view_all_bug_page.php Gramps MantisBT (Mantis BugTracker)]. and become a user. Suggest to please check it regularly. There is no automated notification of issues (and possible feature requests) related to your addon when reported by users.  Users tend to not understand coding and they make assumptions. So be kind and guiding if a report is ambiguous or inaccurate. A negative remark from an addon developer or anyone can be very discouraging.
== Maintain the code as Gramps continues to evolve ==
 
{{man tip|When submitting an update the patch part of the version number MAJOR.MINOR.PATCH is updated during the addon build process e.g. 1.1.3 to 1.1.4|You can find this step in [https://github.com/gramps-project/addons-source/blob/master/make.py#L125 addons-source/make.py].[https://gramps.discourse.group/t/should-addons-pr-include-version-number-update/2591]}}
 
Remember that Gramps addons exist for many reasons and there are many Gramps developers that do support addons in various ways (translations, triage, keeping in sync with master, download infrastructure, etc).
 
Some reasons why the addons exist; they provide:
* A quick way for anyone to share their work; the Gramps-project has never denied adding a addon.
* A method to continuously update and develop a stand-alone component, often before being officially accepted.
* A place for controversial plugins that will never be accepted into core, but are loved by many users (eg, Data Entry Gramplet).
* A place for experimental components to live.
 
== Example code adding common enhancements ==
* Copy all the Gramplet's output to a system clipboard via context pop-up menu : Enhancement request {{bug|11573}}, [https://github.com/gramps-project/gramps/pull/1014/commits/72012e13b4ca15caca4b7f36fdb9702c1fd470fd example pull]
* add a custom [[Gramps_Glossary#viewmode|View Mode]] toolbar icon via the <code>.gpr.py</code> : [https://github.com/gramps-project/gramps/pull/1017 Pull 1017 Discussion], [https://github.com/gramps-project/gramps/pull/1017/commits/76e41d546d6ec519dd78fbe07f663135b5c79351 example Pull]
= Resources =
* [[Brief_introduction_to_Git|Git introduction]]
* [[Getting started with Gramps development]]
* [[Portal:Developers]]
* [https://gramps-project.org/docs/gen/gen_plug.html?highlight=include_in_listing#module-gramps.gen.plug._pluginreg Registration Module]
;Gramps Addons site for Gramps 4.2 and newer* httphttps://github.com/gramps-project/addons-source - Source code (Git)* https://github.svn.sourceforge.net/viewvccom/gramps-project/addons/ - SVN browsedownloadable .tgz files;Gramps Addons site for Gramps 4.1 and older* For 4.1.x and earlier, see [[Addons development old]]. = Addon Development Tutorials and Samples =* [[Report-writing_tutorial|Report-writing Tutorial]]* [[Quick_Views|Quick Views]]* [[Gramplets|Gramplets]]* [[Develop_an_Add-on_Rule|Develop an Add-on Rule]]* [[Develop_an_Add-on_Tool|Develop an Add-on Tool]]* [[Adapt_a_built-in_Report|Adapt a built-in Report]]
[[Category:Developers/General]]
[[Category:Reports]]
[[Category:Gramplets]]
[[Category:Addons]]
Retrieved from "https://gramps-project.org/wiki/index.php/Special:MobileDiff/44063...102511"