Commit

Command line:
tlapi ‑cCOMMIT [‑znPack] sPart
Command line:
tlapi ‑cPUBLISH [‑znPack] sPart
Library call:
nStatus = TLcommit (sPart, nNxtUpd, nPack)
Scripting call:
nStatus = Commit (bNxtUpd)

Function

Commit the current partition update as the partition publish phase.

Arguments

sPart

The path of the partition to be committed. The scripting call uses the Partition property to determine the partition.

nPack

This has the same interpretation as the corresponding argument in the Pack call.

nNxtUpd

If this is non-zero, a new update phase (or new release) is created after committing the current update.

To create the next update from the command line, use the PUBLISH command instead of COMMIT.

bNxtUpd

This applies to the scripting interface only. If this is true, a new update phase (or new release) is created after committing the current update.

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

Notes

A partition must be typeset at least once before it can be committed, and cannot be committed if edit locked.

Once committed, a new update (or release) must be created before the partition document can be updated again.

You must commit a partition before you can extract the partition document published phase using the Get Data call. Third party applications must retrieve the published partition document in order to obtain the published page or leaf boundary markers.

Calls to Commit can be reversed (see Undo Commit) if the next update phase has not been created (that is, if nNxtUpd = 0 and Next Update has not been called).

Examples

Command line:

tlapi ‑cPUBLISH manuals/topix/volume1

Library call:

/* Commit a partition to Publish phase, and create next update (release) */
status = TLcommit("manuals/topix/volume1", 1L, 0L);

Scripting call:

status = topleaf.Commit(false);