Filing instructions file format

The file begins with a list of <tl:leaf> elements that describe every leaf in the document showing its folios (front and back), its release string(s) and whether it is in the current release. After this a set of actions is given describing what needs to be done with each changed leaf: remove, remove/replace or insert. Note that for each existing leaf (for example, leaf 2/1,2/2), the previous release label (“UPDATE”) is included to assist correct identification of the leaf to be removed.

The format is different depending on whether full looseleaf or change pages is being used.

In a full looseleaf publication, release labels are assigned to the leaf, and the <tl:leaf> element declares the leaf currency via the relnum and relstr attributes. The inclusion of a leaf in a release implies that both the front page and back page of the leaf were modified in the same release.

In a change pages publication, the currency of a page is determined by changes to the content of the page. The release information for each page is defined independently, with the <tl:front> and <tl:back> elements declaring the release status for the front and back pages of each leaf. It is entirely possible for the front page and back page of a leaf to have been modified in separate releases.

The following fragment shows the structure of a typical file produced by TopLeaf in looseleaf mode:

…
<tl:filing xmlns:tl="http://www.turnkey.com.au/topleaf/v7.0/filing" parts="1" pages="644" >
<tl:partition path="Demonstrations/test" name="test" pages="22" spage="1" >
<tl:release relnum="3" phase="update" >3</tl:release>
<tl:label>Demonstrations-test</tl:label>
<tl:live.list>
<tl:leaf type="live" relstr="UPDATE" relnum="2" current="0" >
<tl:front>1</tl:front><tl:back>2</tl:back>
</tl:leaf>
<tl:leaf type="live" relstr="REVISION" relnum="3" current="1" >
<tl:front>2/1</tl:front><tl:back>2/2</tl:back>
</tl:leaf>
<tl:leaf type="live" relstr="REVISION" relnum="3" current="1" >
<tl:front>2/2/1</tl:front><tl:back>2/2/2</tl:back>
</tl:leaf>
<tl:leaf type="live" relstr="UPDATE" relnum="2" current="0" >
<tl:front>2/3</tl:front><tl:back>2/4</tl:back>
</tl:leaf>
<tl:leaf type="live" relstr="INITIAL" relnum="0" current="0" >
<tl:front>3</tl:front><tl:back>4</tl:back>
</tl:leaf>
…
<tl:leaf type="live" relstr="UPDATE" relnum="2" current="0" >
<tl:front>101</tl:front><tl:back>102</tl:back>
</tl:leaf>
</tl:live.list>
<tl:filing.list>
<tl:instruction>
<tl:action type="remove" >
<tl:front>2/1</tl:front><tl:back>2/2</tl:back>
<tl:relstr>UPDATE</tl:relstr>
</tl:action>
<tl:action type="replace" >
<tl:front>2/1</tl:front><tl:back>2/2</tl:back>
<tl:relstr>REVISION</tl:relstr>
</tl:action>
<tl:action type="insert" >
<tl:front>2/2/1</tl:front><tl:back>2/2/2</tl:back>
<tl:relstr>REVISION</tl:relstr>
</tl:action>
…
[Note] Note
  • It is possible to create a live pages list for non-looseleaf partitions (i.e. if Page management is set to “None” in the partition properties). Such partitions will create a live pages list with every page in the current release, and an empty filing list.

  • The list of effective pages may not be valid if a composition run generates warnings or errors.

  • Export the partition filing instructions to an external file if you require a list of the pages created in the initial release of a looseleaf partition.