Changes

Jump to: navigation, search

Addons development

828 bytes added, 23:20, 27 October 2020
m
Example code adding common enhancements: snippit: add toolbar icon
# [[#List_and_document_your_addon_on_the_wiki|Document your addon]] and publish it to the addon list
# [[#List_your_addon_in_the_Gramps_Plugin_Manager|Register your addon with the Plugin Manager]]
# [[#Announce_it_on_the_Gramps_mailing_list|Announce it on the Gramps mailing list]] - 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
_("Remaining names | rest")
Where "rest" is the English string that we want to present and "Remaining names" is a hint for translators.
 
==== Commands to compile translations ====
 
To build and compile translations for all projects to their download/Addon.addon.tgz files:
 
: <code>python3 make.py gramps51 build all</code>
 
To compile translations for all projects :
 
: <code>python3 make.py gramps51 compile all</code>
== Create a Gramps Plugin Registration file ==
</pre>
{{man note|Note:|Running the command '''<code>make.py xxx 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".}}
This will 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.
git add gramps52/download/NewProjectName.addon.tgz
git commit -m " Added new plugin: NewProjectName"</pre>
 
== List your addon in the Gramps Plugin Manager==
[[Category:Developers/General]]
</pre>
 
== Miscellaneous commands ==
 
To build and compile translations for all projects to their download/Addon.addon.tgz files:
 
: <code>python3 make.py gramps51 build all</code>
 
To compile translations for all projects :
 
: <code>python3 make.py gramps51 compile all</code>
== Announce it on the Gramps mailing list ==
Join the [[Contact#Mailing_lists|Gramps Mailing lists]] and announce it to the users with general information on why you created and how to use it.
== Support it through issue tracker ==
* 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 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]]
;Gramps Addons site for Gramps 4.2 and newer
4,599
edits

Navigation menu