4,604
edits
Changes
m
→Analysis: registering the report
*{{man label|run_func}} = the function you create in this plugin and that Gramps will execute when the user selects your quick report in the menu
* {{man label|translated_name}} = the name of the report as it will appear in the menu
* [https://github.com/gramps-project/gramps/blob/892fc270592095192947097d22a72834d5c70447/gramps/gen/plug/_pluginreg.py#L58C6-L69 {{man label|status}} ] = is your report '''Stable''', '''Unstable''', '''Experimental''' and '''Beta'''*{{man label|description}} = a description of what your plugin does. This appears in a tooltip over the menu*{{man label|author_name}} = your name*{{man label|author_email}}= your email, so people can congratulate you with your work, or ask for bug fixes...
And beginning with Gramps 5.2 version, there are [https://github.com/gramps-project/gramps/pull/1451 additional registration properties]:
*{{man label|help_url}} = a webpage that will be opened when using the Help*[https://github.com/gramps-project/gramps/blob/892fc270592095192947097d22a72834d5c70447/gramps/gen/plug/_pluginreg.py#L71C8-L71C14-L76 {{man label|audience}} ] = filtering options: ‘All’, ‘Developer’ and ‘Expert’.*{{man label|maintainers}} = name of person currently maintaining the add-on, if different from the author_name*{{man label|maintainers_email}} = email of person currently maintaining the add-on, if different from the author_email*{{man label|requires_mod}}, {{man label|requires_gi}}, {{man label|requires_exe}} = if the addon has prerequisites.
===Analysis: the run function===
