15,534
edits
Changes
→Common API
{|style="width:90%;margin-top:+.7em;margin-bottom:+.7em;background-color: #c0f0ff;border:1px solid #ccc; padding: 5px" align="center"|-|[[Image:Gnome-important.png]]| align="left" style="font-size:150%" |This is still a draft. Please don't link to it yet!|{stub}}
In GRAMPS Gramps there are six five different types of reports.
* Text report
* Graphical report
* Book reportGraph* Code generatorsBook* Web page generator* View only reportpagesOnly Text reports and , Graphical reports and Graphs use the Report (Document) API, since the latter three directly Web reports write their output directly into file(s) or onto the screenfiles, while Book reports are simply combination of Text reports and Graphical reports.
==Common API==
At the moment the combination of textual and graphical elements within one document is not supported (for future plans refer to [[Report API redesign]]), thus Text and Graphical reports are implemented via separate APIs, though they have a common part.This common part is implemented in the [http://www.gramps-project.org/api3docs/gen/BaseDocgen_plug.html#gen.plug.docgen.basedoc.BaseDoc-class.html BaseDoc class], which contains among others basic document opening, closing, and stylesheet handling methods. It also stores the physical description of a page (sheet of paper in print).
===Page===
[[Image:Doc_paper.png|thumbnailright|thumb|400px]] Description of the paper, which every report will be rendered on, is stored by an instance of the [http://www.gramps-project.org/api3docs/BaseDocgen/gen_plug.html#gen.plug.docgen.paperstyle.PaperStyle-class.html PaperStyle class]. This instance is available via the <tt>BaseDoc.paper_style</tt> class attribute. The chosen PaperStyle is given to the document generator at initialization, and is handled by the reporting framework.
==Text document API==
The specification of the Textdoc API is [https://pythonhosted.org/Gramps/gen/gen_plug.html#gramps.gen.plug.docgen.textdoc.TextDoc here] The interface for adding media objects is as follows: <pre> add_media_object(name, align, w_cm, h_cm, alt='', style_name=None, crop=None)[source] Add a photo of the specified width (in centimeters). Parameters: name – filename of the image to add align – alignment of the image. Valid values are ‘left’, ‘right’, ‘center’, and ‘single’ w_cm – width in centimeters h_cm – height in centimeters alt – an alternative text to use. Useful for eg html reports style_name – style to use for captions crop – image cropping parameters</pre> Note that because of the structure of these documents, Images are only allowed as children (i.e. following) Document or Cell. This interface is used in the following reports: {| {{Prettytable}} |-! Report! Built-in! align! style_name! how called|-| Detailed Ancestral Report| Built-in| right| DDR-Caption| via gen/plug/report/utils.py|-| Detailed Descendant Report| Built-in| right| DDR-Caption| via gen/plug/report/utils.py|-| Individual Complete Report| Built-in| right| None| direct|-| Book (Title Page)| Built-in| center| None| direct|-| Person Everything| Addon| single| PE-Level%d| direct|-|} None of the reports use 'alt'. It is understood (from looking at the code in odfdoc.py) that '''left''' and '''right''' alignment should cause the text to wrap around the media object, while for '''single''' alignment, there should be no text on either side of the media object. Since style_name should be used as the style for the caption (i.e. the '''alt''' string) it should also be used for the image itself. Otherwise the caption would not be below the picture. As at December 2014, output appears as follows: {| {{Prettytable}}|-! Format! right! center! single|-| HTML| '''OK''' Picture on right, text wrapped round it| ?| Picture on left margin, text not wrapped|-| RTF| Picture on left margin, text not wrapped| ?| '''OK''' Picture aligned with previous paragraph, text not wrapped|-| ODF| '''OK''' Picture on right, text wrapped round it| ?| Picture centred, text not wrapped|-| PDF| Picture on right, text not wrapped| ?| Picture on left margin, text not wrapped|-|} ==Draw document API== ==Graphical Graph document API== [[Category:Developers/Reference]][[Category:GEPS|R]][[Category:Plugins]][[Category:Reports|A]]