The <page-properties/> command

This command assigns change pages, header-footer, and vertical justification properties to the current page.

Change pages processing

The following attributes assign page identifiers to the current page.

Page identifiers are used when processing a change pages partition. A page identifier may be issued more than once for a page, but only if the same identifiers are assigned each time (in other words, only one identifier may be assigned to a page).

Page identifiers and page group identifiers must:

  • consist only of characters within the US-ASCII character set

  • contain a maximum of 32 characters.

An optional group identifier assigns one or more pages to a page group. See the description of change pages for information on how groups work.

Where allowed

A header or footer mapping.

Range of effect

The current page.

Attributes
id

Assigns a unique identifier to the page

group

Makes the page a member of a named group; this value is optional

Header and Footers

The following attribute assigns header and footer specific properties to the current page.

Where allowed

A header or footer mapping.

Range of effect

The current page.

Attributes
headfoot

Specifies the page type used when processing headers and footers on the current page.

If the attribute value is first, TopLeaf will process the headers and footers defined by the page type active immediately before any data block content is rendered to the current page.

If the attribute value is last, TopLeaf will process the headers and footers defined by the page type active immediately after all data block content has been rendered to the current page. Note that the headfoot mode remains active for one page only, after which it is automatically reset to last.

The default headfoot mode is last.

Vertical spreading

The following attributes assign vertical spreading properties.

Where allowed

The $document mapping.

Range of effect

The current document.

Attributes
max-spread

Specifies the maximum amount of additional vertical space that can be distributed within a page if:

  1. the combined depth of all content in the page data area is less than the depth of the page data area, and

  2. the page vertical alignment mode is set to spread;

If the space available on the page exceeds the value of max-spread or the specified value is 0 then no additional vertical space will be distributed. The default value for this option is 6pc/2.54cm.

max-paraspread

Specifies the maximum amount of additional vertical space that can be distributed between paragraphs when the page vertical alignment mode is set to spread. If this value is not specified, TopLeaf will add as much extra inter-paragraph space as required to vertically spread the page content so that it lines up with the bottom margin of the data block area.

You can use this parameter to prevent too much white space being distributed between paragraphs. Set this value to 0 if you do not want to increase the paragraph spacing when vertically spreading the content of a page.

max-linespread

Specifies the maximum amount of additional vertical space that can be distributed between lines when the page vertical alignment mode is set to spread, and where it is not possible to vertically spread that content by increasing the space between paragraphs. If not specified, and the page cannot be justified by increasing the inter-paragraph space, TopLeaf will increase the line leading by as much as required in order to vertically spread the page content.

You can use this parameter to prevent too much white space being distributed between lines. Set this value to 0 if you do not want to increase the interline spacing when vertically spreading the content of a page.

The parameters max-paraspread and max-linespread control how additional space is distributed within the page.

TopLeaf will not distribute any additional vertical space between or within table rows.

Repositioning short page content

A short page occurs when a single line paragraph is positioned at the start of a page and is followed immediately by a forced page or leaf content break. The following attribute declares where TopLeaf is permitted to reposition the content of a short page.

Where allowed

The $document mapping.

Range of effect

The current document.

Attribute
avoid-shortpages

Sets the short page processing mode. If yes, then TopLeaf is permitted to reposition the content of short pages.

The permitted values are:

  • yes — TopLeaf is permitted to reposition the content of any short page.

  • input-changed — TopLeaf is only permitted to reposition the content of short pages generated from an input changed or manually included leaf.

  • no — TopLeaf is not permitted to reposition the content of a short page. This is the default.

Some constraints may be applied when repositioning the content of short pages. These are declared in the $document mapping using the <page-properties/> command.

Example

Declare the following command in the $document mapping to enable short page minimisation:

<page-properties avoid-shortpages="yes" />

Repositioning rule constraints

The following attributes assign vertical compression properties used when repositioning orphaned paragraphs or the content of short pages.

Where allowed

The $document mapping.

Range of effect

The current document.

Attributes
max-compress

Specifies the maximum amount of additional vertical space that can be removed from a data block when repositioning an orphaned paragraph. If the space required to reposition an orphaned paragraph exceeds the value of max-compress or the specified value is 0 then an orphaned paragraph cannot be repositioned within the last data block on a page. The default value for this option is 6pc/2.54cm.

max-paracompress

Specifies the maximum amount of vertical space that can be removed from between paragraphs when repositioning an orphaned paragraph. Set this value to 0 if you do not want to reduce the paragraph spacing when fitting an orphaned paragraph within a data block.

max-linecompress

Specifies the maximum amount of vertical space that can be removed from between lines when repositioning an orphaned paragraph. If not specified, and an orphaned paragraph cannot be repositioned by reducing the inter-paragraph space, TopLeaf will attempt to fit the orphaned paragraph by reducing the line leading. Set this value to 0 if you do not want to reduce the interline spacing when repositioning orphaned paragraphs.

TopLeaf will not remove vertical space from within or between table rows.