The <segment-properties/> command

Sets properties for the current page segment.

Where allowed

Any mapping.

Range of effect

The current page segment.

Attributes

runhead

Specifies where TopLeaf will position running heads declared within a page segment. The permitted values are:

  • block — position running headers at the top of one or more data blocks in the page segment. This is the default.

  • page — position running headers at the top of a page in a region that horizontally spans all data blocks defined within the page segment.

A running head is a continuation heading that sits within the page data area and appears at the top of new page or column, providing they have been enabled in the Layout Editor. Running heads should not be confused with headers and footers. A running head will only be positioned within a page segment if is active at the start of a new page or column, whereas a header or footer will always be rendered on a page.

By default, all active running heads are rendered at the top of a new page or column that follows the point at which they were declared. In some circumstances, you may want to position your running heads so that they horizontally span all data blocks. To do this, declare the command:

<segment-properties runhead="page"/>

[Note] Note

When page running heads are enabled, all active running head levels will appear at the top of each new page. Running heads will not appear at the start of each new column in a multi-column page style.

frame

Sets a frame type for the segment. If declared this controls the layout of box frame surrounding the segment.

The permitted values are:

  • None — frame rules are disabled (the default)

  • Top — enable top rule only;

  • Bottom — enable bottom rule only;

  • TopBot — enable top and bottom rules;

  • Sides — enable left and right rules;

  • SideTop — enable top, left and right rules;

  • SideBot — enable bottom, left and right rules;

  • Left — enable left rules;

  • Right — enable right rules;

  • All — enable all frame rules

frame-style

Sets a frame style for the segment.

The permitted values are:

  • Normal — a standard thin rule frame

  • Double — a double rule frame

  • Shadow — a shadow box frame

frame-width

Specifies a measure that defines the thickness of the rules in the segment box frame. The default frame weight is 0.1pt.

frame-color

Specifies the rule color for the segment box frame. See “Colors” for a description of how colors are specified.

bgcolor

Specifies the background fill color for the segment box. See “Colors” for a description of how colors are specified.

[Note] Note

Setting a background color of “white” (or “#FFFFFF”) disables any background fill.

top-padding

Specifies the amount by which the segment box extends above the segment top margin. The default is 0.

bottom-padding

Specifies the amount by which the segment box extends below the segment bottom margin. The default is 0.

left-padding

Specifies the amount by which the segment box extends beyond the segment left margin. The default is 0.

right-padding

Specifies the amount by which the segment box extends beyond the segment right margin. The default is 0.

column-balance

Sets the column balancing mode when rendering a multi-column page layout. Permitted values are:

  • yes — reduce the depth of the rendered content by distributing it between the columns.

  • minimal — as for yes, but using the smallest possible number of columns.

  • no — column balancing is disabled. Content flows into the next column only when the previous column is full.

The column balancing mode is inherited from the stylesheet column balancing mode.

balance-threshold

Sets a vertical threshold below which column balancing is not applied. This prevents the application of column balancing to pages where the last column of a layout is almost full. The column balance threshold is inherited from the stylesheet column balance threshold.

split-minheight

This sets the value of the minimum segment split height. It is used when there is insufficient space remaining on the page for a segment.

When a segment is split over multiple pages, the height of the content on the first and last pages will be at least the value of the minimum split height. As a consequence, a segment with a height less than twice this value will not be split.

If not specified, the minimum segment split height is inherited from the stylesheet minimum segment split height.

column-align

When TopLeaf renders the content of a multi-column page layout, the columns of that layout at the end of a page or section may be only partially filled. If all columns in the segment are not used, you can horizontally align the columns that contain content within the page layout data area. The alignment is one of left, right, center, inside or outside. The horizontal column alignment is inherited from the stylesheet horizontal column alignment.