Preferences

This dialog is invoked from the File menu to set TopLeaf general preferences.

The Folders tab

The location of the repository folder cannot be changed while a partition is open. Select File » Close to close the current partition.

The Java Runtime field displays the path to the Java runtime used by TopLeaf's Java components. Press the Change... button to open the Java runtime selection dialog.

TopLeaf searches for all suitable installed Java runtimes and displays them in a list. Click on an item from the list to select a runtime and press OK. Use the Refresh button to reload the list of runtime options (for example, after installing a new runtime).

If a Java runtime is installed but does not appear in the list, use the Browse... button to locate it. Be sure to select the folder into which you installed the runtime; some operations will not work correctly if you select the wrong folder. TopLeaf will only find runtimes of version 6 or later. Using an earlier version may give incorrect results.

This dialog also appears when TopLeaf first starts if no runtime has been selected. In this case, an extra checkbox with the legend Don't show this dialog again appears. Ticking this checkbox prevents the dialog from appearing the next time TopLeaf starts.

The Java Runtime Arguments field can be used to pass arguments to the java virtual machine when TopLeaf runs a java program. See the documentation for the java runtime environment you are using for a list of the arguments you can set.

For example, a value of “-Xmx128m” sets the maximum heap size on a Windows system to 128 megabytes (the default maximum size is usually 64 megabytes).

[Note] Note

You must install and select a Java runtime in order to use TopLeaf.

On a 64-bit operating system only 32-bit runtimes will be displayed. If you select a runtime by using Browse... make sure it is a 32-bit runtime. Some components used by TopLeaf will not work correctly with a 64-bit runtime.

The TopLeaf API will use the value of the JAVA_HOME environment variable to locate the runtime if no runtime has been selected in the workstation.

The TLJAVA_ARGS environment variable can also be used to pass arguments to the virtual machine, but will be ignored if java runtime arguments are also specified in the preferences.

The DITA Open Toolkit Location can be set to the folder containing an instance of the DITA Open Toolkit. If this is set you will be able to use it to pre-process data loaded with Commands » Replace Partition Document…. See “How to process DITA content” for more information.

The Editors tab

Sets the programs to use when editing files. The SGML/XML Documents editor is used when editing the partition document. The Other Files editor is used for all other files (for example, when inspecting the Composition Log).

The Environment tab

Symbolic variables definition file

This file path identifies the name of a text file that declares one or more environment variables that may be referenced from within the content of a mapping customisation. You can use environment variables to identify path names to external folders or files referenced from a tag mapping. Variable names are case sensitive and must not contain spaces.

TopLeaf symbolic variables are assigned using the following command:

SET variable=string

Within a tag mapping customisation, symbolic variables are referenced using the following syntax:

{$variable}

where variable is the name of a symbolic variable.

[Note] Note

Scripts processed by the composition engine's Perl interpreter cannot reference variables declared within the variables definition file.

Catalog file

The Catalog file identifies the name of a default OASIS catalog file. If defined, TopLeaf will use this file when composing any XML partition that does not explicitly declare its own OASIS catalog file.

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

The General tab

The settings in this tab control the state of the following global parameters:

  • Legacy mapping editor: list mappings in precedence order — this determines whether the legacy Map Manager displays the tag and custom mappings alphabetically or ordered by precedence.

    The modern Mapping Editor uses a preference to control mapping display order.

  • Show the Format file folder name when viewing mappings — if this is checked the title bar of a stylesheet dialog shows the folder containing the stylesheet component. This only applies to the legacy editor.

  • Notify me when the composition engine flags warnings or errors — if this is checked, after a typesetting run with warnings and/or errors a dialog will appear asking if you wish to view the composition log.

  • No multiple composition runs when called from GUI — if this is checked, the composition engine will only run once when called from the GUI, even if the stylesheet contains <readgen/> commands to create and read generated files. This does not affect the operation of the composition engine when called from the API.

  • Check all leaves for output page changes — sets the default preference for applying output page comparison to a full looseleaf partition. The state of this option is assigned to the equivalent partition property when selecting a full looseleaf page management model. You can override this setting for individual partitions by setting or clearing the equivalent partition property.

  • Exclude all leaves with unchanged output — sets the default preference for using output page comparison to minimise the size of a release update for a full looseleaf partition. The state of this option is assigned to the equivalent partition property when selecting a full looseleaf page management model. You can override this setting for individual partitions by setting or clearing the equivalent partition property.

  • Notify me when displaying an undefined font or image — if this is checked, the previewer will issue a warning message when a font or image recorded in the output page description cannot be found. These warnings can occur if the output pages for a partition were created on one platform and viewed on another platform that has different fonts installed or assigns different network drive mappings.

  • View output transformations — this is used as an initial default when running a secondary transformation from the workstation.

  • Honor settings for unprintable area — for some print devices, the dimensions of the physical page are larger than the dimensions of the logical page, so when you print to these devices, you may find that your output is shifted slightly to the left or down from the top of the physical page. When this option is checked (the default), the print area of the page is offset by the unprintable area setting for the output print device. If not checked, you must ensure that your page margins are large enough to allow for the unprintable area.

  • Automatically view PDF files — this is used to start the PDF reader after a PDF file is created (you must have a PDF reader installed and associated with the .pdf file type for this to work).

The Languages tab

This tab allows you to set your preferred default language.

The default language is used to set the initial document language for a new publication. The document language for a publication can be changed in the Options dialog.

Note that unlike most other preferences, the default language may be applied for all users on this machine. On operating systems such as Windows 7 you will need to start TopLeaf with elevated privileges to change the setting for all users.