Tools

Allows the user to create and invoke custom tools.

To add an item to this menu, select Customize … to open the Customize Tools dialog:

To create a new custom tool, press the New... button to open the New Tool dialog. Enter the name of a custom tool that will appear in the Tools menu.

The Command: field identifies the executable file that will be run when the tool is invoked.

Arguments

The Arguments: field defines the arguments passed to the command. There are a number of values of the form %param; that can be inserted into the arguments. These change according to the partition which is open when you invoke the tool, so you can create tools that work on many partitions. The variable can be selected from the menu which opens when you press the button to the right of this field.

The argument variables that can be chosen from this menu are:

  • Partition » Name — the path of the current partition (relative to the TopLeaf repository).

  • Partition » Update Document — the current work-in-progress XML document, no leaf markers.

  • Partition » Published Document — the current published XML document, no leaf markers.

  • Partition » Folder — the file path of the partition folder.

  • Partition » Publication Folder — the file path of the publication folder for this partition.

  • Partition » Leaf Folder — for an update, this would be the folder that contains the partition document.

  • Partition » Current Leaf — currently selected leaf in leaf list.

  • Preview » Changed Pages — the set of changed pages (looseleaf only).

  • Preview » Partition Pages — the set of all pages in the partition

  • Preview » Published Pages — the published page set.

  • Dependencies » Format File — the file path of the mapping rules file used by the publication. This is an XML description of the mappings created by the Map Manager.

  • Dependencies » DTD File — the file path of the DTD used by the publication.

  • Dependencies » Catalog File — the file path of the catalog file used by the publication.

  • Exports » Partition Index File — an extracted index file, generated from the current phase.

  • Exports » Partition TOC File — an extracted TOC file, generated from the current phase.

  • Exports » Partition XREF File — an extracted XREF file, generated from the current phase.

  • Exports » Changed Leaf Indicators — a list of indicators for the set of all changed leaves.

  • Exports » Partition Leaf Indicators — a list of indicators for the set of all leaves.

  • Exports » Filing Instructions — the current filing instructions, as an XML document.

  • Exports » Composition Log — output log file from the last run of the composition engine.

  • Exports » Partition PDF File — PDF for all pages in the currently selected phase (update or publish).

  • Properties » Release Label — the identifier of the current release as defined through the Label this Release dialog.

  • Properties » Current Phase — either UPDATE or PUBLISH.

  • Properties » Partition TypeTOPBOOK for a non-looseleaf or change pages partition, or TOPLEAF for a full looseleaf partition.

  • Properties » Markup Language — the markup language used by data in this partition; either XML, SGML or GENCODE.

  • Preferences » Program Files Folder — the file path of the folder where TopLeaf is installed (C:\Program Files\TKS by default).

  • Preferences » TopLeaf Repository — the file path of the folder containing the TopLeaf repository.

  • Preferences » Common Files Folder — the file path of the folder containing common data (C:\Program Files\TKS\common by default).

  • Preferences » XML/SGML Editor — the executable file run to edit a data file in an XML or SGML partition.

  • Preferences » Other Files Editor — the executable file run to edit files other than XML or SGML.

[Note] Note

Previous versions provided arguments for generating secondary transform output. These should be generated by using the API.

Initial Directory

The Initial Directory: field allows you to set the directory which is current when the command starts. You can make this dependent on the current partition by choosing one of the entries in the menu which opens by pressing the button on the right of the field.

Properties

You may also select the following Properties: for the command:

  • Browse for command argument — if this is checked, when the command is run the user is prompted to select a file. The path to this file is appended to the command arguments.

  • Page composition required — when checked, running the command causes the partition to be typeset if necessary.

  • Start new tool group — this causes a separator to appear in the menu before this item.

  • Run as detached process — when checked, control is returned to TopLeaf as soon as the command is started, instead of waiting for it to terminate.