Boundary markers

Each time a release is published, TopLeaf automatically re-allocates the partition content to a set of leaves. When you retrieve the content of an update release from a partition, TopLeaf assembles the content as a single document for processing by your document authoring tool or for archival within your CMS.

A boundary marker defines the position of a published leaf, page or line break within a document.

You can optionally view the published boundaries when editing the partition content or include the published boundaries when exporting that content to an external document file. If you decide to show boundaries, Topleaf uses processing instructions to mark the position of these boundaries within that content. The following table lists the processing instructions that TopLeaf inserts within a document in order to identify the position of leaf, page, and line boundaries:

Type PI name Example
Leaf <?TL ...?> <?TL partition="looseleaf/BOM" folio="5" hyphen="1" ?>
Page <?TLeop ... ?> <?TLeop partition="looseleaf/BOM" relnum="0" relstr="Original Document" folio="6" ?>
Line <?TLeol ... ?> <?TLeol partition="looseleaf/BOM" relnum="0" relstr="Original Document" folio="6" lineno="12" ?>

Each processing instruction marks the position of the associated boundary type within the document content. Page and line boundary markers identify the position of a page or line break for the release in which the containing leaf was last changed or included. A boundary marker describes characteristics of the boundary using one or more of the following attributes:

Atttribute Type Meaning
partition string The partition name
relnum number The TopLeaf release number in which the leaf was last changed or included
relstr string A release label that identifies the release in which the leaf was last changed or included
folio string Identifies the leaf or page to which the boundary applies, or in the case of a line boundary, in which the line occurs.
hyphen number If defined, and equal to 1, indicates that the leaf or page boundary occurs within a hyphenated word.
wrdbrk number A non-zero offset specifying a word break point at which the boundary occurs. For example, in the case of a leaf boundary marker, the declaration wrdbrk="8" indicates that the leaf boundary is positioned eight characters from the start of the current word.

The TL, TLeop and TLeol processing instruction names are reserved for use by TopLeaf. When editing or replacing the content of an update release, you must not add, remove or modify the attributes of any processing instruction declared with these names.