Partition Properties

Partition properties describe a set of characteristics that identify the partition content and indicate how TopLeaf will process that content. The Partition Properties dialog can be accessed from the File menu.

The Looseleaf tab

The option selected in the Page management drop-down defines the method used by TopLeaf to process changes to published pages. Use the default (None) if you only intend to distribute complete publications rather than just the pages that have changed. See “Looseleaf methods” for a comparison of the Full looseleaf and Change pages modes.

The settings below are active only if Looseleaf page management is selected.

  • Single page leaves — When the content is typeset, one page will be allocated to a leaf instead of two pages. Every leaf is composed as a right-hand page ignoring the traditional convention of right pages: odd numbers, left pages: even numbers.

  • Track page boundaries — If this option is enabled, TopLeaf will track the position of each page boundary within the partition content. You can export a copy of the published document content that includes a set of page boundary markers identifying each page boundary.

  • Track line boundaries — If this option is enabled, TopLeaf will track the position of each data block line boundary within the partition content. You can export a copy of the published document content that includes a set of line boundary markers identifying each line boundary.

  • Content contains boundary markers — Indicates that the partition content contains TopLeaf boundary marker processing instructions.

    If this option is enabled, then:

    • the position of each document leaf boundary is identified within the content by a TopLeaf leaf boundary marker;

    • boundary markers are always visible when the document content is edited;

    • content imported into the partition using the TopLeaf API must contain leaf boundary markers.

    This option must be enabled if you plan to initialize a looseleaf partition from a set of existing leaf boundaries.

    If this option is disabled then:

    • when the partition content is updated, TopLeaf automatically compares the updated content with the published content to locate the position of each published leaf boundary;

    • boundary markers are not shown when the document content is edited, unless the option to view the published boundaries is selected before editing the content;

    • you must set Include boundary markers in document to include leaf boundary markers when exporting the partition content to an external document file;

    • tracked page and line boundary markers can only be included when exporting the published document content.

    [Warning] Warning

    Do not delete any of the published leaf boundary markers if your content contains explicitly declared leaf boundary markers. If you need to remove content containing boundary markers, move the markers out of the content before deleting it.

  • Use default leaf indicators — If this option is enabled, TopLeaf will copy the partition default leaf indicators to each new leaf created in a release. In a mainwork, the default leaf indicators are assigned to all leaves. In an update, the default leaf indicators are assigned only to new leaves generated as a result of changes to the partition content. See “Indicators” for more details.

  • Optimize input change tracking — If this option is enabled, TopLeaf composes the content of all adjacent changed or included leaves within the same leaf group or leaf section as a single unit. This usually minimises the total number of replacement pages in a release. If you disable this option then each leaf will be composed independently and TopLeaf will create additional point pages for any leaf that overflows past the end of the last page associated with each leaf.

  • Enable review of published boundaries —This option allows you to review, and if necessary, adjust the positions of published boundary markers without registering the alteration as a change to the document. A boundary marker defines the position of a published leaf, page or line ends within a document. Topleaf uses processing instructions to mark the position of these boundaries within the document content. At a minimum, enabling this option allows you to review the published leaf boundaries. If you intend to review the published page or line boundaries then you must also Enable page boundary markers and Enable line ending markers.

The Page Folio control specifies how TopLeaf formats page folio strings in a full looseleaf partition. You can use the <leaf-settings/> directive to set the point page level separator.

The Initial Page Types controls declares an initial set of page types when typesetting a full looseleaf partition. The following initial page types are defined:

  • First — This defines the default page type applied when rendering the first page of the partition.

  • Followed By —This defines the default page type used when rendering all non-blank pages after the first page.

  • Blank Back — This defines the intentionally blank page type. This page type will be used when the content of a leaf fits entirely within the first page of that leaf.

    Running heads, automatic table headings, margin rules (change bars), and deletion markers are disabled on the Blank Back page type. For example, if you assign the 1 column page type as your Blank Back page type, then running heads and automatic table headings will be disabled on all pages that use that layout. For most publications, the Blank Back page type should be declared as either {implied} or Blank.

The initial First and Followed By page types can be overridden by a tag or custom marker mapping. In a full looseleaf update, you can also declare a set of initial page types as properties applied at the start of a leaf.

The Compose tab

The Compose tab declares a set of partition specific options for the TopLeaf composition engine.

The Document Markup Language selector shows XML or SGML as appropriate (the Legacy setting is provided for jobs created using older versions of TopLeaf). The document markup language can only be set when a partition is created. The option Ignore case in SGML tags is only enabled for SGML data. If set, the processing of all element and attribute names is case insensitive. For example, this means that TopLeaf will regard the tags <title type="section" > and <Title Type="section" > as identical. Setting this option automatically disables full looseleaf page management.

