Changes

Jump to: navigation, search

GEPS 005: Enhanced Plugin Interface

750 bytes added, 04:33, 20 October 2014
no edit summary
# be more consistent across different types of plugins
# be more abstract
 
[[Category:GEPS]]
== Motivation ==
# Refactor the MenuOptions [under review]
# Add needed MenuOptions to cover all reports
# Update all of the reports to use abstract options ("menu" options) (see discussion here [http://wwwgramps.1791082.n4.nabble.com/RFC%3A-Improving-report-options-tf4381788td1796129.html#a12491034RFC: Improving report options] By Brian Matherly - Sep 05, 2007)
# Generalize the report dialogs and remove the need for a report plugin to ever need to define or customize a dialog.
# Rethink each plugin type (report, graph, tool, etc) to be a well-defined API
# Move each plugin registration and handler from its current specific register_TYPE() to generic register(type=TYPE)
 
== Third-Party Plugins ==
 
# Use the new two-file plugin format (.py + .gpr.py) together in a tgz file
# Possible directory-based format
# External SVN (http://sourceforge.net/projects/gramps-addons/)
# Plugin manager
# Need local translations
# Would be nice to incorporate an image of addon for browsing, and possible use in tool/report window.
# Need URL for documentation/updates
# Version number support for out-dated plugins
== Notes ==
### report() function defined in src/ReportBase/_ReportDialog.py
### which actually runs class from class Report
### src/ReportBase/_ReportDialog.py ReportDialog is the window
## Tool.gui_tool(dbstate, uistate, lst[0], lst[1], lst[2], lst[3], lst[4], dbstate.db.request_rebuild)
### gui_tool() function defined in /src/PluginUtils/_Tool.py
== Discussion ==
 
This proposal is discussed here:
*{{bug|1310}} - Plugin interface is too inflexible (resolved 2011)
*[http://gramps.1791082.n4.nabble.com/Report-vs-ReportDialog-question-td1796820.html Report vs. ReportDialog question], Douglas S. Blank, Oct 18, 2007
http://bugsIf you have ideas, comments, or questions, please note them here.gramps-project.org/view.php?id=1310
httpAs a first step, [[GEPS 014://wwwPlugin registration and management]] is being implemented.nabble.com/Report-vs.-ReportDialog-question-tf4645041.html
If you have ideas, comments, or questions, please note them here.[[Category:GEPS|E]]

Navigation menu