Documentation Parts

From RLIB

Jump to: navigation, search

Parts are a collection of reports and/or graphs. This means with Parts, multiple reports/graphs can be put into a single output.

Contents

<Part>

It may contain the tag attributes below:

  • name=expS, the name of the report collection
  • pages_across=expN
  • fontSize=expN, default font size of the report collection
  • orientation=expS, orientation of the report collection. Possible values are: "portrait", "landscape"
  • top_margin=expN, top margin for the report collection
  • left_margin=expN, left margin for the report collection
  • bottom_margin=expN, bottom margin for the report collection
  • paper_type=expS, paper type for the report collection
  • iterations=expN, the number of iterations the report parts are displayed
  • suppressPageHeaderFirstPage=expN, boolean
  • paperType=expS, synonim for paper_type

<Parts> can have <PageHeader>, <ReportHeader> and <PageFooter> subsections. They are described in Report XML Definition. They can be used globally for the report collection, instead of per-report settings.

Parts are laid out similar to HTML tables but using "pr" and "pd" instead of "tr" and "td".

<pr>

A new row in the collection. It may have the following tag attribute:

  • newpage="yes", it makes the next "row" in the collection to make a page break.

<pd>

A new column in the collection. It may have the following tag attributes:

  • width=expN, the width of the row (in percent of page)
  • height=expN, the height of the row
  • border_width=expN, border width for the cells in this row
  • border_color=expS, color specification for the border

<pd>'s can contain N <Report> or <load> subsections. <Report> subsections are just inline <Report>'s as described in Report XML Definition.

<load>

<load> can load external files, which in turn must contain <Report> sections. It may have the following tag attributes:

  • name=expS, the name of the sub-report
  • query=expS, the main query of the sub-report

If query is set in the <load> section then the main query attribute in the <Report> section in the external file will be ignored. Otherwise the query in the external <Report> will be used.

Personal tools