Stylus Studio XML Editor

Table of contents

Appendices

7.23 Properties for Markers

Properties for Markers

marker-class-name[top]

"marker-class-name"

XSL Definition:

0prop-summary lefttoplefttoplefttoplefttoplefttoplefttop
11lefttopValue: 11lefttop<name>
11lefttopInitial: 11lefttopan empty name
11lefttopApplies to: 11lefttopfo:marker
11lefttopInherited: 11lefttopno, a value is required
11lefttopPercentages: 11lefttopN/A
11lefttopMedia: 11lefttoppaged

Values have the following meanings:

<name>

Names used as identifiers must be unique among fo:markers that are (conceptually) attached to the same area.

If the name is empty or if a name-conflict is encountered, an error shall be reported. A processor may then continue processing.

This property identifies the fo:marker as being in a group with others that have the same name, each of which becomes a candidate to be retrieved by an fo:retrieve-marker that has a "retrieve-class-name" property of the same value.

retrieve-class-name[top]

"retrieve-class-name"

XSL Definition:

0prop-summary lefttoplefttoplefttoplefttoplefttoplefttop
11lefttopValue: 11lefttop<name>
11lefttopInitial: 11lefttopan empty name
11lefttopApplies to: 11lefttopfo:retrieve-marker
11lefttopInherited: 11lefttopno, a value is required
11lefttopPercentages: 11lefttopN/A
11lefttopMedia: 11lefttoppaged

Values have the following meanings:

<name>

A name that matches the "marker-class-name" property value of an fo:marker.

This property constrains that the fo:marker whose children are retrieved by the fo:retrieve-marker must have a "marker-class-name" property value that is the same as the value of this property.

retrieve-position[top]

"retrieve-position"

XSL Definition:

0prop-summary lefttoplefttoplefttoplefttoplefttoplefttop
11lefttopValue: 11lefttopfirst-starting-within-page | first-including-carryover | last-starting-within-page | last-ending-within-page
11lefttopInitial: 11lefttopfirst-starting-within-page
11lefttopApplies to: 11lefttopfo:retrieve-marker
11lefttopInherited: 11lefttopno
11lefttopPercentages: 11lefttopN/A
11lefttopMedia: 11lefttoppaged

The term "containing page" is used here to mean the page that contains the first area generated or returned by the children of the retrieved fo:marker.

Values have the following meanings:

first-starting-within-page

Specifies a preference for retrieving the children of an fo:marker attached to an area that is

  • within the containing page

  • whose "is-first" trait is set to "true"

and that precedes in the area tree any other similarly constrained area that is attached to an identically named fo:marker, using pre-order traversal order.

first-including-carryover

Specifies a preference for retrieving the children of an fo:marker attached to an area that is within the containing page and that precedes in the area tree any other similarly constrained area that is attached to an identically named fo:marker, using pre-order traversal order.

last-starting-within-page

Specifies a preference for retrieving the children of an fo:marker attached to an area that is

  • within the containing page

  • whose "is-first" trait is set to "true"

and that follows in the area tree any other similarly constrained area that is attached to an identically named fo:marker, using pre-order traversal order.

last-ending-within-page

Specifies a preference for retrieving the children of an fo:marker attached to an area that is within the containing page whose "is-last" trait is set to "true" and that follows in the area tree any other similarly constrained area that is attached to an identically named fo:marker, using pre-order traversal order.

This property specifies the preference for which fo:marker's children shall be retrieved by an fo:retrieve-marker, based on the areas returned by the parent of the fo:marker relative to the areas returned by the parents of other identically named fo:marker's.

retrieve-boundary[top]

"retrieve-boundary"

XSL Definition:

0prop-summary lefttoplefttoplefttoplefttoplefttoplefttop
11lefttopValue: 11lefttoppage | page-sequence | document
11lefttopInitial: 11lefttoppage-sequence
11lefttopApplies to: 11lefttopfo:retrieve-marker
11lefttopInherited: 11lefttopno
11lefttopPercentages: 11lefttopN/A
11lefttopMedia: 11lefttoppaged

The term "containing page" is used here to mean the page that contains the first area generated or returned by the children of the retrieved fo:marker.

Values have the following meanings:

page

Specifies that the children of any fo:markers whose parent generated or returned a normal area within the containing page or generated non-normal area within the containing page may be retrieved by this fo:retrieve-marker.

page-sequence

Specifies that only the children of fo:markers that are descendants of the fo:flow within the containing fo:page-sequence may be retrieved by this fo:retrieve-marker.

document

Specifies that the children of any fo:marker that is a descendant of any fo:flow within the document may be retrieved by this fo:retrieve-marker.