Repository

Repository root folder

The TopLeaf repository is a directory hierarchy beginning with a single root folder. The location of the repository is set in the File » Preferences tab.

On Windows systems, a TopLeaf repository folder name may include space (U+0020) characters, but when this occurs, the TopLeaf API will reference the repository folder using the equivalent Windows 8.3 short file name. On Unix systems, the repository folder name can not include space characters.

Repository level names

A repository level name must only consist of printable characters located within the US-ASCII (7 bit) character range, subject to the following restrictions.

The following characters cannot be used within a level name:

Code Name
U+0020 SPACE
U+0022 QUOTATION MARK
U+0024 DOLLAR SIGN
U+0025 PERCENT SIGN
U+0027 APOSTROPHE
U+002A ASTERISK
U+002C COMMA
U+002D HYPHEN-MINUS
U+002F SLASH (SOLIDUS)
U+003A COLON
U+003C LESS THAN
U+003E GREATER THAN
U+003F QUESTION MARK
U+005C REVERSE SOLIDUS
U+007C VERTICAL LINE

A level name cannot start or end with an UNDERSCORE (U+005F) nor begin with a FULL STOP (U+002E).

TopLeaf uses the UNDERSCORE (U+005F) character to represent spaces in repository level names. If you use the TopLeaf API to create a partition or repository level, and that level or partition name contains underscore characters, then the underscore characters will be displayed as spaces when viewed from the TopLeaf GUI.

Restructuring or moving a repository

The TopLeaf GUI Open dialog allows you to rename or duplicate a selected repository level or partition. If you need to move a publication to any other level within the same or a different repository then you must work directly with the file system. The general procedure for moving an existing publication to a new location is to first create a target folder for the publication, then copy the publication into that folder. After renaming or moving a publication, it is recommended that you recompose each partition within the publication.

A partition can only be moved into an existing publication level.

Each repository declares a number of components that may contain information specific to the machine on which they were created. This means that care must be taken when copying a repository to a different machine or platform.

The following repository components may contain machine specific information:

Component Scope Notes See also
Font configuration table Repository, publications Ensure that all fonts referenced in the font configuration are installed on the target platform or machine. Font configuration
Linked Documents Partition A linked partition document path must be valid on the target platform or machine. Source document
Linked DTD Partition If a partition references a linked DTD file then the linked file path must be valid on the target platform or machine. DTD File
Linked CATALOG Partition If a partition references a linked CATALOG file then the linked file path must be valid on the target platform or machine. Catalog File
Auto exported files Partition The file paths for all automatically exported derived files must be valid on the target platform or machine. Export To...
Published content Legacy looseleaf partitions Looseleaf partitions created by TopLeaf 7.6 or earlier cannot be renamed or repositioned within a TopLeaf repository. Looseleaf publishing

Reserved folders

The repository level names graphics and notesdef are reserved for use by TopLeaf.

Common drive letter

TopLeaf resolves repository paths into a standard Windows pathname including drive letter. Users accessing the repository across a network will experience problems if they use a different drive letter or folder path to access the root level of a shared TopLeaf repository.

Workaround: always access a shared TopLeaf repository using a fixed drive letter and/or folder path.

Page comparison

The pages generated for the initial release of a full looseleaf or change pages partition reference embedded graphics using absolute file paths. As a consequence, users accessing the repository across a network will experience problems when output differencing these pages.

Workaround: ensure that all images referenced in an initial release are accessible from a common absolute folder path.