JavaScript is disabled on your browser. Please enable JavaScript to enjoy all the features of this site.
Turn-Key Home
TopLeaf Documentation
Looseleaf publishing and version control
Sidebar
Prev
|
Up
|
Next
Full looseleaf publishing
Contents
Search
Release Notes
TopLeaf 8
TopLeaf licensing
Mapping Editor
Mapping Assistant
TopLeaf GUI
TopLeaf API
TopLeaf Help
8.0.020
Enhancements
CALS table support
Repository dialog improvements
Data block link lines
Custom code analyzer
Assigning metadata properties
Opening a partition from the command line
List of recent partitions
Bug Fixes
Mapping table row vertical spans
Unexpected differences when rendering breakable and unbreakable boxes
Variable expressions in conditional commands
Compiled stylesheet files
Font processing error
Variables in quotes not expanded in string assignment
Unexpected error when scanning processing instruction
Removal of obsolete GUI export option
Incorrect binding when processing full looseleaf partition
Unexpected secondary transform failure when processing invalid tag
Incorrectly positioned leaf boundary
Format options dialog
Incorrect line measure applied to last line of paragraph
Stylesheet options file is deleted
8.0.019
Enhancements
Inspection of page and leaf properties
Table cell indents
Data block link lines
Allow ancestor name in mapping attribute selector
Split page footnote separator
Bug Fixes
Using tag occurrence within vertically spanned table rows
Incorrect line leading when processing a paragraph inline mapping
Mapping Assistant failed when processing a bad table row vertical span
Image placement is incorrect
Incorrect paragraph left margin
Setting the label minimum gap and minimum depth
Clarification of Type 1 font support
SVG image sizing
Breakable fixed width space becomes unbreakable
Abnormal exit if processing instruction declared in a table row
TopLeaf libraries not found on PATH
Link target fails when linking to table tag
Mapping Editor did not remove typeface schemes when the last scheme was removed
Rotated text does not appear in secondary transform/assistant input
Incorrect output generated for empty rotated text
Unexpected page footnote error when processing legacy style sheet
Multiple blank lines rendered as a single line
Character entity references not processed in release label
Clarification of maximum number of point page levels
Composition engine timeout when vertically aligning content
Data layout options did not always override block settings
Incorrect folio assigned to 999(ab) point pages
Error if page folio length exceeds permitted maximum
Page change ignored when processing legacy style sheet
8.0.018
Bug fixes
8.0.017
Enhancements
Creating a list of telltales declared within a page
Improvements to hyphenation
Disabling stylesheet mappings
Overriding the line breaking rules
Extend use of bracket pair level separators to all stroke page formats
Improved JPEG image support
Conditionally testing if an attribute exists
Bug Fixes
Table headers not cancelled
Unexpected vertical spreading between table rows
Missing table frame rule
Mainwork declares unexpected leaf groups on forced end of leaf
Disable paragraph tab for table and row mappings
Widow/orphan settings ignored when processing split table row
Unexpected breakable space after line break
Hyphenation not applied if word follows an unbreakable space
Incorrect widow/orphan binding within breakable box
Word break characters not honoured
Unexpected warning when processing inline root element mapping
Abnormal exit when processing an undefined table column name
Paragraph binding not honored when referencing split page footnote
Incorrect value reported within composition log file
Ignore reset margins in Mapping Editor note mappings
Incorrect position of leaf boundary after processing a column break
Incorrect font applied after processing a link line
Error processing an empty table row
Error when processing a duplicate page footnote
Rename legacy footnote mapping when upgrading stylesheet
8.0.016
Enhancements
Bug Fixes
Presentational forms incorrect when processing U+0621
Limit nesting depth of elements
Incorrect section identifier assigned at start of leaf section
Value changed incorrectly in Mapping Editor combo box
TOC entries from stroke pages not included in generated table of contents
GUI progress bar is not updated when locating leaf boundaries
Unexpected leaves flagged by looseleaf input differencing
8.0.015
Enhancements
Mapping display order
Persian RTL support
Processing the content of a scanned top level table tag
Bug Fixes
Incorrect presentation order when processing neutral characters
Incorrect direction assumed at start of overflow line
Breakable box bottom frame does not bind to enclosed content
Bind to last row of table is not honoured
Unexpected warning if a forced break occurs within a breakable box
Abnormal exit when processing unbreakable space
Incorrect sidenote alignment at start of table
Word breaking characters ignored when processing bidirectional content
Incorrect alignment when processing RTL paragraph
Page comparison error is not reported
Composition engine timeout when processing page footnote
Nesting a breakable box within a breakable box
Prescan fails when processing non UTF-8 documents
8.0.014
Enhancements
Alignment of single line paragraphs
Custom code analyzer improvements
Mapping editor improvements
Changing the name of a typeface scheme
Override boundary marker mode when updating content
Enable back-tracking for mapping path selection
Bug Fixes
Namespace definitions not retained in scanned tags
Table scanning restrictions
Incorrect style for float references
Binding ignored when processing split page footnote
Footnote not rendered
Quotes within a processing instruction cause scanning to fail
Corrupted rotated text
Unexpected error when disabling split footnote processing
Error importing CSS stylesheet
Error processing legacy table style
Incorrect figure bind in DITA stylesheet
Properties set when selecting the current partition
Disable import and scheme edit in map editor if read-only
Incorrect display of rotated text
Unexpected error when creating PDF output
Cannot update typesetting indicators
8.0.013
Enhancements
Allow selection of multiple files on graphic import
Creating and modifying typeface selection schemes
Bug Fixes
Malformed attributes not reported
Value of <page-info> current-width is incorrect
Normalise space in EPUB table of contents
Unexpected newline after published leaf boundary marker
Switch to custom content tab when displaying invalid content
Incorrectly formatted initial release label
SVG conversion can fail when using a non-Oracle JRE
TopLeaf workstation page preview zoom settings
Changing custom font did not adjust non-displayable characters
Initial leaf boundary hyphenation status is discarded
Secondary transformation fails when processing malformed CALS table
Unexpected full looseleaf validation error
Template inheritance not updated correctly after an undo
Ignore partition name in initial leaf boundary declaration
Rendering of table columns within secondary outputs
Inconsistent CHM secondary transform enable/disable state
Setting transform properties from the TopLeaf workstation
Secondary outputs listed in TopLeaf partition exports
Duplicate files error when processing tekReader secondary transformation
8.0.012
Enhancements
Content binding properties
Improved selection of blocks within page layouts
Generation of CHM files
Declaring leaf specific release labels in an initial release
Vertical alignment within Headers and Footers
Converting numbers to a formatted string
Bug Fixes
Comma causes release-properties label to be ignored
Remove inconsistences in entity reference parsing
Secondary transforms now honour xml:space
Incorrect leaf split if table header content is hyphenated
Set default based-on for mappings created in the assistant
Table header and body styles could not be set to {inherit} in $document mapping
Add diagnostic when processing an SVG image with no size
Incorrect leaf split when processing empty tag at end of leaf
8.0.011
Enhancements
Improvements to PDF output
Bug Fixes
Defaults for table style properties
Minimum segment split height is ignored
Incorrect value returned for a data telltale
Incorrect paragraph style after processing inline leaf boundary
Unexpected space within box
8.0.010
Enhancements
GUI default dialog font
Highlight variable references within custom content
White space removal at end of a leaf
Custom code analyzer
Page footnote reference binding
Bug Fixes
Tables within secondary transformation file are not well formed
Reporting of <xmlproc/> parsing errors
Abnormal exit on Linux
Incorrect API status reported after an abnormal exit
Highlighting within tags sometimes incorrect
Do not allow space before/after = in attribute definition
Incorrect page spreading within tables
Restrict color palette names to 7-bit characters
Restrict page layout names to 7-bit characters
Restrict PDF profile names to 7-bit characters
User defined thin space width not honored
Legacy page hold not terminated
Unexpected binding error when processing a footnote
Incorrect value returned for a data telltale
Incorrect interword spacing
8.0.009
Enhancements
DITA integration
Typeface scheme editor
Editing custom content
Bug Fixes
A zero value in a typeface scheme range terminates the list
Abnormal exit when processing comment
Single column table does not column balance
Mapping Editor does not remember current image browse path
Mapping Editor sets incorrect initial settings for Label mappings
CJK line breaking
Stylesheet compiler reported errors for zero measures with no units
Inconsistent default for table style properties
HTML transform dialog contained duplicate property
Generated targets placed in the wrong file
Perl call fails for arguments larger than 32K
Box incorrect in RTL mode
Preferences dialog incorrectly displayed 64-bit Java runtimes
Incorrect table cell step alignment
Output difference ignored
Unexpected error if PI declared within scanned content
Unexpected error if PI declared within table cell
Rotated text metrics incorrect when using a scheme
Error merging footnotes from a bound region
Incorrect footnote reset after split page footnote
8.0.008
Enhancements
Characters permitted within user variable names
New Mapping dialog help button
Bug Fixes
Cannot assume all 8-bit characters come from same font
Widow/orphan request ignored when processing split page footnote
Unexpected font applied after changing the current language
Do not publish an undefined linked mainwork document
Error processing oversized inline image
Legacy page hold always ignored
Single quotes in argument cause Perl failure
Mapping Assistant failure with large images
False output differences
Unicode properties wrong for some characters
Mapping Editor did not close font and scheme configuration files
Chinese font causes Arabic diacritics to be positioned incorrectly
Incorrectly positioned leaf boundaries
Hard space characters displayed incorrectly
Glossary demonstration generates unexpected errors
Attribute with empty string value returns incorrect value
Cannot reference attribute values in legacy tag mappings
Unexpected white space when replacing a full looseleaf document content
Leaf boundary ignored when processing scanned content
Incorrectly positioned boxes within RTL tables
Unexpected error when referencing a note from within a split table row
Live pages listing on Linux installations
Check for unmappable CALS and HTML table tags
Incorrect leaf split at hyphenated leaf boundary
Cannot define partition leaf indicators
Incorrect processing of XML comments
Box frame within a split float is missing
Custom table processes backslash character incorrectly
Command selector in Mapping Editor did not update command list
Vertical justification mode not honored at end of leaf
Mapping Editor command dialog is empty
Mapping Editor selected incorrect typeface in list
Arabic diacritics positioned incorrectly
8.0.007
Enhancements
Interword spacing
Image import
Improved publication/partition copying
Improvements to Layout Editor
Add DITA file types in replace document dialog
Improvements to Mapping Editor
Index sorting option to keep punctuation at start of item
Simplify processing of non-breaking spaces
Overriding the line breaking rules
Mapping Editor access to TopLeaf Help
Bug Fixes
Abnormal exit if "end partition" mode not enabled
Incorrect mapping in secondary transform file
Ignore undefined jump targets in secondary transforms
Missing leading in $document is treated as 0.1pt
Layout was not recompiled after an undo last save
Table tags incorrectly coerced to lower case
Cannot set box text indents to zero
Black font color treated as inherit
Restore mapping assistant position after reload
TopLeaf workstation generated an abnormal exit when including a leaf group
Value of attribute variable is incorrect
Mapping Assistant could hang on find if no match was found
Cannot open file from partition booklist
Invalid Xref entry
Error loading Mapping Assistant content
Label offset ignored in $pagenote-body and $colnote-body mappings
Abnormal exit when processing CALS table in SGML mode
Java path not reset after changing GUI preferences
Duplicate page footnote is missing
Inconsistent default partition type in Workstation and API
Error referencing a deleted mapping
Mapping Editor did not fully honour read-only setting
Tag occurrence mappings ignored
Table & box style not set when copying a mapping
CJK line breaking
Graphics warnings not reported
Page footnote position is incorrect
8.0.006
Enhancements
Mapping Assistant
Referencing more that one page footnote from bound content
Bug Fixes
Unexpected implicit binding within split table row
Box rules drawn incorrectly when table row splits
Unexpected footnote continuation block
Linux java shared library problems
Unnecessary mapping occurrence tracking
Partition release temporary folder created in partition folder
Unexpected column boundary warning
Incorrectly rendered BIDI content within inline element
Fixed space widths
Entities written to secondary transform file
Embedded leaf boundaries in unchanged leaves
8.0.005
Enhancements
Referencing more that one page footnote from a single line
Redefining the width of a thin space
Bug Fixes
Names in tags must not be coerced to lower case
Sidenote position is incorrect
Binding not cancelled at column break
Page footnote does not split if processed at end of segment
Custom content fields in Mapping Editor were sometimes shown incorrectly
Unexpected space above data segment
Partition phase not set after publishing update
8.0.004
Enhancements
Mapping import
Add undo save to Mapping Editor
Image processing
Bug Fixes
Page footnote incorrectly split when referenced from within split table row
Line breaking within CJK and RTL content
Mapping Editor used wrong property value for index="xref"
Mapping Editor did not allow label offset for $colnote-body or $pagenote-body
Auto ID generation within tekReader secondary transformations
Widow/orphan settings ignored when splitting table rows
Allow non-ascii characters in <xmlproc/> xpath expression
Incorrect API error status if partition path does not exist
Java API failed when the transform parameters property was an empty string
Ignore leaf boundary markers within <xmlproc/> content
Incorrect rendering of mixed bidirectional content
Sort new items in the Mapping Editor "based on" list
New mappings based on existing mapping don't copy unsaved properties
Unexpected warning when processing end column request at start of page
DITA deferred id's not processed if title map has no pre-content
8.0.003
Bug Fixes
Mapping Editor failed if font configuration file contained unescaped & characters
Mapping Editor invalid content dialog gives wrong result when closed
Incorrect tag white space normalisation when reading leaf
8.0.002
Bug Fixes
Unexpected error when opening mapping stylesheet in European locale
False change indication reported
Missing paragraph alignment options
8.0.001
Enhancements
Allow Java arguments to be set in GUI preferences
Add "breadcrumb" navigation to top of each help page
Bug Fixes
Page file corrupted
Skip target creation for non-DITA elements
Restrictions when importing from CSS
Error if empty <custom-pre/> or <custom-post/> declared in mappings.tlx
Cannot create EPUB file
Transform warning for some java versions
Missing content when processing an inter-segment binding
Mapping compiler should ignore some properties if merging with next
Split page footnote within bound content is discarded
Linux linking problem
Limit to first page when previewing PDF
Nested table header breaks from table body
Java interface returned failure on secondary transform warnings
Fix DITA pre-processing for OT 2.0
Abnormal exit when rendering table cell fill
Incorrect vertical spreading between splittable table rows
Incorrectly positioned <folio/> reference in rotated fixed block
User Guide
Introduction to TopLeaf
What is TopLeaf?
Where does TopLeaf fit into your document production system?
Structure of the documentation
Structure of this volume
Assumed knowledge and conventions
Quick start guide
Installing TopLeaf
Creating a PDF
Working with stylesheets
Getting started with DITA
Getting started with other XML
Typesetting concepts
Mapping basics
Layout basics
Content assembly
Blocks and paragraphs
Margins and indents
Margins
First/left indent
Last/right indent
Images
Vertical spacing
Interword spacing
Leading
Binding
Explicit binds
Implicit binds
Widows and orphans
Internal boundaries
Image scaling
Paragraph merging
Labels and lists
Language support
Line breaking
Page assembly
Column balancing
Vertical alignment
Typesetting structures
Running heads
Data telltales
Notes
Footnote types
Footnote structure
Sidenotes
Endnotes
Floats
Boxes
Tables
Custom tables
Cell borders
Split table rows
Margin rules
Links
Link content
Character rendering
Definitions
Procedure
Typeface selection scheme
Operation
Example
Typeface selection for secondary transforms
Character map
Declaring a character map file
Character map file structure
The <range> element
The <replace> element
Hyphenation
What is hyphenation?
Language specific hyphenation
Controlling hyphenation
Hyphenation exception dictionaries
Using a hyphenation exception dictionary
Exception dictionary file format
Restrictions
Bidirectional processing
Document directionality
Block directionality
Paragraph directionality
Contextual directionality
Character directionality
Image and rules
Data block allocation order
Tables
The repository
Repository components
Releases
The release label
Publishing a release
Repository path names
Working with partitions
Partition content
Book lists
Configuration files
PDF profiles
Font configuration
Typeface selection
Character mapping
Color palette
Stylesheets
Stylesheet files
Mappings Source Format
options element
mapping element
start element
end element
content element
para element
font element
table-style element
box-style element
image element
custom-pre and custom-post elements
convert element
Importing a CSS stylesheet
Selectors
Cascading
Importing other CSS stylesheets
Font names
Generated text
Recognized properties
Shared repositories
PDF creation
PDF profiles
PDF and fonts
Bookmarks
Watermarks
Viewer preferences
Security settings
Metadata
Page labels
Additional PDF files
Example
Omitting pages
JavaScript links
Linking to named destinations
List of metadata properties
Contents, indexes and other generated data
Tables of contents
Entries and levels
The PDF table of contents
Including the TOC file
TOC file format
Content based TOCs
Index generation
Entries and levels
Index entry markup
Including the index file
Index file format
Index post-processing
Index sorting
Grouping
Ranges
See and See Also items
Cross referencing
Marking up an Xref
Using the Xref file
Xref file format
Using Xrefs
Live pages and filing instructions
Filing instructions
Using the filing instructions file
Filing instructions file format
Secondary output transformations
Characteristics of primary and secondary outputs
Stylesheet overrides
Content extraction
Enabling secondary outputs
Secondary output options
HTML transform properties
Starting a New File
Image Scaling
RTF transform properties
Page Size and Margins
EPUB transform properties
Creator names and roles
CHM (HTML Help) transform properties
tekReader transform properties
Uploading the publication
Including additional files
Generating indexes
Document identifiers
Looseleaf publishing and version control
Basic concepts
What is looseleaf publishing
Looseleaf terminology
Looseleaf methods
Method comparison
Full looseleaf
Change pages
Marking the extent of changed content
The looseleaf production cycle
Release management
Setting up a looseleaf partition
Publishing the initial release
The update cycle
Changing the stylesheet
Change pages publishing
How change pages publishing works
Page groups
Setting up change pages publishing
Life cycle of a change pages partition
Determining which pages have changed
Page comparison
Excluding specific content
Full looseleaf publishing
How full looseleaf publishing works
Numbering schemes
Partition based numbering
Section based numbering
Setting up full looseleaf publishing
Page folio format
Point pages
Boundary markers
Processing published leaf boundaries
Determining the position of leaf boundaries
Content scanning
Page and leaf boundaries
Paragraph boundaries
Examples
The leaf status
Changed and deleted content
Manual leaf inclusion
Conditional leaf inclusion
Embedded leaf boundaries
Optimizing input change tracking
Output page comparison
Link lines
Position and style
Content
Blank back (left hand page)
Single page leaves
Setting indicators
Next partition indicators
Leaf indicators
Renumbering leaf groups
Renumbering leaf sections
Importing an existing looseleaf document
Procedure
Identifying existing leaf boundaries
Positioning leaf boundaries
Leaf specific release labels
Creating an initial set of published pages
Restrictions
Link considerations
DITA processing
How to process DITA content
Mapping selection
Targets and links
Target creation
Target positioning
Link evaluation
Topic identification
Page numbers
DITA pre-processing
Map titles
Deferred link targets
Simpletables
Index terms
Draft items
Demonstration stylesheets
The book stylesheet
$headfoot//booktitlealt
map
bookmeta
topicref
topic//topic
xref
figurelist
Workstation reference
Preview pane
Navigation pane
The partition icon
The Format Files tree
The Pages tree
Menus
File
File » Open …
File » Close
File » Save As …
File » Publication
File » Export …
File » Partition Properties …
File » Filing Instructions …
File » Transform to
File » Print Preview
File » Print Special
File » Print
File » Create PDF
File » Print Setup …
File » Preferences …
File » PDF Profiles …
File » 0-9
File » Exit
Commands
Commands » Unlock
Commands » Undo
Commands » Cancel Update
Commands » Cancel Publish
Commands » Edit
Commands » Compose
Commands » Debug
Commands » Renumber …
Commands » Replace Partition Document…
Commands » Add Files to Partition …
Commands » Edit partition document list...
Commands » Leaf Split
Commands » Stylesheet Upgrade
Commands » Indicators…
Commands » Label this Release
Commands » Refresh published pages
Commands » Publish
Commands » Next Update
View
View » Preview Changed Pages in a Separate Window
View » Only show changed pages in Page Tree List
View » Show Boundary Markers when Editing Partition
View » Composition Log
View » Publish/Update Phase
Page
Page » Previous
Page » Next
Page » Go To …
Page » Facing Pages
Preview » Full Page
Page » Zoom
Page » Refresh
Format
Format » Mappings...
Format » Page Layout...
Format » Headers & Footers...
Format » Notes & Running Heads...
Format » Import Stylesheet Images...
Font Configuration …
Color Palette...
Options
Format » Generate Mappings from XML...
Format » Import Mappings from CSS...
Format » DTD File
Format » Catalog File
Legacy Format Files
Tools
Arguments
Initial Directory
Properties
Windows
Help
Help » Contents
Help » Enter License Keys
Help » Turn-Key Systems Home Page
Help » About TopLeaf
Menu accelerator keys
Toolbars
Title bar
Standard toolbar
The File group
The Output group
The Transform group
The Edit group
The Compose group
Stylesheet toolbar
Looseleaf toolbar
Preview toolbar
The Navigation group
The Display group
Indicators
Partition indicators
Keywords
Status bar
Dialogs
Open dialog
Creating new levels
Other operations
Copy To...
Delete
Rename
Print
New Partition
Source document
DTD File
Catalog File
Publication Options
Tag mappings
Paper Size
Table Model
Preferences
The Folders tab
The Editors tab
The Environment tab
Symbolic variables definition file
Catalog file
The General tab
The Languages tab
Partition Properties
The Looseleaf tab
The Compose tab
The Exports tab
Setting an export location which is independent of the repository location
Versioning
The Post-process tab
The DTD & Catalog tab
DTD File
Catalog File
Format Options
Table model
Rule Weight
Measurement units
Document language
Hyphenation method
Hyphenation precedence rules
General preferences
Print
Create PDF
Transform
Font Configuration
Typeface styles
Managing typefaces
Non-Unicode typefaces
PDF Profiles
The General tab
The Fonts tab
The Links tab
The Security tab
Content Suppression
The Images tab
The Colors tab
The Page tab
Offset definition
The Watermarks tab
Text Details
Image Details
Watermark Page Selection
Color Palette
Using the color palette
Removing a color palette
Page Properties
Leaf Properties
Manually including leaves
Leaf groups
Suppressing link lines
Indicators
General indicators
Keywords
Partition Indicators
Default Leaf Indicators
Label Release
Renumber
Add Files
Restrictions
Go To Page
Save As
Exporting leaf and page boundary markers
License Keys
Technical specifications
XML and SGML conformance
Input documents
Documents assumed to be valid
XML name characters
User variable name characters
Comments
Entity resolution
DTD interpretation
SGML declaration
CALS table processing
Implementation
Table directionality
Table nesting
Table orientation
Column separators
Row separators
Table groups
Row groups
Table columns
Column widths
Cell horizontal alignment
Cell vertical alignment
Cross page cell vertical spanning
Row splitting
Tag processing
Unsupported features
Limitations
HTML table processing
Implementation
Table width and alignment
Table directionality
Table nesting
Table frames
Internal table rules
Row groups
Table columns
Column widths
Cell margins
Cell horizontal alignment
Cell vertical alignment
Cross page cell vertical spanning
Row splitting
Tag processing
Unsupported features
Restrictions
Advanced SGML features
Attribute handling
Pseudo parameter entities
OASIS catalog support
Language support
Line breaking rules
CJK languages
RTL languages
Mixed script content
Legacy line breaking algorithm
URL line breaking
Soft hyphens
Spaces
Unicode support
Implementation
Partition
Mappings
Layout
Typesetting structures
Custom content
Notes and floats
Page size and measures
Full looseleaf publishing
Input leaf comparison
Page folio format
Point page level separators
Page comparison
Partition releases
Page assembly
Page timeout interval
Page output layering order
Fonts
Type 1 fonts
OpenType fonts
Images
Bitmap images in SVG images
TIFF images
Limitations
Repository
Common drive letter
Repository folder name
Page comparison
Publication stylesheets
Undoing changes to style sheets
Full looseleaf publishing
Graphics
Custom tables
Renaming partitions
Custom content
Use of ^ in custom content
Use of > in custom content
Paragraphs
Merging paragraphs
Tables
Implementation
Table model
Table elements
Table spacing
Table headers
Table rows
Table cells
Scanned content
Row separators
Boxes
Breakable boxes
Box nesting
Box margins
Box spacing
Fixed block box frames and fill patterns
Fonts
Font characteristics
Images
Filename characters
PDF
Link destinations
URI schemes
Secondary output transformations
Typefaces and Fonts
Images
Tables
Headers and Footers
Sidenotes
Footnotes
Fills
Text Direction
Markup
Running heads
Automatic link targets
Temporary files folder
Supported platforms
Windows
Linux
Licensing
Features
Third Party software requirements
GhostScript
GhostScript location
EPS image files
Calculating the size of an EPS image
Unexpected font substitution within EPS graphics
PDF image files
Restrictions
Calculating the size of a PDF image
SVG image files
Calculating the size of an SVG image
PDFlib+PDI
Glossary
Glossary
Page Layout
Introduction and Terminology
Organization of this Manual
Layout Definitions
Areas
Blocks
Layout Editor Interface
Page type Display
How To Define a Layout
Setting Up a Simple Layout
Having Different Left and Right Pages
Having a Different First Page
Using More Than One Page Type on a Page
Mapping page change requests
Layout Editor Reference
Selecting A Block
Changing Block Dimensions
Using the Mouse
Entering Dimensions
Creating a New Page Type
Creating a New Block
Copying a Page Type
Page Details
Data Details
Automatic Data Block Creation
Block Details
Data Block Fields
Fixed Block Fields
Fixed Rule Fields
Side Note Fields
Margin Rule Fields
Options
Templates
Fixed Block Inheritance
Viewing Two Page Types
The blank Page Type
Link Lines
Paper Sizes
The Crop Area
Crop Mark Style
The Difference Area
Block Mirroring
Layout compilation
Menu Reference
The File Menu
The Edit Menu
The View Menu
The Help Menu
Toolbar Reference
Mapping Guide
Mapping — What and Why
Overview
Types of marker
Tag markers
Custom markers
System markers
Processing instructions
Markers and mappings
Mapping properties
Measures
Colors
Using variables
The $document mapping
Mapping restrictions
Defining and selecting mappings
Creating a new mapping
Editing the selection criteria
Deleting a mapping
Modifying a mapping
Custom markers
Tag in context
Attribute selector
Occurrence
Restrictions
Example
Page context
Based on
Priority and Precedence
Importing mappings
Mapping Assistant
Locating mappings
Creating mappings
Finding text
Text display preferences
Text display limitations
Start Tag tab
Classification Group
List-Item types
Assigning multiple labels to a list item
Mapping CALS table tags
Mapping HTML table tags
Paragraph group
Rules group
Page group
Select page type
Insert break
Priority
Page break
Vertical align
Horizontal line above
End Tag tab
Cancel group
Paragraph group
Merging paragraphs
Rules group
Page group
Select page type
Insert break
End partition
Other properties
Content tab
General group
Notes group
Note styles
Page vs Column footnotes
Content model
Data group
Running heads
Data telltales
Generated data group
Assigning TOC levels
Assigning Index levels and XREF
Links group
Creating a link
PDF Link resolution
Secondary output link resolution
Linking to other PDF files
Linking to a specific page within another PDF file
Creating a link target
Restrictions
Content model
White space processing
Scanned content length
Within tables
Paragraph tab
Margins group
Reset margins Selector
Restrictions
Line indents group
First/Left Indent
Last/Right Indent
Inheritance
Indenting merged blocks
Spacing & Alignment group
Vertical spacing
Alignment
Label offset
Vertical space retention
Label styles
Minimum Gap
Minimum Depth
Other options
Interword spacing
Last line alignment
Single line alignment
Widow/orphan lines
Direction
Vertical alignment
Examples: Margins, indents and offsets
Font tab
Selecting a Font
Typeface
Size
Leading
Color
Background color
Font characteristics
Bold
Italic
Small
Superscript
Subscript
Underline
Lower Case
Upper Case
Reverse
Frame
Overbar
Strikeout
Use kerning
Using variables to assign font characteristics
Other options
Horizontal scale
Character spacing
Baseline position
Hyphenation
Tables tab
Spacing group
Frame & cell borders group
Mask
Style
Weight
Color
Cell indents group
Effects group
Other table settings
Reset margins
Bind to current paragraph
Implied column/row separator visible
Rendering internal rules
Show page break row separator
Restrictions
Box tab
Spacing group
Frame group
Type
Style
Weight
Color
Text indents group
Effects group
Other box settings
Breakable box
Show page break separator
Reset margins
Fixed depth
Restrictions
Image tab
File group
Predefined folder paths
Relative file paths
URI resolution
Supported graphics formats
Size and Orientation fields
Setting field values from variables
Image size
Image transparency
Scalable image formats
Troubleshooting
Custom tab
Custom content
Overview
Adding or editing custom content
Insert code
New window
Validate
Reserved characters
Whitespace handling
Examples
Commands
Command arguments
List of commands
Variables
User variables
Attribute variables
Default or implied values
Namespaces
System variables
Environment variables
Declaring user variables
The <set/> command
Strings and values
Measures
String transformations
String information
Data telltales
Leaf and partition indicators
Metadata properties
PDF metadata properties
Secondary transform metadata properties
Variable expansion
Variables in text
Default values
Complex variable names
Stacking
Custom markers
Example 1 — Creating pseudo attributes or content
Example 2 — Adding new structure to your document
Spaces, rules and fills
The <space/> command
The <rule/> command
Examples
The <fill/> command
Examples
Content assembly
The <break/> command
The <end-column/> command
The <skip-leftpage/> command
The <cancel-bind/> command
Flow control
Conditional execution
Pattern matching
The <if> command
The <while> command
The <switch>..<case> command
The <debug/> command
The <log/> command
The <read/> command
Reading an external file that may or may not exist
Avoiding multiple reads of the same file
Reading part of a file
Generating a PDF page list
The <readgen/> command
PDF commands
The <bookmark> command
Zoom values
Actions
The <bookmark-properties/> command
The <named-target/> command
Tables
The <table-properties/> command
The <row-properties/> command
The <cell-properties/> command
Custom tables
Overview
table-start
table-column
table-head
table-body
table-nextrow
table-cell
table-emit
Example
Restrictions
Automatically generated table rows
Using a DTD
Headers and Footers
Margin rules
The <marginrule/> command
Change bars
Deletion markers
The <marginrule-properties/> command
Example
Font and Text
The <font-properties/> command
Thin space width
Configuring font characteristics
Defaults for configurable characteristics
Example
The <fontmask-properties/> command
Syntax
Font mask operation
Example
The <text-properties/> command
Overriding the line breaking rules
Language specific line breaking rules
The <dictionary/> command
Examples
The <hyphenation/> command
The <rotate-text/> command
Images
The <image-info/> command
The <image-properties/> command
PDF bounding boxes
Scaling images within bound content
The <import/> command
Placeholder pages
Generating placeholder pages
Notes
The <note-properties/> command
Footnote options
Sidenote options
Floats
The <float> command
Column floats
Example
Positioning column floats
Styling column floats
Processing of large float objects
Restrictions
Maximum column float depth
Other float types
Full column floats
Page and Full page floats
The <float-properties/> command
Example
Page segments
The <segment-properties/> command
Processing instructions
Passing PI content via a named attribute
Passing PI content as a list of attributes
Passing PI content as character data
Looseleaf, Change Pages, and Versioning
The <folio/> command
The <leaf-settings/> command
The <leaf-properties/> command
The <linkline-properties/> command
Link line style and content
Example
Restrictions
The <link-folio/> command
Examples
The <page-properties/> command
Change pages processing
Header and Footers
Vertical spreading
The <release-properties/> command
Looseleaf variables
The {release-label} variable
The {published-release-label} variable
The {release-number} variable
Content and variables
Content
Markup within variables
The <content-properties/> command
XML fragment processing
Namespaces in fragments
Restrictions
The <format/> command
Examples
The typesetting environment
The <topleaf-properties/> command
Import Folders
Page control and binding
The <page-info/> command
The <binding-properties/> command
Runtime variables
The <folio/> command
The <link-folio/> command
The <date/> command
The <topleaf-version/> command
The <telltale/> command
System variables
Generated files
Tag specific
Partition specific
Page specific
Page type specific
Perl extensions
The <perl-use/> command
The <perl-call/> command
Returning (Untagged) data from Perl
Passing XML structure into and out of Perl extensions
Example
Logging messages and errors
Perl extension properties
Custom content structure
Structural guidelines
Order of evaluation
Headers & Footers
Overview
The $headfoot mapping
Paragraph tab
Custom, Font and Box tabs
Property Inheritance
Commands
The <telltale/> command
The <headfoot-properties/> command
Vertical alignment of Header & Footer content
Notes
Overview
Note mappings
Property Inheritance
Page contexts
Custom content
Footnotes
Column footnotes
Page footnotes
Double column page footnotes
Footnote splitting
Footnote markers
Vertical spacing
Column footnotes
Page footnotes
Restrictions
Sidenotes
Sidenote placement
Restrictions
Running Heads
Levels and mappings
$runhead-separator
Building a Running Head
Running Feet
Floats
Column floats
Custom, paragraph, font, and table tabs
Box style
Images
Property Inheritance
Editor Reference
Saving
Reloading the layout
View history
Reverting mappings
Disabled mappings
Display units
General preferences
Custom preferences
Import mappings
Choose input file
Choose import default
Choose import actions
Summary
Property conflicts
Typeface selection scheme editor
Custom code analyzer
Troubleshooting
The Composition log file
Job information
The Pagination section
The Job Status section
Debug mode
Debug composition log
Error messages
API Manual
Introduction
Interface Details
Command Line Interface
Common Flag Arguments
Exit Status
Library Interface
Return Value
Using the Library
Scripting Interface
Return Value
Scripting Interface Properties
Repository
Partition
Phase
Status
Message
ComposeStatus
OutputFile
PdfLog
ChangedPages
AutoEditUnlock
Version
Markers
API Concepts
Repository Location
Partition Paths
Partition Phase
Looseleaf Release Control
Reference
API Calls by Function
List of Command Line Functions
List of Library Routines
List of Scripting Methods
API Call Descriptions
Commit
Function
Arguments
Notes
Examples
Compose
Function
Arguments
Scripting Call Return
Examples
Convert XML to PDF
Function
Arguments
Scripting Call Return
Example
Get Composition Log
Function
Arguments
Scripting Call Return
Examples
Get Diagnostic Log or Component File
Function
Arguments
Scripting Call Return
Examples
Get Data
Function
Arguments
Scripting Call Return
Notes
Examples
Get Generated File
Function
Arguments
Scripting Call Return
Output Format
Examples
Restrictions
Get Leaf Indicators
Function
Arguments
Leaf indicator record format
Examples
Get Live Pages
Function
Arguments
Notes
Scripting Call Return
Examples
Get Mapped PDF
Function
Arguments
Examples
Get Page Map
Function
Arguments
Notes
Examples
Get PDF
Function
Arguments
Scripting Call Return
Cross-PDF Linking
Processing Options
Examples
Get Print Image
Function
Arguments
Examples
Get Publication PDF
Function
Arguments
Examples
Get Transformed Output
Function
Arguments
Using Multiple Partitions
Scripting Call Return
Examples
Output transform diagnostic log file
Leaf Split
Function
Arguments
Notes
Examples
Make Partition
Function
Overview
Arguments
Scripting Call Return
Notes
Examples
Next Update
Function
Arguments
Notes
Examples
Pack Partition
Function
Arguments
Notes
Examples
Partition Export
Function
Arguments
Scripting Call Return
Examples
Partition Import
Function
Arguments
Examples
Preview
Function
Arguments
Examples
Print
Function
Arguments
Examples
Put Data
Function
Arguments
Scripting Call
Examples
Notes
Remove Partition
Function
Arguments
Scripting Call Return
Examples
Remove Update
Function
Arguments
Notes
Examples
Set Leaf Indicators
Function
Arguments
Leaf indicator record format
Indicator Examples
Examples
Set Property
Function
Arguments
Partition properties
Typesetting indicators
Examples
Notes
Set Release Label
Function
Arguments
Notes
Examples
Set Repository
Function
Arguments
Call Return
Example
Set Transform Property
Function
Arguments
PDF Property Descriptions
Using a PDF Profile
Stylesheet Export
Function
Arguments
Scripting Call Return
Examples
Stylesheet Import
Function
Arguments
Examples
Transform XML
Function
Arguments
Scripting Call Return
Example
Undo Commit
Function
Arguments
Notes
Examples
Unlock
Function
Arguments
Scripting Call Return
Notes
Restrictions
Examples
Verify
Function
Arguments
Examples
Status Codes
Search Highlighter (On/Off)
