Set Property

Command line:
tlapi ‑cSETMODE [‑isFile] sPart sSymb
Command line:
tlapi ‑cSETPROP [‑isFile] sPart sSymb
Library call:
nStatus = TLsetmode (sPart, sFile, sSymb, nType)

Function

Set one or more partition properties or typesetting indicators. The command line function SETPROP is an alias for SETMODE.

Arguments

sPart

The path of the partition for which the property is to be set.

sFile

The full pathname of a text file containing one or more property settings.

sSymb

A string containing a single property declaration of the form SYMBOL=VALUE

nType

A value that identifies the property type, and is one of:

Type Meaning
1 Assign one or more partition properties
2 Assign one or more typesetting indicators

Partition properties

When setting a partition property, the value of sPart identifies a partition level in the current TopLeaf repository. Each property assignment defines a property name and value.

The following table indicates the set of partition properties that can be defined by the user:

Property Meaning
BCHECK In a full looseleaf partition, declares the Enable review of published boundaries mode. If YES, then you can review the published leaf boundaries when the partition has been moved to the published phase, else NO
CATALOG Declares the name or path to the primary CATALOG file associated with this partition.
DEBUG Declares the Enable Debug mode. If YES, then the typesetting debug mode is enabled, else NO
DTD Declares the name or path to the primary DTD file associated with this partition. In DTD-less mode, this value will be ignored.
EXLINE Declares the property Show Output page line engines mode. If YES, then output line endings will be visible when the content of an update phase is exported, else NO
EXMARKERS Declares the property Export leaf boundary markers mode. If YES, then leaf boundary markers will be visible when the content of an update phase is exported, else NO.
EXNOCHANGE Declares the Exclude all leaves with unchanged output mode. If YES, then leaves with unchanged output will be excluded from a release, even if the input change checking process registers an input change for the leaf. Else NO
SINGLEPAGE Declares the property Single Page Leaves. If YES, then single page looseleaf mode is enabled, else NO
INEXCH Declares the Check all pages for output changes mode. If YES, then output change checking is enabled, else NO
LFIND Declares the property Use default leaf indicators. If YES, then the typesetting engine will apply the default partition leaf indicators to all new pages or leaves created in this update, else NO.
LLB Declares the Enable secondary transforms mode. If YES, then secondary transforms mode is enabled, else NO
LLJOIN Declares the Optimise Input Change Tracking mode. If YES, then optimised input change tracking is enabled, else NO
MARKERS Declares the property Show Leaf Markers, or marker/marker-less looseleaf mode. If YES, then markerless mode is enabled, else NO
MARKUP_TYPE Declares the default document markup language for the partition. The value of this property is one of GENCODE, XML, or SGML.
PART_TYPE Declares the partition type. If LEAF, then the partition is a looseleaf partition. If BOOK, then the partition is a non-looseleaf partition.
PACK Declares the maximum number of releases retained when updating this partition. This value is accessed from the GUI versioning property Keep N releases
POC Sets the Only check for output changes when publishing mode associated with this partition. If YES, then TopLeaf will only check for output changes when publishing an update, else NO
UNDO Declares the maximum number of undoable edits retained for each update cycle. This value is accessed from the GUI versioning property Keep N undo levels
USEDTD Indicates if a primary DTD has been associated with this partition. If YES, then the typesetting engine will use the primary DTD associated with the partition, else NO and the typesetting engine will run in DTD-less mode.
SVPUBDOC Declares the path of an automatically exported Partition Document file
SVPUBNDX Declares the path of an automatically exported Index file
SVPUBTOC Declares the path of an automatically exported TOC file
SVPUBXREF Declares the path of an automatically exported XREF file
SVPUBLIV Declares the path of an automatically exported Filing Instructions file
SVPUBIND Declares the path of an automatically exported Leaf Indicators file
SVPUBPDF Declares the path of an automatically exported PDF file
SVPUBHTML Declares the path of an automatically exported HTML file
SVPUBRTF Declares the path of an automatically exported RTF file
SVPUBEPUB Declares the path of an automatically exported EPUB file
SVPUBCHM Declares the path of an automatically exported CHM file
SVPUBTEKR Declares the path of an automatically exported tekReader file
SVUPDATE

Declares the Export after running the composition engine states for each of the automatically exported files (see above).

The assigned value consists of a list of 9 fields. The field separator character must be a colon (:). Each field value is an integer. If the field value is 1, then the state is enabled and if defined, a partition export file will be exported each time the partition is typeset. If the field value is 0, then the state is disabled, and the associated export file will only be exported when the partition update is published.

The fields are defined as:

Field #1 - 0/1, export partition document (SVPUBDOC)
Field #2 - 0/1, export partition index (SVPUBNDX)
Field #3 - 0/1, export partition TOC (SVPUBTOC)
Field #4 - 0/1, export partition filing instructions (SVPUBLIV)
Field #5 - 0/1, export partition leaf indicators (SVPUBIND)
Field #6 - 0/1, export partition as PDF 
Field #7 - 0/1, export partition XREF 
Field #8 - 0/1, export as HTML (secondary transform)
Field #9 - 0/1, export as RTF (secondary transform)
Field #10 - 0/1, export as EPUB (secondary transform)
Field #11 - 0/1, export as CHM (secondary transform)
Field #12 - 0/1, export as tekReader (secondary transform)
SVPOSTPROC

Declares the partition Post-Process command details.

The assigned value consists of a list of 5 fields. The field separator character must be a pipe (|).

The fields are defined as:

Field #1 = 0/1, enable/disable postprocessing step
Field #2 - 0/1, run after running the composition engine
Field #3 - 0/1, run in a minimised window
Field #4 - string, the name of the command to execute (eg. perl.exe)
Field #5 - string, the command arguments 
WNOPUB

Permit publishing a partition, even if the composition engine generated warnings. If YES, then TopLeaf will publish an update even if the composition engine generated warnings, else NO (default, cannot publish if composition engine generated warnings)

Typesetting indicators

When setting a typesetting indicator for the current update, the value of sPart identifies a partition level in the current TopLeaf repository. Each property assignment defines name of a typesetting indicator and value.

The following table indicates the set of typesetting indicators that can be defined by the user:

Property Meaning
PUBNUM The typesetting keywords string
PARTNAME The value of the partition ID string (linking to the next partition in a sequence of partitions)
STARTPAGE The typesetting start page for the partition
FOLIOMODE The folio mode to use when typesetting the partition
N_PARTNAME The value of the partition LINK ID string (linking to the next partition in a sequence of partitions)
N_PARTPAGE The value of the partition LINK FOLIO string (linking to the next partition in a sequence of partitions)

Examples

Command line:

tlapi ‑cSETMODE manuals/topix/vol1 "DEBUG=YES"

Library call:

status = TLsetmode("manuals/topix/vol1", NULL, "DEBUG=YES", 1L);

Scripting call:

Not available.

Notes

  1. You can use a properties template file to set one or more properties.

  2. You cannot use a single call to this function to set properties from both a template properties sFile and a symbolic sSymb assignment.

  3. The value of a typesetting indicator cannot be set using the command line interface.

  4. Partition indicators or default leaf indicators cannot be set using this function.