Report API - Revision history

Patsyblefebre: /* Page */ 400px

2013-02-13T03:34:37Z

‎Page: 400px

Patsyblefebre: Gramps

2013-02-13T03:33:04Z

Gramps

Patsyblefebre: {{Out of date}}

2012-12-28T02:30:33Z

Nick H: Update with latest report types

2012-03-04T17:45:56Z

Update with latest report types

Romjerome at 10:22, 3 March 2012

2012-03-03T10:22:56Z

Romjerome at 09:38, 3 March 2012

2012-03-03T09:38:14Z

Romjerome at 09:27, 3 March 2012

2012-03-03T09:27:17Z

Sam888 at 02:23, 3 March 2012

2012-03-03T02:23:50Z

Romjerome: /* Common API */

2012-03-02T20:08:58Z

‎Common API

Romjerome: /* Page */

2012-03-02T20:07:33Z

‎Page

@@ Line 16: / Line 16: @@
 ===Page===
-[[Image:Doc_paper.png|thumbnail]] Description of the paper, which every report will be rendered on, is stored by an instance of the [http://www.gramps-project.org/docs/gen/gen_plug.html#gen.plug.docgen.paperstyle.PaperStyle 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.
+[[Image:Doc_paper.png|right|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/docs/gen/gen_plug.html#gen.plug.docgen.paperstyle.PaperStyle 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.
 The <tt>PaperStyle</tt> holds information on the size of the paper ([http://www.gramps-project.org/docs/gen/gen_plug.html#gen.plug.docgen.paperstyle.PaperStyle PaperSize class] instance), the size of the margins, and the orientation of the paper. Use the proper accessor methods to get the values. To get the metrics of the usable area of a paper (page without the margins) one can also use the [http://www.gramps-project.org/docs/gen/gen_plug.html#gen.plug.docgen.paperstyle.PaperStyle.get_usable_width PaperStyle.get_usable_width] and [http://www.gramps-project.org/docs/gen/gen_plug.html#gen.plug.docgen.paperstyle.PaperStyle.get_usable_height PaperStyle.get_usable_height] convenience methods. Width and height are always given according to the orientation of the paper, thus width is always the horizontal, and height is always the vertical dimension.
@@ Line 24: / Line 24: @@
 The origin of the coordinate system is the top left corner of the usable area.
-<br clear="all" />
 ==Text document API==

@@ Line 1: / Line 1: @@
 {{Out of date}}
-In GRAMPS there are five different types of reports.
+In Gramps there are five different types of reports.
 * Text report
 * Graphical report

← Older revision		Revision as of 02:30, 28 December 2012
Line 1:		Line 1:
		+	{{Out of date}}
		+
	In GRAMPS there are five different types of reports.		In GRAMPS there are five different types of reports.
	* Text report		* Text report

@@ Line 1: / Line 1: @@
-In GRAMPS there are six different types of reports.
+In GRAMPS there are five different types of reports.
 * Text report
 * Graphical report
-* Book report
+* Graph
-* Code generators
+* Book
-* Web page generator
+* Web pages
-* View only report
+Only Text reports, Graphical reports and Graphs use the Report (Document) API, since Web reports write their output directly into files, while Book reports are simply combination of Text reports and Graphical reports.
-Only Text reports and Graphical reports use the Report (Document) API, since the latter three directly write their output into file(s) or onto the screen, while Book reports are simply combination of Text reports and Graphical reports.
 ==Common API==
@@ Line 27: / Line 26: @@
 ==Text document API==
-==Graphical document API==
+==Draw document API==
 [[Category:Developers/Reference]]

@@ Line 32: / Line 32: @@
 [[Category:GEPS|R]]
 [[Category:Plugins]]
-[[Category:Reports]]
+[[Category:Reports|A]]

← Older revision		Revision as of 09:38, 3 March 2012
Line 32:		Line 32:
	[[Category:GEPS\|R]]		[[Category:GEPS\|R]]
	[[Category:Plugins]]		[[Category:Plugins]]
		+	[[Category:Reports]]

← Older revision		Revision as of 09:27, 3 March 2012
Line 31:		Line 31:
	[[Category:Developers/Reference]]		[[Category:Developers/Reference]]
	[[Category:GEPS\|R]]		[[Category:GEPS\|R]]
		+	[[Category:Plugins]]

← Older revision		Revision as of 02:23, 3 March 2012
Line 1:		Line 1:
−	~~{\|style="width:70%; border:1px solid #c0a0a0" align="center"~~
−	\|-
−	~~\| style="width:10px; padding:0; background-color:#c00000" \|~~
−	~~\| style="width:60px; padding:0" align="center"\| [[Image:Gnome-important.png\|40px]]~~
−	~~\| style="padding:0" align="left" \| '''This is still a draft. Please don't link to it yet!'''~~
−	\|}
−
	In GRAMPS there are six different types of reports.		In GRAMPS there are six different types of reports.
	* Text report		* Text report

@@ Line 17: / Line 17: @@
 ==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/docs/gen/gen_plug.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).
+This common part is implemented in the [http://www.gramps-project.org/docs/gen/gen_plug.html#gen.plug.docgen.basedoc.BaseDoc 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).
 '''Note!''' The <tt>BaseDoc.open</tt> and the <tt>BaseDoc.close</tt> methods have to be implemented by the subclassed document generators.

@@ Line 22: / Line 22: @@
 ===Page===
-[[Image:Doc_paper.png|thumbnail]] Description of the paper, which every report will be rendered on, is stored by an instance of the [http://www.gramps-project.org/api3/BaseDoc.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.
+[[Image:Doc_paper.png|thumbnail]] Description of the paper, which every report will be rendered on, is stored by an instance of the [http://www.gramps-project.org/docs/gen/gen_plug.html#gen.plug.docgen.paperstyle.PaperStyle 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.
-The <tt>PaperStyle</tt> holds information on the size of the paper ([http://www.gramps-project.org/docs/gen/gen_plug.html?highlight=paperstyle#gen.plug.docgen.paperstyle.PaperStyle PaperSize class] instance), the size of the margins, and the orientation of the paper. Use the proper accessor methods to get the values. To get the metrics of the usable area of a paper (page without the margins) one can also use the [http://www.gramps-project.org/docs/gen/gen_plug.html?highlight=paperstyle#gen.plug.docgen.paperstyle.PaperStyle.get_usable_width PaperStyle.get_usable_width] and [http://www.gramps-project.org/docs/gen/gen_plug.html?highlight=paperstyle#gen.plug.docgen.paperstyle.PaperStyle.get_usable_height PaperStyle.get_usable_height] convenience methods. Width and height are always given according to the orientation of the paper, thus width is always the horizontal, and height is always the vertical dimension.
+The <tt>PaperStyle</tt> holds information on the size of the paper ([http://www.gramps-project.org/docs/gen/gen_plug.html#gen.plug.docgen.paperstyle.PaperStyle PaperSize class] instance), the size of the margins, and the orientation of the paper. Use the proper accessor methods to get the values. To get the metrics of the usable area of a paper (page without the margins) one can also use the [http://www.gramps-project.org/docs/gen/gen_plug.html#gen.plug.docgen.paperstyle.PaperStyle.get_usable_width PaperStyle.get_usable_width] and [http://www.gramps-project.org/docs/gen/gen_plug.html#gen.plug.docgen.paperstyle.PaperStyle.get_usable_height PaperStyle.get_usable_height] convenience methods. Width and height are always given according to the orientation of the paper, thus width is always the horizontal, and height is always the vertical dimension.
 Text reports do not need to care about paper properties, as the document generator (or the external viewer) paginates the report according to those properties. While, on the other hand, graphical reports do need to take paper properties into account when creating graphical elements, i.e. they should not draw on the margins.