16,602
edits
Changes
→Overview
==Overview==
Before going into details, it is useful to note that the report should have three basic parts:
;Report class : This is the code that takes data from the GRAMPS database and organizes it into the document structure. This structure can later be printed, viewed, or written into a file in a variety of formats. This class uses [http://www.gramps-project.org/api3/toc-BaseDoc-module.html BaseDoc] interface to abstract away the output format details.
;Options class : This is the code that provides means to obtain options necessary for the report using a variety of available mechanisms.
;Registration statement : This is a single call to <tt>register_report()</tt> function in the [http://gramps.sourceforge.net/api/public/PluginMgr.PluginMgr-class.html PluginMgr --> 404 Not Found <---]--[[User:Glh|Glh]] 10:32, 3 January 2008 (EST) module. It is trivial, but without it your report will not become available to GRAMPS, even if it is otherwise perfectly written.