The following settings are available:

  • Enable debug mode — if set, then details of the typesetting run are sent progressively to the log file. This setting can be changed at any time using the Debug button

  • Enable mapping assistant and transforms — if set, controls whether the composition engine creates data for the mapping assistant and secondary transformations.

  • Do not publish with composition warnings — if set, prevents a looseleaf partition from being published if the last composition run produced warning messages. If this option is not set a partition can be published with warnings, but not if it has errors.

  • Check all pages for output changes — if set, TopLeaf compares the updated and published output for all leaves in the partition. If the output for a leaf has changed, then that leaf will be included in the update pack. Setting this option has the potential to increase the size of the update pack. This is only enabled for full looseleaf partitions.

  • Exclude all leaves with unchanged output — if set, TopLeaf compares the updated and published output for those leaves in which the content of the leaf has changed or the leaf has been manually, conditionally or automatically included. If the output for the leaf is unchanged, then the leaf will be excluded from the update pack. Setting this option has the potential to reduce the size of the update pack. This option is only enabled for full looseleaf partitions.

  • Only check for output changes when publishing — if set, then output page comparisons are deferred until the partition is published. This is useful when the partition must be composed a number of times, for example if there is an included table of contents built by the first composition pass and rendered by the second pass. This option is not enabled for full looseleaf partitions.

  • Only check difference area for output changes — If set, output page comparisons are restricted to the differencing area defined by that style sheet. This option is only enabled when processing a full looseleaf partition and your publication style sheet uses a TopLeaf legacy page layout.

  • Ignore output changes above content level — if set, will ignore output changes found in content tagged with a suppression level greater than the specified value.

The Exports tab

During a typesetting run, TopLeaf can generate a number of derived files for possible use in later processing.

This tab allows the user to specify where in the system each of these derived files is to be saved. Each file is specified separately, and only those files of interest need be set up. If Export after each composition is ticked, the file is saved automatically at the end of every typesetting run. If not ticked, the files are only created immediately before the partition is published.

To export a file, select the export type and enter the name of the export file in the Export ... To: box or click the Browse button to navigate to an existing folder or target file.

If a simple file name is entered (one without any ‘/’ or ‘\’ characters) it will be stored in the partition folder. Otherwise, you should enter an absolute path for the file.

The files may also be saved manually via the File » Export dialog. The types of derived file are:

  • Document

    Copy the input data file to the specified file name. This may be useful in full looseleaf processing where the file may have markers inserted to show leaf, page or line boundary markers. You can use the {document-file} system variable to reference this file path from your stylesheet mappings. See Looseleaf publishing and version control.

  • TOC (Table of Contents)

    TOC entries mapped from the input file are assembled into an XML file of TOC references together with their corresponding output page folios.

  • Index

    Index entries mapped from the input file are assembled into an XML file of index references together with their corresponding output page folios.

  • XREF (Cross reference)

    This is similar to the Index output, but it can be used for metadata that is not hierarchical in form.

  • Filing Instructions

    TopLeaf creates a file with a record for every output page showing its page folio and status. The content of this file can be used for the automatic production of instructions for filing the new and replacement pages of a release.

  • PDF

    A PDF version of the partition is generated.

  • Secondary transforms

    These options allow you to generate one of the secondary transformation formats, such as RTF and HTML. The default transform properties for the partition are used (see “Secondary output options”). These options are only available if the Enable secondary transforms box is ticked on the Compose tab.

  • Indicators

    A file is created that records all the indicators used in the partition. See “Indicators”.

Setting an export location which is independent of the repository location

Unlike the post-processing step, you cannot specify a relative file path for an exported file. However, the export file name can also include references to environment variables. If you need to specify an export target that is independent of the repository location, first declare the target folder or path in an environment variable, then include a reference to that environment variable within your export target path.

For example: the environment variable WEBDATA is declared as F:\MYWEBDATA.

To export an HTML rendition of the input partition to this folder, declare the HTML output path as:

$WEBDATA/MyHTML.HTM

TopLeaf defines the environment variable $TLPPATH which points to the current partition folder.

Versioning

These selectors control how many previous versions of the partition are retained. Increasing this number allows you to roll back further into the history of the partition, at the cost of increasing the storage required. You can choose to Keep the following:

  • Releases — the maximum number of releases retained each time a new partition update release is created.

    This is the number of releases in addition to the published release and the update release (if present).

    The release immediately before the published release is always retained. This means that there are always at least 2 releases present, or 3 if there is an update release.

  • Undo Levels — the maximum number of copies of the partition content retained within a release. When you edit the content of a partition from within the TopLeaf workstation, Topleaf creates a copy of the document immediately before opening the document editor. You can use the undo option to cancel the changes applied in a previous edit session.

The Post-process tab

TopLeaf can invoke a post-processing program (.EXE or .BAT) after the typesetting run has finished. Browse for the name of the program, and enter any required arguments in the box.

If the Command is either “java” or “javaw” (case-sensitive) the Java runtime specified in the preferences dialog will be used.

For a description of the available arguments see the tools dialog.

If the Launch after running the composition engine box is ticked, the post-processing will be run every time the partition is typeset, otherwise it will only be run immediately before the partition is published.

Tick the Run in a minimized window box if you want your post-processing to run in the background.

The DTD & Catalog tab

DTD File

The DTD file identifies a Document Type Definition associated with the partition. This can be useful if your XML documents do not contain a document type declaration or if the referenced DTD external subset cannot be resolved or is undefined. You can declare a DTD when the first partition is created within a publication. All other partitions inherit the publication DTD file.

The declaration of a DTD is entirely optional. If you do not declare a DTD, then the partition content is processed in DTD-less mode.

Catalog File

Entities within a document type declaration can be resolved using the OASIS catalog mechanism.

TopLeaf's OASIS catalog support is limited. See “OASIS catalog support” for more information.