Leaf Split

Command line:
tlapi ‑cPUBMARK sPart
Library call:
nStatus = TLpubmark (sPart, nNxtUpd, 0L)
Scripting call:
nStatus = PubMark (bNxtUpd)

Function

A leaf split establishes an initial set of published leaves for a full looseleaf partition using an existing set of leaf boundaries. The document content declares one or more leaf boundary markers to identify the existing leaf boundaries. TopLeaf allocates the content between successive leaf boundary markers to one or more document leaves, then automatically moves the partition to the published phase.

Arguments

sPart

The path of the partition that is to be leaf split. The scripting call uses the Partition property to determine the partition to use.

nNxtUpd

If this is non-zero, a new update phase is created after the leaf split.

bNxtUpd

This applies to the scripting interface only. If this is true, a new update phase is created after the leaf split.

For additional command line arguments see “Common Flag Arguments”.

Notes

Please refer to the User Guide for a list of restrictions that apply when performing a leaf split.

After you initialize a partition from an existing set of boundaries, you must establish an initial set of output pages. To do that, you need to create a new update, then compose the partition.

A leaf split can be cancelled by an Undo Commit if the next update phase has not been created (that is, nNxtUpd = 0).

Examples

Command line:

tlapi ‑cPUBMARK manuals/topix/volume1

Library call:

/* Leaf split a partition, don't create a new update */
status = TLpubmark("manuals/topix/volume1", 0L, 0L);

Scripting call:

status = topleaf.PubMark(false);