YouTip LogoYouTip

Obj Region End

XSL-FO region-end Object Image 1: XSL-FO Reference Manual XSL-FO Reference Manual

Definition and Usage

The <fo:region-end> object defines the right region of the page (right margin).

XSL-FO uses the following elements to define the regions of a page:

  • <fo:region-body> defines the body region.
  • <fo:region-before> defines the top region (header).
  • <fo:region-after> defines the bottom region (footer).
  • <fo:region-start> defines the left region (left margin).
  • <fo:region-end> defines the right region (right margin).

Note: region-before, region-after, region-start, and region-end are all part of region-body. To avoid text in region-body overlapping text in other regions, the margins of region-body must be at least as large as the dimensions of the four sub-regions.

Note: According to the recommended standards of XSL-FO 1.0 version, the padding and border-width properties must be 0.


Syntax

<fo:region-end>

<!--

 Contents:EMPTY

 -->

</fo:region-end>

Attributes

Attribute Attribute
background-attachment clip
background-color display-align
background-image extent
background-repeat overflow
background-position-horizontal padding-after
background-position-vertical padding-before
border-after-color padding-bottom
border-after-style padding-end
border-after-width padding-left
border-before-color padding-right
border-before-style padding-start
border-before-width padding-top
border-bottom-color region-name
border-bottom-style reference-orientation
border-bottom-width writing-mode
border-end-color
border-end-style
border-end-width
border-left-color
border-left-style
border-left-width
border-right-color
border-right-style
border-right-width
border-start-color
border-start-style
border-start-width
border-top-color
border-top-style
border-top-width

Example 1

XSL-FO uses page templates called "Page Masters" to define the layout of pages. Each template must have a unique name:

<fo:simple-page-master master-name="intro">

<fo:region-body margin="5in" />

</fo:simple-page-master>

<fo:simple-page-master master-name="left">

<fo:region-body margin-left="2in" margin-right="3in" />

</fo:simple-page-master>

<fo:simple-page-master master-name="right">

<fo:region-body margin-left="3in" margin-right="2in" />

</fo:simple-page-master>

In the above example, three <fo:simple-page-master> elements define three different templates. Each template (page-master) has a different name.

The first template is named "intro". It can be used as a template for an introduction page.

The second and third templates are named "left" and "right". They can be used as templates for even and odd numbered pages.

Example 2

This is a snippet extracted from an XSL-FO document:

<fo:simple-page-master master-name="A4"

 page-width="297mm" page-height="210mm"

 margin-top="1cm" margin-bottom="1cm"

 margin-left="1cm" margin-right="1cm">

<fo:region-body margin="3cm"/>

<fo:region-before extent="2cm"/>

<fo:region-after extent="2cm"/>

<fo:region-start extent="2cm"/>

<fo:region-end extent="2cm"/>

</fo:simple-page-master>

The above code defines a "Simple Page Master Template" named "A4".

The width of the page is 297 millimeters, and the height is 210 millimeters.

The margins on all four sides (top, bottom, left, right) are 1 centimeter.

The margins of the body are 3 centimeters (on all four sides).

The before, after, start, and end regions of the body are all 2 centimeters.

The width of the body in the above example can be calculated by subtracting the left and right margins and the margins of region-body from the page width:

297mm - (2 x 1cm) - (2 x 3cm) = 297mm - 20mm - 60mm = 217mm

Note that the regions (region-start and region-end) are not included in this calculation. As previously explained, these regions are part of the body.


Image 2: XSL-FO Reference Manual XSL-FO Reference Manual
← Obj Region StartObj Region Body β†’