User's Guide

Arbortext Styler
8.3.0.0
Copyright © 2024 PTC Inc. and/or Its Subsidiary Companies. All Rights Reserved.

Copyright for PTC software products is with PTC Inc. and its subsidiary companies (collectively “PTC”), and
their respective licensors. This software is provided under written license or other agreement, contains
valuable trade secrets and proprietary information, and is protected by the copyright laws of the United States
and other countries. It may not be copied or distributed in any form or medium, disclosed to third parties, or
used in any manner not provided for in the applicable agreement except with written prior approval from
PTC. More information regarding third party copyrights and trademarks and a list of PTC’s registered
copyrights, trademarks, and patents can be viewed here: https://www.ptc.com/support/go/copyright-and-
trademarks

User and training guides and related documentation from PTC are also subject to the copyright laws of the
United States and other countries and are provided under a license agreement that restricts copying,
disclosure, and use of such documentation. PTC hereby grants to the licensed software user the right to make
copies of product documentation and guides in printed form, but only for internal/personal use and in
accordance with the license agreement under which the applicable software is licensed. Any copy made shall
include the PTC copyright notice and any other proprietary notice provided by PTC. Note that training
materials may not be copied without the express written consent of PTC. This documentation may not be
disclosed, transferred, modified, or reduced to any form, including electronic media, or transmitted or made
publicly available by any means without the prior written consent of PTC and no authorization is granted to
make copies for such purposes.

UNITED STATES GOVERNMENT RIGHTS

PTC software products and software documentation are “commercial items” as that term is defined at 48 C.F.
R. 2.101. Pursuant to Federal Acquisition Regulation (FAR) 12.212 (a)-(b) (Computer Software) (MAY 2014)
for civilian agencies or the Defense Federal Acquisition Regulation Supplement (DFARS) at 227.7202-1(a)
(Policy) and 227.7202-3 (a) (Rights in commercial computer software or commercial computer software
documentation) (FEB 2014) for the Department of Defense, PTC software products and software
documentation are provided to the U.S. Government under the PTC commercial license agreement. Use,
duplication or disclosure by the U.S. Government is subject solely to the terms and conditions set forth in the
applicable PTC software license agreement.

PTC Inc., 121 Seaport Blvd, Boston, MA 02210 USA

 Contents

About Arbortext Styler................................................................................................13

Understanding Arbortext Styler...................................................................................19
Overview of Arbortext Styler ................................................................................20
Arbortext Styler Concepts....................................................................................20
Free Version of Arbortext Styler..................................................................................23
Overview of Free Version of Arbortext Styler .........................................................24
Limitations of Free Version of Arbortext Styler .......................................................25
Migrating Stylesheets from the Free Version to the Full Version of Arbortext
Styler..............................................................................................................25
Creating a Basic Stylesheet .......................................................................................27
Converting a FOSI to a Stylesheet .......................................................................28
Opening and Creating Stylesheets .......................................................................30
Language Settings..............................................................................................32
Styles Overview..................................................................................................35
Highlight Unstyled Elements in a Document..........................................................36
Applying Styles...................................................................................................37
Starting the Style Helper......................................................................................43
Assigning Division Levels in your Stylesheet.........................................................43
Validating Stylesheets .........................................................................................44
Saving Stylesheets .............................................................................................46
Migrating Stylesheets from a Previous Release.....................................................47
Regenerating Edited Source when Updating a Stylesheet......................................49
Document Preview and Publishing .............................................................................51
Overview of Preview and Publishing.....................................................................52
Preview Options in Arbortext Styler ......................................................................53
PTC Advanced Print Publisher in Arbortext Styler..................................................55
Print Features Available with PTC Advanced Print Publisher ..................................61
PDF Configuration File for the PTC APP Engine ...................................................87
PTC APP PDF Configuration File (.appcf).............................................................96
Generating Accessible PDF Output.................................................................... 138
Chunking Data in HTML Output ......................................................................... 148
Generating XHTML Output ................................................................................ 153
Generating HTML5 Output ................................................................................ 153
Publishing EPUB Output ................................................................................... 153
Generating Accessible HTML Output ................................................................. 155
Managing CSS Files in HTML Output ................................................................. 159
Styling HTML Files from Different Document Types ............................................. 165
Passing Metadata to PDF Output ....................................................................... 169

3
 Alternate Text Support for Graphics.................................................................... 172
Exporting Stylesheets.............................................................................................. 175
Exporting Stylesheets ....................................................................................... 176
Defining Page Layout .............................................................................................. 179
Page Layout Overview ...................................................................................... 180
Creating a Page Set.......................................................................................... 182
Setting a Page Size and Orientation for a Page Set ............................................. 182
Defining Number of Pages for a Page Set........................................................... 184
Setting Margins in a Page Set............................................................................ 185
Setting Columns in a Page Set .......................................................................... 186
Justifying Columns in a Page Set ....................................................................... 189
Defining Page Regions ..................................................................................... 190
Add Page Region ............................................................................................. 192
Adding Headers and Footers to a Page Set ........................................................ 198
Configuring Page Numbers for a Page Set.......................................................... 199
Applying a Page Set to an Element .................................................................... 200
Validating Page Sets ......................................................................................... 200
Adding Border Rules to Block Elements.............................................................. 202
Side by Side Alignment ..................................................................................... 204
Run-in Styling................................................................................................... 215
Hyphenation..................................................................................................... 216
Working with Properties ........................................................................................... 221
Properties Overview ......................................................................................... 222
Deriving Property Values ................................................................................... 223
Resolving Property Values................................................................................. 227
Explicit v Derived Property Values in Arbortext Styler........................................... 229
Modifying Properties ......................................................................................... 233
Applying Properties for Specific Outputs ............................................................. 234
Creating Output Sets in the Outputs to Edit List................................................... 235
Hiding Element Content .................................................................................... 236
Applying Prespace and Postspace to Elements................................................... 239
Initial Properties and Property Sets Applied by Styles .......................................... 243
Arbortext Styler Usability Aids............................................................................ 244
Property Value Precedence in Arbortext Styler .......................................................... 247
Understanding How Arbortext Styler Determines Property Values ........................ 248
Processing Order During Publishing................................................................... 248
Processing Order in Arbortext Styler .................................................................. 249
Creating and Applying Property Sets ........................................................................ 255
Property Sets Overview..................................................................................... 256
Working with Property Sets................................................................................ 256
Applying Property Sets...................................................................................... 258
Property Sets Example ..................................................................................... 261
Working with Elements in Your Stylesheet ................................................................. 263
Elements Overview........................................................................................... 264
Adding New Elements to Your Stylesheet ........................................................... 271

4 User's Guide
 Keeping Elements Together............................................................................... 274
Elements and Document Types ......................................................................... 278
Configuring a Graphic Element .......................................................................... 278
Creating Contexts ................................................................................................... 279
Contexts Overview............................................................................................ 280
Context Priority................................................................................................. 282
Working with Contexts ...................................................................................... 283
Using XPath in Contexts.................................................................................... 288
Contexts Walk-Through..................................................................................... 291
Creating Conditions................................................................................................. 297
Conditions Overview ......................................................................................... 298
Working with Conditions .................................................................................... 300
Conditions Walk-Through .................................................................................. 303
Creating If, Else/If, and Else Conditions .............................................................. 306
Nesting Conditions............................................................................................ 309
Nested and If, Else/If, and Else Conditions in Exported Stylesheets ...................... 317
Using XPath in Conditions ................................................................................. 318
Using Conditions to Change a Document's Page Size ......................................... 320
Cutting, Copying, and Pasting .................................................................................. 323
Cut, Copy, and Paste Overview.......................................................................... 324
Cutting, Copying, and Pasting Elements ............................................................. 324
Cutting, Copying, and Pasting Contexts.............................................................. 325
Cutting, Copying, and Pasting Conditions ........................................................... 327
Cutting, Copying, and Pasting Property Sets....................................................... 328
Cutting, Copying, and Pasting Page Sets ........................................................... 329
Cutting, Copying, and Pasting Tables of Content ................................................. 330
Cutting, Copying, and Pasting Custom Tables..................................................... 331
Cutting, Copying, and Pasting Cross References ................................................ 332
Cutting, Copying, Pasting, and Deleting Properties.............................................. 333
Creating Headers and Footers ................................................................................. 337
Headers and Footers Overview.......................................................................... 338
Creating a Header or Footer .............................................................................. 338
Adding Content to a Header or Footer ................................................................ 341
Inserting Division References in Headers and Footers ......................................... 343
Adding Page Numbers to Headers and Footers .................................................. 345
Working with Tables of Contents............................................................................... 351
Table of Contents Overview ............................................................................... 352
Creating a Basic Table of Contents Format Object............................................... 355
Styling an Element to Generate a Table of Contents ............................................ 357
Customizing the Content of a TOC ..................................................................... 360
Applying Non-Standard Formatting to a Table of Contents ................................... 370
Generating Indexes ................................................................................................. 377
Indexing Overview ............................................................................................ 378
Creating an Index with Element Model Index Terms............................................. 379
Creating an Index with Attribute Model Index Terms ............................................ 381

Contents 5
 Creating a Index with Nesting Element Model Index Terms .................................. 382
Creating See and See-Also Index Terms ............................................................ 384
Configuring Alternative Sorting of Index Terms .................................................... 386
Configuring Multiple Indexes for a Document ...................................................... 388
Modifying the Appearance of an Index................................................................ 390
Modifying Index Parameters .............................................................................. 392
Including Elements not Styled as Index Terms in an Index.................................... 393
Context Matching of Elements in Index Terms ..................................................... 395
Generating a Sorted Inline List........................................................................... 396
Styling Custom Tables ............................................................................................. 403
Custom Table Styling Overview.......................................................................... 404
Creating and Styling a Custom Table.................................................................. 405
Generating Custom Table Cells via XPath........................................................... 411
Reordering Columns in Custom Tables............................................................... 415
Using Background Color in Custom Tables ......................................................... 417
Formatting Footnotes and Endnotes ......................................................................... 421
Footnotes Overview .......................................................................................... 422
Creating and Modifying an Inline Model Footnote ................................................ 425
Creating and Modifying a Reference Model Footnote........................................... 431
Creating and Modifying a Hybrid Model Footnote ................................................ 434
Formatting the Reference Mark in a Footnote ..................................................... 439
Endnotes Overview........................................................................................... 448
Creating and Modifying an Inline Model Endnote................................................. 449
Creating and Modifying a Reference Model Endnote ........................................... 454
Adding Generated Text ............................................................................................ 463
Generated Text Overview .................................................................................. 464
Adding Generated Text to Elements ................................................................... 465
Inserting Element and Attribute Content in Generated Text .................................. 468
Numbering List Items ........................................................................................ 474
Adding Bullets to List Items................................................................................ 479
Labeling and Numbering Divisions ..................................................................... 483
Labeling and Numbering Formal Blocks ............................................................. 491
Advanced Formatting of Titles and Numbering .................................................... 495
Non Standard Numbering with XPath ................................................................. 506
Inserting Leaders, Rules, and Space Fills in Generated Text ................................ 507
Inserting Markup in Generated Text.................................................................... 509
Inserting Graphics in Generated Text ................................................................. 511
Inserting Symbols in Generated Text .................................................................. 513
Inserting Tables in Generated Text ..................................................................... 514
Adding User Formatting Elements to Generated Text .......................................... 517
Using XPath Expressions in Generated Text ....................................................... 518
Creating Repeating Titles .................................................................................. 522
Adding Change Bars......................................................................................... 524
Maintaining Translations of Generated Text ........................................................ 528
Cross References and Other Links ........................................................................... 549

6 User's Guide
 Cross Reference and Linking Overview .............................................................. 550
Creating a Cross Reference Format Object......................................................... 551
Creating Cross References and Cross Reference Formatting .............................. 551
Modifying Default Cross Reference Formatting ................................................... 563
SFEs to Support Linking.................................................................................... 565
Graphic Support...................................................................................................... 567
Supporting Intelligent Graphics Sets .................................................................. 568
PDF Graphics................................................................................................... 570
Publishing PDF with 3D Graphics ...................................................................... 571
Multimedia Support ................................................................................................. 573
Introduction ...................................................................................................... 574
Styling and Publishing Video and Audio Content ................................................. 574
Working with Modules.............................................................................................. 581
Modules Overview ............................................................................................ 582
Creating a Module from an Existing Stylesheet ................................................... 584
Developing a New Stylesheet Using Existing Modules ......................................... 585
Overriding Stylesheet Definitions ....................................................................... 588
Modifying Definitions in a Module ....................................................................... 591
Adding New Definitions to a Module ................................................................... 593
Advanced Formatting Techniques............................................................................. 597
Formatting Landscape Tables and Figures ......................................................... 598
Generating Barcodes and QR Codes ................................................................. 599
Styling DITA Documents .......................................................................................... 619
DITA Styling Overview ...................................................................................... 620
Working with the Resolved Document for Styling................................................. 623
Working with Specialized Elements.................................................................... 630
Non-Latin Language Support ................................................................................... 633
Overview of Support for Non-Latin Text in Arbortext Styler ................................... 634
Combined Fonts ............................................................................................... 635
List and Page Numbering .................................................................................. 638
Hanging Punctuation......................................................................................... 644
Text Underlining and Strikethrough..................................................................... 646
Right-to-Left Layout Direction ............................................................................ 652
Publishing XML Documents as RTF Files.................................................................. 655
Overview of Publishing to RTF........................................................................... 656
Publishing RTF Files ........................................................................................ 656
Creating Export Stylesheets .............................................................................. 657
Publishing RTF With and Without Using Word Style Names ................................. 658
Publishing Word Fields, Instructions, and Switches ............................................. 663
Publishing XML Attributes to Unique Word Paragraph or Character Styles ............ 667
Publishing Figures in RTF Files ......................................................................... 670
Publishing Tables in RTF Files ........................................................................... 672
Publishing Table and Figure Captions in RTF Files .............................................. 673
Publishing Lists in RTF Files.............................................................................. 687

Contents 7
 Publishing Headers and Footers in RTF Files ..................................................... 689
Publishing Footnotes and Endnotes in RTF Files ................................................ 692
Publishing Scoped Tables of Contents in RTF Files ............................................. 692
Using Batch Processing to Publish RTF Files...................................................... 694
Troubleshooting Import and Export Issues .......................................................... 695
Limitations when Publishing to RTF.................................................................... 696
Extending Stylesheets ............................................................................................. 699
Identifying Items that have Edited Source ........................................................... 700
Viewing Stylesheet Source ................................................................................ 701
Editing Stylesheet Source Overview................................................................... 703
Editing Element Source..................................................................................... 706
Editing Property Set Source............................................................................... 709
Editing Page Set Source ................................................................................... 709
Editing FOSI Resource Description Source......................................................... 710
Editing Common XSL Source ............................................................................ 711
Editing XSL Root Template Source .................................................................... 712
Editing PTC APP Root Template Source............................................................. 712
Overview of Autogenerated PTC APP Source..................................................... 714
Tips for Editing Stylesheet Source...................................................................... 722
Editing Stylesheet Source Examples .................................................................. 723
Editing FOSI Source that Contains a Reference to an Object ............................... 725
Editing FOSI Source of Elements with Numbered Contexts or Conditions ............. 726
Extending the Edited Source Function by Adding More Complex Code ................. 727
Deleting Source Edits........................................................................................ 731
Comparing Edited Source and XPath for Stylesheet Extension............................. 731
Working with Custom CSS Styles ............................................................................. 733
Associating External CSS with Styler Stylesheets ............................................... 734
Custom CSS Style Definitions............................................................................ 736
Scripting and Interactivity ......................................................................................... 745
Accessing Scripts from Arbortext Styler .............................................................. 746
Associating a JavaScript Library with a Stylesheet .............................................. 749
Custom JavaScript Functions ............................................................................ 749
Including PDF Forms in PDF Output................................................................... 752
Arbortext Styler Window and Editors......................................................................... 763
Arbortext Styler’s Windows, Lists, and Editors..................................................... 765
Arbortext Styler Window .................................................................................... 766
Elements List ................................................................................................... 769
Property Sets List ............................................................................................. 771
Page Sets List .................................................................................................. 772
Page Types List ................................................................................................ 772
Page Regions List............................................................................................. 774
Generated Contents List ................................................................................... 774
Tables of Contents List ...................................................................................... 774
Indexes List...................................................................................................... 777
Custom Tables List ........................................................................................... 777

8 User's Guide
 Cross References List....................................................................................... 778
Sizes List ......................................................................................................... 778
Combined Fonts List ......................................................................................... 780
PTC ALD Functions List .................................................................................... 781
HTML Functions List ......................................................................................... 781
Columns in List Views ....................................................................................... 781
Description Tab ................................................................................................ 784
Comment Tab................................................................................................... 785
Outputs to edit Field .......................................................................................... 787
Text Category ................................................................................................... 787
Indent Category................................................................................................ 795
Spacing Category ............................................................................................. 800
Breaks Category............................................................................................... 804
Generated Text Category .................................................................................. 818
Property Sets Category ..................................................................................... 820
Footnote Category ............................................................................................ 821
Block border Category ...................................................................................... 823
Side by Side Category....................................................................................... 825
PDF tags Category ........................................................................................... 831
HTML tag Category........................................................................................... 834
RTF Category................................................................................................... 838
Graphic Category ............................................................................................. 843
Page Sets - Page Size Category ........................................................................ 844
Page Sets - Page Types Category ..................................................................... 847
Page Sets - Columns Category.......................................................................... 848
Page Sets - Page Numbers Category ................................................................. 851
Page Sets - Other Category............................................................................... 852
Page Regions - Position Category...................................................................... 853
Page Regions - Text Category ........................................................................... 855
Page Regions - Graphic Category...................................................................... 856
Page Regions - Borders Category...................................................................... 858
Page Regions - Other Category ......................................................................... 859
Indexes - General Category............................................................................... 861
Indexes - Format Category ................................................................................ 861
Custom Tables - Elements Category .................................................................. 862
Custom Tables - Cells Category ......................................................................... 863
Custom Tables - Header Cells Category ............................................................. 864
Custom Tables - Format Category...................................................................... 866
Custom Tables - Background Color Category...................................................... 869
Menus ............................................................................................................. 870
Toolbars........................................................................................................... 894
PTC APP Source Editor .................................................................................... 897
Source Editor ................................................................................................... 899
Generated Text Editor ....................................................................................... 903
Arbortext Styler Dialog Boxes................................................................................... 915
Dialog Boxes .................................................................................................... 918

Contents 9
 Add/Edit JavaScript Library Dialog Box............................................................... 918
Add Module Dialog Box ..................................................................................... 918
Add Namespace Declaration Dialog Box ............................................................ 919
Add New Elements Dialog Box .......................................................................... 920
Add Target Language Dialog Box....................................................................... 921
Attribute Modifier Dialog Box ............................................................................. 921
Attribute Test Dialog Box ................................................................................... 921
Bullet Dialog Box .............................................................................................. 923
Condition Dialog Box ........................................................................................ 925
Configure Columns Dialog Box .......................................................................... 926
Content Test Dialog Box .................................................................................... 927
Context Dialog Box ........................................................................................... 929
Convert Stylesheet Dialog Box .......................................................................... 934
Copy To Module Dialog Box............................................................................... 935
Cross Reference Details Dialog Box................................................................... 935
Custom Content Dialog Box............................................................................... 936
Customize Table of Contents Dialog Box ............................................................ 937
Cut Properties Dialog Box ................................................................................. 939
Definition List Details Dialog Box........................................................................ 939
Delete Properties Dialog Box ............................................................................. 941
Division Details Dialog Box ................................................................................ 941
Division Reference Dialog Box........................................................................... 942
Division Title Number Dialog Box ....................................................................... 942
Document Language Mapping Dialog Box .......................................................... 948
Duplicate Translation Unit IDs in Module ............................................................ 949
Edit Graphic XPath Dialog Box .......................................................................... 949
Edit Module Dialog Box ..................................................................................... 950
Edit Uses List Dialog Box .................................................................................. 950
Edit XPath Override for Current Level Dialog Box................................................ 951
Elements Not in Document Type Window ........................................................... 952
Export PTC APP Template Dialog Box................................................................ 953
Export CSS dialog box ...................................................................................... 954
Export FOSI Stylesheet Dialog Box .................................................................... 954
Export Generated Text for Translation Dialog Box ............................................... 955
Export XSL-EPUB Stylesheet Dialog Box ........................................................... 956
Export XSL-FO Stylesheet Dialog Box................................................................ 957
Export XSL-FO RTF Stylesheet Dialog Box ........................................................ 958
Export XSL-HTML File Stylesheet Dialog Box ..................................................... 958
Export XSL-HTML Help Stylesheet Dialog Box.................................................... 959
Export XSL-Web Stylesheet Dialog Box ............................................................. 960
Field Dialog Box ............................................................................................... 960
Final Page Number Dialog Box .......................................................................... 961
Find Explicit Properties Dialog Box..................................................................... 962
Find Explicit Properties Results Window ............................................................. 963
Find Where Used Dialog Box............................................................................. 964
Find Where Used Results Window ..................................................................... 965
Footnote Number Dialog Box............................................................................. 966

10 User's Guide
 Footnotes Dialog Box........................................................................................ 968
Formal Block Title Number Dialog Box ............................................................... 971
Generated Cell Dialog Box ................................................................................ 977
Graphic Details Dialog Box ................................................................................ 978
HTML/PDF Attribute Dialog Box......................................................................... 979
HTML/CSS Defects List .................................................................................... 982
Import Generated Text Translation Dialog Box .................................................... 983
Import Generated Text Translation — Translation has not Changed...................... 983
Import Generated Text Translation — Translation Identical to Source.................... 984
Import Generated Text Translation — Translation Already Current........................ 984
Incompatible Document Types for Stylesheet Dialog Box..................................... 985
Index Details Dialog Box ................................................................................... 985
Index Term (Attribute Model) Details Dialog Box.................................................. 986
Index Term (Element Model) Details Dialog Box .................................................. 987
Index Term (Nesting Element Model) Details Dialog Box...................................... 989
Insert Attribute Content Dialog Box .................................................................... 990
Insert Attribute Content Dialog Box (Headers and Footers) .................................. 993
Insert Cross Reference Dialog Box .................................................................... 994
Insert Element Content Dialog Box..................................................................... 995
Insert Element Content Dialog Box (Headers and Footers) .................................. 998
Insert Index Dialog Box ................................................................................... 1000
Insert Leaders, Rule or Space Dialog Box......................................................... 1001
Insert Metadata Dialog Box ............................................................................. 1002
Insert Symbol Dialog Box ................................................................................ 1003
Insert Table of Contents Dialog Box.................................................................. 1004
Insert XPath String Dialog Box......................................................................... 1004
Link Details Dialog Box ................................................................................... 1005
Link Target Details Dialog Box ......................................................................... 1006
List Item Number Dialog Box ........................................................................... 1007
Modules Dialog Box ........................................................................................ 1012
Move to Module Dialog Box ............................................................................. 1014
Namespace Declarations Dialog Box ............................................................... 1014
New Custom Counter Dialog Box ..................................................................... 1015
New Module Dialog Box .................................................................................. 1016
New User Formatting Element Dialog Box ........................................................ 1017
No Stylesheet Found Dialog Box...................................................................... 1017
Number Details Dialog Box.............................................................................. 1017
Numbering Restart Dialog Box......................................................................... 1023
Open Stylesheet Dialog Box ............................................................................ 1024
Paragraph Styles for Nested Lists Dialog Box ................................................... 1025
Paste Properties Dialog Box ............................................................................ 1025
Save As Merged Stylesheet Dialog Box............................................................ 1026
Save Stylesheet As Dialog Box........................................................................ 1026
Start At Dialog Box.......................................................................................... 1027
Start of HTML Chunk Test Dialog Box............................................................... 1030
Stylesheet Properties Dialog Box ..................................................................... 1031
Table of Contents Condition Dialog Box ............................................................ 1049

Contents 11
 Tables of Contents Details Dialog Box .............................................................. 1050
Table of Contents Format Dialog Box ............................................................... 1050
Table of Contents Format Details Dialog Box .................................................... 1052
Translation Defects Window ............................................................................ 1054
Translation Note Dialog Box ............................................................................ 1055
Unused Definitions Dialog Box......................................................................... 1056
Use Exported FOSI For Dialog Box .................................................................. 1056
Use Stylesheet For Dialog Box ........................................................................ 1058
Validate Page Sets Dialog Box......................................................................... 1059
XPath Predicate Dialog Box............................................................................. 1060
XPath Test Dialog Box .................................................................................... 1061
Debugging Stylesheets.......................................................................................... 1063
Performance Profiling for Arbortext Styler or FOSI Stylesheets........................... 1064
XPath Performance ........................................................................................ 1078
General Reference Information .............................................................................. 1081
Reference Information..................................................................................... 1082
Keyboard Navigation in the Arbortext Styler Window ......................................... 1082
Differences in Output Support.......................................................................... 1084
FOSI Output Limitations with XPath in Generated Text .......................................1110
Glossary .........................................................................................................1111
Glossary................................................................................................................1113
Index.................................................................................................................... 1121

12 User's Guide
 About Arbortext Styler

This section describes, and uses examples to illustrate, how the key tools and
functions of Arbortext Styler help you create simple to complex stylesheets for
publishing to multiple outputs.

Prerequisite Knowledge
Arbortext Styler can be used by anyone with a basic understanding of document
structure and the principles of layout and design. The advanced features of
Arbortext Styler will be most useful to users who have previous experience
creating stylesheets in a production environment.

Organization of This Guide

The information in this guide is divided into the following sections:
Understanding Arbortext Styler on page An overview of Arbortext Styler and
20 the concepts upon which a stylesheet is
based
Free Version of Arbortext Styler on The capabilities and limitations of the
page 24 free version of Arbortext Styler, and
how to migrate a stylesheet developed
in the free version to the full version of
Arbortext Styler
Creating a Basic Stylesheet on page 30 How to access Arbortext Styler, how to
convert a FOSI to a stylesheet and how
to apply styles to elements
Document Preview and Publishing on The preview and publishing options

13
page 52 available with Arbortext Styler
Exporting Stylesheets on page 176 How to export .style stylesheets to
XSL-HTML, XSL-FO, XSL-HTML
Help, XSL-Web, and FOSI stylesheets
Defining Page Layout on page 180 How to use page sets to format
documents for print and PDF output
Working with Properties on page 222 The use of properties in a stylesheet
Property Value Precedence in Arbortext The processing order of contexts,
Styler on page 248 conditions, and property sets in
Arbortext Styler and during publish
actions
Creating and Applying Property Sets on How to create and apply property sets
page 256 in your stylesheets
Working with Elements on page 264 How to add, delete, and rename DTD
and user-defined elements
Creating Contexts on page 280 How to use contexts to change an
element's formatting based on its
location in the document structure
Creating Conditions on page 298 How to create tests that can be applied
to contexts to further refine an
element's position for formatting
purposes
Cutting, Copying, and Pasting on page How to cut, copy, and paste stylesheet
324 components and properties
Creating Headers and Footers on page How to create header and footer objects
338 and add their content via generated text
Working with Tables of Contents on How to generate and format tables of
page 352 contents
Generating Indexes on page 378 How to generate and format indexes for
print and PDF output
Styling Custom Tables on page 404 How to format elements as a custom
table so they can be edited with the
Table Editor in Arbortext Editor and
published as a table for output
Formatting Footnotes and Endnotes on How to generate and format footnotes
page 422 and endnotes
Adding Generated Text on page 464 How to add generated text to elements,
add numbers to lists, divisions, and
formal blocks, add bullets to lists items,
and create repeating titles

14 User's Guide
Cross References and Other Links on How to format cross references
page 550
Working with Modules on page 582 How to develop and work with
modularized stylesheets
Advanced Formatting Techniques on Advanced formatting techniques
page 598
Styling DITA Documents on page 620 How to style Darwin Information
Typing Architecture (DITA) documents
Non-Latin Language Support on page The extent to which Asian and Arabic
634 text, numbering and punctuation are
supported within Arbortext Styler
Publishing XML Documents as RTF How to map XML structures and export
Files on page 656 XML to RTF
Extending Stylesheets on page 701 How to edit element, property set, page
set, XSL root template, and FOSI
resource description source
Arbortext Styler’s Windows, Lists, and Description of the Source Editor,
Editors on page 765 Generated Text Editor, and the
Arbortext Styler window menus,
toolbars, and property areas

Arbortext Styler Dialog Boxes on page Description of each dialog box

918 associated with Arbortext Styler
Debugging Stylesheets on page 1064 Tips on improving the speed at which
complex stylesheets are processed
General Reference Information on page General information such as keyboard
1082 navigation and units of measurement

Related Documentation
You can access online help for Arbortext Styler from the Stylesheet Development
section of the PTC Arbortext Help Center.
For more information on Arbortext Editor and Arbortext Publishing Engine
products, see thePTC Arbortext Help Center. Help Center includes web-based
HTML information and is accessed from the Help ▶ Help Center menu.
If you are using Arbortext Publishing Engine, see Installation Guide for Arbortext
Publishing Engine and Configuration Guide for Arbortext Publishing Engine for
information on Arbortext Publishing Engine installation, setup, and configuration.
Refer to W3C at http://www.w3.org/Style/XSL/ for more information
on the XSL standard.

About Arbortext Styler 15

Technical Support
The PTC eSupport portal provides resources and tools to support your Arbortext
implementation:
www.ptc.com/support/
If you encounter problems using this product, contact PTC Technical Support. For
complete details, see “Opening a Case” on the Processes tab of the PTC
Customer Support Guide:
www.ptc.com/support/csguide/Processes
You must have a Service Contract Number (SCN) before you can receive
technical support. If you do not know your SCN, see “Preparing to contact TS” on
the Processes tab of the PTC Customer Support Guide for information about how
to locate it.

Help for PTC Products

You can access PTC product help using the following resources:
• Online Help
Click Help from the user interface for online help available for the product.
• Reference Documents website — Information assistance in PDF format:

www.ptc.com/support/refdoc
You must have a Service Contract Number (SCN) before you can access the
Reference Documents site. If you do not know your SCN, see “Preparing to
contact TS” on the Processes tab of the PTC Customer Support Guide for
information about how to locate it:
www.ptc.com/support/csguide
• Help Center
Use the following link to access all PTC Help Centers:
support.ptc.com/apps/help_center/help/

Global Services
PTC Global Services delivers the highest quality, most efficient and most
comprehensive deployments of the PTC Product Development System including
Creo, Windchill, Arbortext, and PTC Mathcad. PTC’s Implementation and
Expansion solutions integrate the process consulting, technology implementation,
education and value management activities customers need to be successful.
Customers are led through Solution Design, Solution Development and Solution
Deployment phases with the continuous driving objective of maximizing value
from their investment.

16 User's Guide
Contact your PTC sales representative for more information on Global Services.

Comments
PTC welcomes your suggestions and comments on its documentation:
• To send feedback about a topic you are viewing in the PTC Arbortext Help
Center, click the send feedback icon in the top right corner of the topic.
The title of the help topic you were viewing when you clicked the icon is
automatically included with your feedback.
• You can also send an email to [email protected].
To help us more quickly address your concern, include the name of the PTC
product and its release number with your comments. If your comments are
about a specific help topic or book, include the title.

Documentation Conventions
This guide uses the following notational conventions:
• Bold text represents exact text that appears in the program's user interface.
This includes items such as button text, menu selections, and dialog box
elements. For example,
Click OK to begin the operation.
• A right arrow represents successive menu selections. For example,
Choose File ▶ Print to print the document.
• Monospaced text represents code, command names, file paths, or other
text that you would type exactly as described. For example,
At the command line, type version to display version information.
• Italicized monospaced text represents variable text that you would
type. For example,
installation-dir\custom\scripts\
• Italicized text represents a reference to other published material. For example,
If you are new to the product, refer to the Getting Started Guide for basic
interface information.

About Arbortext Styler 17

 1
Understanding Arbortext Styler
Overview of Arbortext Styler .......................................................................................20
Arbortext Styler Concepts ..........................................................................................20

Arbortext Styler helps you create simple to complex stylesheets for publishing to
multiple outputs. This section describes its basic concepts.

19
Overview of Arbortext Styler
Arbortext Styler helps you create simple to complex stylesheets for publishing to
multiple outputs. There are two versions of Arbortext Styler:
1. The free version of Arbortext Styler is available with Arbortext Editor and
enables you to develop stylesheets to control display in Arbortext Editor. You
cannot use the free version of Arbortext Styler to develop stylesheets for any
kind of output.
2. The full version of Arbortext Styler is a separate product and enables you to
develop stylesheets for all supported output formats.
Available on all supported Windows operating systems, Arbortext Styler can be
used to create stylesheets to format all documents that use the same set of DTD or
schema elements. You can also create stylesheets for publishing to multiple output
formats, such as print, PDF, and HTML. Creating a stylesheet involves defining
rules for how elements are to be formatted in all the contexts in which they can
appear, and for all the desired outputs.
Stylesheets created with Arbortext Styler are saved with a .style extension.
Arbortext Editor and Arbortext Publishing Engine automatically recognize a
.style file as a stylesheet. If you want to use XSL or FOSI stylesheets, you can
export a .style stylesheet to these formats from within Arbortext Styler. You
can also export a stylesheet as a PTC Advanced Print Publisher (PTC APP)
template (a .3f file).
Arbortext Styler supports modularized stylesheets. This enables you to develop a
stylesheet from modular components. Multiple stylesheets can share common
modules, which adds flexibility to stylesheet design and reduces development
time. A stylesheet can reference any other stylesheet as a module.

Arbortext Styler Concepts

The following concepts are the building blocks of a stylesheet:
• Styles (see Styles Overview on page 35) - apply properties and contexts to
elements.
• Properties (see Properties Overview on page 222) - specify font, indent,
spacing, breaks, and generated text settings.
• Contexts (see Contexts Overview on page 280) - apply properties to elements
based on where the elements occur within the document structure.
• Conditions (see Conditions Overview on page 298) - apply properties to
elements based on the results of attribute, XPath or content tests.

20 User's Guide
In addition to these foundation concepts, a stylesheet uses the following object
definitions. These objects allow you to individually format or reference the
various principle parts of a document:
• Element - an object for each of the elements in the document structure, to
which contexts and conditions can be applied to increase specificity. See
Elements List on page 769 for further information.
• Property set - a named group of properties. See Property Sets List on page 771
for further information.
• Page set - a page format definition. See Page Sets List on page 772 for further
information.
• Page type - an object outlining the layout of a page See Page Types List on
page 772 for further information.
• Page region - an area on a page that can contain text or graphics. Page regions
are placed on page types. See Page Regions List on page 774 for further
information.
• Generated content - an object defining generated content for page regions, for
example, generated text or graphics. See Generated Contents List on page 774
for further information.
• Table of Contents - object defining formatting for tables of contents. See
Tables of Contents List on page 774 for further information.
• Indexes — object defining an index. See Indexes List on page 777 for further
information.
• Custom table - a table style. See Custom Tables List on page 777 for further
information.
• Cross reference - an object defining the format of cross reference links. See
Cross References List on page 778 for further information.
• Size - a size definition that can be referenced anywhere a measurement is
required. See Sizes List on page 778 for further information.
• Combined font - a single font definition object that defines mappings between
characters from the Unicode specification and the system fonts that should be
used to output them. See Combined Fonts List on page 780 for further
information.

Understanding Arbortext Styler 21

 2
Free Version of Arbortext Styler
Overview of Free Version of Arbortext Styler................................................................24
Limitations of Free Version of Arbortext Styler..............................................................25
Migrating Stylesheets from the Free Version to the Full Version of Arbortext
Styler ....................................................................................................................25

The free version of Arbortext Styler is packaged along with Arbortext Editor. This
section gives an overview of its features and limitations.

23
Overview of Free Version of Arbortext
Styler
There are two different versions of Arbortext Styler: a free version packaged
along with Arbortext Editor and a full version that must be licensed as a separate
product. The free version of Arbortext Styler enables you to develop stylesheets to
control display in Arbortext Editor, but does not permit development for other
editors or outputs. In contrast, the full version of Arbortext Styler enables you to
develop stylesheets for all supported output formats.

Note
If you do not want the free version of Arbortext Styler to be available in
Arbortext Editor, use the Options element's allowStyler attribute in the
document type configuration file (.dcf file) to disable the free version of
Arbortext Styler. See Document Type Configuration Files in Arbortext Editor
online help for more information about document type configuration files.

The free version of Arbortext Styler has reduced functionality when compared to
the full version. The Arbortext Styler features required to develop stylesheets for
any print, PDF, or HTML outputs cannot be accessed in the free version, only the
functionality required for developing Arbortext Editor stylesheets. See Limitations
of Free Version of Arbortext Styler on page 25 for more information about the
functionality available in the free version of Arbortext Styler.
If you elect to use the free version of Arbortext Styler to edit an existing stylesheet
originally developed with the full version of Arbortext Styler, you will only be
permitted to change the Arbortext Editor properties of that stylesheet. A warning
message will advise you of this if you attempt to open a full stylesheet in
Arbortext Editor, when your installation does not include a separately licensed
version of Arbortext Styler:

You can, however, migrate a stylesheet developed in the free version of Arbortext
Styler to the full version of Arbortext Styler. See Migrating Stylesheets from the
Free Version to the Full Version of Arbortext Styler on page 25 for more
information.

24 User's Guide
Limitations of Free Version of Arbortext
Styler
The free version of Arbortext Styler has much less functionality than the full
version. Only options for developing Arbortext Editor stylesheets are available.
You cannot access the Arbortext Styler features used to develop stylesheets for
any print, PDF, or HTML outputs.

Migrating Stylesheets from the Free

Version to the Full Version of Arbortext
Styler
You can migrate a stylesheet developed in the free version of Arbortext Styler to
the full version of Arbortext Styler, using the following steps:
1. Open Arbortext Editor, plus a separately licensed version of Arbortext Styler.
2. Open a document in Arbortext Editor that uses the stylesheet developed in the
free version of Arbortext Styler.
3. Select Styler ▶ Edit Stylesheet to invoke the full version of Arbortext Styler
and open the stylesheet.
4. Select File ▶ Stylesheet Properties in Arbortext Styler to invoke the Stylesheet
Properties dialog box.
5. Select the new Publishing types for which your stylesheet will be used and
close the dialog box.
You can now use the full capability of Arbortext Styler to modify the stylesheet
for the new output formats.

Free Version of Arbortext Styler 25

 3
Creating a Basic Stylesheet
Converting a FOSI to a Stylesheet ..............................................................................28
Opening and Creating Stylesheets..............................................................................30
Language Settings ....................................................................................................32
Styles Overview ........................................................................................................35
Highlight Unstyled Elements in a Document ................................................................36
Applying Styles .........................................................................................................37
Starting the Style Helper ............................................................................................43
Assigning Division Levels in your Stylesheet ...............................................................43
Validating Stylesheets................................................................................................44
Saving Stylesheets....................................................................................................46
Migrating Stylesheets from a Previous Release ...........................................................47
Regenerating Edited Source when Updating a Stylesheet ............................................49

This section describes how to create a stylesheet, and give it an introductory

hierarchy that can be built on with subsequent development.

27
Converting a FOSI to a Stylesheet
Arbortext Styler provides a conversion utility that partially converts a FOSI to a
stylesheet (.style file). Before converting a FOSI, refer to the following
limitations of the conversion program.
As a general rule, Arbortext Styler's FOSI conversion generates two contexts for
each FOSI e-i-c (note that this does not apply for titles, or contexts that start with
a “*” wildcard - see limitations below). Arbortext Styler will generate one context
that matches the FOSI e-i-c exactly, e.g. blockquote in para, and one that
contains an additional implicit wildcard, e.g. blockquote anywhere in
para. This ensures that Arbortext Styler matches the FOSI e-i-c matching
process - a built in rule states that, once FOSI has searched unsuccessfully for a
matching e-i-c using context as specified, it prepends a “*” wildcard to all
contexts and starts searching again.

Note
In most cases it is the job of the stylesheet developer to decide which of the
two (almost identical) contexts they wish to keep after the conversion from
FOSI, and delete the other. In most cases, it is recommended that they delete
the “anywhere in” context and keep the “in” context.

Limitations of Converting FOSIs to Stylesheets

The FOSI to Arbortext Styler conversion process does not convert the following
FOSI features because Arbortext Styler does not provide corresponding
capabilities:
• Borders
• Boxing
• Change marks (chgmark)
• Conditional post space (postsp:condit)
• Element-in-contexts whose gitype is pi.
• Environment (envdesc)
• Floats and float locations (floatloc)
• Font width (font:width)
• Footnote description (ftndesc)
• Highlighting (highlt), score weight (scorewt), score offset (scoreoff), and
foreground percent (forpct)
• Hyphenation rule (hyphrule) characteristics other than language
• Hyphenation zones (hyphen:zone)

28 User's Guide
• Keep floats out (keeps:floatsout)
• L-page column spans (span:pageflow)
• Run-in titles
• Security description (secdesc)
• Sentence spacing (sentxsp)
• Word spacing (wordsp)
• Use values (fillval)
• Test values (specval) that use #FOSI, system-var (other than editor-
only, print-only, html-only), system-func or the use of a
textid in the attval characteristic
• Title element contexts that use initial wildcards, i.e. those whose context
attribute value begins with a “*”., for example <e-i-c gi=”title”
context=”*chapter”>. These need to be manually fixed once the FOSI
has been converted to remove the initial wildcards. The steps to carry out this
correction are:
1. Select the element context in the Elements list
2. Choose the Edit ▶ Edit Context menu option
3. In the Edit Context dialog box, select the node that contains the “*”
character and delete it
The numbering of titles will be adversely affected if the wildcards are not
removed in this way.
The following generated text FOSI features are not converted during the
conversion process, but Arbortext Styler provides corresponding capabilities.
Once you have converted your FOSI, you can duplicate the formatting of these
features using the Generated text category in Arbortext Styler:
• Character fills (charfill)
• Counters, reset, and enumerate (enumerat)
• Generated graphics (putgraph)
• Rules (ruling)
• Saved text (savetext)
• Use text (usetext)
• listitem gentext is converted to bullets, and indentation may need to be
modified

Creating a Basic Stylesheet 29

FOSI Conversion
Perform the following steps to convert a FOSI to a stylesheet.
1. Open a document in Arbortext Editor, and choose Format ▶ Select Stylesheets
to select the FOSI stylesheet you want to convert.
2. Choose Styler ▶ Convert Stylesheet.
3. Select OK in the Convert Current Stylesheet dialog box.
4. After the conversion, a message displays indicating that the automatic
conversion is finished. Click OK. The document is updated in the Edit pane,
and Arbortext Styler opens, allowing you to manually convert those features
that the automated process did not.

Opening and Creating Stylesheets

Open an existing stylesheet in Arbortext Editor
1. Open Arbortext Editor, and choose File ▶ Open to open the document whose
stylesheet you want to modify.
2. Choose Styler ▶ Edit Stylesheet to open the stylesheet associated with the
current document, or Styler ▶ Open Stylesheet to open any stylesheet, not
necessarily that currently associated with the document.

Open an existing stylesheet in Arbortext Styler

1. In Arbortext Styler, choose File ▶ Open.
2. The Open Stylesheet dialog box appears, allowing you to browse for, and
select, the required stylesheet.
3. Once you have selected your stylesheet and exited the dialog box the
stylesheet will open, replacing the stylesheet that was previously being edited.

Opening a stylesheet for multiple document types in Arbortext Styler

You are permitted to open the same .style stylesheet for use with multiple
documents in the same Arbortext Styler session, even if the documents are of
different document types. All the following conditions must be met within the
document types of all the documents for which you intend to use the same
stylesheet:
• Their document type configuration files (.dcf) have the same values for the
following attributes of the Options element:
○ implyScaleToFit
○ scaleToFitOverridesScale

30 User's Guide
 ○ idAttribute - the name of the attribute that is treated as an ID attribute
See Document Type Configuration files in Arbortext Editor online help for
further information about document type configuration files.
• Their case sensitivity setting is the same
If any of the conditions are not met, you will see an error message that advises
you that the stylesheets are incompatible for sharing, followed by a confirmation
of the condition in which there is an anomaly. Make the necessary changes in the
.dcf file for the document type that is causing the error.
The ability to open the same .style stylesheet for multiple documents also
applies to DITA documents. You can use the same stylesheet to open both the
ditamap and its constituent topics, open multiple topics from the same ditamap,
preview and publish the ditamap, or edit and publish the Resolved Document for
Editing or the Resolved Document for Styling.
If you are working with FOSI stylesheets, you may also use the same stylesheet
for multiple documents of different document types. Note , though, that this works
in all instances, without having to meet the conditions outlined above for .style
files.

Create a new stylesheet in Arbortext Editor

1. Open Arbortext Editor, and choose File ▶ Open to open a document.
2. Choose one of the following options:
• Styler ▶ New Stylesheet: create a new stylesheet that's pre-populated with
all the elements of your document type, a default set of property sets, page
sets, and other definitions, plus all the Styler Formatting Elements. The
elements are initially assigned the Unstyled style unless they are
configured in the document type configuration file (DCF) as a graphic,
paragraph, document, title, table, link, link target, list, list item, or custom
table. Arbortext Styler automatically applies styles to these elements based
on their description in the .dcf file. Note that property settings made in
Arbortext Styler override .dcf settings if they are changed.
• Styler ▶ New Empty Stylesheet: create a new stylesheet that has no pre-
populated content. It is useful for creating modules to be used in other
stylesheets. A new empty stylesheet cannot stand on its own unless you
copy in the Styler Formatting Elements from another stylesheet. Once you
have done that, however, the stylesheet is perfectly valid and can be used
as a starting point from which you can create your own stylesheet.
The Stylesheet Properties dialog box opens, allowing you to set basic
publishing and chunking settings to be applied via your stylesheet.
3. When you have configured your stylesheet settings in the Stylesheet
Properties dialog box, click OK to save those settings and exit the dialog box.

Creating a Basic Stylesheet 31

 Arbortext Styler opens a new stylesheet.
4. Choose File ▶ Save As to save your stylesheet to the required directory
location, and with your required stylesheet name.

Create a new stylesheet in Arbortext Styler

1. In Arbortext Styler, choose the File ▶ New menu option.
2. The Stylesheet Properties dialog box opens, allowing you to set basic
composition and chunking settings to be applied to your stylesheet.
3. When you have configured your stylesheet settings in the Stylesheet
Properties dialog box, click OK to save those settings and exit the dialog box.

Arbortext Styler opens a new stylesheet that's pre-populated with all the
elements of your document type, a default set of property sets, page sets, and
other definitions, plus all the Styler Formatting Elements.
4. Choose File ▶ Save As to save your stylesheet to the required directory
location, and with your required stylesheet name.

Use existing stylesheets to create a new stylesheet

The steps in the previous procedures describe how to create a new stylesheet from
scratch. You may also make a copy of an existing stylesheet, or a distributed
stylesheet, and make changes and additions to the copy as required. Refer to
Stylesheets overview and Default stylesheet locations in Arbortext Editor help for
information on the stylesheets that are available.

Language Settings
Documents to be published via your Arbortext Styler stylesheet may contain
language definitions. If you want these language definitions to drive styling or
formatting such as hyphenation or translation, you must set up your stylesheet to
recognize the definitions. The Language tab on page 1040 of the Stylesheet
Properties dialog box contains options by which you can make these settings. You
can access the tab from the Stylesheet Properties dialog box on page 1031, or by
choosing the Tools ▶ Language Properties menu option.
You can configure the following language settings:
• Default document language: confirming the language of a document will
ensure that the correct language-specific formatting or information is provided
when your document is published. The document language value will be
analyzed when Arbortext Styler is processing the following:
○ Hyphenation

32 User's Guide
 The default document language information provided here will give
Arbortext Styler the information it needs to set the required hyphenation
language when:
1. The Hyphenation field in the Breaks category on page 804 is set to a
value of (Use document language), and the document language is not
specified in the document scope.
2. The Hyphenation field is set to <Derive> and there is no value to
inherit.
○ Generated text translation
Arbortext Styler will use the document language specification methods
defined here to assess the document language that is in effect when it
encounters a piece of generated text that is set to be translated. It can then
output the correct language version of that generated text. This applies
when the document language is not specified in the document scope.
• Mappings for language codes that could be encountered in documents
Documents to be formatted by the stylesheet could contain generic or non-
standard language codes. Here you can provide more specific information
about the actual language Arbortext Styler should use when it encounters such
codes. You can also provides alternatives to the code that is encountered, for
example swapping US English (en-US) for UK English (en-GB).
For example, a stylesheet may have its hyphenation Language field in the
Breaks category set to (Use Document Language), and a document formatted
by the stylesheet has de as the code for its document language. This specifies
German, but does not make it clear if this should be Reformed or Traditional
German. To apply the correct German hyphenation rules, this distinction must
be made. A mapping matching de to de-1996 (German, Reformed) in the
Document Language Mapping field will ensure that reformed rules are used in
hyphenation.
Similarly, if a document contains a non-standard language code, a mapping
here could provide the additional information to identify the correct language.
For example, if the document’s language code is ENG, a mapping here could
align it with the en-US (United States) language.

Creating a Basic Stylesheet 33

 Note
Languages for generated text, and hyphenation set to (Use document
language), must be specified via standard language codes. You will need to
provide mappings to standard codes if your document uses non-standard
ones.

• Source and target languages for translation of generated text

See Language Settings for Generated Text Translation on page 529 for further
information.
You can use unqualified language codes here even if you have entered a
mapping to a more specific code in the Document Language Mapping field.
Your generated text will still match if its target includes the more generic code.
For example, if you have mapped de to de-1996 to implement the correct
hyphenation rules for a German document, translation of generated text will
still match translations for de if they exist. Note that you should still set a
target for the qualified language code if you have translations with that code.
In general, use general language codes where possible. For example, if your
document requires translation into one German language only, use de as the
language code. This will work for de-1901, de-1996, de-DE. You only need to
specify the variation of a language if you want to translate to multiple
variations of the same base language.
• Value of Lang attribute when generating tagged PDF or HTML outputs.
If the source document specifies a language via the recognized language
attribute identified for the stylesheet, this will be used as the value of the Lang
attribute in output. If the source document does not specify a language in this
way, the value of the stylesheet’s Default language setting will be used.
Refer to Stylesheet Properties — Language on page 1040 for further
information.

How (Use document language) is Determined

The rules below control how language settings are matched in the context of
generated text language and hyphenation when the hyphenation language field is
set to (Use document language). It is a two step process:
1. The document language is determined
2. The document language is matched to a generated text language or
hyphenation rule

34 User's Guide
The following rules define how Arbortext Styler determines the document
language:
1. A document language is derived from the document by following the
Document language specification parameters defined in the Language tab of
the Stylesheet Properties dialog box.
2. If no document language can be extracted from the document, the value of the
Default document language field is set as the document language.
3. If the extracted document language is defined with a Document language
mapping entry, the mapped Language to use (alias) value becomes the
document language. Otherwise the extracted document language is set as the
document language.
The following rules define the precedence used to determine a match between the
document language and a target. A target is either a language with an associated
hyphenation rule or a generated text language. Note that language matching is
case insensitive.
1. If the document language exactly matches the target language, for example if
both have a value of en-GB, the target is used.
2. If the first part of the document language (before a hyphen) exactly matches a
target language, it is considered a match. The largest portion of the target
language to match takes precedence. For example, for a document language of
en-US-nor, Arbortext Styler will test en-US-nor, en-US, and en in that order to
find a match.
3. If no match is found after carrying out the two set of tests above, next steps
will differ between generated text and hyphenation targets:
• For generated text targets, the Source Language defined in the Generated
Text field is used. You may see a warning message if this happens.
• For hyphenation targets, hyphenation is deactivated. You will not be
presented with a warning in this case as this may be intentional. Some
languages do not include hyphenation rules and should not be hyphenated.
You may see a warning if the target is invalid.

Styles Overview
You can use Arbortext Styler to create a simple stylesheet by mapping the
elements in the current document to a set of predefined styles. A style applies a set
of initial properties (such as font characteristics, spacing, and indentation) and in
some cases a set of appropriate contexts.

Creating a Basic Stylesheet 35

 Note
To determine the initial properties set by a style, apply the style to an element
and then look at either the property categories or the Description field.

For example, the following is a list of the initial properties and contexts added to a
set of elements when specific styles are applied. In this case, the chapter
element is mapped to the Division style, level 1, the section element is mapped
to the Division style, level 2, and the title element is mapped to Title.
Arbortext Styler creates three contexts for the title element:
• title in chapter
• title in section
• title everywhere else
Arbortext Styler also applies the following properties to these contexts:
• sanserif, bold, and blue text effects
○ 20pt in chapter
○ 18pt in section
○ 12pt everywhere else
• a division number
• spacing before and after
• a keep with next to prevent title from displaying as the last element on a
page
When you create a new stylesheet, Arbortext Styler applies default styles to
certain elements based on settings in the document type's .dcf file (specifically,
link, link target, document, title, graphic, and paragraph). Changes made to these
elements in Arbortext Styler will override the settings for these elements in the
.dcf file.
Refer to Applying styles on page 37 for more information on styles.

Highlight Unstyled Elements in a

Document
When you create a new stylesheet, Arbortext Styler applies default styles to
certain elements based on settings in the document type's .dcf file (specifically,
link, link target, document, title, graphic, and paragraph). The remaining elements
in the stylesheet appear in Arbortext Styler as Unstyled, meaning that no styles
have been applied. You can highlight unstyled elements in your document as an

36 User's Guide
easy way to identify them as you edit your stylesheet. Once you have elected to
highlight unstyled elements in this way, the tags representing these elements are
displayed with a pink background in any document associated with the stylesheet:

To display unstyled elements in a document:

1. In Arbortext Styler, choose the Options ▶ Highlight Unstyled Elements menu
option.
2. In Arbortext Editor, unstyled elements appear with a pink background and
blue text (unstyled elements will display even if you have set View ▶ No Tags
in your document).

Note
If you choose this setting, unstyled elements will also appear highlighted
in previews executed from Arbortext Styler.

Applying Styles
The first step in creating a stylesheet is to apply styles to those elements whose
styles were not automatically determined by the .dcf file.

Note
You must apply a style to an element before you can add contexts or
conditions.

Mapping elements to appropriate styles allows you to quickly create a simple

stylesheet. For some styles, you will be presented with another dialog box to
provide additional formatting properties.

Creating a Basic Stylesheet 37

To apply styles:
1. In the Elements list, select the element you want to style.
2. Select a style for the element from the Style list, via the Edit ▶ Style menu
option. If you are unsure which style to apply, select the Style Helper button.
This opens the Style Helper wizard, which walks you through the process of
selecting a style. Once you have applied a style, you can modify its formatting
properties.
The following table describes the predefined styles available in Arbortext Styler.

Predefined Styles

Style Description Requires

additional
details?
Block The most basic Block style, this style applies No
to an element that is preceded and followed by
a line break. Blocks can contain text,
elements, text and elements, or they can be
empty elements. They can be contain other
blocks, or they can be more similar to
paragraphs.
Cross An element whose content is automatically Yes - see Cross
Reference generated based on a reference to another References List
element. on page 778
Custom Table A set of elements that together define a Yes - see
custom table. Elements include a table Custom Tables
identifier, row identifier, optional header row List on page 777
identifiers, and optional cell identifiers.
Definition List An element that wraps a list of terms and their Yes - see
definitions. Definition List
Note Details Dialog
Box on page 939
You may be able to achieve the side by
side appearance of a definition list by
configuring side by side alignment for an
element styled as Block. Please refer to
Side by Side Alignment
on page 204 for further information.
Definition List An element that contains a term in a definition Yes - see Bullet
Item list. Dialog Box on
page 923

38 User's Guide
Predefined Styles (continued)
Style Description Requires
additional
details?
Division Hierarchically nested elements that contain Yes - see
titles, such as chapters or sections. Arbortext Division Details
Styler supports up to nine division levels. Dialog Box on
page 941
Note
Refer to Assigning division levels in your
stylesheet on page 43 for more information
on the Division style.
Document Identifies the top-level element in a document. No
Assign the Document style to an element
when the element will always be used as the
top level element in documents.
If the element sometimes is the top level
element, and sometimes is not, then it is
preferable not to assign the Document style
but instead to define a context to be used when
the element does occur at the top level. Assign
the At top level of document option to the
context. See Context Dialog Box on page 929
for further information.
Caution
It is important that the top level element in
the document instance is either given the
Document style or has a context where At
top level of document is checked. If the
outermost element of a document instance
is styled in this way, publishing may fail.
Footnote An element that is associated with a footnote.
This element may contain the text for the
footnote or may be a reference to another
element that contains the footnote text.
Formal Block An element that may contain a title or a No
caption, where those titles can be cross-
referenced, or appear in a table of contents.
These elements differ from divisions because
they can be used at different levels in the
document hierarchy. Formal Block elements
are commonly used to wrap figures or tables

Creating a Basic Stylesheet 39

Predefined Styles (continued)
Style Description Requires
additional
details?
and their associated titles or captions.
Graphic An element that represents a graphic. Initially, Yes - see
Arbortext Styler applies this style if the Graphic Details
element is configured as a graphic in the Dialog Box on
.dcf file. Changes made to a Graphic page 978
element in Arbortext Styler override the
settings in the .dcf file.
Hidden An element whose content is not displayed. No
The content of a hidden element may be
inserted elsewhere in the document if another
element's generated text references it.
Index An element that automatically generates an Yes - see Index
index. Details Dialog
Box on page 985
Index Term An element in a document whose document Yes - see Index
(Attribute type provides a single indexing element with Term (Attribute
Model) several attributes that are used to specify index Model) Details
terms. If the element has content, it may be Dialog Box on
formatted inline or hidden. page 986
Index Term An element in a document whose document Yes - see Index
(Element type allows for several elements to act as Term (Element
Model) indexing elements. The element's content may Model) Details
be formatted inline or hidden. Dialog Box on
page 987
Index Term An element in a document whose document Yes - see Index
(Nesting type allows for several nested elements to act Term (Nesting
Element as indexing elements. The element's content Element Model)
Model) may be formatted inline or hidden. Details Dialog
Box on page 989
Inline The most basic inline style, this style applies No
to an element that does not contain a line
break between it and the preceding and
following elements.
Link A link to a target that is specified by an Yes - see Link
attribute. An element must have a CDATA, Details Dialog
IDREF, or IDREFS attribute to be a link. Box on page
1005

40 User's Guide
Predefined Styles (continued)
Style Description Requires
additional
details?
Initially, Arbortext Styler applies this style if
the element is configured as a link in the
.dcf file. Changes made to a Link element in
Arbortext Styler override the settings in the
.dcf file.
Note
You cannot assign this style to a User
Formatting Element.
Link Target An element that serves as the destination of a Yes - see Link
link. An element must have an id attribute if Target Details
you want to format it as Link Target. If the Dialog Box on
selected element does not have an id attribute, page 1006
the Link Target option will be unavailable.
Initially, Arbortext Styler applies this style if
the element is configured as a link target in the
.dcf file. Changes made to a Link Target
element in Arbortext Styler override the
settings in the .dcf file.
List - Bulleted An element that wraps a set of list items to No
form a bulleted list. Nested bulleted list
elements are formatted appropriately to
differentiate various levels.
List - An element that wraps a set of list items to No
Numbered form a numbered or ordered list. Nested
numbered list elements are formatted
appropriately to differentiate various levels.
List Item An element that is included in numbered or No
bulleted lists. This style is also applied to
elements that wrap term-definition pairs in
definition lists.
No Style An element that does not affect formatting. No
Paragraph A block element that can contain text. No
Initially, Arbortext Styler applies this style if
the element is configured as a paragraph in the
.dcf file. Changes made to a Paragraph
element in Arbortext Styler override the
settings in the .dcf file.

Creating a Basic Stylesheet 41

Predefined Styles (continued)
Style Description Requires
additional
details?
Preformatted An element whose individual spaces and line No
breaks are preserved. By default, text within
Preformatted elements displays in a
monospaced font.
Note
If an element configured in the DTD or
schema to have the xml:space=”preserve”
attribute set is added to the stylesheet
during either a New Stylesheet operation,
or by choosing Insert ▶ Add Elements from
document or Doctype, its style will be set
automatically to Preformatted. Arbortext
Styler will not allow the style to be
changed. When an element’s style is
Preformatted, it will also have a value of
Preformatted in the Alignment field on the
Indent tab and you will not be able to
change this setting.
Table of An element that automatically generates a Yes - see Tables
Contents table of contents. of Contents
Details Dialog
Box on page
1050
Title A title or caption. Typically, a title element is No
used in many different contexts, although it is
possible to have more than one title element.
Titles in division or formal block elements can
be cross-referenced, or appear in a table of
contents.
Unstyled No style has been applied to the element. If No
you do not want an element to affect
formatting, change its style from Unstyled to
No Style.

42 User's Guide
Starting the Style Helper
The Style Helper is an alternative mechanism for attaching a style to an element. It
guides you through dialog boxes that help narrow your choices for selecting a
style.
To access the Style Helper:
1. Open Arbortext Editor, and choose File ▶ Open to open the document whose
stylesheet you want to modify.
2. Choose Styler ▶ Edit Stylesheet to open the stylesheet associated with the
current document, or Styler ▶ Open Stylesheet to open any stylesheet, not
necessarily that currently associated with the document.
3. Select any unstyled element and select the Edit ▶ Style Helper menu option.
You will be presented with the Style Helper wizard, a series of dialog boxes
that allow you to make choices as to the kind of styling that should be applied
to your element.

Assigning Division Levels in your

Stylesheet
Specifying division levels for certain elements allows you to apply special
formatting to the hierarchy in your document. Elements that are mapped to the
Division style may be chapter or section elements or other document structures
such as tables of contents, cross-references, and links.
To specify divisions:
1. Open Arbortext Editor, and choose File ▶ Open to open the document whose
stylesheet you want to modify.
2. Choose Styler ▶ Edit Stylesheet to open the stylesheet associated with the
current document, or Styler ▶ Open Stylesheet to open any stylesheet, not
necessarily that currently associated with the document.
3. Ensure the View ▶ Only Elements in Document option is deselected to ensure
that all objects permitted in the stylesheet are displayed in the Elements list,
rather than those configured for your particular doctype.
4. Choose Styler ▶ New Stylesheet. Arbortext Styler creates a stylesheet
displaying all the elements in your document type.
5. Highlight the element to which the division style is to be applied in the
Elements list, and select the Edit ▶ Style menu option. From the Style list,
choose Division.

Creating a Basic Stylesheet 43

6. Click OK in the Division Details dialog box to specify the element as a level 1
division. Alternatively, select the required division level from the Division
level drop down menu and click OK.
7. In addition to providing a framework for more complex formatting, Arbortext
Styler automatically creates new title contexts for each element mapped to
the Division style. Locate the title element in the Elements list. You will
see that a context has been created for each title element in each division you
have created, each of which can now be modified to differentiate each
division.
Using the DocBook XML doctype as a base, 5 levels of division could be
applied to the document by giving the Division style to the following
elements:
• part: level 1 division
• chapter: level 2 division
• sect1: level 3 division
• sect2: level 4 division
• sect3: level 5 division
If you refer to the Elements list once you have completed the style assignment
for each of these elements, you will see that the following title contexts have
been created:
• title in sect3
• title in sect2
• title in sect1
• title in part
• title in chapter

Validating Stylesheets
Once you have created your stylesheet, you may use Arbortext Styler's Validate
Stylesheet feature to confirm that any of the objects in the stylesheet contain
errors. Choose the Tools ▶ Validate Stylesheet menu option to invoke the
verification process.
If your stylesheet contains no errors, you will be presented with a message in the
status bar in the bottom left corner of the Arbortext Styler window:
[A23592] No stylesheet errors
If your stylesheet contains errors, for example if a custom table is invalid or a
condition relationship is incorrect, you will see the Styler Log window with details
of the error.

44 User's Guide
Some errors in your stylesheet, for example title contexts that are not set correctly
to be used as PDF bookmarks, may not generate error messages when the
stylesheet is validated. If they are displayed as part of the Arbortext Styler UI they
will be shown in the designated Arbortext Styler error color for your environment.
You may set the error color via the stylererrorcolor command - as a
default it is set to red.
A validate stylesheet action is also invoked automatically every time you request a
preview from the Arbortext Styler UI.

Validating translations of generated text

A validate stylesheet action invoked via the Tools ▶ Validate Stylesheet menu
option will provide the following information on the status of translations of
generated text:
• If a translation is missing for a piece of generated text that is set to be
translated. You will be presented with the error message shown below:
Generated text translations are not current for these languages:
es (Spanish), fr (French). Choose "View Translation Status" or
"List Translation Defects" from the "Tools" menu for more details.
• If the generated text source language of a stylesheet differs to that of any of its
modules. You will be presented with the error message shown below:
The generated text source language ("fr (French)") for the module
"stylesheet-module.style" does not match the source language of the
stylesheet ("en (English)").
• If any of the translation units in the stylesheet have duplicate IDs, i.e. when
you attempt to introduce a module that contains translation units with the same
IDs. Arbortext Styler will provide the following prompt for you to proceed
with adding the module or cancelling the action:
IDs of translation units in the module conflict with IDs of translation
units in the stylesheet. If you add the module, these IDs will be
regenerated. If there are outstanding translations, they should be
imported into the module before the IDs are regenerated.
Do you wish to add the module?

If you add the module, Arbortext Styler will automatically regenerate the IDs
in the module to remove the duplicates.
Outstanding translations are those that have been exported to an XLIFF file
(and possibly already been translated) but have not yet been imported into the
stylesheet. As mentioned in the dialog, these should be imported into the
module before the IDs are regenerated, to ensure completeness. Import any
outstanding translations then try again to assign the module to the stylesheet.
Unique IDs will then be applied to the translation units in the module, and
they will exist with their own translations.

Creating a Basic Stylesheet 45

Validating settings for generation of CSS rules
A validate stylesheet action invoked via the Tools ▶ Validate Stylesheet menu
option will provide information about current settings that will affect an export of
CSS information, for all HTML outputs. It will warn if it encounters any explicit
properties specified in the stylesheet that may not have an effect.
You will see the warning when this combination of settings exists in your
stylesheet:
• An HTML output is configured to have CSS rules generated for property sets.
• Contexts or conditions in the stylesheet have explicit properties specified for
the output that is configured to use property sets as the basis for CSS rules.
A stylesheet validation run as part of a preview or export action will provide the
same information about the relevant output only.

Saving Stylesheets
When you choose File ▶ Save in Arbortext Styler, Arbortext Editor saves the
stylesheet with a .style extension.
To save a stylesheet:
• Choose File ▶ Save from the Arbortext Styler window. If the current stylesheet
has already been saved, changes are automatically saved.
• If the stylesheet has never been saved, the Save Stylesheet As dialog box
opens.
Specify the path and file name for the stylesheet in the File Name field, either
manually or using the Browse facility.
Click Use for to save your stylesheet as the default stylesheet for specific
documents. You will see the Use Stylesheet for dialog box, which enables you
to specify the type of document with which the stylesheet should always be
used as default.
• If the current stylesheet has already been saved, and you wish to save it with
another name or to a different location, choose File ▶ Save As.
Specify the desired path and file name in the Save Stylesheet As dialog box.

Improve Document Startup Time by Saving a .genfos File with a

Stylesheet
When a document associated with a .style file is opened, Arbortext Editor has
to generate a .genfos file to support the display of the document in Arbortext
Editor view. The generation of the .genfos takes a certain amount of time,
depending on the length and complexity of the source .style file. This can
mean that the time taken to open the original document is increased. This delay in

46 User's Guide
startup can be avoided by saving the .style file in both .style and .genfos
formats - Arbortext Editor will then no longer need to auto-generate the
.genfos since that file already exists. This will ensure that the time taken to
open the original document is kept to a minimum.
To support this process correctly, the .genfos file must have the following
characteristics:
• The same base name as the source .style file
• The same directory location as the source .style file
• A later saved date/time than the original source .style file
The procedure detailed here must be carried out every time you modify the
source .style file.
If you attempt to open a document whose stylesheet is younger than its
associated .genfos file, i.e. if you have made changes to the stylesheet
without subsequently re-exporting the .genfos file, you will see the
following error message:

To create the .genfos file:

1. Create the stylesheet in Arbortext Styler, make any changes required and save
the stylesheet.
2. Choose the File ▶ Update Stylesheet for Editor menu option. Arbortext Styler
creates a .genfos file with the base file name and directory location as the
.style file.
Now that you have created the file, keep it synchronized with the stylesheet by
repeating the action every time you complete changes to the stylesheet.

Migrating Stylesheets from a Previous

Release
It is good practice to check whether your existing stylesheet .style files need
updating when you install a new release of Arbortext Styler. Stylesheets from
previous releases might not be compatible with the current release of the product.
When you open a stylesheet from a previous release in the current release of the
product, Arbortext Styler might prompt you to update the stylesheet. In this case,
follow the prompts and your stylesheet will be updated automatically. Note that
you must save the stylesheet for the updates to be permanent.
Following are two ways to update existing stylesheets:

Creating a Basic Stylesheet 47

• To update a stylesheet in Arbortext Styler:
1. In Arbortext Styler, select File ▶ Open.
The Open Stylesheet dialog box opens.
2. Select a stylesheet developed in a previous release in the Available
Stylesheets list.
3. Select OK to close the dialog box and open the stylesheet in Arbortext
Styler.
If the stylesheet needs updating, Arbortext Styler prompts you to perform
the update. If you do not perform the update, the stylesheet will not be
usable in the current product release.

4. Follow the prompts to update the stylesheet.

Make sure you save the stylesheet to make the updates permanent. Note
that after you save the updated .style file, it cannot be used by previous
releases of PTC Arbortext software. The automatic updating process does
save a backup of the original stylesheet, however, that you can access if
necessary.
5. Perform this operation for all stylesheets you are migrating to the upgraded
release. Be sure to check all custom directories your site uses for stylesheet
.style files.
• To update a stylesheet in Arbortext Editor:
1. In Arbortext Editor, select Format ▶ Select Stylesheets.
The Select Stylesheets dialog box opens.
2. Highlight the current Editor/Default stylesheet and select the Modify button.
The Modify Editor/Default Stylesheet Selection dialog box opens.
3. Select a stylesheet developed in a previous release in the Available
Stylesheets for Editor/Default list, or add a new one via the Add button.
4. Select the Select button to close the dialog box and set the stylesheet as the
Editor/Default stylesheet.

If the stylesheet needs updating, Arbortext Editor prompts you to perform

the update. If you do not perform the update, the stylesheet will not be
usable in the current product release.

48 User's Guide
 5. Follow the prompts to update the stylesheet.
6. Select the Close button to close the Select Stylesheets dialog box.
7. Make sure you save the stylesheet to make the updates permanent. After
you save the updated .style file, it cannot be used by previous releases
of PTC Arbortext software. The automatic updating process saves a
backup of the original stylesheet, that you can access if necessary.
8. Perform this operation for all stylesheets you are migrating to the upgraded
release. Be sure to check all custom directories your site uses for stylesheet
.style files.
If your stylesheet contains edited source for elements that was created in an earlier
release of Arbortext Styler, or you suspect that it may, it is useful to review the
stylesheet with this in mind when you wish to update it. You may need to recreate
existing source code edits to take into account any new features introduced in the
release.
Refer to Editing Stylesheet Source Overview on page 703 for details about editing
the source of an element context.

Regenerating Edited Source when

Updating a Stylesheet
It is recommended that you review source edits in a stylesheet you are updating to
any major release of Arbortext Styler, to confirm they still produce the correct
output. Some edited source may need to be modified to work as expected in a new
release, if related code changes have been made.
You should inspect all existing edited source that cannot be deleted and consider it
as a candidate for regeneration in the new release.
1. Run the stylesheet through the update process, noting any messages that
indicate possible issues.
2. Review your output once the stylesheet has been updated. You may need to fix
your edited source, especially if you saw messages during the update process.
3. For any edited source cases, review the reason for using edited source to
achieve the required effect. Where possible, use new features in the new

Creating a Basic Stylesheet 49

 release to accomplish the same thing without edited source. Refer to the
release notes for the new and preceding releases for lists of important changes.
Note, since edited source is output dependent, you will need to follow the steps
listed above for each output for which you have edited source.
For each case for which you need to maintain edited source, determine if the
original edited source still provides the desired effect, or if you need to modify it.
If a given object’s edited source is causing undesirable results you will need to
regenerate its edited source. To do this, carry out the steps listed below for each
output with edited source:
1. Determine the edits that were originally made in the edited source. See below
for a suggested process:
• With the version of the software the source edits were created in, capture a
copy of the object source that contains the required edit and save it.
• Again in the version of the software the source edits were created in, delete
that object’s source and regenerate it to create a unedited baseline.
• Compare the original source and the new baseline source to ascertain the
edits that were made in the original version.
2. Move to the new version of the software and update your stylesheet.
3. Delete the object’s edited source for the required output.
4. Regenerate that object’s edited source for that output.
5. Reapply the edits as appropriate to the newly regenerated edited source.
You should need to regenerate edited source if you are updating to the following
releases:
• 6.0 M020
• 6.0 M040

50 User's Guide
 4
Document Preview and Publishing
Overview of Preview and Publishing ...........................................................................52
Preview Options in Arbortext Styler.............................................................................53
PTC Advanced Print Publisher in Arbortext Styler ........................................................55
Print Features Available with PTC Advanced Print Publisher.........................................61
PDF Configuration File for the PTC APP Engine ..........................................................87
PTC APP PDF Configuration File (.appcf) ...................................................................96
Generating Accessible PDF Output .......................................................................... 138
Chunking Data in HTML Output ................................................................................ 148
Generating XHTML Output....................................................................................... 153
Generating HTML5 Output ....................................................................................... 153
Publishing EPUB Output .......................................................................................... 153
Generating Accessible HTML Output ........................................................................ 155
Managing CSS Files in HTML Output........................................................................ 159
Styling HTML Files from Different Document Types.................................................... 165
Passing Metadata to PDF Output.............................................................................. 169
Alternate Text Support for Graphics .......................................................................... 172

This section summarizes the options provided by Arbortext Styler to support

preview and publishing of your document.

51
Overview of Preview and Publishing
The majority of preview and publishing actions for your document are instigated
via Arbortext Editor or Arbortext Publishing Engine:
• Print preview — see Previewing a document in Arbortext Editor help for
further information
• Print — see Printing in Arbortext Editor help for further information
• Publish the final document in the required format:
○ EPUB — see Publishing a document for EPUB in Arbortext Editor help
for further information
○ HTML File — see Publishing a document as an HTML file in Arbortext
Editor help for further information
○ HTML Help — see Publishing a document for HTML Help in Arbortext
Editor help for further information
○ PDF — see Publishing a document as a PDF File in Arbortext Editor help
for further information
○ Web — see Publishing a document for the Web in Arbortext Editor help
for further information
○ using XSL — see Publishing a document using XSL in Arbortext Editor
help for further information
Arbortext Styler supports the publishing process by providing the following
options:
• Creation of a stylesheet that supports each format to which the document may
be published:
○ Arbortext Editor
○ HTML — HTML File, EPUB, HTML Help, and Web
You have options to generate HTML, XHTML, HTML5, or XHTML5
formats.
○ Print/PDF
○ RTF
Once created, the Arbortext Styler stylesheet can be exported from Arbortext
Styler to FOSI or XSL formats, or saved as a PTC Advanced Print Publisher
(PTC APP) template, a .3f file. The exported stylesheet/template can then be
associated with a document and used as the default stylesheet for publish
actions in Arbortext Editor. .3f files can be used in standalone PTC APP
applications to form the basis of new documents.

52 User's Guide
 Note
XSL stylesheets exported from Arbortext Styler do not conform strictly to
the XSL specification. They are designed be supported in other PTC
applications such as Arbortext Publishing Engine. PTC cannot guarantee
that they will work in other XSL-FO applications and do not support this
use case.

• Preview of the output of your document before publishing, in any of the

available formats
The integration of PTC Advanced Print Publisher into Arbortext Styler enhances
the options with which functionality can be appended to a basic stylesheet in
Arbortext Styler. See PTC Advanced Print Publisher in Arbortext Styler on page
55 for further information.

Note
The FOSI and XSL-FO print engines are on sustained support and do not
receive enhancements or maintenance fixes. PTC APP is the recommended
engine for print/PDF output.

Preview Options in Arbortext Styler

You can preview the effects of your stylesheet on your documents from Arbortext
Styler.
Choose the Preview menu option from the Arbortext Styler window and then
choose one of the available outputs:
• Arbortext Editor - displays the document in Arbortext Editor using the current
stylesheet settings.
• Print - displays the document in a print preview window using the current
stylesheet settings.
The publishing engine used to generate a print preview usually depends on the
active print engine setting for your Arbortext Editor with Styler environment.
See Publishing engine overview in Arbortext Editor help for a summary of the
capabilities of each print engine.
One of two distinct preview windows will be used to display your previewed
document, depending on which print engine is generating the preview:

Document Preview and Publishing 53

 1. PTC APP Preview window: displays previews generated with the PTC
APP print engine
2. Print preview window: displays previews generated with the FOSI or XSL-
FO print engines
• PDF - displays the document as a PDF file in Adobe Reader, using the current
stylesheet settings. You must have Adobe Reader installed.
The method used to create the PDF preview mirrors that set in Arbortext
Editor for publishing to PDF.
The engine used to generate the PDF preview usually depends on the active
print engine setting for your Arbortext Editor with Styler environment.
If your Arbortext Editor environment is set to use PTC APP as the print engine
for the publishing action, you will see the interim dialog box Publishing PDF
while it is progressing. The dialog box provides information about the
progress of the publishing action.
• EPUB - displays the document as an EPUB file (.epub) in Calibre’s E-book
viewer using the current stylesheet settings. You must have Calibre 0.8.0 or
later installed.
Refer to Publishing EPUB Output on page 153 for further information.
• HTML File - displays the document as an HTML file in a browser using the
current stylesheet settings.
• HTML Help - displays the document as an HTML Help file (.chm) in
Microsoft's HTML Help viewer using the current stylesheet settings. You must
have Microsoft HTML Help Workshop installed.
• Web - displays the document as a Arbortext Editor web document in a browser
using the current stylesheet settings. You must have a supported browser to
access this preview option.
• RTF - displays the document as an RTF file using the current stylesheet
settings.
Arbortext Styler performs an automatic validation of your stylesheet when you
select a preview action. If there are any errors in the stylesheet, if it contains
incorrect references to modules, or there are incongruences in translation
languages, details of the error will be listed in the Styler Log window.

54 User's Guide
PTC Advanced Print Publisher in
Arbortext Styler
The print engine functionality of PTC Advanced Print Publisher (PTC APP) is
available when working in a Arbortext Editor environment that includes Arbortext
Styler or Arbortext Publishing Engine. PTC APP is the default print engine for
these environments. You can preview and publish documents based on a Arbortext
Styler stylesheet for print or PDF with the PTC APP print engine. The inclusion of
PTC APP extends the functionality available from a Arbortext Styler stylesheet.
See Benefits of Publishing with PTC APP on page 56 for further information.
The PTC APP print engine and associated support files are built into the install
tree when you perform a full installation of Arbortext Editor with Arbortext Styler
or Arbortext Publishing Engine. Once you have installed Arbortext Styler or
Arbortext Publishing Engine you will have the option to set your stylesheet to use
the PTC APP print engine for its preview and publishing actions. See Setting PTC
APP as the Default Print Engine for a Stylesheet on page 58 for further
information on how to do this.

Note
Stylesheets created in earlier versions of Arbortext Styler will retain their
existing print engine setting when updated. New and most distributed
stylesheets use the PTC APP engine as a default.

Arbortext Editor and Arbortext Styler preview and publishing options will reflect
the ability to provide the required output with the PTC APP print engine:
• Arbortext Editor
○ Print preview - see Previewing a document in Arbortext Editor help for
more information
○ Print - see Printing in Arbortext Editor help for more information
○ Publish PDF - see Publishing a document as a PDF File in Arbortext
Editor help for more information
• Arbortext Styler
○ Preview of print or PDF output - see Preview Options in Arbortext Styler
on page 53
With each of these processes, any PTC APP template files (.3f files) that exist in
the document or doctype directories will be listed alongside .style files in the
list of available stylesheets for the process. The option to select .3f files is
possible in the stylesheet file chooser dialog boxes presented for these processes,
where applicable. If you elect to preview your document for print with the PTC

Document Preview and Publishing 55

APP print engine in Arbortext Styler, the preview will be presented in an PTC
APP preview window (see PTC APP preview window in Arbortext Editor help for
information).

Benefits of Publishing with PTC APP

• Support for non-Latin languages
The integration of PTC APP with Arbortext Styler provides access to PTC
APP's capabilities for formatting documents that contain text in languages
other than the standard Latin languages, for example Hebrew, Arabic, Thai, or
those in the Chinese, Japanese, and Korean (CJK) group. The following
features can be used to support font selection, punctuation, and text properties
required to format certain languages correctly:
○ Hanging Punctuation on page 644
○ Combined Fonts on page 635
○ Text Underlining and Strikethrough on page 646
○ Right-to-Left Layout Direction on page 652
• Advanced page layout functionality such as multiple column and gutter
widths, clip regions to page, avoid settings for page regions, and region
borders
Refer to Page Layout Overview on page 180 for further information.
• Automatic shrinking of graphics to fit available space
Refer to Stylesheet Properties — Print/PDF on page 1042 for further
information.
• Inclusion of printers’ marks
You may include printers’ marks in both print and PDF output when it is
published with PTC APP:
○ Crop marks
○ Date mark header
○ Registration marks
• Extending the stylesheet with PTC APP code
With Arbortext Styler's edited source feature, you can access the source code
in your stylesheet and extend it for PTC APP with Javascript code based on
PTC APP's FOM code model. See Editing Stylesheet Source Overview on
page 703 and Editing Stylesheet Source Examples on page 723 for further
information about editing stylesheet source.
• Associating an PTC APP template with a .style file

56 User's Guide
 You can associate an PTC APP template (.3f file) with your Arbortext Styler
stylesheet. If you select this option you can extend the stylesheet with the code
from the PTC APP template. Your stylesheet can then perform PTC APP tasks
not available from the Arbortext Styler interface or edited source, such as
scripting, style code, and control stream-driven functionality, e.g. anchors and
colors. If you associate a template with your stylesheet, the template code will
override the stylesheet code if definitions of the same object exist in both files.
The PTC APP tag description contained in the template code will therefore
take precedence over that contained in the stylesheet, such as that generated by
stylesheet conversion. For example, if your PTC APP template contains an
autoexec script this will be used in preference to any default scripting
provided by the stylesheet.
See Associating an PTC APP Template With a Stylesheet on page 59.
• Exporting the stylesheet as an PTC APP template
If you have created a Arbortext Styler stylesheet that contains PTC APP-
specific information, you can export that stylesheet from Arbortext Styler as
an PTC APP template. Once you have created the template in this way you
can use the template in a standalone PTC Advanced Print Publisher
environment, without the need for Arbortext Styler to be running to interpret
the stylesheet/template. You may also then use PTC Advanced Print Publisher
to touch up, extend, or update the template.

Note
The template can only be opened successfully in the same PTC Advanced
Print Publisher release in which the template was created - you will see an
error message if you try to open the document in an earlier release.

See Exporting Stylesheets on page 176.

Managing PTC APP in your Arbortext Styler

Environment
The PTC APP print engine and associated support files are built into the Arbortext
Styler install tree. The installation of a full Arbortext Editor with Styler
environment will include as a default a subset of the Unicode version of PTC
Arbortext Layout Developer— Desktop, providing the PTC APP print engine and
the capability to generate PTC APP source code for a Arbortext Styler stylesheet.
Note that no PTC APP interface is included. Further information regarding the
installation of PTC APP is given in the list below:

Document Preview and Publishing 57

1. A prerequisite for a successful PTC APP / Arbortext Styler integration is the
availability of an applicable version of Perl. The Perl library perl58.dll is
packaged with a PTC Arbortext installation that includes PTC APP, in the
location Arbortext-path/app/perl/bin (or Arbortext-path/
app/perl64/bin if you are working with a 64-bit installation). If you wish
to specify the location of an alternative Perl installation to support PTC APP,
set the environment variable APTAPPPERL as required (see APTAPPPERL in
Arbortext Editor help for further information)
2. PTC APP files are built into the app directory of your Arbortext Styler install
tree, in the location Arbortext-path/app. The directory contains the
required DLL, system, and library files to run PTC APP from within Arbortext
Styler. Note that the inclusion of an integrated PTC APP version with
Arbortext Styler will not affect any standalone PTC Advanced Print Publisher
installation that currently exists on your system.
3. PTC APP files are not installed if you elect to install Arbortext Editor alone.

Setting PTC APP as the Default Print Engine for a

Stylesheet
1. Navigate to the Print/PDF tab of the Stylesheet Properties dialog box for your
stylesheet, accessed via the File ▶ Stylesheet Properties menu option or when
creating a new stylesheet.
2. Select PTC APP in the Print Engine field to set PTC APP as the print/PDF
engine for the stylesheet and activate the option to browse for an PTC APP
template (this is optional).

Note
Using this option sets the default print engine preference for actions performed
using this stylesheet. Print engine settings made elsewhere in your
environment may mean that a different print engine is actually used for the
action.

Extending a Stylesheet with PTC APP Code

You can edit the source of these objects for PTC APP:
• Context
• Property set
• Page set

58 User's Guide
• Page type
• Page region
To access the PTC APP source of an object in a Arbortext Styler stylesheet for
edit::
1. Select the object in the relevant list view.
2. Select the Edit ▶ Edit objectname Source ▶ PTC APP menu option.
The source of that object opens.
The menu option is only available when your stylesheet is set to use PTC APP
as the print/PDF engine.
3. Make the necessary changes to the object, using JavaScript code that
references objects from PTC Advanced Print Publisher’s Formatting Object
Model.
Refer to the Stylesheet Developer’s Guide to APP Code for information on
making stylesheet edits for PTC APP, plus examples.
Refer to the Formatting Object Model Reference for details of the objects
described by the Formatting Object Model.
See Overview of Autogenerated APP Source on page 714 for further information
on the source generated for objects for PTC APP.

Associating an PTC APP Template With a Stylesheet

You can elect to associate either type of PTC APP template with your Arbortext
Styler stylesheet — both those coded with PTC APP's proprietary macro language
and those coded using JavaScript and PTC APP's FOM object model. In either
case the template will have the .3f file extension.
A template must conform to a certain format to correctly support preview or
publishing from Arbortext Styler. Refer to Guidelines and Limitations for PTC
APP Template Files to be Associated with a Arbortext Styler Stylesheet on page
60 for information.
1. Navigate to the Print/PDF tab of the Stylesheet Properties dialog box for your
stylesheet, accessed via the File ▶ Stylesheet Properties menu option or when
creating a new stylesheet.
2. Select PTC APP in the Print Engine field to set it as the print/PDF engine for
the stylesheet and activate the option to browse for an PTC APP template.
3. Click the Browse button next to the Optional APP template to associate with
stylesheet field.

Document Preview and Publishing 59

4. In the PTC APP Templates file picker dialog box that appears, navigate to and
select the required .3f file. The Files of type field is set to look for files with a
.3f extension.

Note
Selecting a .3f file in the file chooser dialog box will not open it. It will
associate the template with the current stylesheet to extend the stylesheet's
capability.

5. Alternatively, you can type the path to a template in the Optional APP template
to associate with stylesheet field.

If you enter a full path to a template here, and it cannot be found, no error will
be generated.

Best Practice
It is recommended that you place the .3f file in the same directory as the
stylesheet and specify only its file name, with no path.

6. Click OK to accept the selection. The Optional PTC APP template to associate
with stylesheet field contains the full path and filename information for the
selected template file, which will be stored in the stylesheet. Once the change
to the stylesheet has been saved, this setting will persist for the stylesheet in
this and succeeding Arbortext Editor with Styler sessions, until removed or
edited.

Guidelines and Limitations for PTC APP Template Files to be

Associated with a Arbortext Styler Stylesheet
When writing an PTC APP template that will eventually be associated with a
.style stylesheet, you must ensure that its contents comply with the points
listed below.
• Any PTC APP template file may be associated with the stylesheet. The only
restriction is that the file extension is .3f as this is the extension that you can
browse for and select via the user interface.
• When the stylesheet and template are combined, everything present in the
template file will become part of the document created by the publishing
process, including any page items, tags or other PTC APP objects.
• If frames are to format the main content stream, their text content must be set
to "EditorDom0". This may not be possible through the user interface of

60 User's Guide
 PTC Advanced Print Publisher unless the stream exists in the template, so it is
recommended that the frame object itself is edited to include
text "editorDom0",0,0,0,0,0

• The stylesheet compilation process creates numerous tags in the PTC APP
document prior to formatting the content. An existing tag in the template with
the same name as one that would get created during the compilation process
will be used in preference.
• Any autoexec script present in the root namespace will not be run.
• Some (if not all) document preferences set in the template will persist in the
created document unless specifically set by the stylesheet compilation process.
This includes frame guides, which will appear in the PTC APP Preview
window if they have been activated.

Print Features Available with PTC

Advanced Print Publisher
All Arbortext Styler UI options can be handled via all three print engines available
in a PTC Arbortext environment — PTC APP, FOSI, and XSL-FO. Certain print/
PDF output requirements require the use of PTC Advanced Print Publisher to
handle them fully, either by selecting the PTC APP print engine in the Arbortext
Styler UI or by extending Arbortext Styler to access some more advanced
formatting options. These can be arranged into nine distinct categories:
• Output
• Post-publishing touchup
• Language formatting, especially Asian languages
• Color handling
• Rules
• Region control
• Typography
• Testing
• Content streams
Refer to Accessing PTC Advanced Print Publisher Features on page 61 for a
summary of the methods by which you can access these features.

Accessing PTC Advanced Print Publisher Features

The table below summarizes how each PTC Advanced Print Publisher feature can
be accessed:

Document Preview and Publishing 61

 Associat-
ed PTC Native PTC
Arbortext Source APP APP
Feature Styler UI code edit template template
Output on page 64
Multiple files from •
single composition
Graphical output •
formats
Output from single •
frame
Touchup on page 65
Post-publishing •
touchup
Language formatting
on page 66
Ruby •
Warichu (annotation) •
Yakumono •
Thai •
Hanging punctuation • •
Vertical formatting •
Right-to-left •
formatting
Color handling on page
70
Named colors •
Color spaces • •
Gradients •
Rasters as colors •
Tint and brightness •
Color mode •
Rules on page 72
Rounded corners •
Rule patterns •
Rule numbers •
Side rules / accolades •
Region control on page
74
Number of regions • •

62 User's Guide
 Associat-
ed PTC Native PTC
Arbortext Source APP APP
Feature Styler UI code edit template template
Region placement • •
Region properties • •
Region content • •
Typography on page
78
Hyphenation • •
Spacing •
Kerning •
Ligatures •
Character effects •
Blocks •
Drop capitals and • •
words
Paragraph reposition •
Tab stops •
Justification •
Text decoration • •
Testing on page 84
Format result testing •
Content as trigger for •
style change
Direct use of attribute •
values
Content Streams on
page 86
Multiple main content •
streams
External content •
streams
Arbortext Styler UI
Can be selected/configured in the Arbortext Styler UI, when working with a
.style stylesheet
You may need to select the PTC APP print engine to fully support the feature.
You will see a note in the UI to indicate if this is required.

Document Preview and Publishing 63

Source code edit
Requires the extension of the .style stylesheet with PTC APP Javascript
code
Refer to Stylesheet Developer’s Guide to APP Code for some samples of
source code edits.
Refer to Formatting Object Model Reference for descriptions of the objects in
PTC Advanced Print Publisher’s Formatting Object Model, accessed via
JavaScript.
Associated PTC APP template
Requires native PTC APP code compatible with a .style stylesheet.
Associate the template (.3f file) with the .style stylesheet using the option
in the Stylesheet Properties dialog box on page 1042.
Native PTC APP template
Requires native PTC APP code not compatible with a .style stylesheet.
Must be configured in an PTC APP template in a standalone PTC Advanced
Print Publisher desktop installation.
You may need to work with GSO or an PTC APP partner to provide code of
this nature.

Output
Multiple files from one publishing process
PTC Advanced Print Publisher is capable of generating multiple output files from
a single composition process. The following options are available:
• PDF - from Arbortext Styler UI
• PostScript - from Arbortext Styler UI
• PTC APP application (.3d) file for touchup - from Arbortext Styler and
Arbortext Publishing Engine UIs
• Graphical output formats - requires custom code in an associated template
PTC Advanced Print Publisher‘s super print (sprint) function allows multiple
output formats to be generated in a single pass. A customized print configuration
file will provide a simple means to access this capability.

Graphical output formats

PTC Advanced Print Publisher can generate graphical output from published
pages or their frames. Supported graphics formats are:
• EPS

64 User's Guide
 Options include preview type (TIFF, EPSI) and resolution, font embedding,
color mode
• TIFF
Options include DPI, color mode (mono, RGB, or CMYK), anti-aliasing,
compression (LZW)
• GIF
• PNG
• SVG
Use custom code in an PTC APP template associated with your .style
stylesheet to generate these output types.

Output from single frames

PTC Advanced Print Publisher can print a single frame to an output file. This is
often used by a script to generate output files of items that are difficult to present
online, for example mathematics or tables.
Custom scripting in a native PTC APP template is required to generate output of
this type.

Post-Publishing Touchup
.3d files created during publishing can be opened on a PTC Advanced Print
Publisher Desktop license for touch up editing. You must use native PTC APP
templates configured to allow post-publishing changes.
You can carry out these types of touchup task in an PTC APP template:
• Move floating items and reflow pages
• Make text corrections to the content
• Introduce processing instructions or custom markup to change any formatting
property
• Introduce or change page, column, and line breaks. Note: this may require a
document reformat if the page ending has changed
Note the following limitations and considerations:
• The system setup (version, available libraries, fonts, configuration file etc.)
must be identical between the server and desktop environments
• PTC Advanced Print Publisher currently has no DOM editing tool. Making
content changes for documents composed using Arbortext Styler stylesheets
will be cumbersome, but not impossible
The DOM editing tool is expected in a later release.

Document Preview and Publishing 65

• It is possible to create a custom UI and touch up environment in PTC
Advanced Print Publisher to limit what can be changed by the user
• If touch up is a major requirement, consider using native PTC APP templates
• Consider using PTC Advanced Print Publisher's application bundles to capture
a system snapshot for providing touch up
• New markup introduced by PTC APP will make no attempt to validate the
content. It is the users responsibility to ensure that the changes they make are
valid and do not corrupt the well formed nature of the XML
Tools can be created to indicate parsing errors beyond bad formatting.
• If the XML content is changed in the file, it is possible to export this from
PTC Advanced Print Publisher
• Changes to style will not be reflected back into the template
• It may be necessary to reformat the whole document if significant changes
have been made

Language Formatting
Japanese
PTC Advanced Print Publisher addresses a number of features specific to Japanese
typography:
• Ruby
Ruby is the display of a set of characters above another set. It is often used to
provide pronunciation or descriptive information about the main content. PTC
Advanced Print Publisher provides the ability to format Ruby content with
different properties, such as alignment
An PTC APP source code edit is required to apply Ruby content.
• Warichu (annotation)
Annotation is the method of outputting a number of lines of text within a
single line. PTC Advanced Print Publisher supports up to five lines of text.
An PTC APP source code edit is required to apply Warichu text.
• Yakumono
Yakumono is the method by which punctuation characters are resized in order
for them to be displayed correctly. It is possible to remove an amount of a
character's display box from the left (for opening punctuation), from the right
(for closing punctuation) or from either side (for items such as colons).
Behavior differs depending on whether the character is appearing at the start
of a line (for opening punctuation), the end of a line (for closing punctuation)

66 User's Guide
 or in the middle of a line (for all types of punctuation). These properties are
applied when trying to justify the line of text.
PTC APP source code edits are necessary to change default Yakumono
settings.

Thai
Thai formatting support is provided with PTC Advanced Print Publisher,
including line breaking and character building capabilities. No additional code is
required. Select the PTC APP print engine and any Thai content in your document
will be formatted correctly.

Hanging punctuation
In PTC Advanced Print Publisher hanging punctuation is provided using a custom
kerning table. The kerning table tells PTC Advanced Print Publisher how to
handle a list of punctuation characters when they appear at the end or start of a
line of text.
Basic hanging punctuation support is provided through the Arbortext Styler user
interface. The default kerning table instructs PTC Advanced Print Publisher to
hang the following characters into the right margin when the hanging punctuation
option is selected:
• Western full stop / period (.)
• Western comma (,)
• Ideographic full stop / period (。)
• Ideographic comma (、)
An alternative kerning table is provided as part of the PTC APP integration. This
provides support for many more punctuation characters. To access this table, use a
very simple PTC APP source code edit in the style you wish to enhance. Look for
this line:
style.kerningTable = '_app:HangingPunctuationSimple';
Change the line to:
style.kerningTable = '_app:HangingPunctuation';
The enhanced kerning table provides support for:
• End of line
○ Western punctuation
◆ .
◆ ,
◆ !
◆ ?

Document Preview and Publishing 67

 ◆ )
◆ "
◆ '
◆ ]
◆ :
◆ ;
◆ -
◆ ”
◆ ›
◆ »
○ CJK punctuation
◆ 、
◆ 。
◆ 〉
◆ 》
◆ 」
◆ 』
◆ 】
◆ 〕
◆ 〗
◆ 〙
◆ 〛
◆ 〞
◆ 〟
• Start of line
○ Western punctuation
◆ "
◆
◆ (
◆ [
◆ ‘
◆ ‚
◆ ‛

68 User's Guide
 ◆ “
◆ „
◆ ‟
◆ ‹
◆ «
◆ 〈
◆ 《
○ CJK punctuation:
◆ 「
◆ 『
◆ 【
◆ 〔
◆ 〖
◆ 〘
◆ 〚
◆ 〝
If you wish to create your own kerning table for use in Arbortext Styler or
Arbortext Publishing Engine, use the PTC APP tags inside the _app namespace
in the _app.3ns file within the Arbortext-path/APP/libs directory as a
basis.

Vertical formatting
• Vertical formatting
• Embedded western text
You will need to configure vertical formatting in a native PTC APP template.

Right-to-left languages
• Hebrew
• Arabic
• Bidirectional
Right to left formatting is provided through the Arbortext Styler UI. You will need
to select the PTC APP print engine for your publishing action to use the feature.

Document Preview and Publishing 69

Color Handling
Named colors
A useful way of defining specific colors is to create a named color. A named color
allows a single point of definition and update for a color that is used extensively
through a template or stylesheet. PTC Advanced Print Publisher provides a
method for creating a new color, which is then available from every location in
which a color can be selected. The color can be specified using any of the
supported color spaces, as a raster color or a gradient (see below).
Create named colors in an PTC APP template and associate the template with
your .style stylesheet. Use PTC APP source code edits to call the named color,
referring to it by name, wherever you wish to use that color.

Color spaces
PTC Advanced Print Publisher provides support for a number of color spaces that
are more specific to print. By default, PTC Advanced Print Publisher uses the
CMYK color space to define colors for all objects in a template, but it is also
possible to use HSB and RGB values.
PTC Advanced Print Publisher also provides support for a number of color books
from the CSS specification and Pantone. These color books provide predefined
definitions of colors that should be displayed or printed the same on any output
device. The Pantone color books supported by PTC Advanced Print Publisher are:
• Pantone Matching System (4/C process)
• Pantone Matching System (coated)
• Pantone Matching System (uncoated)
• Pantone Process
• Pantone Process coated Euro
• Pantone Solid to Process coated Euro
Colors from the Pantone and CSS color books are used by name and should be
used as a named color.
PTC Advanced Print Publisher color spaces will require PTC APP source code
edits in your .style stylesheet, or native PTC APP templates.

Gradients
PTC Advanced Print Publisher provides support for graduated colors. They can be
created and used in the same way any other color.
PTC Advanced Print Publisher's graduated colors are built from a number of base
colors and stops. PTC Advanced Print Publisher creates a blend from one color to
the next. A gradient can have several stops, each with their own color. The stops

70 User's Guide
are positioned along a linear range. You may also control the resolution of the
gradient and the way the gradient should expand or tile within the area that uses it.
The gradient can also be rotated.
To use a gradient, create it as a named color in an PTC APP template associated
with your .style stylesheet. Use PTC APP source code edits to call the named
color, referring to it by name, wherever you wish to use that color.

Rasters as colors
You might wish to use a raster as a color if you have large text that should be
printed using an image. For example, if you would like text to appear as though
created from an image of clouds, you can use the cloud image as a color and apply
that to the text.
It is possible to specify that a color is derived from a raster that is loaded, or
linked, to a template. As with gradients, raster colors can be used wherever a color
can be used. A raster color also has controls for its appearance and alignment
within the area that uses it.
Create a raster color as a named color in an PTC APP template associated with
your .style stylesheet. Use PTC APP source code edits to call the color,
referring to it by name, wherever you wish to use that color.

Tint and brightness

When using a color in PTC Advanced Print Publisher it is possible to specify its
tint and brightness. This is similar to specifying color saturation and brightness in
the HSB color space. Using tints and brightness is an excellent way of providing
color coherence within a design, without requiring many colors to be defined.
To access tint and brightness, provide the necessary values as a ratio when calling
the color. For example, for a 50% tint at 100% brightness of red, use 100/50
red. For a 25% tint at 50% brightness of blue, use 50/25 blue.
PTC APP source code edits are required to access these features.

Color mode
When creating PDF in PTC Advanced Print Publisher, it is possible to specify the
color mode. You can select from:
• Color
Uses the color as defined in the template or attached images
• Monochrome
Produces a monochrome PDF with no color
• CMYK
Transforms all colors to the CMYK color space

Document Preview and Publishing 71

• RGB
Transforms all colors to the RGB color space
• CMYK plus spot
Provides support for specific named colors in addition to CMYK
PTC Advanced Print Publisher is able to generate color separations when printing
to PostScript and PDF. If you wish to print one or more named colors separately to
the others, or to print the CMYK plates with additional plates for named colors,
you can do this by creating a print control stream in PTC Advanced Print
Publisher. You will need a native PTC APP template to handle this, probably with
the support of GSO or an PTC APP partner.

Rules
Rounded corners
PTC Advanced Print Publisher rules around objects can have rounded corners.
You specify the corners that are to be rounded and the radius of the rounding.
Positive and negative rounding values can be used to give some interesting results.
PTC APP source code edits will give access to rounded corners on blocks and
frames.
Refer to Stylesheet Developer’s Guide to APP Code for samples of how to draw
rules with rounded corners.

Rule patterns
PTC Advanced Print Publisher's rule functionality allows you to create your own
rule patterns. You can combine pre-existing pattern components to create your
own, and even create your own pattern components (marks) if a highly
customized rule pattern is required.
The rule patterns and their components can use any PTC Advanced Print
Publisher color (see above).
PTC Advanced Print Publisher will try to justify the pattern over the area it is
being drawn. It does this by allocating a stretch factor to the pattern components.
For dot and dash type patterns, the space between marks can be stretched.
In addition to the simple pattern, a rule can have a start and end pattern which
includes arrowheads and other terminal marks. As with pattern components,
custom versions of these can be made.
PTC APP source code edits will allow you to set the rule pattern on underline,
strikethrough, blocks, and page regions.
Refer to Stylesheet Developer’s Guide to APP Code for samples of how to draw
rules based on patterned line styles.

72 User's Guide
Multiple rules
Each one of these objects can have up to 20 rules applied with PTC Advanced
Print Publisher:
• Paragraphs
• Blocks
• Block columns
• Tables
• Table cells
• Frames (regions)
It is possible to assign a color of none to rules in order to provide an offset. Rules
with a positive value push inwards on the object, negative values push outwards.
PTC APP source code edits allow you to set additional rules on blocks and
regions.
Refer to Stylesheet Developer’s Guide to APP Code for samples of how to draw
multiple rules.
Note that rules on tables are only accessible by customizing the PTC APP tables
library provided with Arbortext Styler.

Side rules / accolades

PTC Advanced Print Publisher uses a feature called accolades to draw complex
rules in the margin.
Accolades are drawn between a start and an end position. Their horizontal start or
end position can be either absolute or relative to page, frame, column, or current
text margin. Their vertical start or end position can be either absolute or relative to
page, frame, column, text, table, table column, or the edge of the text. The exact
position allows interesting effects, such as linking arrows, to be created between
two pieces of text.
Accolade start and end positions are not constrained to the logical structure of
content. It is possible to start an accolade at one level in the content hierarchy and
end it at another.
• When using graphical rule type accolades, background colors can be applied.
Up to 8 graphical rules can be applied to an accolade.
• Characters such as parentheses, braces, and brackets can form the accolade.
These objects can be positioned to the left or the right of the text.
• A new option allows the side on which an accolade is drawn to remain on the
inside or outside of a page.

Document Preview and Publishing 73

• Accolades can be drawn behind text, but on top of other rules and background,
or on top of all text and backgrounds.
• The accolade draw mode can be configured to only draw the accolade if a
certain amount of content has been output between its start and end point.
Other conditions can also be used to dictate whether the accolade appears.
Create accolades in an PTC APP template and associate it with your .style
stylesheet. You may be able to achieve the same effect with PTC APP source code
edits but you may need assistance from GSO or an PTC APP partner.

Region Control
Number of regions
Arbortext Styler provides access to more page regions than were previously
available. You can design page layouts that feature more than the standard three
page regions (main, header and footer).
PTC Advanced Print Publisher provides the ability to have up to 400 regions
applied to the same page.
The Arbortext Styler UI does not permit the use of multiple regions on the same
page to contain the main content flow. This could be used when creating title and
cover pages, or when creating parts catalogs where one region contains tabular
content and the other regions hold descriptive information. To create additional
regions on a page layout to contain the main content, use PTC APP source code
edits for the page type object that defines the page layout. Add a new region that
references the editorDom0 content stream.

Region placement
Arbortext Styler provides access to a number of positioning methods for regions.
Regions can be placed relative to margins or page edges, or with absolute
coordinates.
PTC Advanced Print Publisher inherently uses absolute positions. Relative values
can be configured through the Arbortext Styler UI.
The following complex region placement requirements can also be met with PTC
Advanced Print Publisher. It is advisable to engage GSO or an PTC APP partner
to achieve them:
• Inline region creation
It is sometimes necessary to extract some content from the main text and place
it into a separate page region. PTC Advanced Print Publisher allows users to
create a frame (page region) dynamically during formatting and place it on the
current page at the position required. It is possible to place the frame relative
to the position of the markup item in the document that triggers its creation.

74 User's Guide
 To create inline regions, use custom FOM code to create a frame and place it.
The frame can be populated with any information and carry any of PTC
Advanced Print Publisher's frame properties. Content can be extracted from
the main content stream using XPath or PTC Advanced Print Publisher's show
strings. External files (text or graphics) can be loaded into the frame.
Refer to Stylesheet Developer’s Guide to APP Code for a simple example of
how to create a frame, position it at the same vertical position in the document
at which an element should be, and populate it with content.
• Anchored regions / floats
Anchored regions are PTC Advanced Print Publisher frames placed on a page
according to conditions and rules. They typically hold text and/or graphics. An
example of an anchored region is a figure in a book with a caption that is
placed near its reference in the text.
PTC Advanced Print Publisher allows the creation of complex placement
rules, such as place in my current column or place in column X on the next
page but not before frame Y.
• Regions that span pages
With PTC Advanced Print Publisher you can create regions that span facing
pages, in order to place very wide content. This is achieved by tying pages
together. The tied pages are formatted as one and the frame placed across the
two pages. It is possible to create rules that govern how a table should be
formatted when it spans the two pages, including how to avoid the gutters
between the two pages.

Region properties
A number of PTC Advanced Print Publisher's advanced page region properties are
available through the Arbortext Styler UI:
• Avoid
When a region overlaps another, the content of the lower region wraps around
the boundary of the upper region.
• Page clipping
If a page region should extend beyond a page boundary, the content can be
clipped to the page boundary. Any content that overlaps the edge of the page
will not be output to the printed file.
Deactivating page clipping allows items to run off the page. This enables the
creation of bleed tabs, which rely on blocks of color extending off a page
when printed.
• Rules

Document Preview and Publishing 75

 The Arbortext Styler UI provides an option to apply a single rule to a region.
PTC Advanced Print Publisher regions can carry up to 20 separate rules (see
Multiple rules on page 73 for more information.
PTC Advanced Print Publisher supports additional properties for regions. These
are not available through the Arbortext Styler UI, but can be accessed through
PTC APP source code edits:
• Column control
The integration of PTC Advanced Print Publisher (PTC APP) in Arbortext
Styler uses blocks to control text column configurations as they can potentially
be changed mid-page.
Regions can also have their own column configurations, which can be set by
the user. One use of frame columns is to place side notes. Another is to strictly
enforce a column configuration for the duration of the page set.
• Mode
PTC Advanced Print Publisher regions can have a mode property, which
governs when the region should appear. This type of conditional appearance
can be based on whether the current page is left or right (or odd or even) or
based on an expression. The conditional expression will force the frame to
appear if it evaluates to a non-zero value and can test any variable information
available in PTC Advanced Print Publisher.
• Copy fit
If the content of a frame does not fill the frame, or overflows, rules can be
applied to make the frame fit the content (or the content fit the frame). You can
specify that certain text properties should change in order to make the content
fit, or that certain frame dimensions should change in order to resize the frame
for the content it holds.
• References
Frame references are discrete items of PTC Advanced Print Publisher code
that are run when different formatting events are encountered:
○ Frame start references
Executed when the frame is started. These are often used to record the
page break positions in a content stream. It is possible to query the current
stream position and store this in a variable, as part of the page string or as
a property on the page object.
○ Column start references
Executed at the top of each column on the frame. You could use these (or
frame start references) to output some information. Be careful when doing

76 User's Guide
 this, however, as it will affect the content being formatted at the column
(or page) break
○ Paragraph start references
Executed when PTC Advanced Print Publisher starts a new paragraph.
Paragraph start references occur before any paragraph styling.
○ Line start references
Executed at the start of every line. They occur before paragraph start
references. Line start references have been used as part of a line-
numbering implementation as it is possible to use the reference to store
both line number and vertical position in a variable or stream. The
information is then output later.
• Filler
If content runs short in a frame, filler references can be used to add content to
fill the frame up. That content could be a graphic, rules, text, or leaders.
• Cutting guides
Each frame can carry its own cutting guides. This is useful if you are
producing a layout that will be cut into smaller parts (for example, business
cards) or if you wish to add lots of extra content off the edge of the main page
area. Apply cutting guides to regions to achieve this, rather than outputting
them for the whole page.

Region content
When configured in the Arbortext Styler UI, regions are permitted to hold three
types of content:
• Main content (one region per page)
• Generated content (for example headers and footers
• Graphical content (extracted from the main text using an XPath expression, or
referencing an external file)
If other content is required, you can make PTC APP source code edits in the .style
stylesheet to point a page region to the content you wish to apply to it.
PTC Advanced Print Publisher can accept non-XML or SGML text content so it is
possible to pull in any external files, regardless of their content type.
Style can be applied to the content as long as it contains &entities; or
<elements>. To apply style in this way, create a tag in an PTC APP template
and associate the template with your .style stylesheet. PTC APP will look for
an element or entity with the same name in the stylesheet.

Document Preview and Publishing 77

Typography
Hyphenation
In the Arbortext Styler UI, you can activate and deactivate hyphenation
completely, or confirm that words can break but without displaying a hyphen.
PTC Advanced Print Publisher's line breaking capability is powered by the same
library as the FOSI engine. However, PTC Advanced Print Publisher is a line-
based processor rather than a paragraph-based one, so there may be differences
between the two when it comes to line endings. PTC Advanced Print Publisher
will scan back to the beginning of the paragraph to achieve an aesthetic output,
but will not consider the paragraph as a whole. Additionally, PTC Advanced Print
Publisher can allow letter and word spacing adjustments, which also affect line
breaking (see later).
When PTC Advanced Print Publisher is processing a line of text, it will always do
what it can to fit the content into the space available. This means that table cell
content should never overhang the cell boundaries.
PTC Advanced Print Publisher has its own group of hyphenation settings:
• Hyphenation level
PTC Advanced Print Publisher's hyphenation level ranges from 0 to 10, from
least strict to off. Additional levels 11 and 12 mean that hyphenation
is deactivated, but will handle words that are too long. Level 12 forms
Arbortext Styler's off setting. A word will not hyphenate unless it is too long
to fit in the current measure, when it will break at an appropriate point. Level
11 is a strict line-based hyphenation rule. It will not consider the rest of the
paragraph, and so ignores other settings related to hyphenation.
Hyphenation level is controlled by the <?thyc> processing instruction (PTC
Advanced Print Publisher syntax) or the fStyle.hyphenationLevel
property.
• Number of consecutive hyphens
Set a maximum number of hyphens that can appear down the edge of the page.
• Minimum word size to hyphenate
Ensure that small words do not get hyphenated.
• Minimum characters before and after a hyphen
Ensure that a minimum number of widow and orphan characters appear on a
line.
• Disable hyphenation
Specify that hyphenation should be disabled under certain conditions:
○ For words in capitals

78 User's Guide
 ○ At the end of a paragraph
○ At the end of a column
○ At the end of a page
As with FOSI, exception dictionaries can be used. These allow you to specify
custom hyphenation points in words. Two dictionaries can be applied with PTC
Advanced Print Publisher.
You can also define the hyphenation character to be used, on a paragraph or an
inline basis. The normal hyphen character (-) can be replaced with any other
character, or set to nothing. This is useful when formatting chemical names, URLs
and so on.
PTC Advanced Print Publisher provides the ability to specify word break
characters. These are the characters that are permitted to break lines without
introducing a hyphen. By default, this is set to the hyphen (-) and the forward
slash (/), but it is simple to add and remove characters. PTC Advanced Print
Publisher can have up to 16 characters configured as permitted word break
characters.
PTC APP source code edits are required to access PTC Advanced Print Publisher's
hyphenation control. Refer to Stylesheet Developer’s Guide to APP Code for some
samples of how to configure hyphenation.
PTC Advanced Print Publisher also provides support for the Dieckmann
hyphenator, which provides superior hyphenation rules for many different
languages. You must purchase dictionaries to use this function. These are
available from Dieckmann or DataCopy, a PTC partner. Engage the services of
GSO or an PTC APP partner to implement this hyphenator.

Spacing
Letter and word spacing is used to improve the aesthetics of justified text by
varying the amount of space between letters and words. PTC Advanced Print
Publisher can apply a basic setting, but also set maximum values for 'stretch' and
'squash', which allows an amount of flex when making the text fit onto a line.
Spacing works in conjunction with hyphenation settings to produce nice looking
text.
To access PTC Advanced Print Publisher's spacing settings, use PTC APPsource
code edits to the style. The following properties are exposed to the user through
the FOM:
• Letter spacing
○ Basic letter spacing — fStyle.letterSpace
○ Letter spacing stretch — fStyle.letterSpaceExtra
○ Letter spacing squash — fStyle.letterSpaceSquash
• Word spacing

Document Preview and Publishing 79

 ○ Basic word spacing — fStyle.wordSpace
○ Word spacing stretch — fStyle.wordSpaceExtra
○ Word spacing squash — fStyle.wordSpaceSquash
PTC APP source code edits are required to access PTC Advanced Print Publisher's
methods of controlling space. Refer to Stylesheet Developer’s Guide to APP Code
for some samples of how to configure character width, stretch, and squash
properties.

Kerning
You may apply custom kerning tables with PTC Advanced Print Publisher. You
will need to configure this in an PTC APP template that can then be associated
with your .style stylesheet.

Ligatures
You may apply custom ligature tables with PTC Advanced Print Publisher. You
will need to configure this in an PTC APP template that can then be associated
with your .style stylesheet.

Character effects
Some fairly uncommon requirements for text character position and visual effects
can be achieved in PTC Advanced Print Publisher:
• Vertical position
Text is usually positioned on a baseline, an invisible line on which the
majority of characters sit. PTC Advanced Print Publisher can align text so that
the tops, centers, or bottoms of the characters align. It can also provide an
offset to align the characters at a specified position relative to the true
baseline.
• Rotation
Characters can be rotated 90, 180 or 270 degrees on the line. This is
sometimes used when vertically formatting text. Rotation does not effect the
order in which the characters appear.
• Character width
Characters in any font can be output at a specified fixed width. The alignment
of the characters in that width can also be controlled.
• Flip and mirror
Characters can be flipped (vertically mirrored) or mirrored horizontally. Flip
and mirror do not effect the order in which characters appear.
• Pseudo-italic and pseudo-bold

80 User's Guide
 Both pseudo-italic and pseudo-bold can accept a value to specify the amount
of slant (italic) or offset (bold). For pseudo-italic, negative values can also be
used. PTC Advanced Print Publisher's pseudo-bold applies a copy of the
character offset from the true character. Text outline (see below) may also be
used to make a character appear thicker.
• Character outline
PTC Advanced Print Publisher can change the outline thickness of a character.
By default, the color of the character's outline is none, but this can also be set
to any color supported by PTC Advanced Print Publisher. Character outlines
have been used to provide a pseudo-bold effect. With additional coding they
can also provide a drop shadow effect by underprinting numerous copies of
the same text in lighter colors and greater outline thickness.
All character effects can be accessed via PTC APP source code edits. Refer to
Stylesheet Developer’s Guide to APP Code for some samples of how to configure
character effects.

Blocks
Blocks are a layout feature common to Arbortext Styler, XSL-FO, and CSS. They
are available in PTC Advanced Print Publisher as a new formatting object,
alongside tables and paragraphs. PTC Advanced Print Publisher blocks have
additional functionality which will be of use to stylesheet designers.
• Block width
PTC Advanced Print Publisher's blocks can carry a width property, which
specifies how wide the block should be within its measure. The block width
can be a percentage of the available space, or an absolute value.
• Boxing
Blocks can have a background color and rules on all sides.
• Columns
○ Columns within columns
Content can be displayed in multiple columns within a parent column, for
example a list in text.
○ Column width control
PTC Advanced Print Publisher uses blocks to specify page columns, rather
than controlling frame columns mid-page. Unequal column widths can be
configured in the Arbortext Styler UI. If further control is needed, add
PTC APP source code edits to a block or page set to allow even more
precise control of column appearance.
○ Column alignment control

Document Preview and Publishing 81

 The Arbortext Styler UI provides the option to align column sets within
the space available. For example, if three columns of 20mm each are
required, but the measure is 120mm and column gutters are 5mm, 50mm
of space will be left. By default the three columns will be left-aligned, with
the 50mm of white space appearing to their right. However, it is possible
to center or right align the columns in that space.
○ Column fill order
Block columns will be filled with content depending on the layout
direction set for the object (right-to-left or left-to-right). Multi-column
blocks in PTC Advanced Print Publisher can be filled to a specified order
if required, for example column 3, column 2, column 4, then column 1.
• Rotation
Individual blocks can be rotated in PTC Advanced Print Publisher to 90, 180
or 270 degrees.
These effects can be achieved using PTC APP source code edits. Refer to
Stylesheet Developer’s Guide to APP Code for some examples of working with
blocks.

Drop capitals and words

The first letter (or word) can be output significantly larger than the main content,
often spanning a number of lines of the paragraph. The lines wrap around the
dropped letter or word.
Drop capitals can be achieved using PTC APP source code edits. Refer to
Stylesheet Developer’s Guide to APP Code for an example of how to configure a
drop capital.
The development of drop word formatting requires more complex work. Engage
the services of GSO or an PTC APP partner.

Paragraph reposition
When a paragraph starts after another, it is usual for it to start below the preceding
paragraph at a distance specified by margins and leading. However, it is possible
to start a paragraph at a different position. PTC Advanced Print Publisher provides
simple tools to position paragraphs:
• To last para start
Some side by side layout requirements can be achieved by repositioning the
current paragraph to the start position of the preceding paragraph. This allows
either paragraph to run as long as necessary.
• To last para end

82 User's Guide
 PTC Advanced Print Publisher allows a paragraph to be repositioned to the
baseline position of the last line of the preceding paragraph.
• Vertically center in measure
Some titles, for example cover page titles, need to be vertically centered in the
page area. PTC Advanced Print Publisher provides a simple instruction to
achieve this.
• Flush to column bottom
PTC Advanced Print Publisher can position text flush to the bottom of a
measure without using margins.

Tab stops
Tab stops allow content to jump to and align on specified horizontal positions
based on the presence of tab characters. For example, text on a line might be left
aligned at 10mm, centered at 100mm, and right aligned at 200mm.
PTC Advanced Print Publisher allows the configuration of tabs to align text in the
following ways:
• Justified
• Non-justified
• Centered
• Right aligned
• Decimal aligned
When setting up tabs it is possible to specify leader properties (character and
spacing). You can also set up trigger characters other than the TAB character.
PTC APP source code edits are required to access tab stops.

Justification
Refer to Spacing on page 79 for information on how word and letter spacing work
with justification.
In PTC Advanced Print Publisher it is possible to specify a justification limit. This
is the distance from the right measure at which text justification is turned off in a
line. If a line falls very short of the measure, forcing it to justify would add too
much space between letters or words. The justification limit tells PTC Advanced
Print Publisher how short the line can be before deactivating justification.
PTC APP source code edits can achieve this effect.

Document Preview and Publishing 83

Text decoration
The Arbortext Styler UI provides options for text underlining, strikethrough, and
inline text background color. The underline feature can apply color and line style
while the strikethrough feature can apply color. Both underline and strikethrough
can be applied to words and spaces or words only, although underline is restricted
to a single non-patterned line.
PTC Advanced Print Publisher can apply lines for underline, strikethrough, and
background color, but can also apply an overbar. All lines can carry an offset and
a color. All lines can be based on any line pattern described in PTC Advanced
Print Publisher, including start and end patterns to apply arrows to text. Refer to
Rules on page 72 for further information on line patterns.
Use PTC APP source code edits to achieve these effects. Refer to Stylesheet
Developer’s Guide to APP Code for some examples of how to add text decoration
properties.

Testing
Testing is one of PTC Advanced Print Publisher's strongest features. It provides
access to content hierarchy testing though XPath. It also supplies a number of
other tools that allow you to associate formatting properties and behavior, and
output, with the results of the tests.

Format result testing

While PTC Advanced Print Publisher is formatting a document, it allows access to
some information. This information can then be tested and used to drive output.
Useful format results to test include (but are not limited to):
• Paragraph and text properties
○ Current text height
○ Current font
○ Current text baseline position from top of page
○ Line number on page/paragraph/column
○ Current column width
○ Number of column where paragraph started
• Document and page properties
○ Number of current, first, or last page
○ Number of pages
○ Page sequence used to generate current page
○ Name of main layer on current page

84 User's Guide
• Table properties
○ Number of current row
○ Number of current cell in row
○ Column width
• Content properties
○ Size of text content stream (number of characters)
○ The depth a content stream would format to, when it is of a certain width
○ Current position in text stream
○ Dimensions of a graphic
○ Graphic resolution
○ File type
○ Location of source file
○ Color type of graphic
• System and interface information
○ Current date and time
○ Mouse position
These values are mostly available through PTC Advanced Print Publisher getvars,
which are exposed as global variables. Others are available through certain
functions. Any of these values can be accessed through PTC APP source code
edits to the .style stylesheet.
Refer to Stylesheet Developer’s Guide to APP Code for some examples of how to
test and use formatting information.

Using content as trigger for style changes

It is sometimes necessary to change formatting properties or insert an item when a
particular character or pattern is matched, without markup being present to do this.
For example, a price field in a table may be given as $123.45, but the output
requirements state that the $ symbol should be separated from the price, which is
aligned on the decimal point. As another example, the first two or three words of
the first paragraph can be output in small capitals, then the paragraph reverts to
normal case.
Effects of this type are possible in PTC Advanced Print Publisher using either a
hash callout or a yank function. Hash callouts are a means of using a character as
a trigger to execute some additional PTC Advanced Print Publisher code. Yanks
allow the extraction of content from the main content stream, following a matched
pattern. That content can be passed to a variable, a string counter, or another
content stream, then output as required.

Document Preview and Publishing 85

This type of customization can be achieved using source code edits, but will
probably require additional support from GSO to implement.

Content Streams
PTC Advanced Print Publisher can format most types of content, providing the
content , provided the content includes tokens to which to assign formatting, A
token is either an <element> (in angle brackets) or an entity &reference;
(delimited by ampersand and semi-colon). By default, when PTC Advanced Print
Publisher is formatting a content stream, when it encounters one of these tokens it
will search its list of tags to find a match by name. If a match is found, the tag will
be processed.
An PTC Advanced Print Publisher tag is a container for information. There are
many tag types. A tag’s type indicates how it will be processed.

Multiple main content streams

There is no limit (other than memory) to the number of content streams an PTC
Advanced Print Publisher document can hold. Many of PTC Advanced Print
Publisher's tag types can be used as content displayed on a page. Content streams
can be called by reference (by referring to the tag) or explicitly (by placing their
content into a frame/region).
Engage GSO or an PTC APP partner to set up a template or stylesheet that can
process multiple main content streams.

Loading and referring to other content streams

Some publishing requirements demand that external content streams be referenced
from the main content. For example, a pricing file for a catalog is presented
separately to the main catalog content to allow quick updates.
PTC Advanced Print Publisher can load content files using JavaScript commands
and extract fragments of that file based on:
• XPath
If the file is well-formed XML, PTC Advanced Print Publisher can use XPath
or XPointer to call a fragment of the external file
• Character position
A fragment of any content stream can be called using the start and end
character positions of the desired fragment
Formatting can then be applied using PTC Advanced Print Publisher tags.
Engage the services of GSO or an PTC APP partner to make use of these features.

86 User's Guide
PDF Configuration File for the PTC APP
Engine
A default XML configuration file that supports publishing of PDF with the PTC
APP engine is provided with a Arbortext Editor environment that includes
Arbortext Styler or Arbortext Publishing Engine:
Arbortext-path/app/standard.appcf
You can save a custom version of this file if you wish to tailor your own PDF
publishing process/output. Open the file in Arbortext Editor (without a stylesheet),
make changes, then save the custom file, with the same file extension, in any of
these locations:
• Publishing PDF from Arbortext Editor or Arbortext Styler — you can browse
for a custom file, or locate it in the APTCUSTOM\app directory where PTC
APP will find it
• Publishing PDF via Arbortext Publishing Engine — a custom file must be
located on the PE server, in any of these locations:
○ Arbortext-path\app
○ any APTCUSTOM\app directory
○ an application or custom doctype\nnn directory, where nnn is the
short doctype name of the doctype of the document being published.
Custom .appcf files must contain a single Print and a single Format
element, although these do not require child elements to be valid.
Use the set appconfigfile command to specify an alternate location for an
PTC APP configuration file. For more information, see the Arbortext Command
Language Reference.
See APP PDF Configuration File (.appcf) on page 96 for information on the
contents of the PTC APP configuration file.
Guidelines for customizing some common PDF properties in the configuration file
are provided here:
• Initial View on page 88
The default configuration file defines these initial view document properties:
○ Navigation tab — Page Only
○ Page layout — Single Page
○ Magnification — Default
○ Open to page — 1
○ Window Options — Resize window to initial page

Document Preview and Publishing 87

 ○ Window Options — Show Document Title
• Compression Level on page 90
The default configuration file specifies these levels of compression:
○ Text compression activated
○ Monochrome images — CCITT Group 4 Compression
○ Grayscale images — Flate (Zip) Compression
○ Color images — Flate (Zip) Compression
○ Quality of grayscale JPEG compression — medium
○ Quality of color JPEG compression — medium
• PDF Compatibility / Version on page 94
The default configuration file sets compatibility to PDF 1.7 (Acrobat 8
onwards)
• Web-Optimized PDF Output on page 94
The default configuration file specifies that web optimized output will not be
generated.
• Printing Marks and Bleed Areas on page 95
The default configuration file specifies that crop marks and registration marks
will be output according to selections made in the Publish dialog. Crop marks
and bleed areas have default size and placement settings:
○ Crop mark size — 9mm
○ Crop mark offset from page — 1mm
○ Bleed areas — a bleed area of 4mm will be applied to each side of a page

Initial View
You can configure the following initial view options for a PDF:
• Navigation tab
• Page layout
• Magnification
• Open to page
• Window Options
• Show
• User Interface Options

88 User's Guide
Initial view settings are configured with attributes of the Open element in a
.appcf file. In the file, add the following element hierarchy to the required
Print element:
Print
PDFPrinter
Open
Define an optional attribute for the Open element for each initial view setting:
Initial View Setting Attribute of Open Possible Values
Navigation tab show • useNone — Page
Only
• useOutlines —
Bookmarks Panel and
Page
• useThumbs — Pages
Panel and Page
• useAttachments —
Attachments Panel
and Page
• useOC — Layers
Panel and Page
• fullScreen — full
screen mode
Page layout pageLayout • singlePage — Single
Page
• oneColumn — Single
Page Continuous
• twoPageRight —
Two-Up (Facing)
(Odd pages on right)
• TwoColumnRight —
Two-Up Continuous
(Facing)
(Odd pages on right)
Magnification magnification • default — Default
• fitWindow — Fit Page
• fitWidth — Fit Width
• fitHeight — Fit
Height

Document Preview and Publishing 89

Initial View Setting Attribute of Open Possible Values
• fitVisible — Fit
Visible
• 25 - 1600 — fixed
zoom levels (%)
Open to page openOnPage Number
Window Options — window • fitWindow — Resize
Window window to initial page
• centerWindow —
Center window on
screen
Window Options — displayTitle • yes — Show
Show Document Title
• no — Show File
Name
User Interface Options interface • showAll — Show all
toolbars
• hideMenubar — Hide
menu bar
• hideToolbar — Hide
tool bars
• hideWindowUI —
Hide window controls

Compression Level
You can reduce the size of an output PDF file by setting its compression level. The
level of compression that is possible depends on the content of the PDF:
• Using a moderate compression will give the best quality output.
• PDFs that only contain text are already compressed as far as possible with the
default settings
• When PDFs contain raster graphics (TIFF, JPEG, PNG, etc.), the default
setting is to use the Flate (zip) lossless compression scheme
Compression settings are configured with the Compression element in a
.appcf file, and its child elements. In the file, add the following element
hierarchy to the required Print element:
Print
PDFPrinter
Compression

90 User's Guide
Text Compression
The attribute compressText for the Compression element activates compression
for text and line art. Use the value yes.

Image Compression
Child elements of the Compression element define the compression level for
images.

Document Preview and Publishing 91

 Child element of
Image Type Compression Attributes and Values
Monochrome images MonochromeImages type
• auto — use most
appropriate
compression for
image type
• ccitt3
• ccitt4
• flate
• none — do not
compress
This option is ignored for
linked images when
passthrough is enabled
(see the Images
element, a child of
PDFPrinter).
Grayscale images GrayscaleImages type
• auto — use most
appropriate
compression for
image type
• flate
• jpeg
• none — do not
compress
quality
Amount of compression
to apply when printing to
JPEG
• high
• low
• max
• med
• min
Color images ColorImages type
• auto — use most

92 User's Guide
 Child element of
Image Type Compression Attributes and Values
appropriate
compression for
image type
• flate
• jpeg
• none — do not
compress
quality
Amount of compression
to apply when printing to
JPEG
• high
• low
• max
• med
• min

Retain Original JPEG File Size

You can bypass any image compression settings by using the option to pass
images directly to PDFLib without processing in PTC APP before output. With
this option selected, JPEG files in PDF output will retain the same size as in
original source.
The Images element in a .appcf file includes an option to process images in
this way. In the file, add the following element hierarchy to the required Print
element:
Print
PDFPrinter
Images
Give the linked attribute for the Images element a value of passthrough.

EPS Files with Vector Graphics

You can set the level of PStill interpreter accuracy, which can reduce the size of
EPS files containing vector graphics, especially those with many curves.
The Images element in a .appcf file includes an option to set the DPI to use
when converting EPS files. In the file, add the following element hierarchy to the
required Print element:
Print

Document Preview and Publishing 93

 PDFPrinter
Images
Give the epsDPI attribute for the Images element a value that represents the
required setting, for example 600.

PDF Compatibility / Version

You can publish PDF output that conforms to a particular version of PDF.
Specifying the version applicability of PDF in this way means that the PDF can be
opened in a specific release of Adobe Acrobat (or equivalent).
The PDF element in a .appcf file defines the compatibility level of output PDF.
In the file, add the following element hierarchy to the required Print element:
Print
PDFPrinter
Compatibility
PDF
Set the level attribute of the PDF element to a value that represent the required
compatibility level:
Value PDF Compatibility Acrobat Version
Level
1.4 PDF 1.4 Acrobat 5
1.5 PDF 1.5 Acrobat 6
1.6 PDF 1.6 Acrobat 7
1.7 PDF 1.7 Acrobat 8
1.7ext3 PDF 1.7 ext 3 Acrobat 9
1.7ext8 PDF 1.7 ext 3 Acrobat 9
2.0 PDF 2.0

Web-Optimized PDF Output

You can optimize PDF output for fast web view. Graphics are provided in a low
resolution format. The PDF will be formatted using a streaming technique, which
means that traditionally slowing objects such as cross references and indices are
resolved throughout the document, rather than being provided in a single entry at
the end of the document.
Note that selecting this option will increase publishing time, and will output a
bigger file.
The PDFMode element in a .appcf file includes an option to specify whether or
not to generate web-optimized PDF output. In the file, add the following element
hierarchy to the required Print element:
Print
PDFPrinter

94 User's Guide
 PDFMode
Set the fastWebView attribute of the PDFMode element to yes to optimize PDF
output for fast web viewing.

Printing Marks and Bleed Areas

You can add an entry to the configuration file to activate crop marks (cutting
guides) and registration marks in PDF output. You can also specify the length of
the crop marks, and define the size of the gap between the marks.
You can also use the configuration file to define a bleed area for each side of a
page.
Crop marks, registration marks, and bleed areas are configured with attributes of
the PageConfig element in a .appcf file. In the file, add the following
element hierarchy to the required Print element:
Print
PageConfig
Define an optional attribute for the PageConfig element for each initial view
setting:
Attribute of
Setting PageConfig Possible Values
Activate crop marks cuttingGuides • inherit — use settings
made in Publish
dialog
• forceYes — override
Publish dialog setting
to activate crop marks
• forceNo — override
Publish dialog setting
to deactivate crop
marks
Size of crop marks cuttingGuideSize Measurement including
unit, for example 9mm
Offset of crop marks from cuttingGuideOffset Measurement including
page unit, for example 1mm
Activate registration registrationMarks • inherit — use settings
marks made in Publish
dialog
• forceYes — override
Publish dialog setting
to activate registration

Document Preview and Publishing 95

 Attribute of
Setting PageConfig Possible Values
marks
• forceNo — override
Publish dialog setting
to deactivate
registration marks
Size of bleed area on top bleedAreaTop Measurement including
of page unit, for example 4mm
Size of bleed area on bleedAreaBottom Measurement including
bottom of page unit, for example 4mm
Size of bleed area on left bleedAreaLeft Measurement including
of page unit, for example 4mm
Size of bleed area on right bleedAreaRight Measurement including
of page unit, for example 4mm

PTC APP PDF Configuration File (.appcf)

A Arbortext Editor environment provides a default XML configuration file that
supports publishing of PDF with the PTC APP engine:
Arbortext-path/app/standard.appcf
The file is made up of five main elements, with which you can configure groups
of PDF properties and settings.
• Print element on page 130 (required)
The outputs to which the document will be printed, and page areas such as
crop marks (cutting guides)
• Format element on page 106 (required)
Format specific options such as number of format passes to take
• DocumentProperties element on page 104 (optional)
Document properties such as title and author, and custom properties
• FormatHooks element on page 107 (optional)
Custom JavaScript functions to run during formatting
Changes made to this element and its children would most likely not be
supported. They have a significant impact on performance and can negatively
alter the publishing process.
• Debug element on page 104 (optional)

96 User's Guide
 Debugging settings
Changes made to this element and its children would most likely not be
supported. They have a significant impact on performance and can negatively
alter the publishing process.

APPConfig element (required)

Parent Re-
APPConfig Elements quired Child Elements
Yes • Print on page 130
(required)
• Format on page 106
(required)
• DocumentProper-
ties on page 104
• FormatHooks on page
107
• Debug on page 104

APPConfig is the root element of the .appcf configuration file.

Attributes of APPConfig define doctype information for the file. It also permits
other .appcf files to be referenced and loaded.
Attributes of
APPConfig Property Permitted values
version (required) The version of the 1.0
APPConfig dtd
Required to ensure the
configuration file is
processed correctly in the
event of changes to the
DTD
xmlns (required) The namespace for all http://www.arbortext.com/
elements in the namespace/APP/
configuration file APPPrinterConfig
Any elements not in this
namespace will be
ignored

Document Preview and Publishing 97

Attributes of
APPConfig Property Permitted values
include References another File name (and location)
.appcf file
The file will be loaded
and will provide the
default values for any
elements or properties set
in it. Values set in the
source configuration file
take precedence over any
values in an included file.
Relative file paths will be
resolved with reference to
the location of the output
file provided in the
Publish dialog box. You
can also specify an
absolute path to an
alternate location.
label If set, the value will be String
displayed as file name in
Arbortext Editor and
Arbortext Publishing
Engine.

BoundingBoxes element (optional)

Parent Re-
BoundingBoxes Elements quired Child Elements
PDFPrinter on No
page 128

Attributes of BoundingBoxes specify whether to output trim, art, crop, and

bleed boxes in PDF output.

98 User's Guide
Attributes of
BoundingBoxes Property Permitted values
trimBox Whether to output trim • yes — output trim
boxes in PDF output boxes in PDF output
• no (default) — do not
output trim boxes in
PDF output
artBox Whether to output art • yes — output art
boxes in PDF output boxes in PDF output
• no (default) — do not
output art boxes in
PDF output
cropBox Whether to output crop • yes — output crop
boxes in PDF output boxes in PDF output
• no (default) — do not
output crop boxes in
PDF output
bleedBox Whether to output bleed • yes — output bleed
boxes in PDF output boxes in PDF output
• no (default) — do not
output bleed boxes in
PDF output

ColorProfile element (optional)

Parent Re-
ColorProfile Elements quired Child Elements
PDFPrinter on No
page 128

Attributes of ColorProfile define how to handle colors in a PDF file.

Document Preview and Publishing 99

Attributes of
ColorProfile Property Permitted values
defaultRGB The default RGB color String
profile to use
Specify sRGB to use the
built in sRGB profile
defaultGray The default Grayscale String
profile to use
defaultCMYK The default CMYK color String
profile to use

ColorImages element (optional)

Parent Re-
ColorImages Elements quired Child Elements
Compression No
on page 103

Attributes of ColorImages define how to compress color images in a PDF file.

Note
This option is ignored for linked images when passthrough is enabled. See
Images on page 113 for information.

Attributes of
ColorImages Property Permitted values
downsampleDPI The size to which to Number (default value
downsample images 150)
downsampleMode Algorithm for • off (default)
downsampling • subsample — fastest,
When downsampleMode uses nearest pixel
is set to a value other than from original image
off, and the DPI of an
image is equal to or above The original image
the value of type will not be
downsampleThreshold, changed with this
the image is method.
downsampled to • average — uses
downSampleDPI. average of the group
of pixels surrounding

100 User's Guide

Attributes of
ColorImages Property Permitted values
the nearest pixel from
Note the original image
linked= • bicubic — slowest but
"original" must
best quality, an
be set for Images on
enhanced bicubic
page 113 for
algorithm
downsampling
settings to have an
effect in PDF output.
downSampleThreshold The threshold size of an Number (default value:
input image 225)
quality The amount of • min
compression to apply to • low
the images when printing
• med (default)
to JPEG
• high
• max
type (required) Compression type • auto — use the most
appropriate
compression for the
type of image
• none — do not
compress
• flate (default) — Flate
encoding
• jpeg — JPEG
compression

Document Preview and Publishing 101

Compatibility element (optional)
Parent Re-
Compatibility Elements quired Child Elements
PDFPrinter on No PDF on page 124
page 128 or
PDFX on page 129, PDFA on
page 125
or
PDFUA on page 128

Attributes of Compatibility define PDF tag and PDF layer support. Its child
elements define PDF version and standards support.
Attributes of
Compatibility Property Permitted values
tagging Whether to process any • inherit (default) —
PDF tag instructions in obey the setting in the
the stylesheet/template stylesheet/template
when publishing to PDF • forceYes —override
the stylesheet/
template setting and
process PDF tag
instructions
• forceNo — forceYes
—override the
stylesheet/template
setting and do not
process PDF tag
instructions
layers Whether to process any • yes
PDF layer changes found • no (default)
in the template when
publishing to PDF

102 User's Guide

Compression element (optional)
Parent Re-
Compression Elements quired Child Elements
PDFPrinter on No • MonochromeImages
page 128 on page 116
• GrayscaleImages on
page 110
• ColorImages on page
100
Attributes of Compression define whether text content will be compressed in
the PDF. Its child elements define compression for multiple image types.
Attribute of
Compression Property Permitted values
compressText Whether to compress text • yes (default)
content in the PDF • no

CustomProperty element (optional)

CustomProper- Parent Re-
ty Elements quired Child Elements
DocumentPro No
perties on page
104
Attributes of CustomProperty define custom document properties.
Attribute of
CustomProperty Property Permitted values
name The name of the custom String
property
value The value of the custom String
property

Document Preview and Publishing 103

Debug element (optional)
Parent Re-
Debug Elements quired Child Elements
APPConfig on No • SaveDocument on
page 97 page 136
• PrintDocument on
page 130

Attribute of Debug defines debugging settings.

Caution
These options can have a significant impact on performance and drastically
alter the way the document is published. They should only be used when
absolutely required. Custom settings for these options will most likely not be
supported.

Attribute of Debug Property Permitted values

debugFlags The value to which to set Number (default value 0)
fTemplate.debug
Flag before publishing
starts

DocumentProperties element (optional)

DocumentPro- Parent Re-
perties Elements quired Child Elements
• PDFPrinter No CustomProperty on page
on page 128 103
• PSPrinter
on page 135
• PNGPrinter
on page 130
• TIFFPrint-
er on page
138
• APPConfig
on page 97

Attributes of DocumentProperties define document properties.

104 User's Guide

Any properties specified as children of the printer elements (for example,
PDFPrinter on page 128, PNGPrinter on page 130) override any document
properties specified in the root of the configuration file (APPConfig on page 97)
when printing to that output. Setting these properties will override any values
provided by the stylesheet.
Attributes of
DocumentProper
ties Property Permitted values
title The title of the document String
author The author of the String
document
subject The subject of the String
document
keywords Keywords for the String
document
xmpMetadata Location of a custom String
XMP metadata file
(.xmp)

Error element (optional)

Parent Re-
Error Elements quired Child Elements
ErrorOverr No
ides on page 106

Attributes of Error define an override for an individual PTC APP formatting

message.
Attributes of Error Property Permitted values
code (required) The number of the error Number
to override
level (required) The new level for the • ignore
error • info
• warning
• error
• fatal

Document Preview and Publishing 105

ErrorOverrides element (optional)
Parent Re-
ErrorOverrides Elements quired Child Elements
Format on page No Error on page 105
106
ErrorOverrides overrides error messages raised during formatting. Its child
elements define the specific error messages.

Fonts element (optional)

Parent Re-
Fonts Elements quired Child Elements
PDFPrinter on No
page 128

Attributes of Fonts specify whether fonts should be subset in the PDF.

Attributes of Fonts Property Permitted values
subsetting Whether to subset all • yes (default)
fonts in the PDF • no
subsetPercent A percentage of available Number (default value
characters in a font 100)
If this value is exceeded
by the number of
characters used in a font,
subsettting will be
disabled for the font

Format element (required)

Parent Re-
Format Elements quired Child Elements
APPConfig on Yes • Passes on page 123
page 97 • PageChecksums on
page 121
• ErrorOverrides on
page 106

The Format element defines formatting options, for example the number of
passes to be made and whether page checksums should be generated.

106 User's Guide

FormatEnd element (optional)
Parent Re-
FormatEnd Elements quired Child Elements
FormatHooks No CDATA
on page 107

Attribute of FormatEnd defines a JavaScript function to be run at the end of

formatting, when all passes are complete. The function can be provided either as
an external file, or inside a CDATA block as a child of this element.
Attribute of
FormatEnd Property Permitted values
filename Name of the file File name (and location)
containing a JavaScript
function.
Relative file paths will be
resolved with reference to
the location of the output
file provided in the
Publish dialog box. You
can also specify an
absolute path to an
alternate location.

FormatHooks element (optional)

Parent Re-
FormatHooks Elements quired Child Elements
APPConfig on No FormatStart on page
page 97 109, FormatPass on page
109, FormatEnd on page
107
or
FormatOverride on page
108
The FormatHooks element defines custom JavaScript functions to run before,
during, and after formatting. Its child elements provide the file definition.
Custom functions provide extra control over the formatting process. For example,
they can set properties not supported by the configuration file or other job-specific
parameters. A JavaScript object will be passed into each function to allow
properties that were set in FormatStart on page 109 to be seen in, for

Document Preview and Publishing 107

example, FormatPass on page 109 or FormatEnd on page 107. JavaScript
can be either embedded in a CDATA block inside the element, or provided in an
external file.

Caution
These options can have a significant impact on performance and drastically
alter the way the document is published. They should only be used when
absolutely required. Custom settings for these options will most likely not be
supported.

FormatOverride element (optional)

Parent Re-
FormatOverride Elements quired Child Elements
FormatHooks No CDATA
on page 107

An attribute of FormatOverride defines a JavaScript function to be run

instead of normal formatting code. The function can be provided either as an
external file, or inside a CDATA block as a child of this element.
As this function will replace the standard format pass and print loop, it must
handle all parts of formatting and printing, as required.
Attributes of
FormatOverride Property Permitted values
filename Name of the file File name (and location)
containing a JavaScript
function.
Relative file paths will be
resolved with reference to
the location of the output
file provided in the
Publish dialog box. You
can also specify an
absolute path to an
alternate location.

108 User's Guide

FormatPass element (optional)
Parent Re-
FormatPass Elements quired Child Elements
FormatHooks No CDATA
on page 107

An attribute of FormatPass defines a JavaScript function to be run at the start

of each pass during formatting. The function can be provided either as an external
file, or inside a CDATA block as a child of this element.
Attributes of
FormatPass Property Permitted values
filename Name of the file File name (and location)
containing a JavaScript
function.
Relative file paths will be
resolved with reference to
the location of the output
file provided in the
Publish dialog box. You
can also specify an
absolute path to an
alternate location.

FormatStart element (optional)

Parent Re-
FormatStart Elements quired Child Elements
FormatHooks No CDATA
on page 107

An attribute of FormatStart defines a JavaScript function to be run at the start

of formatting, before any passes. The function can be provided either as an
external file, or inside a CDATA block as a child of this element.

Document Preview and Publishing 109

Attributes of
FormatStart Property Permitted values
filename Name of the file File name (and location)
containing a JavaScript
function.
Relative file paths will be
resolved with reference to
the location of the output
file provided in the
Publish dialog box. You
can also specify an
absolute path to an
alternate location.

GrayscaleImages element (optional)

GrayscaleImag- Parent Re-
es Elements quired Child Elements
Compression No
on page 103

Attributes of GrayscaleImages define how to compress grayscale images in a

PDF file.

Note
This option is ignored for linked images when passthrough is enabled. See
Images on page 113 for information.

Attributes of
GrayscaleImages Property Permitted values
downsampleDPI The size to which to Number (default value
downsample images 150)
downsampleMode Algorithm for • off (default)
downsampling • subsample — fastest,
When downsampleMode uses nearest pixel
is set to a value other than from original image
off, and the DPI of an
image is equal to or above The original image
the value of type will not be
downsampleThreshold, changed with this
method.

110 User's Guide

Attributes of
GrayscaleImages Property Permitted values
the image is • average — uses
downsampled to average of the group
downSampleDPI. of pixels surrounding
the nearest pixel from
Note
the original image
linked=
• bicubic — slowest but
"original" must
best quality, an
be set for Images on
page 113 for enhanced bicubic
downsampling algorithm
settings to have an
effect in PDF output.
downSampleThreshold The threshold size of an Number (default value:
input image 225)
type (required) Compression type • auto — use the most
appropriate
compression for the
type of image
• none — do not
compress
• flate (default) — Flate
encoding
• jpeg — JPEG
compression
quality The amount of • min
compression to apply to • low
the images when printing
• med (default)
to JPEG
• high
• max

Document Preview and Publishing 111

ICCProfile element (optional)
Parent Re-
ICCProfile Elements quired Child Elements
• PDF on page No
124
• PDFX on page
129
• PDFA on page
125
An attribute of ICCProfile defines an ICC color profile for PDF/A and PDF/X
output.
Attributes of
ICCProfile Property Permitted values
profile (required) The name of the ICC File name (and location)
color profile
Relative file paths will be
resolved with reference to
the location of the output
file provided in the
Publish dialog box. You
can also specify an
absolute path to an
alternate location.

ICCProfileURL element (optional)

Parent Re-
ICCProfileURL Elements quired Child Elements
• PDFX on page No
129
An attribute of ICCProfileURL defines ICC profile URLs for PDF/X output.
Attributes of
ICCProfileURL Property Permitted values
url (required) The URLs of the ICC String
color profile

112 User's Guide

Images element (optional)
Parent Re-
Images Elements quired Child Elements
PDFPrinter on No
page 128

Attributes of Images specify how to handle linked images in the PDF, and the
DPI to use when converting EPS files.
Attributes of Images Property Permitted values
linked How to process linked • original — use the
images imported image from
PTC APP,
compressing
according to values in
the Compression
on page 103 element
• draft — use the low
quality preview
version of the image
• passthrough (default)
— use the actual
image file without any
conversion
epsDPI The DPI to use when Number (default value
converting EPS files 600)

Document Preview and Publishing 113

Attributes of Images Property Permitted values
epsPathAccuracy The number of decimal Number (default value 2)
places to use when
converting paths in EPS
files. Lower values will
result in smaller file sizes
but may be less accurate.
epsPathCompression The amount of • off (default) – Do not
compression to apply compress path data
when converting paths in when converting
EPS files. paths in EPS files.
• small – Optimize EPS
path data to shrink file
size while preserving
accuracy.
• smaller - Further
optimize EPS path
data to result in a
smaller file size, with
a risk of lower
accuracy.

Interactive element (optional)

Parent Re-
Interactive Elements quired Child Elements
PDFPrinter on No
page 128

Attributes of Interactive define how to handle interactive content in the PDF

such as rich media or PDF Forms.
Attributes of
Interactive Property Permitted values
documentOpenAction The name of the APP tag String
containing the document
open script to embed into
the PDF.
richMediaAssets The name of the APP tag String
containing the list of extra
assets to include with the
rich media content.

114 User's Guide

Attributes of
Interactive Property Permitted values
useFormItems Whether to output PDF • yes (default)
form items in the PDF. • no
useRichMedia Whether to output rich • yes (default)
media content such as • no
audio or video in the PDF.

Media element (optional)

Parent Re-
Media Elements quired Child Elements
PSPrinter on No
page 135

Attributes of Media define support for paper types when printing to PostScript
output.
Attributes of Media Property Permitted values
firstPage The paper tray to use • default (default)
when printing the first • tray1
page of the document
• tray2
• manual
otherPages The paper tray to use • first (default)
when printing the • tray1
remaining pages of the
• tray2
document
• manual
duplex Whether to enable duplex • yes (default)
printing • no
pageSize Whether to select paper • auto (default) —
size based on the size of automatically select
page in the document • none — do not select
different paper size if
page size changes
autoRotate Whether to automatically • yes (default)
rotate the page to fit the • no
media size

Document Preview and Publishing 115

MonochromeImages element (optional)
MonochromeI- Parent Re-
mages Elements quired Child Elements
Compression No
on page 103

An attribute of MonochromeImages defines how to compress monochrome

images in a PDF file.

Note
This option is ignored for linked images when passthrough is enabled. See
Images on page 113 for information.

Attributes of
MonochromeImages Property Permitted values
downsampleDPI The size to which to Number (default value
downsample images 300)
downsampleMode Algorithm for • off (default)
downsampling • subsample — fastest,
When downsampleMode uses nearest pixel
is set to a value other than from original image
off, and the DPI of an
image is equal to or above The original image
the value of type will not be
downsampleThreshold, changed with this
the image is method.
downsampled to • average — uses
downSampleDPI. average of the group
Note of pixels surrounding
the nearest pixel from
linked=
the original image
"original" must
be set for Images on • bicubic — slowest but
page 113 for best quality, an
downsampling enhanced bicubic
settings to have an algorithm
effect in PDF output.

116 User's Guide

Attributes of
MonochromeImages Property Permitted values

Note
Monochrome images
are converted to
grayscale to achieve
the average values
required for average
or bicubic modes.
This may result in a
larger PDF file,
although
downsampling and
compression could
make it smaller than
including the original
(subsample method)..
downSampleThreshold The threshold size of an Number (default value:
input image 450)
type (required) Compression type • auto — use the most
appropriate
compression for the
type of image
• none — do not
compress
• ccitt3 — CCITT3
• ccitt4 (default) —
CCITT4
• flate — Flate
encoding

Open element (optional)

Parent Re-
Open Elements quired Child Elements
PDFPrinter on No
page 128

Attributes of Open define PDF display properties.

Document Preview and Publishing 117

Attributes of Open Property Permitted values
show View of the PDF • useNone (default) —
open with no panels
displayed
• useOutlines — show
the bookmarks panel
• useThumbs — show
the thumbnails
(pages) panel
• useOC — show the
layers panel
• useAttachments —
show the attachments
panel
• fullScreen — open in
full screen mode
pageLayout Page layout • singlePage (default)
— display one page at
a time
• oneColumn — display
the pages continually
in a column
• twoPageLeft —
display the pages two
at a time, with odd-
numbered pages on
the left
• twoPageRight —
display the pages two
at a time, with odd-
numbered pages on
the right
• twoColumnLeft —
display the pages in
two columns, with
odd-numbered pages
on the left
• twoColumnRight —
display the pages in

118 User's Guide

Attributes of Open Property Permitted values
two columns, with
odd-numbered pages
on the right
magnification Magnification • default (default) —
use the default
magnification level
• fitWindow —fit the
page to the window
• fitWidth — fit the
width of the page to
the window
• fitHeight — fit the
height of the page to
the window
• fitVisible — fit the
visible contents of the
page to the window
• 25 - 1600 — use a
fixed zoom level
(percentage)
openOnPage The page number on Number (default value 1)
which the PDF will open
window Window options • fitWindow (default) —
resize window to
initial page
• centerWindow —
center window on
screen
displayTitle Whether to display the • yes (default)
document title (title • no
document property) in the
title bar
If no, the file name will
be displayed

Document Preview and Publishing 119

Attributes of Open Property Permitted values
interface Whether to hide areas of • showAll (default) —
the user interface show all toolbars
• hideMenuBar — hide
the menu bar
• hideToolbar — hide
the toolbars
• hideWindowUI —
hide the window
controls
bindingLtR Whether to display the • yes (default) — – Left
pages in left-to-right to right order of pages
order. • no — Right to left
order of pages

OutputRange element (optional)

Parent Re-
OutputRange Elements quired Child Elements
• PDFPrinter No
on page 128
• PSPrinter
on page 135
• PNGPrinter
on page 130
• TIFFPrint-
er on page
138
Attributes of OutputRange define the output file name, and the page range to
use when printed the formatted document to the selected output.
Multiple printer outputs may require different settings to those specified in the
Publish dialog or Arbortext Editor publishing rules. This setting can be used as a
final override to settings made in those locations if necessary.

120 User's Guide

Attributes of
OutputRange Property Permitted values
filename The name of the output File name (and location)
file
Relative file paths will be
resolved with reference to
the location of the output
file provided in the
Publish dialog box. You
can also specify an
absolute path to an
alternate location.
startPage The page from which to Number (default value 1)
start printing, for this
output type
endPage The page at which to end Number (default value -1)
printing, for this output
type
Use -1 for the end of the
document

PageChecksums element (optional)

PageCheck- Parent Re-
sums Elements quired Child Elements
Format on page No
106
Attributes of PageChecksums specify that page checksums should be output
during formatting.

Document Preview and Publishing 121

Attributes of
PageChecksums Property Permitted values
filename The name of the output File name (and location)
file
Relative file paths will be
resolved with reference to
the location of the output
file provided in the
Publish dialog box. You
can also specify an
absolute path to an
alternate location.
pass The format passes from • first
which to save page • last (default)
checksums
• all

PageConfig element (optional)

Parent Re-
PageConfig Elements quired Child Elements
Print on page No
130
Attributes of PageConfig define settings for printing marks and bleed areas:
Attributes of
PageConfig Property Possible values
cuttingGuides Activate cutting guides • inherit (default) — use
setting from the Publish
dialog
• forceYes — override setting
from Publish dialog to
activate cutting guides
• forceNo — override setting
from Publish dialog to
deactivate cutting guides
cuttingGuideSize Size of cutting guides Measure plus unit (default
value 9mm)
cuttingGuideOffset Offset of cutting Measure plus unit (default
guides from page value 1mm)
bleedAreaTop Size of bleed area at Measure plus unit (default

122 User's Guide

Attributes of
PageConfig Property Possible values
top of page value 4mm)
bleedAreaBottom Size of bleed area at Measure plus unit (default
bottom of page value 4mm)
bleedAreaLeft Size of bleed area on Measure plus unit (default
left of page value 4mm)
bleedAreaRight Size of bleed area on Measure plus unit (default
right of page value 4mm)
bleedString Text to output in bleed String
area
registrationMarks Activate registration • inherit (default)— use
marks setting from the Publish
dialog
• forceYes — override setting
from Publish dialog to
activate registration marks
• forceNo — override setting
from Publish dialog to
deactivate registration
marks
showLineNumbers Activate line numbers • yes
• no

Passes element (optional)

Parent Re-
Passes Elements quired Child Elements
Format on page No
106
Attributes of Passes specify the number of formatting passes to perform, and the
method to use when comparing the passes to check if the format process has
finished.
If the maximum number of passes is reached and the specified compareMode has
not indicated the document has finished, an error will be generated.

Document Preview and Publishing 123

Attributes of Passes Property Permitted values
minumum The minimum number of 2 - 10(default value 2
passes to perform during
formatting
maximum The maximum number of 2 - 10(default value 6
passes to perform during
formatting
compareMode The method for • none — format the
comparing passes to document until the
confirm that formatting is maximum number of
complete passes is reached
• stability (default) —
format the document
until all the stability
checks are met, or the
maximum number of
passes is reached
• checksum — format
the document until the
page checksums are
identical between two
passes, or the
maximum number of
passes is reached

PDF element (optional)

Parent Re-
PDF Elements quired Child Elements
Compatibility No ICCProfile on page 112
on page 102

An attribute of PDF specifies the version of PDF to be created.

124 User's Guide

Attributes of PDF Property Permitted values
level PDF version • 1.4
• 1.5
• 1.6
• 1.7 (default)
• 1.7ext3
• 1.7ext8
• 2.0

PDFA element (optional)

Parent Re-
PDFA Elements quired Child Elements
Compatibility No ICCProfile on page 112
on page 102

An attribute of PDFA specifies which level of PDF-A output should be enabled.

Attributes of PDFA Property Permitted values
level Level of PDF-A • none (default)
• 1a:2005
• 1b:2005

PDFMark element (optional)

Parent Re-
PDFMark Elements quired Child Elements
PSPrinter on No
page 135

Attributes of PDFMark define additional pdfmark commands to add to PostScript

output when converting it to PDF.
Attributes of PDFMark Property Permitted values
lnk pdfmark commands to String
add when outputting links
dest pdfmark commands to String
add when outputting
destinations

Document Preview and Publishing 125

Attributes of PDFMark Property Permitted values
out pdfmark commands to String
add when outputting
bookmarks
article pdfmark commands to String
add when outputting
articles

PDFMode element (optional)

Parent Re-
PDFMode Elements quired Child Elements
PDFPrinter on No
page 128

Attributes of PDFMode define some PDF-specific options.

126 User's Guide

Attributes of PDFMode Property Permitted values
color Whether to convert colors • document (default) —
preserve colors as
specified in the
document
• mono — convert all
colors to monochrome
• rgb — convert all
colors to RGB
• cmyk — convert all
colors to CMYK
• cmykspot — convert
all colors to CMYK,
preserving any spot
colors
defaultLanguage The default language Language code
code for the PDF
If left empty, the
publishing process will
use the value set in
Arbortext Styler
(Stylesheet Properties,
Language tab)
fastWebView Whether to optimize the • yes
PDF for fast web viewing • no (default)

Document Preview and Publishing 127

PDFPrinter element (optional)
Parent Re-
PDFPrinter Elements quired Child Elements
Print on page No • OutputRange on page
130 120
• PDFMode on page 126
• Compatibility on
page 102
• ColorProfile
• Images on page 113
• Compression on page
103
• Fonts on page 106
• Open on page 117
• Security on page 136
• Interactive on page
114
• DocumentProper-
ties on page 104
• BoundingBoxes on
page 98

PDFPrinter groups PDF-specific output driver options. Its child elements

define each of the specific options.

PDFUA element (optional)

Parent Re-
PDFUA Elements quired Child Elements
Compatibility No
on page 102

An attribute of PDFUA activates the support for PDF/UA output.

128 User's Guide

Attributes of PDFUA Property Permitted values
level Activate/deactivate PDF/ • none — do not output
UA support PDF/UA compliant
PDF (default)
• 1 — output PDF/UA
compliant PDF

PDFX element (optional)

Parent Re-
PDFX Elements quired Child Elements
Compatibility No • ICCProfile on page
on page 102 112
• ICCProfileURL on
page 112

An attribute of PDFX specifies which level of PDF-X output should be enabled.

Attributes of PDFX Property Permitted values
level (required) Level of PDF-X • none (default)
• 1a:2003
• 3:2003
• 4
• 4p
• 5g
• 5pg

PNGMode element (optional)

Parent Re-
PNGMode Elements quired Child Elements
PNGPrinter on No
page 130

An attribute of PNGMode defines PNG-specific options.

Attributes of PNGMode Property Permitted values
interlace Whether to create • yes
interlaced PNG files • no (default)

Document Preview and Publishing 129

PNGPrinter element (optional)
Parent Re-
PNGPrinter Elements quired Child Elements
Print on page No • OutputRange on page
130 120
• Resolution on page
135
• PNGMode on page 129
• DocumentProper-
ties on page 104

PNGPrinter groups PNG-specific output driver options. Its child elements

define each of the specific options.

Print Element (required)

Parent Re-
Print Elements quired Child Elements
APPConfig on No • PageConfig on page
page 97 122
• PDFPrinter on page
128
• PSPrinter on page
135
• PNGPrinter on page
130
• TIFFPrinter on page
138
The Print element defines the outputs specified by inclusion of one or more of
its child elements. If multiple child elements are provided, for example
PDFPrinter on page 128 and PNGPrinter on page 130, the document will
be printed to both simultaneously. If no child elements are defined, the document
will not be printed.

PrintDocument element (optional)

Parent Re-
PrintDocument Elements quired Child Elements
Debug on page No
104

130 User's Guide

Attributes of PrintDocument define the option to preserve printed documents
from multiple passes.
Attributes of
PrintDocument Property Permitted values
filename The name of the file to File name (and location)
which incomplete
documents should be
output
Relative file paths will be
resolved with reference to
the location of the output
file provided in the
Publish dialog box. You
can also specify an
absolute path to an
alternate location.
pass The format passes from • first
which to preserve printed • second
output
• last
• all (default)

PSFonts element (optional)

Parent Re-
PSFonts Elements quired Child Elements
PSPrinter on No
page 135

Attributes of PSFonts specifies how to output fonts in PostScript output.

Attributes of PSFonts Property Permitted values
include When to include font • perDocument
definitions (default) — once per
document
• perPage — once per
page
type The format of font • type1 (default) —
definitions to be included PostScript Type 1
format
• type3 — PostScript
Type 3 format

Document Preview and Publishing 131

Attributes of PSFonts Property Permitted values
screenFonts Whether to include screen • yes (default)
fonts • no
printerFonts Whether to include • yes (default)
printer fonts • no

PSImages element (optional)

Parent Re-
PSImages Elements quired Child Elements
PSPrinter on No
page 135

Attributes of PSImages define how to output images in PostScript output.

Attributes of
PSImages Property Permitted values
linked The version of linked • original (default) —
images to use use the imported
image from PTC
APP, compressing it
according to the value
of compression
• draft — use the low
quality preview
version of the image
compression Compression type • none (default) —
uncompressed
• rle — compression
using Run-Length
Encoding
• zip — zip
compression

132 User's Guide

Attributes of
PSImages Property Permitted values
binary Whether to output images • yes (default)
as binary • no
opiComments Whether to include OPI • yes (default)
comments when • no
outputting data
• excludeTIFF —
include OPI
comments, but do not
include original TIFF
data

PSMode element (optional)

Parent Re-
PSMode Elements quired Child Elements
PSPrinter on No
page 135

Attributes of PSMode define some PostScript specific options.

Document Preview and Publishing 133

Attributes of PSMode Property Permitted values
color Color conversion type • mono (default) —
convert all colors to
monochrome
• rgb — convert all
colors to RGB
• cmyk — convert all
colors to CMYK
• cmykspot — convert
all colors to CMYK,
preserving any spot
colors
scratchFile A temporary file to use as Filename (and location)
a scratch file during
printing
If no value is given,
information will be
printed in memory. Not
using a scratch file saves
disk space, but can be
slower.
Relative file paths will be
resolved with reference to
the location of the output
file provided in the
Publish dialog box. You
can also specify an
absolute path to an
alternate location.
screening The method to use to • app (default) — PTC
handle halftone screening APP
• device — PostScript
device

134 User's Guide

PSPrinter element (optional)
Parent Re-
PSPrinter Elements quired Child Elements
Print on page No • OutputRange on page
130 120
• PSMode on page 133
• Media on page 115
• PSFonts on page 131
• PSImages on page 132
• PDFMark on page 125
• DocumentProper-
ties on page 104

PSPrinter groups PostScript-specific output driver options. Its child elements

define each of the specific options.

Resolution element (optional)

Parent Re-
Resolution Elements quired Child Elements
• PNGPrinter No
on page 130
• TIFFPrint-
er on page
138
Attributes of Resolution define the resolution to use when printing to raster-
based output devices, for example PNG or TIFF.
Attributes of
Resolution Property Permitted values
horizontalDPI The horizontal DPI of the Number (default value
output raster 300
verticalDPI The vertical DPI of the Number (default value
output raster 300

Document Preview and Publishing 135

SaveDocument element (optional)
Parent Re-
SaveDocument Elements quired Child Elements
Debug on page No
104
Attributes of SaveDocument specify whether to save the PTC APP document
before, during, or at the end of formatting.
Attributes of
SaveDocument Property Permitted values
filename The name of the saved Filename (and location)
PTC APP document
Relative file paths will be
resolved with reference to
the location of the output
file provided in the
Publish dialog box. You
can also specify an
absolute path to an
alternate location.
pass The format pass on which • initial (default)
to save the PTC APP • first
document
• last
• all

Security element (optional)

Parent Re-
Security Elements quired Child Elements
PDFPrinter on No
page 128

Attributes of Security define security settings for a PDF.

Attributes of
Security Property Permitted values
userPassword The user password for the String
document
Leave the value empty for
no password
masterPassword The master password for String
the document

136 User's Guide

Attributes of
Security Property Permitted values
Leave the value empty for
no password
noPrint Whether a user is • yes
permitted to print the • no (default)
PDF
noModify Whether a user is • yes
permitted to edit the PDF • no (default)
noCopy Whether a user is • yes
permitted to copy or • no (default)
extract text or graphics
noAnnots Whether a user is • yes
permitted to create or • no (default)
change annotations
noForms Whether a user is • yes
permitted to modify • no (default)
forms
noAccessible Whether a user is • yes
permitted to extract text • no (default)
for accessibility
noAssemble Whether a user is • yes
permitted to insert, delete, • no (default)
or modify pages,
bookmarks, or thumbnails
noHiresPrint Whether a user is • yes
permitted to print a low • no (default)
resolution version of the
PDF

TIFFMode element (optional)

Parent Re-
TIFFMode Elements quired Child Elements
TIFFPrinter No
on page 138

Attributes of TIFFMode provide TIFF-specific options.

Document Preview and Publishing 137

Attributes of
TIFFMode Property Permitted values
color Conversion of all colors • mono — convert to
in the TIFF monochrome
• rgb (default) —
convert to RGB
• cmyk — convert to
CMYK
antialias The amount of • none (default)
antialiasing to apply to • low
TIFF files
• medium
• high

TIFFPrinter element (optional)

Parent Re-
TIFFPrinter Elements quired Child Elements
Print on page No • OutputRange on page
130 120
• Resolution on page
135
• TIFFMode on page 137
• DocumentProper-
ties on page 104

TIFFPrinter groups TIFF-specific output driver options. Its child elements

define each of the specific options.

Generating Accessible PDF Output

Arbortext Styler provides several options for delivering PDF output in an
accessible form. These options are only available when publishing PDF with the
PTC APP engine:
• Tagged PDF output on page 139
Tags in PDF output supply information that can be used by screen readers to
improve accessibility to written documentation by providing a recognizable,
standardized structure (PTC APP only).
• User assignable tags and attributes in tagged PDF output on page 142

138 User's Guide

 Manually override the default tags and default settings for common attributes
that are automatically generated by the PTC APP engine when generating
tagged PDF output.
• Alternate text for graphics and links in tagged PDF on page 172
Annotate your graphics and links so they can be identified by readers of the
document.
• PDF/UA output on page 147

Tagged PDF Output

Arbortext Styler provides the option to include PDF tags in PDF output, where it
associates elements, contexts, and conditions in a source XML document with
default PDF tags based on the style given to the elements in the stylesheet. You
may then choose to include these tags in PDF output by selecting the Tagged PDF
option in publishing dialog boxes.
You must be using the PTC APP engine to publish tagged PDF. Tagged PDF
output will not be available if you publish to PostScript.

PTC Arbortext Stylesheets Configured to Output Tagged PDF Output

PTC Arbortext provides some sample stylesheets that are configured to support
tagged PDF output:
For DITA 1.2 and 1.3
• Arbortext-path\doctypes\dita\ditabase\ditabase.style
• Arbortext-path\application\
com.ptc.arbortext.techinfo\doctypes\1.3\techinfo\
techinfo.style
For DITA 2.0
• Arbortext-path\doctypes\dita\2.0\ditabase\
ditabase.style
• Arbortext-path\application\
com.ptc.arbortext.techinfo\doctypes\2.0\techinfo\
techinfo.style
For non-DITA documents
• Arbortext-path\doctypes\axdocbook\axdocbook.style
You can extract a list of contexts that are configured in the stylesheet to output
PDF tags:
1. Open a sample file from the Arbortext-path\doctypes\dita\
ditabase, Arbortext-path\application\

Document Preview and Publishing 139

 com.ptc.arbortext.techinfo\doctypes\techinfo, or
Arbortext-path\doctypes\axdocbook directories, and its
associated stylesheet, in Arbortext Styler.
2. Use the menu option Edit ▶ Find Explicit Properties to open the Find Explicit
Properties dialog box.
3. Add search criteria in the dialog box:
• Category: PDF tags
• Property: Element PDF tag

You can also set this field to Before-text PDF tag or Element content PDF
tag to produce a list of secondary (nested) PDF tags. See Configuring
Primary and Secondary PDF Tags on page 145 for information.
• Assigned any value
4. Run the search with Find. Arbortext Styler generates a list of all contexts that
have a PDF tag assigned in this sample stylesheet.

Tagged PDF Standards

Arbortext Styler’s support for tagged PDF output conforms to the PDF standard
ISO 32000–1:2008. You can refer to the standard for an overview of the rules to
which tagged PDF output must conform.
Adobe provides the PDF Document management — Portable document format —
Part 1: PDF 1.7 in the PDF Reference area of its website. See section 14.8
Tagged PDF for information.

Output default PDF tags in tagged PDF output

This procedure describes how to set your stylesheet so that default PDF tags are
associated with elements in your source XML. It also explains how to publish the
tagged PDF output.
1. Navigate to the Print/PDF tab of the Stylesheet Properties dialog box. Check
the Generate tagged PDF option. Selecting this option will ensure you have
access to the Tagged PDF option in the Publish to PDF File dialog box when
generating PDF output.
2. In Arbortext Editor, choose the File ▶ Publish ▶ PDF File menu option and
choose a stylesheet with the Tagged PDF option selected. The Publish to PDF
File dialog box appears, with the Tagged PDF option checked.
3. Click OK to complete the publishing operation. Your PDF will output with
default PDF tags.
4. If you have Adobe Acrobat Professional available, open the PDF in the
application. Select the Tags display option (for example View ▶ Navigation
Panels ▶ Tags or View ▶ Show/Hide ▶ Navigation Panels ▶ Tags menu option,

140 User's Guide

 although this differs between Adobe Acrobat versions). The default PDF tags
assigned in the PDF will be listed in the Tags panel, in the structural hierarchy
in which they have been defined.
The table below describes the default tags assigned to elements with a given style:
Style PDF tag
Document Art
Block (block) P
Block (inline) (No tag)
Cross Reference (block) P
Cross Reference (inline) (No tag)
Custom Table Table
When a context is part of a custom table, its default
tag depends on its role in the custom table (see Table
style below). A context is part of a custom table if the
element is a row or cell in the customer table model
and follows one of these hierarchies (in the Custom
Tables tab, the Role column of the Custom table
elements table states its role in the custom table):
• table element/row element
• table element/cell element
Definition List L
Definition List Item LI
Division Sect
Footnote Reference
This tag will be the default both for item styled as
Footnote, and for those which just have settings made
in the Footnote property category.
Footnote (Footnote Area Note+{Lbl}1
Properties)
Formal Block Sect
Graphic Figure
Hidden (No tag)
Index Sect
Index Term (No tag)
Inline (block) P
Inline (inline) (No tag)
Link (block) P
Link (inline) Link
Link Target (No tag)

Document Preview and Publishing 141

Style PDF tag
List — Bulleted L
List — Numbered L
List Item LI+{Lbl}LBody
Paragraph (block) P
Paragraph (inline) P
Preformatted (block) P
Preformatted (inline) (No tag)
Table Default tag is assigned based on the item’s role in the
table:
• Table — Table
• Header section — THead
• Body section — TBody
• Row — TR
• Cell — TD
• Footer section — TFoot
Table of Contents Sect
Title H
No Style (No tag)
1. + indicates that secondary tags follow. {} indicates the Before-text (generated text) tag
The attributes Lang, RowSpan, and ColSpan will also be set with default values as
needed by the PTC APP engine, when the tagged PDF option is activated for the
stylesheet. Note that the value of Lang will be determined according the language
settings made in the stylesheet on the Language tab on page 1040 of the
Stylesheet Properties dialog box.
You can manually override the PDF tags and attributes that are assigned to an
element by default when tagged PDF is generated by the PTC APP engine. See
User Assigned PDF Tags and Attributes on page 142. You can also include
alternate text for graphics and links in your tagged PDF output. See Alternate Text
Support for Graphics on page 172.

User Assigned PDF Tags and Attributes

Arbortext Styler associates a default PDF tag with each style in the stylesheet,
when it is set to generate tagged PDF output. The attributes Lang, RowSpan, and
ColSpan will also be set with default values as needed by the PTC APP engine.
You can manually override these default settings, or add other standard tags or
attributes, to meet your own requirements. Use the PDF tags category to assign
non-default PDF tags or attribute for individual elements, contexts, or conditions,
or for property sets.

142 User's Guide

These options are only available when you are publishing tagged PDF with the
PTC APP engine.
Refer to Validating a Tagged PDF Structure on page 146 for information on how
to validate your tagged PDF settings and output.

Overriding the default PDF tag setting for an element

The procedure below explains how to override the default PDF tag that has been
assigned to an element based on its style. The PDF tag will be output for every
instance of the element from the document, when the document is published as
tagged PDF.
For example, the draft-comment element has the Inline style (Inline structure)
in your stylesheet. By default it will not output a PDF tag based on its style, when
the source document is published to tagged PDF. To specify that draft-
comment elements should output the Annot PDF tag in tagged PDF output,
follow the steps below in Arbortext Styler:
1. Navigate to the Print/PDF tab of the Stylesheet Properties dialog box. Confirm
that the Generate tagged PDF option is selected. Selecting this option will
ensure you have access to the controls in the PDF tags category. Confirm that
your environment is set to use the PTC APP print engine.
2. Select the draft-comment element in the Elements list.
3. Navigate to the PDF tags category.
4. From the Element tag drop down list, select Annot. You have now associated
the Annot PDF tag to the draft-comment element. As it is an explicit
setting, note that the title of the drop down list is now bold and blue.
5. Publish tagged PDF, selecting the Tagged PDF option in the Publish to PDF File
dialog box.
In the resulting tagged PDF output, you will see an Annot PDF tag output for
every instance of a draft-comment element in your source document.
In this example, you have configured a single PDF tag for an element. Arbortext
Styler also provides the option to configure primary and secondary (nested) tags
for elements of certain styles. Refer to Configuring Primary and Secondary PDF
Tags below for information.

Assigning an attribute to a PDF tag

The procedure below shows how to add a PDF attribute to the PDF tag output for
an element when published to tagged PDF output. You will also specify that the
value of the PDF attribute in output should be the value of an XML attribute on
the source element.

Document Preview and Publishing 143

 Note
A PDF tag attribute can only be configured for the Element tag.

For example, abbr elements in your source document include an attribute

expansion, whose value is the full version of the abbreviation. Use the steps below
to output the PDF attribute /E on the PDF tag output for the abbr element, and
pass the value of the original expansion attribute as its value.
1. Navigate to the Print/PDF tab of the Stylesheet Properties dialog box. Confirm
that the Generate tagged PDF option is selected. Selecting this option will
ensure you have access to the controls in the PDF tags category.
2. Select the abbr element in the Elements list.
3. Navigate to the PDF tags category.
4. Note the PDF tag that the element is set to output, for example Note.
You cannot set a PDF attribute if the Element tag is not configured for the
element.
5. In the Attributes field, click Add to open the PDF Attribute dialog box.
6. From the PDF attribute drop down list, select E. You will see that the
Synchronize with HTML attribute box is checked, with a suggested attribute in
the associated drop down list. Make changes to this setting if required.
Deselect it if you don’t plan to generate a corresponding attribute in HTML
output from the same source, or wish to provide a different attribute for the
element in HTML output.
7. In the Value field, select the From attribute option.
8. In the From attribute field, enter the name of the source attribute, i.e.
expansion. The XML attributes defined for the element in the DTD/schema
are listed in the drop down list for selection. You may have to type the
attribute name in the field if it is not declared in the DTD/schema.
9. Click OK to exit the dialog box. You will see that the PDF attribute setting is
listed in the Attributes table of the PDF tags category.
10. Publish tagged PDF, selecting the Tagged PDF option in the Publish to PDF File
dialog box.
In the resulting tagged PDF output, you will see a Note PDF tag output for
every instance of an abbr element in your source document. Each one will
have an /E attribute whose value is the value of the expansion attribute on its
source element.

144 User's Guide

Configuring Primary and Secondary PDF Tags
You can configure primary and secondary (nested) PDF tags to represent the
constituent parts of certain elements. Arbortext Styler provides these PDF tag
options:
• Primary tag
○ Element tag — represents the whole element
• Secondary tags
○ Before-text tag — represents any generated text output by the element
If this PDF tag is configured for the element, but the element generates no
generated text, this PDF tag will not be output.
○ Element content tag — represents the element’s content
The availability of secondary tags depends on the setting of the primary tag. Refer
to Validating a Tagged PDF Structure below for details of the rules controlling
secondary tags.
For example, you can configure a list item element to output three PDF tags that
wrap the list item itself, its generated text marker, for example a bullet, and its text
content. Follow the steps below:
1. Navigate to the Print/PDF tab of the Stylesheet Properties dialog box. Confirm
that the Generate tagged PDF option is selected. Selecting this option will
ensure you have access to the controls in the PDF tags category.
2. Select the element that represents the list item in the Elements list, for example
li.
3. Navigate to the PDF tags category.
4. In the Element tag drop down list, select the PDF tag that represents the list
item element, for example LI.
5. In the Before-text tag drop down list, select the PDF tag that represent the list
item’s generated marker, for example Lbl
6. In the Element content tag drop down list, select the PDF tag that represents
the text content of the list item, for example LBody.
7. Publish tagged PDF, selecting the Tagged PDF option in the Publish to PDF File
dialog box.
In the resulting tagged PDF output, you will see this type of PDF tag hierarchy
output for every instance of an li element in your source document (example
shown is from a bulleted list):
<LI>
<Lbl>
•
<LBody>

Document Preview and Publishing 145

 <P>
List item content

Validating a Tagged PDF Structure

Several controls assist you in creating a valid PDF tag structure in PDF output:
1. The Enforce valid PDF tag structure stylesheet property
Enable this property in the Print/PDF tab of the Stylesheet Properties dialog
box to request that the PDF tag structure is validated during publishing of
PDF. If an invalid structure is detected, no PDF will be output by the
publishing action and errors will be generated in the Event Log for the action.
This option is only available when the stylesheet is set to publish print/PDF
with the PTC APP engine, and the Generate tagged PDF option is selected.
2. Configuration of secondary tags (Before-text tag, Element content tag) is
subject to a set of rules:
• Secondary tags are not permitted when the Element tag is configured as an
Artifact.
• Certain secondary tags are available, based on the configuration of the
Element tag
Element tag Secondary tags permitted
(No tag) Valid Element tag choices
L LI
LI Lbl, LBody
TOC TOC and TOCI
TOCI Lbl, Reference, NonStruct, P, TOC
Table TBody, THead, TFoot
THead TR
TBody TR
TFoot TR
TR TD, TH
Ruby RB, RP, RT
Warichu WP, WT

A Tools ▶ Validate Stylesheet action will flag errors if secondary tags are
not configured according to these rules.
• Certain secondary tags are available, based on the category of the Element
tag:

146 User's Guide

 Permitted in these categories of Element
Secondary tag tag
Caption Grouping tags1 (Not TOCI), Figure, List, Table
Lbl BibEntry, LI, Note, TOCI
Top level inline tags2 Not permitted in grouping tags or strict structure
tags3
Paragraph like tags4 Not permitted in inline tags or strict structure
tags
1. Grouping tags: Document, Part, Art, Sect, Div, BlockQuote, TOC, TOCI, Index,
NonStruct, Private
2. Top level inline tags: Span, Quote, Note, Reference, BibEntry, Code, Link, Annot,
Ruby, Warichu
3. Strict structure tags: L, LI, Table, TBody, THead, TFoot, TR, TOC, TOCI
4. Paragraph like tags: P, H, H1–H6

A Tools ▶ Validate Stylesheet action will flag errors if secondary tags are
not configured according to these rules.
• Primary and secondary tags are configured as a single group. It is not
possible to explicitly set one and inherit the other.
• PDF tag attributes can be applied to Element tags only. If the Element tag
is configured as (No tag), an attribute cannot be set.

PDF/UA Output
PDF/UA (PDF/Universal Accessibility) is a standard that defines requirements for
accessibility in PDF documents and applications. Conformance to the PDF/UA
standard means that PDFs are accessible with assistive technology such as screen
readers, screen magnifiers, and other technologies to navigate and read electronic
content.
Arbortext Styler provides the option to generate tagged PDF that conforms to the
PDF/UA standard. The PDFUA element in the PTC APP configuration file, when
included and set to a value of 1, will specify that PDFs generated are PDF/UA
compliant.
For more information, see PTC APP PDF Configuration File (.appcf) on page 96.
You must ensure your stylesheets and PDF publishing action are set to generate
tagged PDF if requesting PDF/UA compliant PDF.
For more information, see Stylesheet Properties — Print/PDF on page 1042
You can use the Conformance section in Adobe Acrobat to confirm that your PDF
conforms to the PDF/UA standard. The Standards panel provides the
Conformance section of information.

Document Preview and Publishing 147

Requirements for Conformance to PDF/UA
Certain PDF tags and attributes, if they are present in a PDF, must meet specific
requirements if the PDF is to conform to PDF/UA standard, for example:
• The H tag must not be used — use H1-H6 instead
• A Note tag must have an ID attribute
• Graphics must include alternate text
For more information, see Alternate text for graphics and links in tagged PDF
on page 172.
• Tables must have headers defined with TH header cell tags
• TH tags must have a Scope attribute.
• L tag (list) must have a ListNumbering attribute
Refer to www.iso.org for the PDF/UA Specification, ISO 14289–1:2014.

PTC Arbortext Stylesheets Configured to Output PDF/UA Compliant

PDF
PTC Arbortext provides a sample stylesheet that is configured to support PDF
output that is PDF/UA compliant:
• Arbortext-path\doctypes\axdocbook\axdocbook.style
Ensure that the stylesheet is set to output tagged PDF, and that the current PTC
APP PDF configuration file (.appcf) includes the PDFUA element with a value
of 1.

Chunking Data in HTML Output

If you intend to publish a document to EPUB, HTML Help, or Web formats you
can configure your Arbortext Styler stylesheet to break the final output into
individual chunks for the purposes of display. Each chunk can be thought of as an
individual HTML file, but the actual packaging will depend on the type of final
output. You specify what elements should form a chunk boundary, with the option
of indicating that a chunk boundary should only be created for certain contexts of
the element or when particular conditions are matched. You can also supply
further information for each chunk, such as the filename to use when storing that
chunk and other metadata values. This supplementary information may either be
set as a static value or it may be extracted from other objects within the document.
Note that only elements of Block structure can form a chunk boundary. Refer to
the Structure type field in the Breaks category for the element - if the field has a
value of Inline you will still have access to the chunk boundary option but this will
not be used in final output.

148 User's Guide

Note also that if there are any footnotes in the document, an extra chunk is created
containing just the footnotes for all chunked outputs.
Features in Arbortext Styler support the process of data chunking:
• Defining an element as forming a chunk boundary at which the document
should break
The HTML chunking category for an element, a sub-category of Breaks,
contains a Chunk boundary option with which you specify whether the
element forms a chunk boundary or not
• Setting your stylesheet to obey the chunk boundary settings defined for each
element in the document:
The HTML tab of the Stylesheet Properties dialog box includes the Chunk
boundaries field , which you can check to ensure final output is chunked as
you have specified.
• Specifying a filename for each chunk in output
The HTML Chunking dialog box contains a Persistent filename option with
which you specify or generate a file name for a chunk.

Note
By default, if the id attribute is set for the resourceid element in a
DITA topic, it will be used as the filename for the equivalent output
HTML file.

• Passing metadata to each chunk in output

The Generated Text Editor for an element, accessed via the Generated text
category, includes the Insert ▶ Advanced ▶ Metadata menu option with which
you can specify or generate metadata for a chunk.
• Creating contexts or conditions based on Start of HTML Chunk tests
○ The Context dialog box contains a At start of HTML chunk option, with
which you specify that an element's position at the top of an HTML chunk
defines its context.
○ The Start of HTML Chunk Test dialog box, accessed by clicking New Chunk
Test in the Condition dialog box, contains options with which you can
create a condition that matches either if the element is at the top of an
HTML chunk in chunked output, or if it is not.
• Creating a table of contents (TOC) for the chunked output

Document Preview and Publishing 149

 The properties area for the Tables of Contents list contains a Use for chunked
HTML outputs (EPUB, HTML Help, and Web) option with which you can specify
that the TOC object will generate a table of contents that includes elements set
as forming chunk boundaries in output.

Example: Defining chunk boundaries in Arbortext Styler

The procedure given below describes how to specify that certain elements should
be classed as a chunk boundary in chunked output. The document will break into a
chunk every time an instance of the element(s) is encountered in the data during
the publishing process, with the hierarchy between the elements maintained if
applicable. The example is based on the transport.xml sample document,
located at Arbortext-path/samples/styler.
1. In Arbortext Editor, click Styler ▶ New Stylesheet to create a new stylesheet
for the document.
2. In the Elements list, highlight the chapter element and give it a Division
style via the Edit ▶ Style menu option. Set the division level to 1 in the Division
Details dialog box.
3. Navigate to the Breaks category for the element and note that the Structure
type field reads Block, since the element is styled as a division. Navigate to the
HTML chunking category.
4. Set the value of the Chunk boundary field to Yes. You will see that the color
of the label of the HTML Chunking field changes to blue, to indicate that an
explicit value exists for the option.
5. Repeat steps 2–4 for the sect1 element, giving it a division level of 2.
6. In Arbortext Editor, choose File ▶ Publish ▶ For Web. In the Stylesheet field of
the Publish for Web dialog box (see Publish for Web dialog box in Arbortext
Editor help), ensure your stylesheet is selected. Click OK to start the
publishing process.
7. Refer to the source output files and notice that you have the following data
chunks, in addition to the frame and graphic definition files and directories:
• 1 first level chunk, numbered sect1, based on the document element.
The top level element of the document is always chunked automatically.
• 6 second level chunks, numbered sect1sect1 - sect1sect6, based
on the chapter elements.
• 1 third level chunk, numbered sect1sect2sect1, based on the only
sect1 element in the sample document, the Employee Information
section in chapter 2.
Note that the chunks are labeled according to the Arbortext Styler default
naming scheme, based on their hierarchy within the document. You may elect
to provide your own numbering scheme for the chunks - the steps detailed in

150 User's Guide

 Defining persistent chunk filenames in Arbortext Styler below give an example
of how this can be achieved.

Example: Defining persistent chunk filenames in Arbortext Styler

This example describes how to provide filenames for the data chunks created in
the section Defining chunk boundaries in Arbortext Styler. The file name of each
chunk will be the title of the original element on which the chunk is based.
1. Set your stylesheet to chunk the content of the transport.xml sample
document into chapter and sect1 elements, as described in Defining
chunk boundaries in Arbortext Styler above.
2. In the Elements list, highlight the chapter element and navigate to the
Breaks category for the element. Go to the HTML chunking sub-category.
3. Set the value of the Persistent file name field to Yes. The From attribute and
From XPath options become active.
4. In the From XPath field, enter the expression title. This will extract the
content of the chapter's title child element.
5. Repeat steps 2–4 for the sect1 element.
6. In Arbortext Editor, choose File ▶ Publish ▶ For Web. In the Stylesheet field of
the Publish for Web dialog box (see Publish for Web dialog box in Arbortext
Editor help), ensure your stylesheet is selected. Click OK to start the
publishing process.
7. Refer to the source output files and note that the chunks are each labeled
according to the title they have in the original document. Spaces and
punctuation from the original title have been transformed for the file name
during the publishing process.

Example: Passing metadata to chunked HTML output

The procedure defined below describes how to include metadata with each data
chunk created in Defining chunk boundaries in Arbortext Styler.
Once complete, you will be able to view the assigned metadata by inspecting the
source HTML for the chunk.
1. Set your stylesheet to chunk the content of the transport.xml sample
document into chapter and sect1 elements, as described in Defining
chunk boundaries in Arbortext Styler above.
2. In the Elements list, highlight the chapter element and navigate to the
Generated text category for the element. Click the Edit button for the Before-
text field to open the Generated Text Editor.
3. In the Generated Text Editor, choose the Insert ▶ Advanced ▶ Metadata menu
option to open the Insert Metadata dialog box. Check the Static option and

Document Preview and Publishing 151

 select Author from the list of standard metadata types. Note that you can
also type a name of your own in this field.
4. Click OK to exit the dialog box. Arbortext Styler inserts a Meta tag, with
MetaName and MetaValue children. The MetaName field contains the
name of the metadata type you selected in the previous step:

5. In the MetaValue field, type the value for the Author metadata type.
You can also generate the value of the MetaValue field programmatically if
you wish. For example, if your chapter contained keywords, you could enter
the Keywords metadata type in the MetaName field, then use the Insert ▶
Element Content menu option in the MetaName field to insert all occurrences
of the keyword element from the chapter into the field. In this instance
Arbortext Styler will extract the content of each keyword element and insert
them in the MetaValue field wrapped in an _sfe:CollectionItem
element, creating a comma separated list of keywords for the chapter.
6. Place your cursor after the Meta tag, and choose a second Insert ▶ Advanced ▶
Metadata action. This time, check the Dynamic option in the Insert Metadata
dialog box and click OK. Arbortext Styler inserts a Meta tag again, this time
with both MetaName and MetaValue tags blank.
7. In the MetaName tag, type the metadata type Title.
8. In the MetaValue tag, choose the Insert ▶ Element Content menu option. In
the Insert Element Content dialog box, configure the following settings:
• Select the By XPath option
• In the Expression field, enter the expression title
• Set the Insert field to Only content
Here you have specified that the value of the Title metadata type for a
chunk will be set to the title of the chapter upon which the chunk is based.
Click OK to exit the dialog box . Arbortext Styler enters an
ElementContent tag into the MetaValue field.
9. Choose File ▶ Apply and Close to exit the Generated Text Editor. The Add
before element content field now contains <_gte:Meta>,
<_gte:MetaName>, and <_gte:MetaValue> tags defining the metadata
settings you made.
10. In Arbortext Editor, choose File ▶ Publish ▶ For Web. In the Stylesheet field of
the Publish for Web dialog box (see Publish for Web dialog box in Arbortext

152 User's Guide

 Editor help), ensure your stylesheet is selected. Click OK to start the
publishing process.
11. Refer to the source output files and open the first chapter chunk in a text
editor. Note that the head element contains your metadata definition, in the
form shown below:
<meta name="Author" content="John Smith"
scheme="atiChunkerMeta">
<meta name="Title" content="Introduction"
scheme="atiChunkerMeta">

Generating XHTML Output

1. Refer to the HTML tab of the Stylesheet Properties dialog box.
2. For any of your HTML outputs, check the box in the Generate XHTML field.
3. Publish your document to the required HTML output as usual.
Your document has been output in XHTML format. It includes the required XML
declaration and is based on the relevant XHTML DTD.
If you are generating output for EPUB, it will always be provided in XHTML
format. The Generate XHTML field will not be available.

Generating HTML5 Output

1. Refer to the HTML tab of the Stylesheet Properties dialog box.
2. For any of your HTML outputs, check the box in the Generate HTML5 field.
3. Publish your document to the required HTML output as usual.
Your document has been output in HTML5 format. It includes the relevant
doctype declaration.
Select both the Generate XHTML and Generate HTML5 options to generate
XHTML5 output. XHTML5 output includes the required UTF-8 encoding.

Publishing EPUB Output

EPUB is a non-proprietary eBook (electronic book) format that can be used as
content for mobile devices. PTC Arbortext offers the option to publish and
preview EPUB ready output with the standard publish and preview menu options,
or via publishing rules if you are working with Arbortext Publishing Engine. You
can set your Arbortext Styler stylesheet to be used to generate EPUB output and
configure the stylesheet to provide specific styling for the format.

Document Preview and Publishing 153

EPUB output is made up of a zipped file containing valid XHTML data,
packaging files, and container files. You may customize the output for use in a
specific device by making necessary changes in your Arbortext Styler stylesheet.
You must have Calibre 0.8.0 or later installed to be able to publish and preview
EPUB output. Calibre is a free and open source e-book library management
application. It provides eBook conversion and an eBook viewer. The Calibre
viewer allows you to view output once the publishing or preview action is
complete.
Use the set epubinstalldir option to declare the directory location of the
Calibre installation. The EPUB publishing process will search for a valid Calibre
install directory the first time it is launched. The stated directory will be
considered valid if it contains the files ebook-convert.exe and ebook-
viewer.exe. If the value of epubinstalldir is not set or is not valid, PTC
Arbortext will attempt to locate a valid Calibre2 directory by searching these
locations:
1. \Program Files and \Program Files(x86) on all mounted disks
2. Each directory declared by the PATH environment variable
If PTC Arbortext encounters a valid directory, it will use that Calibre installation
and set the value of epubinstalldir to this directory location. If it does not
find a valid Calibre installation with these searches, it will display a file browser
dialog for you to select the directory location of a valid installation.

Note
If you are publishing EPUB with Arbortext Publishing Engine, you must still
install Calibre on the Arbortext Editor client. The EPUB viewer must run on
the client to enable you to view the resulting output. Use a set
epubinstalldir=path command in an ACL script in the Arbortext-
path/custom/init directory to declare the location of the installation.

PTC Arbortext’s EPUB output conforms to the EPUB Standard Version 2.

Different e-reader applications have varying levels of support for this standard and
you may see differences between output viewed in Calibre e-reader during
publishing and your selected reader. Ensure that you have tested output in your
various required readers to confirm the appearance is satisfactory. If there are
unexpected anomalies, use the View EPUB option in the Publish to EPUB dialog
box to confirm the appearance is correct in the Calibre e-reader. If it is incorrect
there, contact Technical Support.

154 User's Guide

Generating Accessible HTML Output
Arbortext Styler provides several options for delivering HTML output in an
accessible form:
• Semantic HTML Output on page 155
Tags in HTML output supply information that can be used by screen readers to
improve accessibility to written documentation by providing a recognizable,
standardized structure. Arbortext Styler converts XML elements into default
HTML tags during every HTML publishing operation. It also provides the
option to publish semantic HTML output, where paragraphs and titles are
tagged more specifically to provide a hierarchical structure in the HTML.
For example, when generating semantic HTML output, a level 1 header will
be tagged as <h1> instead of <div>.
• User assignable tags and attributes in HTML output on page 156
Manually override the default tags and default settings for common attributes
that are automatically generated when publishing HTML output. You can also
provide values for attributes that would otherwise not be set during publishing.
• Alternate text for graphics in semantic HTML output on page 172
Annotate your graphics so they can be identified by readers of the document.
• The attribute lang is automatically set for certain tags during publishing.
Note that the value of lang will be determined according to the language
settings made in the stylesheet on the Language tab on page 1040 of the
Stylesheet Properties dialog box.

Semantic HTML Output

HTML tags are included in HTML output during a publishing operation, where
elements, contexts, and conditions in a source XML document are associated with
default HTML tags based on the style given to the elements in the stylesheet. You
can elect to add additional context to some tags in the output by specifying that
the stylesheet should generate semantic HTML. In semantic HTML output,
paragraphs and division titles are assigned to semantic tags that define their use, i.
e. p, and h1–h6.

Output semantic HTML output

This procedure describes how to set your stylesheet so that semantic HTML
output is generated from your source XML.

Document Preview and Publishing 155

1. Navigate to the HTML tab of the Stylesheet Properties dialog box. Check the
relevant Generate semantic HTML/XHTML option.
2. In Arbortext Editor, choose the File ▶ Publish menu option and select the
required HTML output type. Elect to use the stylesheet with the Generate
semantic HTML/XHTML option selected.
3. Click OK to complete the publishing operation. Your HTML output will
include a set of default HTML tags, with additional contextual information
applied in the form of p tags for each paragraph, and h tags for each division
title, numbered according to their hierarchy level.
The table below describes how outputting semantic HTML changes the HTML
tags output for certain XML elements:
HTML tag in regular HTML tag in semantic
Style HTML output HTML output
Paragraph (block) div p
Paragraph (inline) span span
Title table or div1 h1–h6
1. depending on setting of Format titles as tables field in HTML tab of Stylesheet
Properties dialog box
You can manually override the HTML tag and attributes that are assigned to an
element by default when HTML is generated. See User Assigned HTML Tags and
Attributes on page 156. You can also include alternate text for graphics in your
HTML output. See Alternate Text Support for Graphics on page 172.

User Assigned HTML Tags and Attributes

Arbortext Styler associates a default HTML tag with each style in the stylesheet,
when it is set to generate regular or semantic HTML outputs. The attributes class,
style, align, lang, rowspan, and colspan will also be set with default values as
needed. You can manually override these default settings, or add other standard
tags or attributes, to meet your own requirements. You can also set a value for the
id attribute where it is not set by the HTML publishing process. When HTML
publishing sets the value of id, this value will take precedence over the user
assigned value.
Use the HTML tag property category to assign a non-default HTML tag or attribute
for individual elements, contexts, or conditions, or for property sets.
If the stylesheet is set to generate HTML5 output (see Generating HTML5 Output
on page 153), HTML5 tags will be included in the list of tags presented.

156 User's Guide

 Note
You cannot manually assign an HTML tag to an element given any of the
following styles:
• Cross Reference
• Definition List
• Definition List Item
• Document
• Footnote
• Graphic
• Index
• Link
• Link Target (block structure)
• List Item
• Preformatted (block structure)
• Table
• Table of Contents
• No Style
The HTML tag control will be disabled if the selected element is of one of
these styles.

Overriding the default HTML tag setting for an element

The procedure below explains how to override the default HTML tag that has
been assigned to an element based on its style. The HTML tag will be output for
every instance of the element from the document, when the document is published
as regular or semantic HTML.
For example, the cite element has the Inline style in your stylesheet. By default
it will be associated with the span HTML tag based on its style, when the source
document is published to regular or semantic HTML. To specify that cite
elements should output the q HTML tag in HTML output, follow the steps below
in Arbortext Styler:
1. Select the cite element in the Elements list.
2. Navigate to the HTML tag property category.

Document Preview and Publishing 157

3. Select the HTML output type for which the setting should apply from the
Outputs to edit field, if applicable.
4. From the HTML tag drop down list, select q. You have now associated the q
HTML tag with the cite element. As it is an explicit setting, note that the
title of the drop down list is now bold and blue.
When you publish regular or semantic HTML, you will see a q tag output for
every instance of a cite element in your source document.
Bear these general rules in mind when configuring HTML tags:
• If you assign the HTML tag (no tag) to an element, there will be no styling
for that context in output. It is the equivalent of proving the No Style style.
• Configured tags may be ignored in the publishing process if they are not
applicable to the element style they are associated with. This is most likely to
occur when configuring tags for property sets, where they could be associated
with elements of any number of styles. Also, for some elements, a different tag
is applied depending on whether the element is of a block or inline structure.
Depending on how the structure is resolved, the assigned tag may or may not
applicable.

Assigning an attribute to an HTML tag

The procedure below shows how to add an HTML attribute to the HTML tag
output for a context when published to HTML output. You will also specify an
explicit value for the HTML attribute in output.
For example, ph elements in your source document are styled as Inline (inline
structure), which by default outputs a span tag in HTML output. You want to
ensure that the content of these ph elements are presented in right to left reading
order in HTML output, if their content is in Japanese. The presence of Japanese
content is identified by the inclusion of the xml:lang ="ja" attribute on the
original ph element. Use the steps below to output the HTML attribute dir on the
span HTML tag output for the ph element with Japanese content, and give the
attribute the value rtl.
1. Select the relevant context of ph in the Elements list, for example with the
condition ph everywhere, if attribute "xml:lang" = "ja".
2. Navigate to the HTML tag property category.
3. Note the HTML tag the context is set to output, for example span.
4. Click Add to open the HTML Attribute dialog box.
5. From the HTML attribute drop down list, select dir. You will see that the
Synchronize with PDF attribute box is not checked, since there is no automatic
equivalent attribute for a PDF tag.
6. In the Value field, select the Text option.

158 User's Guide

7. In the Text field, enter rtl.
8. Click OK to exit the dialog box. You will see that the HTML attribute setting is
listed in the Attributes table of the HTML tag category. Arbortext Styler has
escaped the text in the Value field, to provide a valid XPath expression for
your setting.
When you publish tagged HTML, you will see a span dir=”rtl” tag output for
every instance of the selected context of ph in your source document.

Validation of HTML output when configuring HTML tagging

Arbortext Styler is not able to assess whether HTML tagging configured for a
document will result in valid HTML output. It is generally acceptable to use
invalid HTML, for example it will display without problem in a browser. If the
final HTML output needs to be parsed, or used in an application that will only
accept valid HTML, it is the stylesheet developer’s responsibility to ensure the
required configuration and testing is carried out. Particular care must be taken in
these cases:
• Selecting the Generate semantic HTML/XHTML stylesheet property increases
the chances of the output HTML being invalid. The p tag output for paragraph
elements has restrictions in HTML, for example it cannot contain nested p
tags, or ul or ol tags.
• Assigning non-default tags to elements may provide an invalid hierarchy.

Managing CSS Files in HTML Output

Arbortext Styler supports three different methods of outputting CSS information
in all HTML outputs (HTML File, Web, HTML Help, and EPUB):
• Declaring CSS as values of each element's style attribute.
• Specifying CSS in a named style rule in the style element in the HTML
document's head section, and then setting the element's class attribute to the
name of the style rule. This is the default treatment of CSS information in
HTML File output.
• Outputting CSS in a named style rule in an external .css file, referencing
that file via a link element in the HTML document's head section, and then
setting each element's class attribute to the name of the relevant style rule.
This is the default treatment of CSS information in chunked HTML outputs -
Web, HTML Help, and EPUB.
The .css file is output with a specific file name, depending on the output
format chosen:
○ Chunked HTML outputs (EPUB, HTML Help, and Web) – the file will be
named styler.css

Document Preview and Publishing 159

 ○ HTML File output – the file will be named output_filename.css
It is possible to specify that CSS in a particular output should be treated in a non-
default way, and the sections below provide some examples of how this can be
accomplished:

Output CSS to an external file in HTML File output

In this procedure you will specify that publishing to HTML File output should
output CSS information into a specified external file, rather than writing it into the
style element at the head of the HTML file, as is the default behavior for this
output type.
1. In Arbortext Styler, choose the File ▶ Stylesheet Properties menu option to
open the Stylesheet Properties dialog box for your stylesheet. Note that the
dialog box will also open when you elect to create a new stylesheet via the File
▶ New menu option.
2. Select the publishing type HTML File if this has not already been done.
3. Navigate to the HTML tab of the Stylesheet Properties dialog box. In the HTML
File group, select the option External file in the CSS style location field. Click
OK to save the setting and exit the Stylesheet Properties dialog box.
4. In Arbortext Editor, choose the File ▶ Publish ▶ HTML File menu option. When
the publish action is complete, refer to the output. The HTML file output_
filename.htm does not contain any embedded CSS, and the file output_
filename_files/output_filename.css has been created to contain
the CSS information.
The CSS information has been written to the external file output_
filename_files/output_filename.css. Note that the directory is
named under a particular naming convention - the HTML document
output_filename.htm will always be paired with its associated file
directory output_filename_files, following standard Windows
behavior for connected files. In particular, when you carry out a move,
rename, copy or delete action on either the output_filename.htm file or
the output_filename_files files directory, the action will always
include the other one.

160 User's Guide

 Note
If generated, the output_filename_files directory has the same
name for both HTML File and RTF output. If you produce both HTML
and RTF output for the same document, and publish them to the same
output directory, both outputs will reference the same output_
filename_files directory. This could cause issues in certain
circumstances:
• If, after generating both HTML File and RTF output, you delete/move the
.htm file, Windows will also delete/move the output_filename_
files directory. If the equivalent RTF output contains linked graphics,
these will be lost when the output_filename_files directory is
deleted. To avoid this issue, take care to output HTML File and RTF to
separate directories, or set your RTF file to use embedded graphics.
• Your stylesheet may be set up to treat a graphic in different ways,
depending on whether it appears in HTML File or RTF output. In this case
it is not acceptable to reference the same output_filename_files
directory for both outputs, since this will result in only one version of the
graphic being available.
Note also that publishing to HTML File may change the file extension of a
graphic, as the process converts graphics to web friendly format. Take care
that this will not overwrite a graphic of the same name that is intended to
be referenced in RTF output only. For example, a graphic named
styler.cgm will be converted to styler.jpg when the document is
published to HTML File. If the graphic styler.jpg already exists in
the output_filename_files directory, but for RTF output only, this
distinction will be lost when the file is overwritten.
It is a good idea to publish HTML File and RTF outputs of the same
document to separate directories to avoid these issues.

Declare CSS in elements' style attributes in Web output

In this procedure you will specify that publishing to Web output should declare
CSS information in the style attributes of each element in the document, rather
than exporting it to an external file. You need to edit the .style file directly, and
change the default value of the CSS configuration attribute for the Web output.
You can use the same procedure to change the default treatment of CSS
information for any of the chunked HTML outputs.
1. In Arbortext Editor, open the .style file that will support publishing your
document to Web output. Note: use the File ▶ Open menu option rather than

Document Preview and Publishing 161

 the Styler ▶ Open Stylesheet option, to ensure the stylesheet is opened as an
editable document.
2. Add an HtmlOutputConfig element as the child of the
StyleSheetInfo element, if one does not already exist.
3. Open the Modify Attributes dialog box for the element, and set the value of the
output attribute to web. Set the value of the cssStyleLocation attribute to
onElements. Click OK to save the change and exit the dialog box, then close
the stylesheet in Arbortext Editor.
4. Still in Arbortext Editor, open the XML document that is to be published via
the stylesheet you’ve worked on, and choose the File ▶ Publish ▶ For Web
menu option. When the publish action is complete, refer to the output. You
will see that, in each of the document chunks in the output directory, each
individual element in a chunk has the CSS style information declared in its
style attribute.
HtmlOutputConfig elements in your stylesheet define the method by which
CSS information will be generated for your document in each of the HTML
output types. If an HtmlOutputConfig element does not exist in your
stylesheet for a particular HTML output, the default method of CSS generation
will be applied when the document is published to that format. You can, however,
change the default setting by adding a HtmlOutputConfig element to the
stylesheet as described above, then setting the value of its attributes as described
below.
The output attribute relates to the possible HTML output types. The permitted
values are web, htmlhelp, epub, and htmlfile.
The cssStyleLocation attribute describes the method by which CSS information
will be generated. the permitted values are:
• externalCssFile - generate a CSS file in the output directory
• inHtmlHead - declare all CSS information for the document once, in the head
element of the HTML document
• onElements - declare all CSS information for the document in the style
element of each element in the HTML document

Add custom styling with a custom CSS file

Using this procedure you can override the styling that is defined in the default
CSS file created when publishing to Web output. Once the default CSS file has
been saved to an external file, you can create a custom CSS file and include it
with the default CSS file in the output directory for the Web output. Any style
information contained for an element in the custom CSS will supersede any
styling defined for the same element in the default CSS file. You can use the same
procedure to create custom styling for any of the HTML outputs.

162 User's Guide

Note that the output CSS file in this example is named styler.css – this is the
default file name for the CSS file produced when publishing to chunked HTML
output (EPUB, HTML Help, or Web). If you are carrying out this procedure as
part of publishing to HTML File, your default CSS file will be named output_
filename.css, and hence your custom CSS file should be named output_
filename_custom.css.
1. In Arbortext Editor, publish your document to Web output using the default
publishing settings (create CSS in external file).
2. Refer to the output. A CSS file to accompany the Web output has been
created: refer to the file css/styler.css.
Note that another CSS file, dmc.css, has also been created in the same
directory. This CSS file contains global style settings which are overridden by
styling applied to any elements by your Arbortext Styler stylesheet. You
should not alter or delete this file.
3. Create an empty text file called styler_custom.css and save it in the
same directory location as styler.css.
4. Copy any style rules that you want to change from styler.css into
styler_custom.css. Make the styling changes you require to these rules.
Save the changes to the document and exit the editor.
5. View your Web content in a browser. You will see that the display of elements
whose styling you customized has changed, whereas the styling of the rest of
the content has not.

Generate CSS rules based on property sets

CSS information generated for property sets can be shared between HTML files
that are based on different document types. Refer to Styling HTML Files from
Different Document Types on page 165 for further information.
1. Refer to the HTML tab of the Stylesheet Properties dialog box.
2. For any of your HTML outputs, set the value of the Create CSS rules for field
to Property sets.
3. Publish your document to the required HTML output as usual.
If you examine the source HTML output, you will see that the description of a
context or condition that references a property set in the stylesheet also contains a
reference to that property set in the HTML output. The CSS information for your
HTML output contains the details of the property set.

Document Preview and Publishing 163

 Note
Property settings made explicitly to contexts and conditions are not reflected
in any HTML or CSS output when Create CSS rules for is set to Property sets.
Use the Tools ▶ List HTML/CSS Defects menu option to list properties of this
type. A stylesheet validation action will also warn you if any such explicit
property settings exist.

Export CSS Information

You may choose to export CSS information from a stylesheet as a separate action
from publishing. You may then use this new CSS file to style existing HTML or
XHTML files.
1. Refer to the HTML tab of the Stylesheet Properties dialog box.
2. For any of your HTML outputs, set the value of the Create CSS rules for field
to the required value. If you wish to share styling across documents based on
different document types, set the field to Property sets.
See Styling HTML Files from Different Document Types on page 165 for
more information on sharing styling information across HTML files.
3. Save the changes you made.
4. Choose the File ▶ Export CSS menu option and select the required HTML
output format.
5. In the Export CSS dialog box that appears, enter the location to which the CSS
file should be saved, and the name and title of the file.
6. Click OK to export the file.
The following properties affect the transformation from XML to HTML or
XHTML, or the chunking of the (X)HTML. They cannot be changed by exporting
a new CSS file after the (X)HTML files have been published.
• Hidden
• Structure type (Block or Inline)
• Preformatted alignment (all other changes in the Alignment field are permitted)
• All properties in the HTML chunking category
• All properties in the Generated text category
• All properties in the Footnote category

164 User's Guide

Styling HTML Files from Different
Document Types
It is possible to style HTML or XHTML pages or files via a single set of CSS
rules, even if the files were generated from XML using different document types.
This enables you to provide a consistent look over a document set.
Elements in the HTML output refer to CSS rules. Those CSS rules will be based
on the property sets referenced by the elements in the stylesheet. The basic
process to support this requirement is as shown below. Specific use cases will be
dealt with in more detail later.
1. A group of common property sets holds any HTML properties that are
required. The property sets are made available for sharing across the
stylesheets of all the documents to be consistently styled, for example by
declaring them in a common stylesheet module.
2. Every element in each of the HTML files to be consistently styled references
these property sets in their stylesheet for the required HTML output:
Explicit properties specified for an element will not be included.
3. CSS information generated from the stylesheets is based on the property sets
so it is uniform across all document types whose elements reference those
property sets. Use the Create CSS rules for option in the HTML tab of the
Stylesheet Properties dialog box. Set its value to Property sets when
publishing your HTML output or generating CSS information as a standalone
file.
You may generate the CSS information from just one of the stylesheets and share
it amongst all the documents. The stylesheet used to generate the CSS must
include the information listed below:
• Definitions for every property set referenced by any of the stylesheets used in
the document set.
• Definitions for every table of contents object referenced by any of the
stylesheets used in the document set, if the TOCs are to appear in the body of
the document and have indented levels.
If the definitions do not appear in the stylesheet used to generate the CSS
information, the entries in the resulting body TOCs will all have the same
indent.
• Definitions for every combined font referenced by any of the stylesheets used
in the document set.

Document Preview and Publishing 165

New stylesheets
Use this process if you are creating new stylesheets for documents of different
document types and you want all resulting documents to display the same styling.
1. Create a new stylesheet to support the first document type, for example
axdocbook.
2. Create a new module and move all property sets to the new module.
3. Set up the stylesheet as required:
• Assign Styler styles to all the elements
• Specify any generated text settings
• Specify property settings that should be reflected in the HTML output by
referencing property sets from the property sets module.
If you need to create a new property set, ensure you move it to the property
sets module.
Referencing property sets from a module is considered best practice for this
process. It facilitates the sharing of property sets between stylesheets and
ensures consistency of name.
4. Create a new module for any objects defining tables of contents (TOCs) that
will appear in the body of the final document, if applicable. Move all such
TOC objects to the module.
This step does not include the TOC that appears in the left hand frame of
EPUB, HTML Help, and Web outputs.
Referencing TOC objects from a separate module is considered best practice
for this process, as above. You could include the TOC objects in the same
module as the property sets.
5. Create a new module for any combined font definitions in the stylesheet, if
applicable. Move all combined font definitions to the module.
Referencing combined font definitions from a separate module is considered
best practice for this process, as above. You could include them in the same
module as the property sets and/or TOC objects.
6. Refer to the HTML tab of the Stylesheet Properties dialog box. Set the Create
CSS rules for field for the required HTML output to the value Property sets.
7. Create a new stylesheet to support the second document type, for example
DITA.
8. Add a reference to the property sets module created for the first (axdocbook)
stylesheet, and TOCs and combined font modules if you created them.
9. Delete all property sets in the root module so that they will not override the
ones in the property set module.

166 User's Guide

10. Set up the stylesheet as required, as described above.
11. Set the Create CSS rules for field for the required HTML output to the value
Property sets, as shown above.
12. Create your required HTML (or XHTML) output in the usual way.
13. You will see that documents published from both stylesheets have a consistent
look. CSS information generated by the publishing action will include
references to the property sets rather than specific properties.

Note
Generated text, including automatic numbering, is created when the XML is
transformed to HTML or XHTML. You cannot change its content by making
changes to a CSS file. Be sure to configure generated text before publishing.

Existing stylesheets
Use this process if you already have stylesheets to support documents of different
document types and you want to amend them so that all resulting documents
display the same styling.
1. Determine the set of property sets that will be used in all stylesheets to provide
the styling for the required HTML output.
2. Create a new stylesheet module and move all property sets to the new module.
Referencing property sets from a module is considered best practice for this
process. It facilitates the sharing of property sets between stylesheets and
ensures consistency of name.
3. Create a new module for any objects defining TOCs that will appear in the
body of the final document, if applicable. Move all such TOC objects to the
module.
This step does not include the TOC that appears in the left hand frame of
EPUB, HTML Help, and Web outputs.
Referencing TOC objects from a separate module is considered best practice
for this process, as above. You could include the TOC objects in the same
module as the property sets.
4. Create a new module for any combined font definitions in the stylesheet, if
applicable. Move all combined font definitions to the module.
Referencing combined font definitions from a separate module is considered
best practice for this process, as above. You could include them in the same
module as the property sets and/or TOC objects.

Document Preview and Publishing 167

5. For each stylesheet:
• Add the property sets module, and the TOC and combined font modules if
these exist.
• Assign the necessary property sets to the element contexts and conditions,
replacing explicit property settings for the required output format as these
will not be included.
• Change existing references to TOC objects to point to the new shared
module, if applicable.
• Change existing references to combined font definitions to point to the
new shared module, if applicable.
• Refer to the HTML tab of the Stylesheet Properties dialog box. Set the
Create CSS rules for field for the required HTML output to the value
Property sets.
6. Create your required HTML (or XHTML) output in the usual way.
7. You will see that documents published from both stylesheets have a consistent
look. CSS information generated by the publishing action will include
references to the property sets rather than specific properties.

Existing HTML content with shared styling

Use this process if you already have HTML content from different document
types that shares consistent styling. You can change the look of all the documents
without having to regenerate the content, by creating a new CSS file in isolation.
1. Edit one of the stylesheets that was originally used to produce the output.
2. Make the required changes to the properties of the property sets in the
common property sets module.
You may not make change to properties that are classed as transform
properties. Refer to Export CSS Information in Managing CSS Files in HTML
Output on page 159 for information.
3. Make the required changes to indents for TOCs in the common TOCs module.
4. Make the required changes to any combined font definitions in the common
combined fonts module.
5. Refer to the HTML tab of the Stylesheet Properties dialog box. Set the Create
CSS rules for field for the required HTML output to the value Property sets.
6. Export a CSS file for the required output format via the File ▶ Export CSS
menu option.

168 User's Guide

 Since the stylesheet shares its property set, TOC and combined font definitions
with the other stylesheets in the set, the exported CSS will apply to documents
created with all those stylesheets too.
7. Place the new CSS file in the location that all the existing documents
reference. Overwrite the existing file to provide the new styling.

Passing Metadata to PDF Output

Once defined in the .style stylesheet, metadata is generated when publishing to
PDF format with that stylesheet. A single set of metadata will be generated for the
whole PDF document, although the metadata can be defined for any context or
condition in the stylesheet. The metadata will be displayed in the Document
Properties dialog box for the PDF document. The standard metadata items
Title, Author, Subject, and Keywords will be displayed in the
Description tab of the dialog box, whilst all other items, including user defined
metadata types, will be retained in the Custom tab.
The procedure defined below describes how to define metadata for a PDF
document published from the transport.xml sample document, located at
Arbortext-path/samples/styler.

Example: Creating metadata for a PDF document

1. In Arbortext Editor, click Styler ▶ Edit Stylesheet to open the sample
document's associated stylesheet for edit. This is a read only stylesheet so you
will need to save a local copy in order to make changes.
2. Select the Print/PDF option in the Outputs to edit field.
3. In the Elements list, select the book everywhere context.
You can select any context or condition here - any metadata defined for the
document will be output in the Document Properties dialog box of the final
PDF document, regardless of the context or condition for which it is defined in
the stylesheet.
4. Navigate to the Generated text category for the element, then click the Edit
button next to the Before-text field. The Generated Text Editor opens.
5. In the Generated Text Editor, choose the Insert ▶ Advanced ▶ Metadata menu
option to open the Insert Metadata dialog box. Check the Static option and
select Author from the list of standard metadata types. Note that you can
also type a name of your own in this field.
6. Click OK to exit the dialog box. Arbortext Styler inserts a Meta tag, with
MetaName and MetaValue children. The MetaName field contains the
name of the metadata type you selected in the previous step.
7. In the MetaValue field, type the value for the Author metadata type.

Document Preview and Publishing 169

 You can also elect to generate the value of the MetaValue field
programmatically. For example, if your book contained keywords, you could
create metadata whose value is made up of a list of their values. Enter the
Keywords metadata type in the MetaName field, then use the Insert ▶
Element Content menu option in the MetaName field to insert all occurrences
of the keyword element from the book into the field. In this instance
Arbortext Styler will extract the content of each keyword element and insert
them in the MetaValue field wrapped in an _sfe:CollectionItem
element, creating a comma separated list of keywords for the book.
8. Place your cursor after the Meta tag, and choose a second Insert ▶ Advanced ▶
Metadata action. This time, check the Dynamic option in the Insert Metadata
dialog box and click OK. Arbortext Styler inserts a Meta tag again, this time
with both MetaName and MetaValue tags blank.
9. In the MetaName tag, type the metadata type Booktitle. This is not a
default or standard metadata type for PDF, but Arbortext Styler permits the
inclusion of user-defined metadata types.
10. In the MetaValue tag, choose the Insert ▶ Element Content menu option. In
the Insert Element Content dialog box, configure the following settings:
• Select the By name and occurrence-within-ancestor option
• In the Name field, select the element title
• In the Occurrence field, select 1st
• In the Within field, select the element book
• In the Insert field, select the Only content option
Here you have specified that the value of the Booktitle metadata type will
be set to the title of the book element.
Click OK to exit the dialog box - Arbortext Styler enters an
ElementContent tag into the MetaValue field.
11. Choose File ▶ Apply and Close to exit the Generated Text Editor. The Before-
text field now contains _gte:Meta, _gte:MetaName, and _gte:
MetaValue tags defining the metadata settings you made.
12. If your stylesheet is set to publish print or PDF via FOSI, choose the Preview ▶
Print menu option to generate a preview of your final document. This will
ensure that Arbortext Styler updates the .genfos file associated with your
stylesheet with the changes you have made, thus ensuring that the metadata
settings are passed to the publishing engine. See Saving Stylesheets on page
46 for information on saving a .genfos file.
13. In Arbortext Editor, choose File ▶ Publish ▶ PDF File. In the Stylesheet field of
the Publish to PDF File dialog box (see Publish to PDF File dialog box in

170 User's Guide

 Arbortext Editor help), ensure your stylesheet is selected. Click OK to start the
publishing process.
14. Once publishing is complete, open the output PDF file. Access its Document
Properties dialog box by clicking File ▶ Document Properties in the Acrobat
menu.
15. Click on the Description tab if it not already active, and note that the Author
field contains the value you set.
16. Click on the Custom tab, and note that the Custom Properties field
contains an entry for Booktitle. The value of the entry is “Welcome to the
Wonderful World of Modern Transportation”, which is the title of the original
transport.xml document.

Include Custom XMP Metadata in PDF Output

You can reference a custom XMP file from your stylesheet, and specify that its
metadata should be included in PDF output. This option is available if you are
publishing PDF output with the PTC APP engine.
To reference a custom XMP metadata file:
1. Confirm that your environment is set to use PTC APP as the PDF publishing
engine.
2. Save your XMP metadata file (.xmp) to a location that can be referenced by
your stylesheet.
3. Open the PTC APP PDF configuration file (.appcf) that you are using to
manage your PDF publishing actions.
4. Navigate to this element in the file:
Print ▶ PDFPrinter ▶ DocumentProperties

For more information, see PTC APP PDF Configuration File (.appcf) on page
96
5. Set the value of the xmpMetadata attribute for the element to the path to your
custom XMP file, for example xmpMetadata=”D:\test.xmp”. Save the file.
6. Publish your document to PDF output.
7. The metadata defined in the XMP file is included as metadata for the PDF file.
For example, you can open the PDF in Adobe Acrobat and navigate to this
path to view the XMP metadata:
File ▶ Properties ▶ Document Properties ▶ Additional Metadata ▶ Advanced

Document Preview and Publishing 171

 Note
Custom XMP metadata is merged with system generated XMP metadata and
other document properties configured in the stylesheet. The custom XMP
metadata will be overridden if the other two contain the same entries.

Alternate Text Support for Graphics

You can provide alternate text for graphics included in HTML and tagged PDF
outputs. This is one way of making PDF and HTML content more accessible.
Screen readers will read the alternate text supplied for a graphic to provide
information or context when the graphic can’t been accessed by the end user of
content.
If you have set your stylesheet to output HTML or tagged PDF outputs, you may
use the following techniques to include alternate text for graphics in those outputs.
Use the fields in the HTML tag and PDF tags categories for elements, contexts, and
conditions, or property sets, to configure alternate text.
The following notes apply when configuring alternate text for graphics:
• PDF: publishing of tagged PDF is only permitted when working with the PTC
APP engine. You can assign alternate text for document graphics, or graphics
in generated text. You can not provide alternate text for page region graphics.
• HTML: You can assign alternate text for document graphics, or graphics in
generated text.

Alternate Text for Document Graphics

The example below shows how to extract alternate text for a graphic in your
source document, and include it as an Alt attribute for the graphic when the
document is published as tagged PDF output. The alternate text will be extracted
from a child element of the graphic tag, which contains the alternate text in the
source document.
For example, graphics in your document are represented by the image element,
which have a child element alt that contains the alternate text. The alt element
is hidden from output. Follow these steps to output an Alt attribute in tagged PDF,
whose value is the content of the original alt element.
Alternatives for configuring the alt attribute in HTML output are given in
parentheses. Alternatively, you could select the Synchronize with HTML attribute
option in the PDF Attribute dialog box, and Arbortext Styler will configure the
equivalent alt attribute automatically.

172 User's Guide

1. Navigate to the Print/PDF tab of the Stylesheet Properties dialog box. Confirm
that the Generate tagged PDF option is selected. Selecting this option will
ensure you have access to the controls in the Tags category.
The option is only available when the stylesheet is set to publish print/PDF
with the PTC APP engine.
HTML: no need to carry out equivalent selection, alternate text can be
included in regular or semantic HTML outputs.
2. Select the image element in the Elements list.
3. Navigate to the PDF tags category.
HTML: Navigate to the HTML tag category.
4. Note the PDF tag that is set for the image element, for example Figure
HTML: Note the HTML tag that is assigned, for example img.
5. In the Attributes field, click Add to open the PDF Attribute dialog box.
HTML: clicking the Add button will open the HTML Attribute dialog box.
6. From the PDF attribute drop down list, select Alt.
HTML: select alt from the HTML attribute list.
7. In the Value field, select the From XPath option.
8. In the From XPath field, enter the XPath expression that will extract the
content of the child alt tag of the image element, i.e. child::alt.
9. Click OK to exit the dialog box. You will see that the attribute setting is listed
in the Attributes table.
10. Publish tagged PDF, selecting the Tagged PDF option in the Publish to PDF File
dialog box.
In the resulting tagged PDF output, you will see a Figure PDF tag output for
every instance of an image element in your source document. Each one will
have an /Alt attribute (Alternate Text) whose value is the value of the alt
attribute on its source image element.
In HTML output, note the presence of img tags with alt attributes.

Translation of Alternate Text for Document Graphics

Translations of alternate text for document graphics is not generally supported. It
is anticipated that alternate text will be extracted from the source document, which
will usually be in the target language.
If you need to translate a literal string as the alternate text, use one of the
following methods:

Document Preview and Publishing 173

1. PDF output only: use an XPath expression to evaluate a UFE for the alternate
text for the document graphic. The UFE could have the alternate text
translation as its content.
2. PDF and HTML outputs: use an XPath expression to evaluate a script that
retrieves translated generated text. This is not recommended as it does not
make use of Arbortext Styler’s native support for translation.

Alternate Text for Graphics in Generated Text

The example below shows how to add alternate text to a graphic in generated text
in your source document, and include it as an Alt attribute for the graphic when
the document is published as tagged PDF (or an alt attribute when published to
HTML).
For PDF, this feature is only supported if you are publishing with the PTC APP
engine.
1. If publishing to PDF, ensure that your stylesheet is set up to generate tagged
output. Confirm that the Generate tagged PDF option on the Print/PDF tab of
the Stylesheet Properties dialog box is selected. Selecting this option will
ensure you have access to the controls in the PDF tags category.
2. Select the element that is set to output a generated graphic in the Elements list,
for example draft-comment.
3. Refer to the PDF tags category and note the PDF tag that the element is set to
output, for example Note
HTML: Refer to the HTML tags category and note the assigned tag, for
example span
4. Refer to the Generated text category. Open the generated text that includes the
graphic in the Generated Text Editor.
5. Open the Modify Attributes dialog box for the relevant _gentextgraphic
element.
6. Add the required alternate text to the alt attribute, then close the dialog box.
7. Close the Generated Text Editor.
When you publish the document to tagged PDF output, you will see the Note
PDF tag for each occurrence of a draft-comment in your source. The Note
tag includes a Figure tag for the generated graphic, which has an /Alt attribute
(Alternate Text) with the value of the alt attribute on the original graphic.
HTML output: You will see a span HTML tag for the draft-comment, which
includes an img element and an alt attribute.

174 User's Guide

 5
Exporting Stylesheets
Exporting Stylesheets .............................................................................................. 176

This section describes the formats to which you can export your stylesheets for
use with processors other than Arbortext Styler.

175
Exporting Stylesheets
Arbortext Styler stylesheets are saved with a .style extension, a format that
Arbortext Editor and Arbortext Publishing Engine automatically recognize. Since
.style files are proprietary, you can also export your stylesheet to a standard
format.

Exporting stylesheets in PTC Advanced Print Publisher (PTC APP)

format
To export a Arbortext Styler stylesheet as an PTC APP template (.3f file):
1. Choose File ▶ Export ▶ PTC APP in Arbortext Styler.
Your stylesheet must be set to use PTC APP at its effective print engine.
2. In the Export PTC APP Template dialog box that appears, specify the path and
file name to which you want to save the stylesheet in the File name field. If the
stylesheet has never been saved, the file name consists of a path and file name
based on the document directory, and the default stylesheet name, with a .3f
extension. You can edit the path and file name, or use the Browse button to
navigate to an existing template.
3. Click Save to export the stylesheet.
You may now use the .3f file in a standalone PTC Advanced Print Publisher
installation if required.

Note
The template can only be opened successfully in a compatible PTC
Advanced Print Publisher release - you will see an error message if you try
to open the document in an earlier release.

Exporting stylesheets in FOSI format

To export a Arbortext Styler stylesheet to FOSI format:
1. In Arbortext Styler, choose File ▶ Export ▶ FOSI.
Your stylesheet must be set to use FOSI at its effective print engine.
2. In the Export FOSI Stylesheet dialog box that appears, specify the path and file
name to which you want to save the stylesheet in the File name field. If your
stylesheet has not been saved before, Arbortext Editor fills in this field with a
path that would make the stylesheet the default stylesheet either for the
document or for the current document type.

176 User's Guide

 Click Use for to open the Use Exported FOSI For dialog box, in which you can
choose the document instance in which your stylesheet should be used.
Arbortext Editor provides a default name and location for each possible use to
ensure it is picked up automatically as required.
3. Choose the publishing type(s) for which the stylesheet can be used. The
choices in this field are Print/PDF and HTML File. The stylesheet title or its path
and file name display in the stylesheet list in the dialog boxes associated with
the publishing types selected. For example, if you select Print/PDF, the
stylesheet is added to the Stylesheet list in the Preview, Print, and Publish PDF
File dialog boxes.
4. In the Title field, specify the name of the stylesheet that displays in the Select
Stylesheet dialog box and the dialog boxes associated with the Publishing
types you select. If you do not specify a title, the path and file name of the
stylesheet display in these dialog boxes.

Note
Arbortext Editor truncates the path and file name if they exceed 57
characters.

5. Click Save to export the stylesheet.

Exporting stylesheets in XSL format

While a Arbortext Styler stylesheet can be used for many outputs, an XSL
stylesheet can only be used for one. When you export an XSL stylesheet you must
pick the type of XSL stylesheet to export, i.e. the correct one for the target output
of the stylesheet.
You cannot edit exported XSL stylesheets in Arbortext Styler, so you should still
save your stylesheet (.style file) for making further modifications.
To export a Arbortext Styler stylesheet as an XSL stylesheet
1. Choose File ▶ Export in Arbortext Styler.
2. Select the type of XSL stylesheet you want to export from the Export
submenu:
• XSL-FO (for Print/PDF output)

Your stylesheet must be set to use XSL-FO at its effective print engine.
• XSL-EPUB
• XSL-HTML File
• XSL-HTML Help

Exporting Stylesheets 177

 • XSL-Web
• XSL-FO RTF
3. In the associated Export dialog box that appears, specify the path and file
name to which you want to save the stylesheet in the File name field. If the
stylesheet has never been saved, the file name consists of a path and file name
based on the document directory, and the default stylesheet name, with an
.xsl extension. You can edit the path and file name, or use the Browse button
to navigate to an existing stylesheet.
4. Specify a title for the exported stylesheet in the Title field. This title displays in
the Select Stylesheet and publishing dialog boxes. If you do not specify a title,
the path and file name of the stylesheet display in these dialog boxes.

Note
Arbortext Editor truncates the path and file name if they exceed 57
characters.

5. Click Save.
If you will be generating an XSL-HTML stylesheet from the .style file, you
can specify that the XSL-HTML stylesheet should produce XHTML output when
publishing, rather than the standard HTML. In the HTML tab of the Stylesheet
Properties dialog box, select the Generate XHTML option for the required output.
You can then export the .style file to the required XSL format and use it to
support publishing.

Note
XSL stylesheets exported from Arbortext Styler do not conform strictly to the
XSL specification. They are designed be supported in other PTC applications
such as Arbortext Publishing Engine. PTC cannot guarantee that they will
work in other XSL-FO applications and do not support this use case.

178 User's Guide

 6
Defining Page Layout
Page Layout Overview............................................................................................. 180
Creating a Page Set ................................................................................................ 182
Setting a Page Size and Orientation for a Page Set.................................................... 182
Defining Number of Pages for a Page Set ................................................................. 184
Setting Margins in a Page Set .................................................................................. 185
Setting Columns in a Page Set ................................................................................. 186
Justifying Columns in a Page Set.............................................................................. 189
Defining Page Regions ............................................................................................ 190
Add Page Region .................................................................................................... 192
Adding Headers and Footers to a Page Set ............................................................... 198
Configuring Page Numbers for a Page Set ................................................................ 199
Applying a Page Set to an Element ........................................................................... 200
Validating Page Sets................................................................................................ 200
Adding Border Rules to Block Elements .................................................................... 202
Side by Side Alignment ............................................................................................ 204
Run-in Styling ......................................................................................................... 215
Hyphenation ........................................................................................................... 216

This section describes how to define the layout of pages using page sets.

179
Page Layout Overview
Arbortext Styler uses page sets to define page layout. Page sets are a set of page
layout descriptions for a sequence of pages in a major division of a document. All
pages using the same page set are numbered sequentially in the document and
typically share some basic characteristics.
Every element that generates output must either specify a page set or have an
ancestor that has specified a page set. Once an element has specified a page set,
the page set is used until the element ends.

The Page Sets list displays a list of page sets configured for the stylesheet.
You can configure the following features in a page set:
• Page size and orientation: see Setting a Page Size and Orientation for a Page
Set on page 182 for information
• Page layout: page types made up of a specific set of page regions define page
layout. See Defining Page Regions on page 190 for information.
• Margins: see Setting Margins in a Page Set on page 185 for information
• Columns: see Setting Columns in a Page Set on page 186 for information
• Regions to hold text or graphic content: see Defining Page Regions on page
190
• Headers, footers and other generated content: see Adding Headers and Footers
to a Page Set on page 198 for information
• Page numbers: see Configuring Page Numbers for a Page Set on page 199 for
information
Some characteristics of page sets are listed below, which may be useful when you
are deciding how to set your pages:
• A page set is either single or double-sided and a set of properties can be
applied accordingly. It is not possible to mix single singled and double sided
properties in a single page set: you cannot, for example, choose double-sided
margins and single-sided headers.
• Single-sided documents have the same page layout on left and right pages.
• Double-sided documents are designed to print on both sides of a page. You can
specify different settings for left and right pages.
• First pages usually occur on the right side of a two page spread. They are also
known as “recto” pages. Note , though, that the first page of a document that is
formatted right-to-left will occur on the left. You can also specify that the first
page should start at any number in the Breaks category.

180 User's Guide

 Even pages always occur on the left side and are also known as “verso” pages.
• Mirror margins indicate that the inside margins on both right and left pages are
the same, as are the outside margins on right and left pages. Mirror margins
refer to inside and outside margins, not left and right margins since the inside
margin on an even page is the right margin and the inside margin on an odd
page is the left margin.

Print Engine Support for Page Layout Features

The table below provides a list of available page layout features, and describes the
support provided by each of the PTC Arbortext print engines.
Feature PTC APP FOSI XSL-FO
Different page layout for left and right Yes No No
blank pages
Unequal column and gutter widths Yes No No
Horizontal column alignment within Yes No No
page region
Gutter rules Yes No No
Page regions1 Yes Yes Yes
Arbitrary number of generated text Yes Yes Yes
regions (not limited to header and
footer)
Clip regions at page Yes No No
Region avoid and avoid margins Yes No No
Rotate content in regions to 90, 180, Yes Partial Partial
and 270 degrees counter-clockwise2
Rotate region to arbitrary angle2 Yes Partial Partial
Region graphics specified via an XPath Yes No No
expression
Region graphic scaling: independent X Yes No No
and Y scaling
Region borders Yes No No

1
FOSI and XSL-FO require that the main content flow region be the same
width for all pages.
2
FOSI and XSL-FO support rotation of 90 degrees only for the main content
flow region.

Defining Page Layout 181

Nested Page Sets
As a general rule, PTC Arbortext publishing will process nested page sets. If you
are using the XSL-FO engine, however, you should note the following:
• Nested page sets are not valid under the XSL-FO specification, although the
publishing process will attempt to handle them.
• In some rare cases, the results using nested page sets will be slightly different
to those provided by a flat page set arrangement, because of the way in which
XSL-FO property inheritance works.
• Arbortext Styler will attempt to flatten a nested page sequence when
publishing via the XSL-FO engine. Flattening the sequence adds a non-trivial
amount of time to the publishing process and may provide unexpected results
in output, for example numbering sequences may not continue as required or
unnecessary blank pages may appear.
You may see these differences in print, PDF or RTF outputs.
To avoid this situation, you may wish to reconfigure your page sets to ensure they
are not nested. Select XSL-FO as the effective print engine, then click Tools ▶
Validate Page Sets. Select the Require XSL-FO compliance option to indicate which
page sets do not confirm to the XSL-FO specification as they are nested.

Creating a Page Set

To create a new page set, simply select the Insert ▶ Page Set menu option. The
Page Sets list will open, if it is not already active, and the new page set will
be added to the list with the name New Page Set. Once you have renamed the
page set you can use the property categories for the Page Sets list to configure its
settings.
The following sections contain descriptions of the available options.
Once the page set has been created you can assign it to elements in the stylesheet.
For example, assign a page set to the chapter element to specify that all
chapters in the document should be laid out according to the page set's properties.
See Applying page sets on page 200 for details.

Setting a Page Size and Orientation for a

Page Set
The first step in creating a page set is specifying the page size and the page
orientation in the Page size category for the Page Sets list.

182 User's Guide

Example: Setting Page Size and Orientation for a Page Set

1. Open the Page Sets list . You will see a list of page sets configured for the
stylesheet.
2. Alternatively, choose the Insert ▶ Page Set menu option to create a new page
set. Give the new page set a name, for example body-usletter.
3. If you want to create a double-sided page set, select the Double-sided option.
Don't select the option if you want to create a single-sided page set.

Note
When you select Double-sided, the Preview window displays two pages
instead of one.

4. Go to the Page size category.

5. Select an appropriate standard page size in the Page size field, or add Width
and Height values to create a custom page size. When you select a configured
page size, its width and height specifications are displayed in the Width and
Height fields, and a preview of the selected size is displayed in the Preview
window.

Note
If you change the width and height settings for a distributed page size, the
selected page size changes to Custom.

If you wish to create a custom page size, set the value of the Width and Height
fields. You may either type an arbitrary size in the fields or choose a defined
measure by selecting from the list of Size objects configured for your
stylesheet. For the latter option, click the Select Size button next to the
field for which you wish to set the measurement and select the name of the
required Size object from the resulting list. Once you have selected a Size
object the measurement it defines will be displayed wrapped in angle brackets
(< > characters) in the relevant field. For example, the Size object InchSize
defines a measurement of 1.00in:

Defining Page Layout 183

6. Choose a page orientation. The following options are available:
• Portrait: prints everything on the page, including headers and footers, in a
portrait orientation.
If you click to change to Landscape, the values of the Width and Height
fields will be swapped.
• Landscape: prints everything on the page, including headers and footers,
in a landscape orientation.
If you click to change to Portrait, the values of the Width and Height fields
will be swapped.

Defining Number of Pages for a Page Set

To set the number of pages that a page set should output (including blank pages if
necessary), use the Other category for the Page Sets list.

Example: Setting the Extent of a Page Set

1. Open the Page Sets list . You will see a list of page sets configured for the
stylesheet. Select the one you want to update.
2. Alternatively, choose the Insert ▶ Page Set menu option to create a new page
set. Give the new page set a name, for example body-50pages.
3. Go to the Other category.
For more information, see Page Sets — Other Category in the User's Guide to
Arbortext Styler.
4. Select a number of pages in the Make last page a multiple of field, or enter your
own value (between 1 and 64). For example, enter 50.
This is the multiplier for the number of pages — the page set will output a
multiple of this number.
When publishing a document to PDF (with the PTC APP engine), the element that
is assigned the body-50pages page set will output a multiple of 50 pages to fit
its content. The page set will output blank pages to make up the page count if
necessary.
You can set the length of a document in this way, by assigning the page set to the
document element. Any child elements formatted by page sets with an extent set
will output their own number of pages within those output by the document page
set.
Be aware of the following:

184 User's Guide

• As many blank pages as necessary will be added to the page set to
accommodate content, until the number of pages is a multiple of the value of
Make last page a multiple of.
• Page numbers represent the number of pages from the beginning of the
document.
• If a page set specifies a start on a certain page (e.g. odd) which requires a
blank page to accommodate, the blank page is output from the last page set
that created a visible page.

Setting Margins in a Page Set

You can specify margins for a single-sided or a double-sided page set by
configuring the settings in the Page size category for the Page Sets list.
Margins set in this category are guides only. They are only used to provide the
correct positioning for regions that are given measures relative to the margins (see
the Position category on page 853 for the Page Regions list). If a page set contains
regions that all have absolute positioning, the margins will have no effect.
Each field in the category allows you to either type an arbitrary size in the field or
choose a defined size by selecting from the list of Size objects configured for your
stylesheet. For the latter option, click the Select Size button next to the field
for which you wish to set the measurement and select the name of the required
Size object from the resulting list. Once you have selected a Size object the
measurement it defines will be displayed wrapped in angle brackets (< >
characters) in the relevant field. For example, the Size object InchSize defines a
measurement of 1.00in:

Example: Setting Margins in a Single-Sided Page Set

1. Select the page set whose margins you would like to set.
2. Go to the Page size category in the properties area of the Page Sets list.
3. Deselect the Double-sided option.
4. In the Top and Bottom fields, specify top and bottom margins as desired. Refer
to Units of measurement in Arbortext Editor help for more information about
the units that are permitted in the fields.

Defining Page Layout 185

5. In the All pages field, specify left and right margins as desired.
6. The graphic representation of the page layout in the Preview window will
change as you amend the margins, to give you an idea of how the page will
appear. The solid horizontal lines represent the page content and show how the
margins change. Note that this preview is not a WYSIWYG preview.

Example: Setting Margins in a Double-Sided Page Set

Note
When working with FOSI and XSL-FO engines, blank pages in a double sided
document will always display the margins configured for left pages. In some
earlier releases of Arbortext Styler blank pages were laid out with odd page
margins when the document was published with XSL-FO. You may need to
update your page sets to take account of this change.
This constraint does not apply to content generated via the PTC APP engine.

1. Select the page set whose margins you would like to set.
2. Got to the Page size category in the properties area of the Page Sets list.
3. Select the Double-sided option.
4. In the Top and Bottom fields, specify top and bottom margins as desired. Refer
to Units of measurement in Arbortext Editor help for more information about
the units that are permitted in the fields.
5. If you want to draw the same margins on both left and right pages, select the
Mirror margins option. Specify values for the left and right margins in the Left
pages field. The settings you make here will be effective in all pages
formatted by the page set.
6. If you wish to have different margins on left and right pages, deselect the
Mirror margins option. Specify individual values for left and right margins in
both the Left pages and Right pages fields.
7. The graphic representation of the page layout in the Preview window will
change as you amend the margins, to give you an idea of how the page will
appear. The solid horizontal lines represent the page content and show how the
margins change. Note that this preview is not a WYSIWYG preview.

Setting Columns in a Page Set

You can configure up to eight columns in a page set. These are column
arrangements for the pages formatted by the page set.

186 User's Guide

You can configure the following properties for the columns in a page set:
• Column width
• Gutters
• Column horizontal alignment - how to place the columns horizontally within a
region
• Vertical justification - how to align columns in relation to the other columns
on the page

Note
When you specify justified columns, you must also specify variable
spacing for some of the elements within the page set. Arbortext Styler
applies variable spacing to elements in the page set to justify the content.
Arbortext Styler cannot justify the content within a page set if you do not
specify variable spacing. It does not know where to distribute the extra
space added to make the content fill the page.

• Balancing - Arbortext Styler attempts to evenly distribute content among the

columns on the page when the content does not fill the entire page. If columns
are not balanced, you may end up with a short or empty last column on a page.
Use the Columns property categories for the Page Sets list to configure these
properties.
Each measurement field in the categories allows you to either type an arbitrary
size in the field or choose a defined size by selecting from the list of Size objects
configured for your stylesheet. For the latter option, click the Select Size button
next to the field for which you wish to set the measurement and select the
name of the required Size object from the resulting list. Once you have selected a
Size object the measurement it defines will be displayed wrapped in angle
brackets (< > characters) in the relevant field. For example, the Size object
InchSize defines a measurement of 1.00in:

Example: Setting Columns in a Page Set

1. Select the page set whose default columns you would like to configure.
2. Click on the Columns category in the properties area of the Page Sets list.
Here you specify some general settings for the columns in the page set.

Defining Page Layout 187

3. Enter or select the required number of columns in the Initial number of
columns field.

Note
An explicit setting in the Columns field in the Breaks category for an
element will override this setting.

4. Select the alignment of the columns in the Column horizontal alignment field.
Note that the setting made here does not affect the alignment of content within
the columns.
5. Confirm if the columns should be balanced across the page by selecting the
Balance columns option.
6. In the Default gutter width field, set a width of gutter that should be used if you
do not plan to explicitly define column widths.
7. In the Gutter rules field, configure any rules to be drawn around column
gutters. Rules will apply to default gutters or gutters explicitly set in the x
columns property categories.

This option only applies to print/PDF output generated with the PTC APP
engine. The field is not available if your stylesheet is set to use FOSI or XSL-
FO as the default engine.
8. Navigate to the x columns property categories. Here you explicitly configure
column and gutters and define their widths.
You can maintain a different column layout for each number of columns in the
same page set.
9. Select the Unequal columns option if you want to set different widths for the
columns in a Width field for each column. Leave the option unchecked if you
want all columns to be the same width. You will be presented with a single
Width field.

This option only applies to print/PDF output generated with the PTC APP
engine. The field is not available if your stylesheet is set to use FOSI or XSL-
FO as the default engine. You will only be able to set one column and gutter
width to be repeated across all columns.
10. Select the Unequal gutters option if you want to set different widths for the
gutters between columns in a Gutter field for each column. Leave the option
unchecked if you want all gutters to be the same width. You will be presented
with a single Gutter field.

188 User's Guide

 This option only applies to print/PDF output generated with the PTC APP
engine. The field is not available if your stylesheet is set to use FOSI or XSL-
FO as the default engine.
11. For each column (or all columns if working with equal columns), set a column
width in the Width field, and a gutter width in the Gutter field.
Note that there is no gutter field for the last column.
Once you have configured the columns for your page set, you can define the
regions and content the pages should display.

Justifying Columns in a Page Set

Justified columns align along the top and bottom of a page. When you define
justified columns, you must also specify variable spacing for the elements within
the page set. Arbortext Styler applies the variable spacing to elements associated
with the page set to justify the content, by distributing the extra space within these
elements to make the content fill the page
Use the following settings to justify the columns in a page set:
• In the Columns category for the page set:
○ Select the Balance columns option to evenly distribute content among the
columns on the page when the content does not fill the entire page.
○ Select Justified in the Vertical justification field to align content at both the
top and bottom of a column.
• In the Spacing category for elements such as paragraphs in the page set:
○ In the Allow space to vary (Print/PDF only) groups, add the necessary values
in the Minimum and Maximum fields.

Note
If a column doesn't justify, you may need to specify a larger value in
the Maximum field to add more variable space. However, if the content
in the last column on a page fills less than half the column, Arbortext
Editor will not justify the content, even if you have selected
Justified and specified variable spacing.

Defining Page Layout 189

Defining Page Regions
A page region is an area on a page. Page regions can hold document content,
generated text, or graphics, or remain empty. By taking into account the order in
which regions are laid onto a page, you can define certain page layout effects in a
page set.
Once you have defined the regions you would like to appear on a page, you can
assign them to a page type to create the overall page layout.
Headers and footers are page regions. Use the Position category for the Page
Regions list to place them as headers and footers on the page. Use the Text and
Graphic categories to define the information they should display. Please refer to
Creating a Header or Footer on page 338 for further information.

Note
Only page regions that can be identified as headers or footers will be included
in RTF output.

Arbortext Styler provides an option to create commonly used page regions via a
built in helper. Please refer to Add Page Region on page 192 for further
information.
The steps to creating and using page regions for your page set in the Page Regions
list are:
1. Create the page region in the Page Regions list.
2. Configure the background color, position, content, and rotation of the page
region.
3. Assign the page region to a page type in the Page Types list so it forms part of
a configured page layout. Add page regions in a specific order to ensure any
avoid settings are obeyed.
4. Preview the page type with the relevant page set in the Page Types list.
5. Assign the page type to the relevant page set by choosing it to format certain
pages within that page set, for example Right pages or First page. Use the
Page types category for the Page Sets list.

Example: Creating a Page Region for Document Content

In this example you will create two page regions for the first page formatted by a
page set. The first region will hold a graphic and will be placed on the right of the
page. The second region will hold document content and its text content will avoid
the graphic from the first region.

190 User's Guide

 Note
The option to avoid overlaid regions is only available when you are generating
print/PDF output with the PTC APP engine.

The example assumes that a single sided page set based on the Letter page size
(8.5in x 11in) is already available in the stylesheet.

1. In the Page Regions list , create two new Page Region objects using the
Insert ▶ Page Region menu option. Name them as required, for example
firstpage-graphicfirstpage-content.
2. Configure settings for the region that will hold the graphic:
• Position category:

○ Origin: Top left

○ X position: 2.5in from left margin
○ Y position: 3in from top margin
○ Width: Absolute width 4in
○ Height: Absolute height 2in
Here you create a region that is 4in wide and 2in high, placed in the center
right of a page formatted by a Letter sized page set. The measures assume
that the page set has left and right margins of 1in, and top and bottom
margins of 1.5in.
• Graphic category:

○ Select the Underlay region text with graphic option.

○ Use the Browse button to find the graphic you would like to display in
the region.
○ Set the scaling of the graphic as required. For example, select Fit
region in the Horizontal scaling or Vertical scaling fields.
• Other category:

○ In the Avoid field, select the Underlaid regions avoid this region option.
This field is only available when your stylesheet is set to generate
print/PDF output with the PTC APP engine.
3. Configure settings for the region that will hold document content:
• Position category:

○ Origin: Top left

Defining Page Layout 191

 ○ X position: 0in from left margin
○ Y position: 0mm from top margin
○ Width: Absolute width 6.5in
○ Height: Absolute height 8in
Here you create a region that is 6.5in wide and 8in high. The region
matches the text area of a Letter sized page set that has left and right
margins of 1in, and top and bottom margins of 1.5in.
• Text category:

○ In the Type field, select Main Content Flow

4. Navigate to the Page Types list and create a new page type via the Insert ▶
Page Type menu option. Name it as required, for example firstpage-
layout
5. Use the Add button to add the page regions firstpage-graphic and
firstpage-content to the Page region (front to back) list. Use the up and
down arrows to ensure that firstpage-graphic precedes firstpage-
content in the list. This will ensure that the document content is laid under
the graphic and the avoid settings for the graphic region will be obeyed.
6. Select your Letter sized page set in the Preview with page set field. The
properties area will provide a graphical representation of your page set,
including the page regions.
7. Navigate to the Page Sets list and select your Letter sized page set.
8. Go to the Page types category. In the First page field, select the page type you
just created.
9. Preview your document for print or PDF with the PTC APP engine. You will
see that the first page formatted by your letter sized page set will display
document content and the selected graphic.

Add Page Region

Use Add Page Region to quickly create and add the regions most commonly used
in a page set, and give them some standard properties. The helper will also add the
region to the page set from which it was launched. Access the helper by clicking
the Add Region button in the Page Sets list , ensuring that the page set to which
the region is to be added is highlighted in the list.
The helper allows you to enter information over several pages. The options
displayed in a page depend on the selection you have made in previous pages. Use
the Back and Next buttons to navigate through the pages of the helper.

192 User's Guide

Page 1 The type of page region • Enter the name of the region in the
to create Name field.

The name will be used for the page

region in the Page Regions list.
• Choose the type of region, based on
its role on the page:
○ Main content flow
○ Header
○ Footer
○ Other
You may also choose to add an existing
page region from this page.
Next step:
Move to the next page in the helper to specify the pages in a page
set on which the region should appear.
Page 2 The pages in the page set Select any of the provided page
on which the region categories:
should appear • Add to right pages
• Add to first page when right
• Add to left pages
• Add to first page when left
• Add to blank pages
Options here correspond with those
provided in the Page types category for
the selected page set. Each of the
selected categories of page must
reference a page type (layout), which is
made up of page regions.
If the page set is single-sided, the
choices will be Add to left and right
pages and Add to first page.
If you selected Main content flow in
page 1, you will not see an option to
add the region to blank pages.
If you are adding an existing page
region that already exists for one of
these options, the option will be
checked and disabled to indicate that

Defining Page Layout 193

 you cannot opt to remove the region
from that category of page from within
the helper.
Result:
Page type definitions are created based on the selections made
here, according to the following rules:
• If you choose to add the region to a page category that
references an existing page type (layout) that is also used in
other page sets, you will be given the option to add the region
to all those page sets or to create a new page type for this page
set only.
If you choose to create a new page type for this page set only,
the new page type will be a copy of the existing page type that
includes the existing page regions and the new one.
• The helper will create page type definitions if they don’t
already exist in the page set to provide layout for the page
categories you wish to add the region to. Page type definitions
may also be created in order to avoid adding the new page
region to a page.
For example if you specify that the new region should only be
added to the right page, but the page set has the left page
configured to (Same as right page), a page type will be
created for the left page that will not contain the page region.
Next step:
Move to the next page of the helper to name any new page types.
Page 3 Name any page types Depending on the choices you made in
created in page 2 page 2, select one of the following:
(will only appear if new • Add region to all page sets that use
the page type
page types are needed
following selections made • Create a new page type for this page
in page 2) set.

Enter a name in the text field if you

select this option. The page type
will display this name in the Page
Types list and in the Page types
category for the page set.
• Page type to be created for selected
page category

Enter the name in the text field if

194 User's Guide

 you select this option. The page
type will display this name in the
Page Types list and in the Page
types category for the page set.
This page will provide options with
which you can name each of the new
page types needed, following your
choices in page 2.
Result:
Any new page types are created for the page set. Once you have
clicked Finish on the last page of the helper, they will appear in the
Page Types list and be referenced from the Page types category for
the page set.
Next step:
Move to page 4 to define the content of the region

Defining Page Layout 195

Page 4 Define the content to be The options presented here will depend
placed in the region, and on the type of region you selected in
whether the region should page 1:
underlay other regions. • Main content flow
You will be asked if you want to
rotate the content by 90 degrees.
• Header or Footer

You can size the region and specify

the Generated Content object that
will provide its content.
○ From edge: add a measure from
the page edge at which to place
the region
○ Height: add a measure for the
height of the region
○ Insert existing generated
content: select a Generated
Content object from the list
defined for the stylesheet.
○ Create generated content: add a
name for a new Generated
Content object.
The object will be created in the
Generated Contents list when
you click Finish on the last page
of the helper.

196 User's Guide

 • Other:

You can specify the Generated

Content object that will provide its
content.
○ Insert existing generated
content: select a Generated
Content object from the list
defined for the stylesheet.
○ Create generated content: add a
name for a new Generated
Content object.
The object will be created in the
Generated Contents list when
you click Finish on the last page
of the helper.
○ Leave empty: provide no content
All regions will provide an option
Underlay page region. The new page
region will be placed either at the very
front or very back accordingly. If you
need finer control, adjust the
positioning afterwards.
Next step:
Click Finish to create the page region according to the settings in
the helper.
Result:
All new page region, page type, and Generated Content objects will
be created in their relevant lists.
Once you have finished configuring the region, the requested page types and page
region will be created. The region will be given certain characteristics, depending
on its type. Refer to Default Properties for Regions Created Via Helper on page
197for details. You may amend these default settings as required by accessing
them in the property categories for the Page Regions list.

Default Properties for Regions Created Via Helper

The table below shows the default properties allocated to regions created the
Create Page Region helper:

Defining Page Layout 197

Property Region Type
Main Content Header Footer Other
Flow
Region Top left Top left Bottom left Top left
reference point
X position From left From left From left From left
margin 0in margin 0in margin 0in margin 0in
Y position From top From page top From page From top
margin 0in value (user bottom value margin 0in
specified) (user
specified)
Width From width From width From width From width
between between between between
margins 0in margins 0in margins 0in margins 0in
Height From height Absolute value Absolute value From height
between (as specified in (as specified in between
margins 0in helper) helper) margins 0in
Rotation Content 0 or Content 0 Content 0 Content 0
90 degrees (as degrees degrees degrees
specified in
helper)
Text type Main content Generated Generated Generated or
flow None (as
specified in
helper)
Generated n/a As specified in As specified in As specified in
content helper helper helper or n/a
Vertical n/a Top Bottom Top or n/a
alignment

Adding Headers and Footers to a Page

Set
Headers and footers are particular types of page region. You can configure the
page region as a header or footer by specifying its position on a page. You must
then assign the page region to a page type (page layout). Page sets then reference
page types to provide their page layout. Arbortext Styler provides several options
for selecting the page types to be used for the pages in the page set, depending on
whether the page set is single- or double-sided.

198 User's Guide

Refer to Creating a Header or Footer on page 338 for an example of how to create
header and footers for the first and body pages of a single sided page set. The
example describes how to create text based header and footers. You can also
include graphics in headers and footer regions. Please refer to Adding Content to a
Header or Footer on page 341 for further information.
Page set headers and footers that appear as declarations within a page set
definition will be transformed into individual objects in the Generated Content
list when a stylesheet is updated from a pre-6.0 version of Arbortext Styler.

Configuring Page Numbers for a Page Set

You can style the page numbers to be used in a page set by configuring settings in
the Page numbers category for the Page Sets list. This category provides options
in which you can set the format of the page number, and its numbering style.

Example: Setting the Page Numbering in a Page Set

1. Select the page set whose page numbers you would like to set.
2. Go to the Page numbers category in the properties area of the Page Sets list.
3. In the Page number style field, select the required numbering scheme. For
example you could use Japanese numbering from the Katakana scheme
ァ,ィ,ゥ.
4. To set the format of the numbering, open the Generated Text Editor by
clicking the Edit button next to the Page number format field.
5. Choose Insert ▶ Page Number to insert the number of the page in the
document.
Choose Insert ▶ Page Set Starting Division Number to insert the number of the
division that contains the page, for example a chapter. Using Page Set Starting
Division Number and Page Number, you can create compound numbering for
the page in the division, for example 1–1, 1–2, etc.
6. Add any text that will complete the format of the page number. For example,
you could set the page set to output Generated Page Number (Chapter
Generated Chapter Number).
7. Choose File ▶ Apply & Close to save the numbering settings and exit the editor.
The Page Number format field now shows details of the numbering settings
you have made for the page set.
You can also output page numbers in headers or footers. When configuring the
Generated Content object for the page region representing the header or footer,
use the Generated Text Editor to add the page or division number. Refer to Adding
Page Numbers to Headers and Footers on page 345 for information.

Defining Page Layout 199

Applying a Page Set to an Element
Once you have created a page set, you can apply it to an element. Once an element
has been assigned a page set, the page set remains in effect until the element ends
in the document.
You cannot apply page sets to a title element. Instead, you must apply the page
set to the title element's parent element. For example, you would apply a page
set to a chapter element rather than to the title in chapter context.

To Apply a Page Set to an Element

1. In the Elements list, choose the element to which you want to apply the page
set.
2. Go to the Breaks category.
3. In the Print/PDF and RTF only group, select Page, Odd Page, or Even Page
in the Start new list to define the page type on which the element should start.
For example, if you are applying the page set to the chapter element, you
should select Odd Page to start chapters on odd pages.
4. Select the name of the page set from the list of available page sets in the Name
field.
5. Choose a Page number option:
• <Derive>: inherit numbering from parent element
• Continue: do not restart page numbering when element starts
• Initial: restart page numbering when element starts
6. Choose File ▶ Save to save the stylesheet.

Validating Page Sets

Validating your page sets can help you avoid problems that might occur during
publishing. Below are some circumstances in which your page set may not be
valid:
• The Print/PDF Engine is set to XSL-FO, the document contains nested page
sets (an element starts a page set, and one of its ancestors also starts a page
set), and the Require XSL-FO Compliance option is enabled on the Validate
Page Sets dialog box.

The option is only available when the Arbortext Styler environment is set to
use the XSL-FO print engine.
Nested page sets are not permitted under the XSL-FO specification. Arbortext
Styler will attempt to eliminate nesting of page sets when composing with the
XSL-FO engine. As part of the flattening process, some elements that were not

200 User's Guide

 styled to start a page set will, in fact, start a page sequence This page sequence
will inherit the page set of the element’s parent.
• No page set is specified for content being output on a page. The content can be
text, a graphic, a rule, a symbol, etc. and it might be document content, or it
could be generated text. It is an error if any such content occurs before an
element has been processed that starts a page set.
To validate a page set:
1. In your Arbortext Styler stylesheet, choose Tools ▶ Validate Page Sets.
2. The Validate Page Sets dialog box provides a structured view of your
document, and indicates where page sets have been applied to the elements in
the document.

3. Page set errors are indicated by a red mark through the icon for either the
element or the page set . The number of errors found is displayed at the
bottom of the dialog box. Refer to the graphic below. The title and
productname elements have been set to start a new page but they have not
had a page set applied. Since they appear before elements that have had a page
set applied, they are flagged as errors.

Defining Page Layout 201

4. Use the Next Error button to highlight each successive error.
5. Select an element within the Validate Page Sets dialog box and choose Go To
Element to highlight the element in the Elements list and move your cursor to
that element for edit.
Use the options in the Breaks category to add or remove page sets from
specific elements.
6. Select an element that has a page set applied and choose Go To Page Set to
highlight the page set in the Page Sets list.
7. Use the Refresh button after you have made corrections to re-validate your
page sets.

Adding Border Rules to Block Elements

You can configure border rules and background color for block elements. Settings
of this type apply when Structure type in the Breaks category is set to Block.
The steps to creating border rules for block elements are:
1. If creating for print/PDF output, ensure your environment is set to use PTC
APP as the print engine.
2. Select the element for which you wish to configure border / background color
settings. Navigate to the Breaks property category and ensure that Structure
type is set to Block.

202 User's Guide

3. Navigate to the Block border property category for the Elements or Property
Sets list.

Note
Properties in the Block border category are disabled if the Outputs to edit
field is set to anything other than Print/PDF (PTC APP), any of the HTML
outputs, or Base (All Outputs).

For more information, see Block border Category on page 823.

4. Choose the sides of the block to which to apply border rules using the Sides
pickers in the Border properties field.
Select Yes for each side on which the border should appear.
5. Choose the style, thickness, and color of rule to apply to each side:
• Style — use the Style picker
• Thickness — use the Thickness field
• Color — use the Color picker
6. Specify the distance at which the rule should be offset from the block edge in
the Offset field.

Note
A positive offset increases padding, pushing the border further away from
the content. The block may take up more space in output, and may
displace neighboring content.

7. If you want to change the default style of corner for adjoining borders, select
Yes in the Rounded corners field.

If you have activated rounded corners, you can select the stretch of curve of
the corner with the Radius picker.

Note
A rounded corner setting only applies to corners that have two borders.

8. You can also select a background color for the block element using the Color
picker in the Background properties field.

Defining Page Layout 203

Please be aware of these implementation notes:
• Border rules and backgrounds configured in this category apply in these
outputs:
○ Print/PDF via the PTC APP engine
○ Chunked HTML outputs (EPUB, HTML Help, Web)
○ HTML File output
• Some Arbortext Styler border styles are not supported in HTML output. These
mapping to HTML border styles apply:
Styler style HTML style
Single Solid
Double Double
Dot Dotted
Dash Dashed
Long Dash Dashed
Dot Dash Dashed
Dot Dot Dash Dotted
Jagged Solid
Jagged Double Double
Curvy Solid
Curvy Double Double

• Adding rules to a block element has an impact on its margin priority settings,
when publishing to PDF with the PTC APP engine. Margin merging cannot be
applied.

Side by Side Alignment

It is possible to format two or more elements side by side in output, rather than the
second element always following the first and appearing below it. This type of
formatting has many uses, for example graphics aligned next to text for purposes
of illustration, or side heads or titles.
To achieve side by side formatting, specify in the stylesheet that the first element
(current element) should be displayed to the side of the element that follows it in
the source XML file (following element). This setting is configured in the Side by
side category for the Elements list, by giving the Align side by side with following
field a value of Yes. You may then set appropriate measures to ensure the required
distance between each element in output. The following elements do not have to
have any special side by side properties configured.

204 User's Guide

All side by side properties must be specified on the same object. They cannot be
combined from multiple objects. For example, a context may derive all side by
side properties from a property set (or condition), but it should not set some
properties explicitly and derive others from a property set (or condition).
The current element must precede the following elements in the source XML file.
However, the current element may be formatted to either the right or the left of the
following element in output.
The following sections provide some examples on using side by side formatting to
achieve certain effects. Sample files and stylesheets that demonstrate these
examples can be found at Arbortext-path/samples/Styler/
SideBySide.

Example: Side Titles

This example demonstrates how to output the title of a section next to the content
of the section, instead of above it.
Within section, the title element is the current element and will be given
side by side alignment properties. The para elements are the following elements.
It is possible to format title to appear on either the left or the right of the
content of the para elements. In this example it will appear on the left, as shown
below:

Refer to the samples sidehead/sidehead_left.xml and sidehead/

sidehead_left.style in the samples directory for the settings necessary to
format a section in this way.
The sample stylesheet is configured to use PTC APP as its print engine. Leave this
setting in place while you try this example.
1. For the section element, go to the Indent category and configure a left
indent large enough to accommodate the length of the title text plus any
further gap that is desired. In the sample stylesheet the indent is set to 15pc
relative to the parent left indent.
This step will ensure that all the content of the section starts at 15pc from the
parent left indent. You therefore do not have to set the same indent for each of
the separate child elements of section.
2. For the title in section context, configure the following settings in the
Side by side category:

• Align side by side with following: Yes

• Placement: Left

Defining Page Layout 205

 • Horizontal offset: -15pc

Note that the negative horizontal offset for the title will offset the left
indent configured for the rest of the content of the section. The title will
start at the parent left indent of section.
• Width: 13pc

Setting the width of the title to 13pc with reference to the section’s left
indent of 15pc implies a 2pc gap between the end of the title text (plus any
added gap) and the start of the content of the following paragraph.
• Horizontal gap: 0pc

As best practice, specify a gap of 0 to apply margins to the block. Set

indents for the following content element to create the gap wherever
possible.
In FOSI and XSL-FO print/PDF outputs, a non-zero gap will cause
unintended results when you are creating a non-wrapping alignment.
In PTC APP print/PDF and HTML outputs, a gap specified with a non-
zero value will only have an effect if it is larger than the gap that results
from the indent settings for the following content element.
3. For the para element, go to the Indent category and set the left indent values
to 0pc. This will ensure that the content of para starts at the end of the width
measurement specified for the title element.
4. Preview your document for print via the PTC APP engine. You will see that
the title and para elements in a section are aligned as you have described.
The title of the section will start at the parent left indent. The paragraphs in the
section will start at 15pc from the parent left indent.
Activate the block guides and the grid in the PTC APP Preview window by
clicking the Show / Hide the blocks and buttons. Select the unit of
measurement you have used from the drop down list . This will
display all the blocks you have configured with your side by side settings.

Example: Side by Side Procedure

This example demonstrates how to output the steps in a procedure with
informative graphics next to the text of the step. The example assumes that the
source document type contains the following markup (for illustration purposes
only):
<!ELEMENT procedure (title?, step+)>
<!ELEMENT step (info?, para+)>
<!ELEMENT info (warning | caution | figure)+>

206 User's Guide

Within step, the info element is the current element and will be given side by
side alignment properties. It will contain a figure. The para elements are the
following elements. It is possible to format info to appear on either the left or
the right of the content of the para elements. In this example it will appear on the
right, as shown below:

Refer to the samples procedures/procedure_right.xml and

procedures/procedure_right.style in the samples directory for the
settings necessary to format a procedure in this way. The graphics are located at
Arbortext-path/application/com.arbortext.sma/graphics.
The sample file is formatted via the Default Page Set in its associated stylesheet.
The page set defines a page width of 8.5 in. It has left and right margins of 1in
each, providing a content area of 6.5in.
1. For the info element, set the Structure Type to Block in the Breaks category.
Configure the following settings in the Side by side category:
• Align side by side with following: Yes
• Placement: Right
• Horizontal offset: 0pc
• Width: 19pc
• Horizontal gap: 0pc

Here you have specified that info should be aligned to the right of the
following elements (para). There is 19pc of available horizontal space for
info, and no offset value means it should fill that horizontal space. Note that

Defining Page Layout 207

 the sample XML file specifies scalefit=”1” for the graphic, which scales the
graphic to fill the available space.
2. For the first para in step and not first para in step contexts,
set the Structure Type to Block in the Breaks category.
Configure the following settings in the Side by side category:
• Align side by side with following: No

Configure the following settings in the Indent category:

• Right: 20pc relative to Parent right indent

Here you have confirmed that the para element will be positioned to the left
of the info element. para will be aligned from the right of the content area
on the page, and will start at 20pc from the right margin. With reference to the
width of 19pc set for info, this implies that an additional 1pc of space will
separate the right edge of the para from the graphic in the info element.
3. For the first para in step context, configure the numbering for the steps
in the procedure. Ensure that the numbering restarts at procedure.
4. For the title in figure context, set the Spacing After field in the Spacing
category to a suitable value. This will ensure that the figure title is separated
from any text or graphic that comes beneath it.
You must avoid setting a Spacing before value for the info, figure, and
graphic elements or the first para in step context. The tops of the
graphics may not align with the top of the step text if a non-zero value is used
here.
5. For the step element, configure the following settings in the Side by side
category:
• Align side by side with following: No
• End all contained alignments: No

Here you have confirmed that all steps in a procedure will continue the side by
side alignment settings. This includes those that don’t include their own
graphics - the text of steps without their own graphics will immediately follow
the text of the previous step. See step 2 in the sample file which aligns to the
side of the graphic from step 1 in output.
6. Preview your document for print via the PTC APP engine. You will see that
the info and para elements in a step are aligned as you have described.
Activate the block guides and the grid in the PTC APP Preview window by
clicking the Show / Hide the blocks and buttons. Select the unit of
measurement you have used from the drop down list . This will
display all the blocks you have configured with your side by side settings.

208 User's Guide

Some suggested variations on the styling defined here:
• You may want the text of steps without their own graphics to be placed
vertically below the graphic of the preceding step. In this case, set the value of
the End all contained alignments field to Yes for step.
• If a step’s text is long enough to extend below the graphic it is aligned with,
you may want the text to wrap around under the graphic. To achieve this
effect, modify the original styling as follows:
○ For the info element, set the Horizontal gap field in the Side by side
category to a non zero value, e.g. 1pc.
○ For the first para in step and not first para in step
contexts, remove the right indent settings in the Indent category.
In this case you do not need to use edited source to set a left indent for
FOSI and XSL-FO outputs.
○ As noted earlier, the title in figure context specifies a Spacing after
value. In all outputs, this controls the space after the title when what
follows is a new step or a new element within the same info parent. It
does not impact the space after the title when step text wraps beneath the
title. To control that space, add a Spacing after value to the info element.
Use a low precedence so it does not affect the spacing after a new step
following the title.
Note that HTML outputs add vertical space values together rather than
merging them. This means that having a Space after value set for both
info and title in figure will create more space than is desired. In
the procedure_right.style sample, the info element sets
Spacing after to 3pc, but has HTML File-specific properties that set
it to 0pc.
If an HTML output is configured to format list items as tables, then all the
lines of a list items are indented the same. A list that’s adjacent to the
current (aligned) element will only wrap at a list item boundary.

Considerations when Configuring Side by Side

Alignment
Please take the points listed below into consideration when configuring side by
side alignment:
• If you are working with FOSI and XSL-FO print/PDF engines some special
handling is required to output right aligned side by side positioning. With right
alignment, these engines use the left indent and first line indent settings in the
Indent category to determine the left edge of the current (aligned) element.

Defining Page Layout 209

 They ignore the Horizontal offset value in the Side by side category. PTC APP
and HTML use the Horizontal offset and Width values on the Side by side
category to determine the left edge of the right aligned element. You will need
to use FOSI or XSL-FO edited source to set the left indent to the required
value if you want FOSI or XSL/FO print/PDF output to work in the same way
as in HTML or PTC APP print/PDF outputs from the same stylesheet.
• Nested alignment groups do not format correctly when working with the FOSI
and XSL-FO engines.
• Side by side settings are only supported for an element that has a Structure
type of Block. Arbortext Styler attempts to enforce this by disabling the Side
by side controls if the element being styled appears to be inline.

It can be difficult to confirm the structure type when property sets apply for
the element, as more than one can apply in a given instance. It may be the case
that side by side formatting is applied to an inline element. When working
with HTML outputs, this can lead to unexpected results. You can try and
mitigate this:
○ Avoid setting side by side properties directly on the element that is
expected to be inline.
○ Use context and conditions to avoid setting side by side properties in
Property Sets when the element would also be inline (either by Property
Set or by direct assignment).
• If any HTML outputs are configured to create CSS rules for property sets, side
by side properties should also be specified in a property set. Side by side
properties set in a context or condition will cause HTML/CSS defects to be
reported.
Refer to Styling HTML Files from Different Document Types on page 165 for
information on creating CSS rules for property sets.
• When working with HTML outputs, some browsers ignore a Yes value for
End previous alignment on some elements, but obey it on others. The behavior
is not consistent among browsers. It may be necessary to experiment with
configuring the setting for multiple elements, or using End all contained
alignments to prevent problems. This limitation can be seen in the
procedures/procedure_left and procedures/procedure_
right sample documents in the samples directory. Refer to procedures/
about_procedure_samples.xml for further information.
• When working with HTML outputs, setting End previous alignment to Yes

210 User's Guide

 will usually end all previous alignments. Sometime it has no effect. This
creates limits on what can be done with nested alignments.
• Refer to Differences in Behavior of Indent Settings Between Outputs in Side by
Side Category on page 825 for a list of differences in effect of the side by side
properties between the various possible outputs.

Relationship Between Side by Side Positioning

Properties
Below are some graphics demonstrating the relationship between the various
properties that can be applied to produce side by side alignment. The graphics
show how different values of the same set of properties work together to produce
a particular desired effect.
The samples are based on the same piece of source markup. It consists of a
section with child title and para elements:
<section>
<title>This is the align block, there is content which wraps a line</title>
<para>Paragraph text which follows the title text. Paragraph text which
follows the title text. Paragraph text which follows the title text.
Paragraph text which follows the title text. Paragraph text which
follows the title text. Paragraph text which follows the title text.
Paragraph text which follows the title text. Paragraph text which
follows the title text. Paragraph text which follows the title text.
Paragraph text which follows the title text. Paragraph text which
follows the title text.
</para>
</section>
The title element is classed as the align block (current element), with para as
the content block (following element).

Simple Left Aligned Side by Side

Settings for section element - see Indent category:
• Left indent: 10cm
• Right indent: 0cm
Settings for title element (align block) - see Side by Side category:
• Align side by side with following: Yes
• Placement: Left
• Horizontal gap: 0pt
• Width: 8cm
• Horizontal offset: -9cm
These settings will produce the effect shown below:

Defining Page Layout 211

Right Aligned Side by Side Title with Negative Offset and Indents
Settings for section element - see Indent category:
• Left indent: 0cm
• Right indent: 10cm
Settings for title element (align block) - see Side by side and Indent property
categories:
• Align side by side with following: Yes
• Placement: Right
• Horizontal gap: 0pt
• Width: 8cm
• Horizontal offset: -9cm
• Left indent: 1cm
• Right indent: 1cm
Settings for para element (content block) - see Indent category:
• Left indent: 1cm
• Right indent: 1cm
These settings will produce the effect shown below:

212 User's Guide

Left Aligned Side by Side Title with No Offsets, with Wrapping and
Indents
Settings for section element - see Indent category:
• Left indent: 0cm
• Right indent: 0cm
Settings for title element (align block) - see Side by side, Indent, and Spacing
property categories:
• Align side by side with following: Yes
• Placement: Left
• Horizontal gap: 1cm
• Width: 8cm
• Horizontal offset: 0cm
• Left indent: 1cm
• Right indent: 1cm
• Bottom margin (Spacing after): 2cm
Settings for para element (content block) - see Indent category:
• Left indent: 1cm
• Right indent: 1cm
These settings will produce the effect shown below:

Defining Page Layout 213

Left Aligned Side by Side Title with a Small Offset and Wrapping and
Indents
Settings for section element - see Indent category:
• Left indent: 4cm
• Right indent: 0cm
Settings for title element (align block) - see Side by side, Indent, and Spacing
property categories:
• Align side by side with following: Yes
• Placement: Left
• Horizontal gap: 1cm
• Width: 8cm
• Horizontal offset: -4cm
• Left indent: 1cm
• Right indent: 1cm
• Bottom margin (Spacing after): 2cm
Settings for para element (content block) - see Indent category:
• Left indent: 1cm
• Right indent: 1cm
These settings will produce the effect shown below:

214 User's Guide

Run-in Styling
You can configure run-in styling between titles, blocks, inline elements, and text
nodes. Use the Run-in control in the Breaks category to set the following layout
relationships between elements:
• Run in with following — an item’s content will run into the content of the
sibling item that comes after it
• Run in with preceding — an item’s content will run into the content of the
sibling item that comes before it
• Run in with both — an item’s content will run into the content of the sibling
items that come before and after it
For example, you may wish to have a section title run directly into the text of the
first paragraph in the section.

Configure these Run-in settings to achieve the effect:

1. title in section context — With following
2. first paragraph in section context — With preceding
Note that run-in settings must be configured for both elements to have the desired
effect. You will be advised to set the setting for the second element the first time
you configure run-in styling for the first element.

Defining Page Layout 215

Run-in styling settings are applicable for PTC APP and FOSI outputs. Please be
aware of the implementation notes:
• XML nodes must be siblings to enable run-in styling between them. They can
be either element or text nodes.
• Adjacent nodes that are set to run-in together must both specify that they will
not break. The following items do not force a break
○ Elements styled as Inline
○ Text nodes
○ Blocks with a run-in setting (without a run-in setting, a block will be break
before and after the element)
• A block nested within an element that has a run-in setting will not affect that
run-in setting.
• When working with PTC APP, a run-in sequence must start with an element
that has either a With following or a With both run-in setting.
• When working with FOSI, a run-in sequence can start with an inline item or a
text node. Items starting a sequence do not need to have a run-in setting.
• Borders and background color settings configured in the Block border category
will apply to elements that are set to run-in with each other (each has a run-in
setting to appear on the same line).

Hyphenation
To set up hyphenation in your stylesheet, you need to configure the following
settings:
1. Document language
See the Language tab on page 1040 of the Stylesheet Properties dialog box.
In the Document language specification group, set a default value for the
document language and (optionally) specify the attribute that holds document
language information in a document. When the language is not specified in the
user document, the default language is used for the document language. You
then have the option to set a (Use document language) option for hyphenation,
which will pick up the current document language based on these settings.
You may also set hyphenation language to <Derive>. If no ancestor specifies a
hyphenation language to inherit, then US English is used.
2. Hyphenation setting for elements or contexts
See the Breaks category on page 804 in the Elements or Property Sets lists.

216 User's Guide

 In the Word breaking field, specify if you want the words in the content of the
element or context to break. You may use these settings:
• Hyphenate: hyphenate as necessary to avoid overruns in lines
• Break without hyphen: break the word without inserting a hyphen, when
necessary to avoid overruns in lines. Valid break points are immediately
after any of the following characters:
Charac-
ter Unicode Name Common name
- 002D Hyphen
/ 002F Solidus Forward slash
\ 005C Reverse solidus Back slash
= 003D Equals
_ 005F Low line Underscore
You may configure the characters at which words should break under this
setting. Refer to the breakAfterChars attribute of the StylesheetInfo
element in a .style file.
• Do not break: effect depends on the print engine set for the PTC Arbortext
environment:
○ PTC APP will still hyphenate as necessary to avoid overruns in lines
○ FOSI and XSL-FO will not break at all. Lines can extend beyond their
boundaries.
3. Hyphenation language for elements or contexts
See the Breaks category on page 804 in the Elements or Property Sets lists.
Set the language model to which an element should be hyphenated. You can
set this for the document element or on an individual element basis. You can
configure three different types of value:
• <Derive>: inherit the hyphenation language from system default, property
set, or ancestor settings.
The default document language specified in the Language tab of the
Stylesheet Properties dialog box will be used if there is no value to inherit.
• (Use Document Language): use the current document language as the
hyphenation language
Note that any context or condition inheriting this value will not inherit the
document language from the previous evaluation. Document language
analysis will be carried out again for the current context.
• Specific language: select a value from the drop down list provided, or
enter a country code manually.

Defining Page Layout 217

 Refer to Languages Supported for Hyphenation on page 219 for a list of
supported hyphenation languages and their associated language codes.
How you set up these properties depends on how hyphenation should work in
your document. Two examples are given below:

Single Hyphenation Language for Document

In this instance your document will use a single language throughout. Configure
the following settings:
• Document language
○ Provide a default document language.
• Language mappings
○ If necessary, map general languages from the document to more specific
ones. For example, map en to en-GB to specify that UK English
hyphenation rules should be used when the document's language is
English.
• Hyphenation language
Set one of the following for the document element:
○ Set Language to (Use Document Language)
○ Set Language to the name of the required hyphenation scheme

Multiple Hyphenation Languages - Language

Defined by Attribute
In this instance Arbortext Styler will automatically switch hyphenation language
based on the language of the document content being hyphenated. Document
language is defined by an attribute in the document. Configure the following
settings:
• Document language
○ Provide a default document language
○ Specify the attribute that holds document language information in the
Attribute field
• Language mappings
○ If necessary, map general languages from the document to more specific
ones. For example, map en to en-GB to specify that UK English

218 User's Guide

 hyphenation rules should be used when the document's language is
English.
• Hyphenation language
Set one of the following:
○ For each element or context that should be hyphenated, set Language to
(Use Document Language)
○ For the document element, set Language to (Use Document Language). For
each element or context that should be hyphenated, set Language to
<Derive>.

Languages Supported for Hyphenation

Publishing via the PTC APP engine
The list of languages supported by PTC APP for hyphenation is given below:
Hyphenation Language Language value
Afrikaans afr
Basque eu or eus or baq
Brazilian (Portuguese) pt-br
Bulgarian bg or bul
Catalan ca or cat
Croatian hr or hrv or scr
Czech cs or cze or ces
Danish da or dan
Dutch nl or nld or dut
English, United Kingdom en or eng or en-uk or en-gb or
en_uk or en_gb
English, United States en-us or en_us
Esperanto eo or epo
Estonian et or est
Finnish fi or fin
French fr or fra or fre
French, Canadian fr-ca
Gaelic Gaelic
German, Reformed de-1996 or rde
German, Swiss gsw or de-ch
German, Traditional de-1901 or de or deu or ger
Greek, Classic grc
Greek, Common el or ell or gre

Defining Page Layout 219

Hyphenation Language Language value
Hungarian hu or hun
Icelandic is or isl or ice
Indonesian id or ind
Italian it or ita
Latin la or lat
Latvian lv or lav
Lithuanian lt or lit
Malay ms or msa or may
Maltese mt or mlt
Norwegian nn or nno
Polish pl or pol
Portuguese pt or por
Romanian ro or ron or rum
Russian ru or rus
Saxon ans
Slovak sk or slk or slo
Slovenian sl or slv
Spanish es or spa
Swahili sw or swa
Swedish sv or swe
Turkish tr or tur
Ukrainian uk or ukr
Welsh cy or cym or wel

Publishing via the FOSI and XSL-FO Engines

Note that some existing languages are renamed to match standard usage:
Existing value Value changed to
Brazilian Portuguese, Brazil
British English, United Kingdom
English English, United States
German German, Traditional

If the specified hyphenation language is not one supported by the print engine
being used for a publish action, hyphenation will not occur. This applies whether
the value is specified on the Breaks category, or derived from the document
language.

220 User's Guide

 7
Working with Properties
Properties Overview ................................................................................................ 222
Deriving Property Values.......................................................................................... 223
Resolving Property Values ....................................................................................... 227
Explicit v Derived Property Values in Arbortext Styler ................................................. 229
Modifying Properties................................................................................................ 233
Applying Properties for Specific Outputs.................................................................... 234
Creating Output Sets in the Outputs to Edit List.......................................................... 235
Hiding Element Content ........................................................................................... 236
Applying Prespace and Postspace to Elements ......................................................... 239
Initial Properties and Property Sets Applied by Styles................................................. 243
Arbortext Styler Usability Aids .................................................................................. 244

This section describes ways in which you can use properties to provide the
required formatting for the components of your document.

221
Properties Overview
Each element context or condition, or property set has formatting properties
assigned to it to control the style for a particular usage. These properties may have
been assigned by default, by styles you have applied, or by property sets
(collections of property values). In addition, each element may include any
number of contexts and conditions, which may assign different properties to an
element depending on where it is in the document or how a particular attribute has
been defined. The properties for each element, context, condition, or property set
are grouped in categories in the lower area of the Arbortext Styler window. Select
one of the categories from the Category list to access the properties in that
category:
• Text category - Specifies formatting characteristics for any text, such as bold,
italic, underline, font family, size, and color. See Text Category on page 787
for further information.
• Indent category - Specifies properties related to horizontal positioning of text
(text alignment and indents). See Indent Category on page 795 for further
information.
• Spacing category - Specifies properties related to vertical spacing of text (line
spacing, space before, and space after). See Spacing Category on page 800 for
further information.
• Breaks category - Specifies properties related to line, column, page breaks,
keeps, run-in titles and HTML chunking. See Breaks Category on page 804 for
further information.
• Generated Text category - Specifies automatically generated content including:

○ Content to precede or follow the element, including numbers and bullets.

○ Content to use for repeating titles (also known as continued titles).
See Generated Text Category on page 818 for further information.
• Property Sets category - Specifies the property sets that have been assigned to
the element and those that are available in the stylesheet. See Property Sets
Category on page 820 for further information.
• Footnote category - Allows you to specify the behaviour of an element/
context/condition when it is set to form part of a footnote. See Footnote
Category on page 821 for further information.
• Side by side category - Allows you to specify that an item should be placed to
the side of a preceding / succeeding item. See Side by Side Category on page
825 for further information.
• PDF tags category - Allows you to configure PDF tags and attributes for
inclusion in output to improve accessibility. See PDF tags Category on page
831 for further information.

222 User's Guide

• HTML tags category - Allows you to configure HTML tags and attributes for
inclusion in output to improve accessibility. See HTML tag Category on page
834 for further information.
• RTF category - Maps Arbortext Styler element contexts to RTF-specific styles
and fields to be included in published RTF output. This category is only
available when Arbortext Import/Export is installed and licensed. See RTF
Category on page 838 for further information.
• Graphic category - Allows you to specify properties for PDF graphics inserted
into XML content and included in PDF output. See Graphic Category on page
843 for further information.

Deriving Property Values

Property settings for an element can be specified in several ways:
• The property value is set depending on the element's context (where it is
located in the document).
• Properties can be set explicitly (applied directly to the element itself). Explicit
properties cannot be affected by any other source.
• Properties can be applied via a property set, which is a named collection of
property values that can be applied to many different elements.
• A property value can be inherited from an ancestor of the current element, if
it’s not set for the current element. For example, a para element in a
listitem may be formatted in a blue font because the orderedlist
element's font value was set to blue.
• An element can be set to derive its value from another source (see below).
When you publish your document with a stylesheet, the publishing process takes
into account all of the sources of property values that could affect the format of
each element, and derives the final format for the element according to the relative
precedence of the source.
Property values can be derived from the following sources:
• Property sets - Contexts, conditions, and property sets can obtain property
values from property sets. See Working with Property Sets on page 256 for
further information.
• Conditions - Contexts can obtain property values from conditions. See
Working with Conditions on page 300 for further information.
• Base properties - You can choose to set properties for specific types of output
(uses) by selecting a use from the Outputs to edit field. If you have not applied
output specific values for a context or condition, the values set for Base (all
uses) will be used.

Working with Properties 223

• Ancestor contexts - Values not specified by the context of an element can be
obtained from the context of parent or ancestor elements.
• Arbortext Styler defaults - Arbortext Styler applies default values when
property values are not set anywhere else in the process.

Derivation Chain
Derivation often involves a chain of sources, referred to as the derivation chain.
Following are some examples of derivation chains:
• A context derives from a condition that derives from a property set.
• A proper value is derived from a property set applied to a condition of the
context.
• A context has the Arbortext Styler default setting, derived from the parent
context of its parent context.
• Base properties values derived from a property set that is set to derive from an
original property set are applied to an element whose parent context derives its
properties from its parent context, where the grandparent context derives its
properties from a condition that has the original property set assigned.
The Arbortext Styler property categories use tool tips, colored labels, and a variety
of shortcut menus to assist you in determining this chain of property sources.

Deriving Properties from Ancestors

Most element's properties will be affected by, or inherited from, their ancestors.
Therefore, it is not necessary to explicitly set all properties for each element's
contexts. Arbortext Styler can derive property values for a context from the
context of its parent (or another ancestor) element in the document being
published. Some properties can derive values from ancestors, while others cannot.
When Arbortext Styler has derived a context's properties, properties that have not
been set can derive their values from ancestors. If a context cannot derive its value
from an ancestor, it derives its value from a Arbortext Styler default.
For example, you may want to specify several values, such as font and line
spacing, for the context of the document's root element. These values will be
inherited by most of the document's child elements, making it unnecessary to set
them all explicitly.
Arbortext Styler can derive the following properties from an element's ancestors:
• All properties in the Text category.
• Line spacing properties in the Spacing category.
• Word breaking and Language properties in the Breaks category, and the widow
and orphan controls in the Keeps category.

224 User's Guide

Properties that Cannot be Derived from Ancestors
Properties that cannot be derived from ancestors are listed in the following tables,
along with their default values.

Spacing properties that cannot be derived from ancestors

Property Default value

Spacing before 0pt
Spacing after 0pt
Space before Precedence none
Space before Minimum <Derive>
Space before Maximum <Derive>
Keep space before at top of column or Not selected
page
Space after Precedence none
Spacing after Minimum <Derive>
Space after Maximum <Derive>

Breaks properties that cannot be derived from ancestors

Property Default value

Structure type Inline
Number of columns No change
Start new Blank
Landscape page body for duration of Not selected
element
Page set No change
Page number Continue

Gentext properties that cannot be derived from ancestors

Property Default value

Before-text Blank
After-text Blank
Marker None

Working with Properties 225

Deriving Property Sets from Ancestors
Sometimes several contexts need to use the same property settings, but Arbortext
Styler cannot derive the property values from ancestors. For example, titles in a
document often share font properties that are different from the font properties of
their parent elements. You can use property sets to modularize property settings in
such situations. You might create a Title Font property set that sets values for
the Font, Bold, and Color properties in the Text category, and then several different
title contexts can reference this property set.

Note
To make them easier to use, property sets should only affect a few closely
related properties. For example, the Title Font property set should not set
spacing or alignment properties.

Deriving Properties from Base Properties

You can use base properties (Base (All Uses) in the Properties to Edit list) to set
common properties for all of the available types of output (uses).
For example, you may want titles for all uses to be bold and Arial, but you want
title color and point size to be black and 18pt respectively for Print/PDF and blue
and 24pt for all other uses. To specify these settings:
1. Select the title in chapter element (or other title in context) in the
Elements list.
2. Choose Base (All Uses) from the Outputs to edit list.
3. In the Text category, set Font family to Arial, Bold to Yes, Text color to
blue, and Font size to 24pt. The labels on each of these fields change to
blue and bold when you make these explicit settings.
4. Choose Print/PDF from the Outputs to edit list.
5. In the Text category, select black as the Text color and 18pt as the Font size.
Note that Font family is set to Arial and Bold is set to Yes because these
properties are derived from Base (All Uses) (if you place your cursor over the
Font family or Bold fields, the tool tip indicates that the property is Derived
from Base (All Uses)).

Derivation Exceptions
• The Property Sets category displays the property sets configured for the
stylesheet (Available property sets), and the property sets referenced by the
current object (Used property sets). However, when you resolve a context with

226 User's Guide

 a property set applied, the derived values do not display on the Edit Property
Set dialog box.
• Generated text applied to a specific output (using the Properties to Edit list)
sets all of the generated text for that context or condition explicitly. For
example, if you add generated text after the para in listitem context for
Print/PDF output, Arbortext Styler automatically sets the Repeating titles and
Add Before generated text options explicitly. If you choose the Derive option
from any shortcut menu on the Generated text category, all of the generated
text settings will be set to Derive.
• Generated text applied to multiple conditions on an element cannot be
combined. If a specific element matches more than one condition, the
generated text associated with the last condition in the Element list will be
applied. For example, if one condition sets generated text before the element
and another condition sets generated text after the element, then if both
conditions apply, only the generated text setting from the last condition
applies.

Resolving Property Values

When you are creating or editing a stylesheet, it is often necessary to review the
cumulative affects of your property settings. As changes are made to an element's
properties, Arbortext Styler filters each source of change and displays the
resolution in the property tabs. The resolution process involves:
• Identifying the values that affect the selected context, condition or property
set. The order of precedence is as follows:
1. Output specific properties
2. Output specific property sets
3. Base properties
4. Base property sets
• Determining whether the properties are explicitly set or derived.
• If the properties are derived, determining the source of the derivation.
When you place your cursor within an element in a document associated with the
stylesheet open in Arbortext Styler, Arbortext Styler selects the matching context
for the element. The element icon and matching context are highlighted in green
in the Elements list, along with any conditions that the element meets.
In Arbortext Styler, contexts can be fully or partially resolved. If a context is
partially resolved, properties that are set to inherit their value from an ancestor of
the current context will not show derived values, but will display the text

Working with Properties 227

<Derive>. In this case, Arbortext Styler is displaying the value for the context or
condition but without reference to its element ancestry. Arbortext Styler cannot
display values for some properties on the property tabs.
When a context is fully resolved, Arbortext Styler can carry out the following
actions to ascertain a property value:
1. Determine the conditions that are true for the element, allowing the property
tabs to display values from matching conditions that override the context's
values.
2. If the selected context does not have a value set for a particular property,
Arbortext Styler can derive that value from the context's ancestor. If a property
cannot be derived from an ancestor (refer to Deriving Property Values on page
223 for information), Arbortext Styler applies the property's default value.
When a context's properties are fully resolved, the property tabs display the
settings that will be used for the element selected in the Arbortext Editor
document when the document is published.
The Sets tab differs from the other property tables when resolving conditions. As
an example, suppose an element context uses property set A, and has a condition
that uses property set B. When the condition matches, both property sets will be
applied, as if the context referenced property set A and property set B. The Sets
tab, however, shows the context's property sets usage.

Example: Resolving property values

This example illustrates the difference between partial resolution and full
resolution of values on property tabs.
1. Open Arbortext Editor, and open the transport.xml document located at
Arbortext-path/samples/styler.
2. Choose Styler ▶ New Stylesheet. Arbortext Styler creates a stylesheet with
entries for all the elements in the document type.
3. In Arbortext Styler, locate the para element in the Elements list, expand it,
and select the para everywhere else context.
Refer to the Font tab. It displays the unresolved values for the context by
displaying the phrase <Derive> in each unresolved field.
4. In Arbortext Editor, click in the para element within the abstract element
at the top of the document. With your cursor still in the document, switch to
the Arbortext Styler window.
The para everywhere else context is selected in the Elements list, and
the resolved values for the context are displayed on the Font tab.

228 User's Guide

Explicit v Derived Property Values in
Arbortext Styler
The Arbortext Styler user interface displays values in various ways to help you
understand how they have been set.

Displaying property values

Arbortext Styler displays explicitly set and derived values in the associated
property field. When Arbortext Styler cannot determine the derived value of a
specific property, <Derive> will be displayed in the property field.
If you select multiple contexts, conditions, or property sets, or if you select an
item from the Outputs to edit list that includes more than one output, some
property values may differ among the selected objects. In this case, the property
fields appear in the indeterminate state, which is a blank field for most controls.

Finding explicit property values

Use the Edit ▶ Find Explicit Properties menu option to open the Find Explicit
Properties on page 962 dialog box. In this dialog box you can specify a property
and value then click Find to launch a search for all explicitly set occurrences of
that property in the stylesheet.

Label colors
The label colors on the property tabs vary depending on the source of the
property's value:
• Blue and bold — the value has been explicitly set (either directly or by
assigning a style).
• Orange and italic — the value differs for each of the selected objects or
outputs
• Black — the value has been derived from an ancestor, property set, condition,
base properties, or the Arbortext Styler default.
If you select multiple contexts, conditions, or property sets, or you select an item
from the Outputs to edit list that includes more than one output, a specific
property's value may differ among the selected objects. If the values of the objects
differ, the labels for the property fields will be orange (and italic), regardless of
whether or not any of the selected objects were explicitly set. The label is blue and
bold only if all selected objects have the same explicitly set value for a property.

Working with Properties 229

 Note
You can change the label color for explicitly set and indeterminate properties .
See set stylerexplicitfontcolor and set stylerindeterminatefontcolor commands
in Arbortext Command Language Reference help for further information.

Note
The label color will not be blue or orange for disabled properties. They will
still be bold and italic.

Description tab
The Description area describes explicitly set property values for an object and lists
any property sets referenced by a context, condition, or property set. For contexts
and conditions, the Description area includes and differentiates base property
settings and settings for other uses (if any). The description area is blank if you
select multiple objects from the same list.

Tool tips
Tool tips display when you place your cursor over a field in a category, indicating
the source of the value in the field.
• Derived or Derive - Indicates the value is derived.

○ Derived from - if a single item is selected the tool tip will indicate where
the value is derived from, if possible. Refer to Deriving Property Values on
page 223 for further information.
○ Derived - if multiple items are selected and they all derive the same value,
the tool tip says Derived. It is possible in this case that the value is derived
from various places.
○ Derived from Styler default - The value is derived directly from default
Arbortext Styler settings.
○ Derive - the derived value is not defined for this context, for example, if a
context will inherit a property value from its parent element. Arbortext
Styler has information about the source of the value, but not about the
value itself.
• Specified explicitly - Indicates that the value has been explicitly set. This value
may have been explicitly set by you or by assigning a style.

230 User's Guide

• Values differ among multiple selected objects and uses - Occurs when you
select multiple contexts, conditions, or property sets, or when the item selected
in the Outputs to edit list includes multiple uses.
• Value is both derived and explicit for selected objects and outputs - this tool tip
displays for a property field if all of the following conditions are true:
○ you have selected multiple objects, or the item you select in the Outputs to
edit list includes multiple uses.
○ the property's value is the same for all selected objects and uses.
○ the property is derived for some objects, and explicitly set for others.

Shortcut menus
Arbortext Styler provides shortcut menus to allow you to view and edit the source
(s) of a property value. To display a shortcut menu for a property value, place your
cursor over the field on the category, and right click. The content of the shortcut
menu depends on whether the value in the field is explicitly set or derived.
For example, if you explicitly set a property value, the shortcut menu may only
contain Derive. If you select Derive, Arbortext Styler removes the explicit setting,
resolves the value if possible, and displays either the derived value or <Derive> in
the property field.
If a property's value has been derived, the shortcut menu displays the derivation
chain. Refer to Deriving Property Values on page 223 for more information.
For example, if you click in a para element in a Arbortext Editor document, and
then right click on the Text color property in the Text category in Arbortext Styler,
a shortcut menu displays information of this nature::
Styler default
Context book everywhere
Context chapter everywhere
Context itemizedlist everywhere else
Context listitem in itemizedlist
This shortcut menu indicates that the value for the Color field was obtained from a
Arbortext Styler default. To obtain this value, Arbortext Styler performed the
following process:
1. Checked the parent of the para element (listitem in itemizedlist ),
which did not specify a color value.
2. Checked the parent of listitem in itemizedlist (itemizedlist
everywhere else), which did not specify a color value.
3. Checked the parent of itemizedlist everywhere else (chapter
everywhere), which did not specify a color value.

Working with Properties 231

4. Checked all other ancestor elements of the original context, as well as the
document-level element, none of which specified a color value.
5. Applied the value specified by the Arbortext Styler default to the property.
A shortcut menu with derivation sources is not always available when Arbortext
Styler cannot resolve the derivation chain. This can occur when you select
multiple objects (elements, contexts, conditions, or property sets) in Arbortext
Styler or if you select an option from the Outputs to edit list that includes two or
more uses. This is because the source of the property value may not be the same
for the selected objects or uses.
You can select items on the shortcut menu to edit the associated property in the
specified object in Arbortext Styler. The following table describes the process that
occurs when you select specific items on the shortcut menu.

Editing objects on the property shortcut menus

Item Description
Base (All Outputs) Selects the context or condition for
which Base (All Outputs) is specified,
Base (All Outputs) is selected in the
Outputs to edit list, and the description
and property tabs change to reflect the
context or condition's values.
Note
Use the Back button to return to the
previously selected object and use.
Condition Selects the condition in the Elements
list, and the description and property
tabs change to reflect the condition's
values.
Note
Use the Back button to return to the
previously selected object.
Context Selects the context in the Elements list,
and the description and property tabs
change to reflect the context's values.
Note
Use the Back button to return to the
previously selected object.

232 User's Guide

Editing objects on the property shortcut menus (continued)
Item Description
Property set Selects the property set in the Property
Sets list If you make changes to the
property set, the changes are reflected
in the appropriate fields on the property
tabs for all elements that reference the
property set..
Arbortext Styler default You cannot edit Arbortext Styler
defaults, so nothing happens when you
select this option.

The following example describes how to use the shortcut menu to edit a value
derived from a property set.
1. Open Arbortext Editor, and choose File ▶ Open.
2. Select the transport.xml document located at Arbortext-path/
samples/styler, and then click Open.
3. Choose Styler ▶ Edit Stylesheet. This is a read only stylesheet so you will need
to save a local copy if you want to make amendments.
4. In Arbortext Editor, click in the title element within the book element.
In Arbortext Styler, note that the title in book context is selected.
5. With the title in book context selected in Arbortext Styler, place your
cursor over the Text color property in the Text category, and right click.
6. Click on Property set Title color, which is the property set from
which the Text color field derived its value. The Property Sets list will open,
with the Title color property set selected.
7. In the Text category for the property set, change Text color to orange, and then
click OK.
8. Revert to the Elements list. Note that the title in book context is still
selected, but now the Text color field displays orange. The derived value
displays for the Text color field because it is derived from a property set.
9. Choose Preview ▶ Arbortext Editor.
10. In Arbortext Editor, scroll to the top of the document and note that the content
of the title element within the book element is now orange.

Modifying Properties
Once you have assigned a style to an element, you can modify its formatting
properties.

Working with Properties 233

To modify properties:
1. If you are in the Elements list (View ▶ List View ▶ Elements), select the
contexts, conditions, or elements (which selects all their contexts) whose
properties you want to modify.
If you are in the Property Sets list (View ▶ List View ▶ Property Sets), select the
property sets whose properties you want to modify.
2. Modify the properties for the selected items by making selections in the
property categories in the Category control.
If you select only one context, condition, or property set, values that are
changed display in the fields in the property categories.
If you select multiple contexts, conditions, elements, or property sets, values
that are changed are applied to all of the selected objects.
When multiple objects are selected, values are displayed in the property fields
only if they are identical for every object. .

Note
If you want to apply the same properties to a group of contexts, conditions, or
elements, you may want to use property sets as they are easier to maintain.
Refer to Property Sets Overview on page 256 for more information.

Applying Properties for Specific Outputs

You can use Arbortext Styler to configure stylesheets for different outputs (uses).
For example, you can create a stylesheet that has properties that are applied when
you are publishing HTML documents, while other properties can be applied when
you are publishing printed documents.
To apply properties to specific uses:
1. In the Elements list (View ▶ List View ▶ Elements), select the contexts,
conditions, or elements (which selects all its contexts) whose properties you
want to modify.
2. In the Outputs to edit list, select the appropriate use for the property you want
to add.
3. Set the properties you want to apply to the specific use as usual.
You may also follow this process for a property set from the Property Sets list.
You must then apply to the property set to the required elements/contexts/
conditions for its properties to have an effect.

234 User's Guide

 Note
Please read the notes below if configuring property sets when working with
FOSI source:
• FOSI property set edited source does not include Arbortext Editor or Print/
PDF output properties.
• FOSI edited source for contexts and conditions will contain resolved property
settings from output properties in any referenced property sets.
• Changes to property set output properties are not reflected in existing FOSI
edited source of elements and contexts that reference the changed property set.

Creating Output Sets in the Outputs to

Edit List
You can create sets of outputs in the Outputs to edit list, where you can add
multiple output types to a single set. You can then use a single click to specify that
a property assigned to an element should apply in the output types declared in the
set.

Note
You can only apply properties on the Gentext tab to one use at a time.
Therefore, if you select a combined entry from the Outputs to edit list, the
options on the Gentext tab will be unavailable.

To create an output set in the Outputs to edit list:

1. In the Arbortext Styler window, click on the down arrow to the right of the
Outputs to edit field, and select <Edit this list>.
2. In the Edit Uses List dialog box that opens, navigate to the Uses list and
highlight the output formats that you wish to add to the output set. Use the
CTRL key to select multiple outputs - for example, press CTRL and click
EPUB, Arbortext Editor, and RTF from the list.
3. Click Add to add the combined entry to the Preview of “Outputs to edit” list
field. The set is added to the list, with the members of the set listed in
alphabetical order.
4. In the Preview of “Outputs to edit” list field, note that there is now an entry
named EPUB Arbortext Editor, RTF.

Working with Properties 235

5. If you want to remove an entry from the Preview of “Outputs to edit” list field,
select the entry and click Remove.

Note
When you choose to remove a combined entry, it is deleted.

6. Click OK to save the set and exit the dialog box.

7. Navigate to the Outputs to edit field in the Arbortext Styler window and click
the down arrow. Note that the output set EPUB, Arbortext Editor, RTF is now
available. Select this entry when you want to give an element a property that
should apply in all three outputs in the set, but not others.

Hiding Element Content

You can suppress element content that you don't want to display in Arbortext
Editor or in output.

Example: Hiding Element Content Using the Hidden Style

The following example describes how to hide the content of the bookinfo
element at all times, by applying the Hidden style to the element.
1. In Arbortext Editor, open the transport.xml sample document located at
Arbortext-path/samples/styler.
2. Choose Styler ▶ Edit Stylesheet to open the associated stylesheet for edit. This
is a read only stylesheet so you will need to save a local copy.
3. In Arbortext Styler, select the bookinfo element from the Elements list.
4. Select the Hidden style from the Style dropdown list, accessed via the Edit ▶
Style menu option.
5. In Arbortext Styler, choose Preview ▶ Print.
6. In the Print Preview window, note that none of the content from the
bookinfo element is displayed.

Example: Hiding Element Content Using the Hidden Property and

Contexts
You may want to suppress certain elements or contexts of elements in a specific
output. The following example describes how to hide the content of the

236 User's Guide

bookinfo element when the final document is output to HTML. This is
achieved by creating a context for the element in HTML output and specifying
that its content should be hidden in that context.
1. In Arbortext Editor, open the transport.xml sample document located at
Arbortext-path/samples/styler.
2. Choose Styler ▶ Edit Stylesheet to open the associated stylesheet for edit. This
is a read only stylesheet so you will need to save a local copy.
3. In the Elements list, select the bookinfo element.
4. Select Block from the Style dropdown list, accessed via the Edit ▶ Style menu
option.
5. In Arbortext Styler, choose Preview ▶ HTML File.
6. When the page displays in the browser, note that the bookinfo content
displays at the top of the HTML page.
7. Back in Arbortext Styler, select the bookinfo everywhere context in the
Elements list.
8. Choose HTML File from the Outputs to edit field.
9. In the Text category for the context, set the value of the Hidden field to Yes.
10. Choose Preview ▶ HTML File.
11. When the page displays in the browser, note that the bookinfo content no
longer displays.
12. In Arbortext Styler, choose Preview ▶ Print.
13. In the Print Preview window, note the display of bookinfo content. That is
because the Hidden property was only applied to the bookinfo element in
its context in HTML output. The bookinfo element, and its content, will
still display in all other outputs.

Example: Hiding Element Content Using the Hidden Property and a

Condition
The following example describes how to hide graphics in a document when the
role attribute of the book element is set to a value of nograph. This is achieved
by creating a condition for the graphic elements based on a test for the attribute
value and specifying that graphics should not appear in the document when the
condition matches.
1. In Arbortext Editor, open the transport.xml sample document located at
Arbortext-path/samples/styler.
2. Choose Styler ▶ Edit Stylesheet to open the associated stylesheet for edit. This
is a read only stylesheet so you will need to save a local copy.

Working with Properties 237

3. In Arbortext Editor, click inside the book element at the top of the document,
and set the role=”nograph” attribute for the element.
4. In Arbortext Styler, select the inlinegraphic everywhere context, and
then choose Insert ▶ Condition to create a new condition for the element.
5. In the New Condition dialog box that opens, click New Attribute Test.
6. In the New Attribute Test dialog box that opens, activate the Ancestor option,
and select book from the drop down list.
7. Select role from the drop down list in the Attribute Name field.
8. In the Attribute value field, check the Includes whole word option and type
nograph in the text box to the right of the option.
9. Click OK to save the test and exit the dialog box. The attribute test “role” of
element “book” includes the whole word “nograph” is listed in the
Tests area of the New Condition dialog box.
10. Click OK to save the condition and exit the dialog box. In the Elements list,
note that you have created the condition If attribute “role” of
element “book” includes the whole word “nograph” for the
inlinegraphic everywhere context.
11. Highlight the condition you just created and go to the Text category.
12. Set the value of the Hidden field to Yes.
13. Select the graphic element in the Elements list, selecting all of its contexts.
14. Repeats steps 4–13 for the graphic element, to create the condition If
attribute “role” of element “book” includes the whole word
“nograph” for all contexts of the element.
You have now specified that no inlinegraphic or graphic elements
should be displayed in your document when the top level element of the
document, i.e. book, has the attribute role=”nograph” set.
15. Choose Preview ▶ Print.
16. In the Print Preview window, note that the document contains no graphics.
17. In Arbortext Editor, delete the role=”nograph” attribute from the book
element.
18. In Arbortext Styler, choose Preview ▶ Print again. In the Print Preview window,
note that the graphics now display as set.

238 User's Guide

Applying Prespace and Postspace to
Elements
You can apply prespace and postspace to an element using the options in the
Spacing category. Prespace is vertical space added before an element. Postspace is
the amount of vertical space added after an element.

Note
Prespace and postspace settings applied to empty elements are ignored. If you
wish to force a certain amount of vertical space in generated text, insert a User
Formatting Element (UFE) that is styled as a Block, and specify the required
Space Before or Space After setting for that UFE. The UFE must contain a
space, however, for the setting to have an effect, which in turn means that the
UFE's Line Spacing setting will also be effective. For this reason you should
ensure that the value of the UFE's Space Before / Space After setting plus its
value for Line Spacing add up to the required amount of vertical space.

For print and PDF output, spacing can be fixed or variable. Spacing is fixed when
the Minimum and Maximum values for Allow space to vary are omitted or are the
same as the Preferred value. Spacing is variable when the Minimum, Maximum,
and Preferred values are different. Variable spacing is used for vertical
justification, which is specified in the Columns category for a page set. Vertical
justification allows you to bottom-align columns. Variable spacing is also used by
the Desktop Composer to produce better looking pages when vertical justification
is not set.
Refer to Justifying columns on page 189 for more information on vertical
justification.

Specifying Precedence
Arbortext Styler allows you to specify a precedence associated with an element's
prespace and postspace. When one element applies prespace and an adjacent
element applies postspace, in most cases, only one of the values is used. The
precedence setting determines which element's spacing requirements are applied.
When a conflict occurs, Arbortext Editor and Arbortext Publishing Engine use the
value of the element with the highest precedence. If the precedences are equal,
Arbortext Editor and Arbortext Publishing Engine use the larger preferred amount.
Precedence values are none, low, medium, high, and force. The following table
describes the interaction between elements' prespace and postspace, and the role
precedence plays in determining the spacing value that Arbortext Editor and
Arbortext Publishing Engine apply.

Working with Properties 239

Prespace Precedence

Value Outcome
force The element's prespace takes
precedence over the preceding
element's postspace.
Note
Arbortext Editor applies the
combined preferred values for an
element's prespace and the
preceding element's postspace when
both are set to force.
high The element's prespace takes
precedence when the preceding
element's postspace precedence is set to
none, low, or medium.
medium The element's prespace takes
precedence when the preceding
element's postspace precedence is set to
none or low.
low The element's prespace takes
precedence when the preceding
element's postspace precedence is set to
none.
none The preceding element's postspace
always takes precedence, unless its
precedence is also none, in which case,
the one with the larger Preferred value
is used.

240 User's Guide

Postspace Precedence

Value Outcome
force The element's postspace takes
precedence over the following
element's prespace.
Note
Arbortext Editor applies the
combined preferred values for an
element's prespace and the
preceding element's postspace when
both are set to force.
high The element's postspace takes
precedence when the following
element's prespace precedence is set to
none, low, or medium.
medium The element's postspace takes
precedence when the following
element's prespace precedence is set to
none or low.
low The element's postspace takes
precedence when the following
element's prespace precedence is set to
none.
none The following element's prespace
always takes precedence, unless its
precedence is also none, in which case,
the one with the larger Preferred value
is used.
When an element's postspace precedence and the following element's prespace
precedence are the same, Arbortext Editor and Arbortext Publishing Engine apply
the larger of the two Preferred values.

Example: Applying Prespace and Postspace

The following example walks through applying prespace and postspace.
1. Open the transport.xml document located at Arbortext-path/
samples/styler, and then click Open.
2. Choose File ▶ Save As to create a local copy of transport.xml.
3. Choose Styler ▶ New Stylesheet.

Working with Properties 241

4. In Arbortext Styler, select the formalpara element in the Elements list, and
choose Formal Block from the Style list. The context title in
formalpara is automatically created for the title element.
5. Click on the title in formalpara context in the Elements list.
6. Go to the Spacing category.
7. Specify 1in in the Preferred field in the Spacing after group.
8. Choose None in the Precedence list.
9. Choose Preview ▶ Print.
10. In the Print Preview window, locate the title of the first formal paragraph. Note
that there is one inch of white space between the title and the following
paragraph.
11. In Arbortext Editor, click inside the para element following the title in
the first chapter.
12. Select the para everywhere else context then go to the Spacing
category.
13. Specify 3in in the Preferred field in the Spacing before group.
14. Choose None in the Precedence list.
15. Choose Preview ▶ Print.
16. In the Print Preview window, locate the title of the first formal paragraph. Note
that there is now three inches of white space between the title and the
following paragraph. This is because an PTC Arbortext print publishing action
uses the larger Preferred value if no precedence level is set.
17. With the title in formalpara context selected in Arbortext Styler, go to
the Spacing category.
18. Set the Precedence field in the Spacing after group to low.
19. Choose Preview ▶ Print.
20. In the Print Preview window, locate the title of the first formal paragraph. Note
that there is now only one inch of white space between the title and the
following paragraph. This is because an PTC Arbortext print publishing action
uses the prespace value on the para everywhere else has a precedence
of low while the postspace value on the title in formalpara context has
no precedence level set.
21. With the title in formalpara context selected in Arbortext Styler, go to
the Spacing category.
22. Set the Precedence field in the Spacing after group to force.
23. Select the para everywhere else context, and set the Precedence field in
the Spacing before group to force.

242 User's Guide

24. Choose Preview ▶ Print.
25. In the Print Preview window, locate the title of the first formal paragraph. Note
that there is now four inches of white space between the title and the following
paragraph. When an element's postspace precedence and the following
element's prespace precedence are both set to force, PTC Arbortext print
publishing applies the combined Preferred values.

Prespace in tables in RTF output

Microsoft Word does not apply prespace to tables, only to paragraphs. You may
find that a table that has a prespace setting still runs into preceding content or
tables when a RTF document is opened in Word. To ensure that prespace is
maintained, apply it in the stylesheet to a paragraph in generated text before the
table, using the following steps:
• For the required table context, create generated text using the Before-text
option.
• Create or insert a User Formatting Element (UFE) as the generated text. The
UFE must be styled as Block.
• Apply the required prespace setting to the default context of the UFE.
When you publish the document, the prespace will be applied to the table in RTF
output. Note that the total resulting space will be the height of the empty
paragraph UFE, as determined by its line spacing setting plus the height of its
prespace.
This solution applies to both standard and custom tables.

Initial Properties and Property Sets

Applied by Styles
When you create a new stylesheet using the Styler ▶ New Stylesheet menu option
in Arbortext Editor, Arbortext Styler automatically creates property sets that are
used when setting initial element styles.
The property set names often begin with the style they apply to, for example, the
Title 1 property is applicable to the Title style.
You can modify the properties for these styles, remove these property sets from
element styles, and use them to style other elements just as you would with any
property set you define.
To see the list of property sets created by Arbortext Styler:
1. Open the transport.xml document located at Arbortext-path/
samples/styler.
2. Choose File ▶ Save As to create a local copy of transport.xml.

Working with Properties 243

3. Choose Styler ▶ New Stylesheet.
4. In Arbortext Styler, select the Property Sets category. Available property sets
shows the property sets created by Arbortext Styler.
5. To view the properties in a specific property set, click on the name in the
Available property sets list and press the Edit button.

Arbortext Styler Usability Aids

Arbortext Styler makes use of configurable color options in the user interface to
make it easier to identify important settings made in a stylesheet.
This section identifies the specific uses of color and the associated commands for
changing the color settings. In all cases where a color is used for distinguishing a
change, the font is also modified in another way, for example, bold or italic, so
that color is not the only method of identification.
Interface Description Command
Property category The label of a category changes set
stylerexplicitfontcolor -
labels to blue and bold when a
see set
property is explicitly set in that
stylerexplicitfontcolor in
category. For example, if you
Arbortext Command
explicitly set the spacing before
Language Reference
and after an element, the word
Spacing on the Spacing category
will be blue and bold. This helps
you easily locate the categories
that contain explicit property
settings.
Property labels Labels for individual properties set
stylerexplicitfontcolor -
change to blue and bold when
see set
the property is explicitly set. For
stylerexplicitfontcolor in
example, if you set the
Alignment property in the Indent Arbortext Command
category to Left , the word Language Reference
Alignment will be blue and bold.
This helps you easily identify
any properties that you
explicitly set.
Outputs to edit Most stylesheet editing is done set
stylernotbasefontcolor -
label with the Outputs to edit field set
see set
to Base (All Uses). If you set the
Outputs to edit field to any value stylernotbasefontcolor in
besides Base (All Uses), the Arbortext Command
Outputs to edit label turns red Language Reference

244 User's Guide

Interface Description Command
and bold as a visual reminder
that you have changed your
selection to a more specific
value.
Unstyled element When you preview the output of set
stylerunstyledfontcolor
preview a stylesheet, if Options ▶
Highlight Unstyled Elements is and set
stylerunstyledfontshad
set, the output displays the name ing - see set
of any element whose style is stylerunstyledfontcolor and
Unstyled, or that is missing from set
the stylesheet, in a blue font stylerunstyledfontshading
with red shading. in Arbortext Command
Language Reference
Indeterminate When you select multiple set
stylerindeterminatefont
properties contexts, conditions or property color - see set
sets, the value displayed for a stylerindeterminatefontcol-
property may be indeterminate. or in Arbortext Command
For example, if you select two Language Reference
title contexts, the font size in
one may be 12pt while the other
is 24pt. In this situation, the
property label Size is orange and
italic.
Generated text Special constructs in the set
Generated Text Editor, such as stylergentexttagfontcol
constructs or and set
the page number indicator, are stylergentexttagshading -
displayed as a special tag with see set
brown font and yellow shading. stylergentexttagfontcolor
and set
stylergentexttagshading in
Arbortext Command
Language Reference

Working with Properties 245

 8
Property Value Precedence in
Arbortext Styler
Understanding How Arbortext Styler Determines Property Values ............................... 248
Processing Order During Publishing ......................................................................... 248
Processing Order in Arbortext Styler ......................................................................... 249

This section summarizes the order in which properties are analyzed and applied
when Arbortext Styler processes a stylesheet.

247
Understanding How Arbortext Styler
Determines Property Values
There are several ways in which properties can be assigned to elements, contexts,
conditions and property sets in Arbortext Styler - some of which take precedence
over others depending on the position in which they are applied or the
circumstances in which they are read. By understanding the precedence that a
certain instance of a property value can take over another, you will be able to
tailor your stylesheets, modules and property sets to meet any individual output or
formatting requirement.
The processing of a document takes place in two main strands:
• Processing order: the order in which Arbortext Editor matches and processes
the elements, contexts and conditions it encounters in the document. See
Processing Order During Publishing on page 248 for further information.
• Processing order in Arbortext Styler: the order in which properties associated
with each one of the objects described above are applied, and the priority
given to conflicting properties associated via different means or for different
output methods. See Processing Order in Arbortext Styler on page 249 for
further information.

Processing Order During Publishing

The following procedure describes how Arbortext Editor processes contexts and
conditions to determine property values when publishing a document.
1. Arbortext Editor starts processing the document using the Arbortext Styler
default settings.
2. For each element, Arbortext Editor determines which context of the current
element is the best match based on the current position in the document. See
Context Priority on page 282 for details on context priorities.
3. Once Arbortext Editor selects a context for an element in the document, it
processes the context's base properties, applied via the Base (All Outputs)
option.
First, all property sets referenced by the context's base properties are merged
in the order referenced, from top to bottom, as they appear in the Property Sets
list in Arbortext Styler. For a property set being merged, any property sets
that it references are first merged, again in the order referenced. When
merging occurs, any property that is specified becomes the current value for
that property in the property set, overriding any previous value.

248 User's Guide

 The context's base properties are merged into the result of the previous step.
Again, any property that is specified becomes the current value for that
property in the property set, overriding any previous value.
4. Once a context's base properties have been processed, Arbortext Editor
processes the context's output-specific properties for the output being
published.
First, all property sets referenced by the output-specific properties are merged
in the order referenced, from top to bottom, as they appear in the Property Sets
list in Arbortext Styler. For each property set being merged, any property sets
that it references are first merged, again in the order referenced.
Then the output-specific properties are merged with the base properties
resulting from step 4. Any property specified as part of the output-specific
properties becomes the current value for that property, overriding any previous
value.
5. Finally, Arbortext Editor evaluates a context's conditions. If a condition is true,
Arbortext Editor overlays the properties of that condition on the previous
results. Arbortext Editor first processes the condition's base properties and
then its output-specific properties. All true conditions are processed in the
order they are specified in the Elements list in Arbortext Styler. You can
modify the order of a condition (and hence its position in the processing order)
by selecting it in the Elements list and pressing either the up or down arrow in
the Elements toolbar to move the condition up or down in the list, or the right
or left arrows to increase or decrease its nesting level.

Property sets associated with conditions are processed via the same logic as
for contexts.

Processing Order in Arbortext Styler

This section discusses how the order in which each element's properties are
processed in Arbortext Styler.

Contexts
This section describes how Arbortext Styler resolves and displays property values
when you select a context. There are two cases - when Arbortext Styler can fully
resolve the context, and when Arbortext Styler can only partially resolve the
context. Refer to Resolving Property Values on page 227 for further information.
The following steps describe how to fully resolve property values. There are two
variants on partial resolution:

Property Value Precedence in Arbortext Styler 249

• References to the resolution of conditions are ignored if Options ▶ Resolve
Conditions is turned off.
• If you have selected a context in the Elements list in Arbortext Styler, the
process is the same as for full resolution except:
○ Steps that examine conditions are skipped.
○ Steps that start “if the property can be derived from an ancestor:” are
skipped. Instead, properties without values at that point remain unresolved.

Base (All Outputs)

If the Outputs to edit field is set to Base (All Outputs), the possible sources of a
property's value, and their order of precedence, are shown in the following list.
Arbortext Styler examines each possible source in the order shown, and stops
when it finds a value for the property.
1. Examine conditions from last to first, and for each one that is true:
a. Determine if there is an explicit setting in the condition's base properties.
b. Examine the property sets that the condition's base properties use, from
last to first, and, for each property set, determine if it sets the property
value.
See Context Priority on page 282 for details on context priorities.
2. Determine if there is an explicit setting in the context's base properties.
3. Examine the property sets that the context's base properties use, from last to
first, and, for each property set, determine if it sets the property value.

Note
Arbortext Styler follows the processing order described in Property sets
below for each property set.

4. If the property cannot be derived from an ancestor, Arbortext Styler applies

the property's default value.
5. If the property can be derived from an ancestor:
a. In the Arbortext Editor document, Arbortext Editor finds the parent
element of the element whose context is being resolved. Arbortext Editor
then finds the matching context for that element in the stylesheet, and
searches for the property's value in that context using the same rules as
described here, starting at step 1 above.
b. If no value is set for the property after Arbortext Styler examines all the
parent elements, Arbortext Styler applies the property's default value.

250 User's Guide

Outputs Other Than Base (All Outputs)
If the Outputs to edit field is set to a value other than Base (All Outputs), the
possible sources of a property's value, and their order of precedence, is as shown
below. Arbortext Styler examines each possible source in the order shown, and
stops when it finds a value for the property.
1. Examine conditions from last to first, and for each condition that is true:
a. Determine if there is an explicit setting in the condition's use-specific
properties for the selected use.
b. Examine the property sets that the condition's use-specific properties
reference, from last to first, and, for each property set, determine if it sets
the property value.
c. Determine if there is an explicit setting in the condition's base properties.
d. Examine the property sets that the condition's base properties reference,
from last to first, and, for each property set, determine if it sets the
property value.
See Context Priority on page 282 for details on context priorities.
2. Determine if there is an explicit setting in the context's use-specific properties
for the selected use.
3. Examine the property sets that the context's use-specific properties reference,
from last to first, and, for each property set, determine if it sets the property
value.
4. Determine if there is an explicit setting in the context's base properties.
5. Examine the property sets that the context's base properties use, from last to
first, and for each property set, determine if it sets the property value.
6. If the property cannot be derived from an ancestor, Arbortext Styler uses the
property's default value.
7. If the property can be derived from an ancestor:
a. In the document, Arbortext Editor finds the parent element of the element
whose context is being resolved. Arbortext Editor then finds the matching
context for that element in the stylesheet, and searches for the property's
value in that context using the same rules as described here, starting at step
1 above.
b. If no value is set for the property after Arbortext Styler examines all the
parent elements, Arbortext Styler applies the property's default value.

Note
When examining property sets, Arbortext Styler follows the processing order
described in Property sets below for each property set.

Property Value Precedence in Arbortext Styler 251

Conditions
This section describes how Arbortext Styler resolves and displays property values
when you select a condition in Arbortext Styler.

Base (All Outputs)

If the Outputs to edit field is set to Base (All Outputs), the possible sources of a
property's value, and their order of precedence, are shown in the following list.
Arbortext Styler examines each possible source in the order shown, and stops
when it finds a value for the property.
1. Determine if there is an explicit setting in the condition's base properties.
2. Examine the property sets that the condition's base properties use, from last to
first, and, for each property set, determine if it sets the property value.

Note
Arbortext Styler follows the processing order described in Property sets
below for each property set.

At this point, properties without values remain unresolved. Refer to Resolving

Property Values on page 227 for information on resolving property values.

Outputs Other Than Base (All Outputs)

If the Outputs to edit field is set a value other than Base (All Outputs), the possible
sources of a property's value, and their order of precedence, are shown in the
following list. Arbortext Styler examines each possible source in the order shown,
and stops when it finds a value for the property.
1. Determine if there is an explicit setting in the condition's use-specific
properties for the selected use.
2. Examine the property sets that the condition's use-specific properties
reference, from last to first, and, for each property set, determine if it sets the
property value.

Note
Arbortext Styler follows the processing order described in Property sets
below for each property set.

252 User's Guide

3. Determine if there is an explicit setting in the condition's base properties.
4. Examine the property sets that the condition's base properties use, from last to
first, and, for each property set, determine if it sets the property value.

Note
Arbortext Styler follows the processing order described in Property Sets
below for each property set.

At this point, properties without values remain unresolved. Refer to Resolving

Property Values on page 227 for information on resolving property values.

Property Sets
This section describes how Arbortext Styler resolves and displays property values
when you select a property set in Arbortext Styler.
The possible sources of a property's value, and their order of precedence, are
shown in the following list. Arbortext Styler examines each possible source in the
order shown, and stops when it finds a value for the property.
1. Determine if there is an explicit setting in the property set's properties.
2. Examine the property sets that the property set references, from last to first,
and, for each property set, determine if the referenced property set specifies
the property value. Follow the processing order described here for each
property set, starting with step 1.
At this point, properties without values remain unresolved. Refer to Resolving
Property Values on page 227 for information on resolving property values.

Property Value Precedence in Arbortext Styler 253

 9
Creating and Applying Property
Sets
Property Sets Overview ........................................................................................... 256
Working with Property Sets ...................................................................................... 256
Applying Property Sets ............................................................................................ 258
Property Sets Example ............................................................................................ 261

This section describes how to create and manage property sets in your stylesheet,
and apply them to the elements in the stylesheet to produce the desired formatting.

255
Property Sets Overview
Property sets are predefined sets of formatting properties that can be applied to
contexts or conditions, or combined to create additional property sets. You can use
property sets to modularize your stylesheet, making it easier to maintain.
For example, you may have ten elements in your DTD or schema that you want to
format in the same way - 10pt, italic, and red. You can apply these properties to
each element individually. However, if you want to change the point size from
10pt to 11pt, you must change the point size for each of the ten elements.
If you configure a property set that incorporates these three properties, you can
change the point size in the property set, and Arbortext Styler applies this change
to all elements that reference the property set.

Note
Property values set by a property set do not override property values that are
explicitly set for an element.

You can use the Outputs to edit field on page 787 to configure output-specific
properties to be applied with a property set.
The order of property sets is important if you apply more than one property set to
an element and the property sets have conflicting values for a property. The value
from the last property set that sets a value takes precedence.

Note
Property sets correspond to FOSI charsubsets, and are closely related to XSL
attribute-sets.

Working with Property Sets

Property sets are created and managed via the Property Sets view.
When you select a property set in the view, the Description field displays the
values given to the selected property set.

256 User's Guide

Creating Property Sets

1. In Arbortext Styler, click the Property Sets view tab. The Property Sets list
displays in the top portion of the Arbortext Styler window. This list contains
all the property sets configured for the stylesheet, if there are any.
2. Choose Insert ▶ Property Set.
This adds a property set named NewPropertySet to the Property Sets list,
and it is selected for editing.
3. Provide a descriptive name for the new property set, and press ENTER. The
new property set is added to the list in alphabetical order.
4. Specify the formatting properties you want to include in the property set using
the property categories in the lower section of the window.
The property set you just created does not display in the Available property sets
list from the Property sets category, because a property set may not reference
itself.

Editing Property Sets

1. In the Property Sets list, select the property sets you want to edit
2. Make the necessary changes with the property categories in the lower half of
the window.

Renaming Property Sets

Renaming property sets allows you to change the name of a property set and all
references to it.
1. In Arbortext Styler, choose the Property Sets tab.
2. Select the property set you want to rename, and then click on it again.
3. With the property set selected for editing, type the new name, and then press
ENTER. The property set is moved to its new alphabetic position in the list
When you rename a property set, Arbortext Styler automatically changes all the
references to the new name, including those references in modules associated with
the stylesheet. You will see a warning to this effect when you elect to rename a
property set:

Creating and Applying Property Sets 257

 Note
If you have edited XSL or FOSI source for an element that references the
renamed property set, you must manually change the attribute-set references
(XSL) or charsubset references (FOSI) in the edited source to point to the new
name.

Deleting Property Sets

You may delete property sets that you no longer need.

1. In the Property Sets view, select the property sets you want to delete from
the Property Sets list, right click and select Delete.
2. For each property set being deleted, a message displays indicating the number
of references to it in the stylesheet.

Choose Yes or No to confirm whether or not you wish to delete the property
and all references to it in the stylesheet, where possible.

Applying Property Sets

To Apply a Property Set to Elements, Contexts or Conditions
Use the Property sets category for the Elements list to select the property set
to be applied to an element, context or condition.
1. Select the elements, contexts, or conditions to which you want to apply the
property sets. Note that if you select an element, the property set will be
applied to the element and all of its contexts (but not its conditions).

258 User's Guide

 Note
If you select multiple contexts or conditions that reference different
property sets, you cannot make any changes to properties in the Property
sets category.

2. Use the Outputs to edit field to specify the output(s) in which the property set
will be applied to the object.
3. Click on the Property sets category.
4. Select one or more property sets, and then click Add. The property sets are
moved to the Used Property Sets list.
5. If you want to change the location of the new property set in the Used Property
Sets list, click the up or down arrows.

Note
The order of property sets is important if you include property sets that
each contain values for the same property. The values of the last property
set take precedence over the others.

6. To ensure that the element looks the way you intended, choose a preview
option from the Preview menu.

Note
When a single property set is selected in either the Available property sets list,
or the Used property sets list from the Property sets category, the Description
area for the Property sets category reflects the selected property set's values.

To Apply a Property Set to Another Property Set

Use the Property sets category for the Property Sets list to select the property
set to be applied to another property set.
1. Select the property set to which you want to apply another property set.
2. Use the Outputs to edit field to specify the output(s) in which a property set
will be applied to the selected property set.
3. Click on the Property sets category.

Creating and Applying Property Sets 259

4. Select one or more property sets, and then click Add. The property sets are
moved to the Used Property Sets list.
5. If you want to change the location of the new property set in the Used Property
Sets list, click the up or down arrows.

Note
The order of property sets is important if you include property sets that
each contain values for the same property. The values of the last property
set take precedence over the others.

6. To ensure that the element looks the way you intended, choose a preview
option from the Preview menu.

Example: Creating Output-Specific Properties with Property Sets

This example shows how to use property sets to configure titles in your stylesheet
to be displayed in blue text in all outputs except print. Titles will be output in
black text in print output.
Once you have set up the property sets, you only need to make a single reference
for each title context to provide the required outputs.
1. Create a property set Title color.
2. Configure the property set for multiple outputs as follows:
• Base (All Outputs) — use the Text category to set the text color to blue.
• Print/PDF output — use the Text category to set the text color to black.
3. For each title context, reference the Title color property set from the
Property sets category.
To subsequently change the text color for titles in HTML outputs to red, make the
relevant change to the Title color property set and it will automatically
propagate to all the title contexts. You will not need to reference a new property
set for all HTML outputs.
1. Access the Title color property set.
2. Make the following changes to the property set:
• Use the <Edit This List...> feature of the Outputs to edit control to create a
group of all HTML outputs.
• Select this new group in the Outputs to edit control for the property set.
• Use the Text category to set the text color to red.

260 User's Guide

Property Sets Example
Example: Creating Property Sets
This example walks you through creating, applying, renaming, and deleting a
property set.
1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/styler.
2. Choose Styler ▶ New Stylesheet to create a new stylesheet.
3. In the Elements list , select the year element.
4. Give the element the Inline style, by selecting it from the Style list accessed
via the Edit ▶ Style menu option.
5. Choose Insert ▶ Property Set. The Property Sets list opens, with a new
property set named New Property Set added to the list.
6. Click again on the new property set and type Arial-Orange in the Name
field. You will see the Arbortext Styler message warning that renaming a
property set will affect all definition and references in the stylesheet. Click OK
to proceed with the rename action.
7. In the Text category, select Arial from the Font family list.
8. Select orange from the Text color list.
9. Open the Elements list and select the year element.
10. Use the Outputs to edit field to specify the output(s) in which the property set
will be applied to the object.
11. In the Property sets category, select the Arial-Orange property set in the
Available property sets list.
12. Click Add to copy the property set to the Used property sets list.

Creating and Applying Property Sets 261

 This completes the assignment of the property set to the year element.
13. Choose Preview ▶ Arbortext Editor, and note that the year element in the
document is orange.
14. Open the Property Sets list and select the Arial-Orange property set.
Click on it again, rename it fontarial-colororange, and then press
ENTER.
15. Open the Elements list and select the year element.
16. Go to the Property sets category, and note that the Used Property Sets list for
the year element now includes the fontarial-colororange property
set.
17. With the year element still selected in the Elements list, go to the Text
category, and select purple from the Text color list. This explicitly sets the
color for the year element to purple and overrides the property set value of
orange.
18. Choose Preview ▶ Arbortext Editor, and note that the year element in the
document is now purple.
19. Open the Property Sets view. Select the fontarial-colororange
property set, right click and select Delete. A message indicates the number of
places in which the property set is referenced. Select Yes to delete the property
set.

262 User's Guide

 10
Working with Elements in Your
Stylesheet
Elements Overview ................................................................................................. 264
Adding New Elements to Your Stylesheet .................................................................. 271
Keeping Elements Together ..................................................................................... 274
Elements and Document Types ................................................................................ 278
Configuring a Graphic Element................................................................................. 278

This section describes the types of element that can be included in a stylesheet,
and how to manage them.

263
Elements Overview
You can use Arbortext Styler to format many different types of elements as
described below:
• Elements declared in a DTD or schema
• Undeclared elements
• Namespaced elements
• Elements in a free-form XML document
• Styler Formatting Elements (SFE)
• User Formatting Elements (UFE)

Declared and Undeclared Elements

A declared element is one that is declared in a DTD or schema. If an element is
not declared in a DTD or schema, it is an undeclared element. Undeclared
elements can appear anywhere inside the root of an XML document because they
are not governed by the rules of the DTD or schema. However, when a stylesheet
is created from a document type, it will not contain any undeclared elements.
To add undeclared elements from your document, choose Insert ▶ Element and
create the new element with the name you require. You will see a message
warning you that the element is not declared in the DTD:

Namespaced Elements
XML (optionally) allows for element names to exist within a declared namespace.
An element in a document can be namespaced via two mechanisms:
1. Its name may be written with an explicit prefix (separated from the element's
name by a colon), for example ns:elementname
2. It may be unprefixed but be within the scope of a default namespace
declaration. Certain document types define a default namespace so that all
elements within that document type are namespaced.
When an Arbortext Styler stylesheet is written for a set of namespaced elements,
all those elements will be prefixed in the stylesheet regardless of whether they are
usually prefixed in a document of this doctype or not.

264 User's Guide

When you add namespaced elements to a stylesheet, the element names in the
stylesheet can be generated according to the following rules
• If the namespaced element is in the document type's default namespace,
Arbortext Editor displays the element without a prefix, but Arbortext Styler
adds a special prefix to the name ( _: ). For example, Arbortext Styler would
change html to _:html.
• If the namespaced element has a prefix, Arbortext Styler uses the prefix in the
stylesheet. For example, ns:graphic will be added as ns:graphic.
• If you enter a prefixed/namespaced element or attribute with a prefix from
which Arbortext Styler cannot determine a unique namespace declaration,
Arbortext Styler will prompt you to enter the namespace name (URI) by
presenting the Add Namespace Declarations dialog box. If you enter a URI
that is already associated with another prefix, that existing prefix will be used.
• You may not enter _gte: or _sfe: as a namespace prefix, since these are
reserved in Arbortext Styler to represent generated text elements or Styler
Formatting Elements it generates or uses.
• Arbortext Styler will use a different prefix than the one specified in the
document if the prefix has already been defined in the stylesheet. So, for
example, Arbortext Styler may change ns:figure to ns3:figure.
The use of modular stylesheets means that there is a potential for conflicts in
namespace declaration in a single stylesheet:
• Different prefixes mapped to the same namespace URI
• Same prefix mapped to different namespace URIs (note: this is not legal
according to the XML Namespace specification)
In the former case Arbortext Styler attempts to determine the correct namespace
URI for any prefix and thereby maintain the expected precedence relationship
between element definitions of namespaced elements. This is carried out when a
stylesheet is loaded via a validation procedure, which ensures that namespace
declarations from the user document or document type are declared in all modules
of the stylesheet. It also checks that namespace declarations from each module in
all other modules of the stylesheet. In the event that a conflict is detected,
Arbortext Styler renames the prefix for the declaration being added and provides
you with a message that confirms that the rename has taken place. Arbortext
Styler will largely continue to work correctly with renamed prefixes. In the latter
case, though, Arbortext Styler will issue an error if it encounters any such
occurrences. It is essential that conflicts of this nature are corrected as soon as
possible. – it will be easier for you to recognize and track element names in the UI
if namespace prefix usage is kept consistent.
When working with a modularized stylesheet, if two modules in a single
stylesheet use different prefixes for the same namespace this will have an effect on
the order in which elements are listed in the Elements list. Since elements are

Working with Elements in Your Stylesheet 265

displayed with the prefix for the namespace that applies in the module in which
the element definition occurs, definitions for the same element may not be
displayed adjacent to each other in the list. Their precedence relationship will be
maintained, however.

Elements in a Free-Form XML Document

If you are creating a stylesheet for a free-form XML document, Arbortext Styler
adds all elements in the document to the stylesheet. Because a free-form XML
document has no content model, any element can be the parent, ancestor, or child
of any other element.
There are no declared attributes for elements in free-form XML documents.
However, Arbortext Editor tracks the list of attributes it has seen for each element.
Arbortext Styler uses this list of attributes anywhere you are allowed to select an
attribute (for example, in the Attribute Test dialog box for context setup). You are
also allowed to type the name of an attribute (in case the attribute you want has
not been used on the selected element).

Styler Formatting Elements

Styler Formatting Elements (SFE) are predefined elements in the stylesheet that
are defined in their own namespace. Arbortext Styler uses SFEs to mark up certain
constructs in generated text and control the formatting of the generated text they
enclose, for example:
• Cross references
• Links
• Headers and footers
• Indices
• Tables of contents: note that SFEs only apply to inline tables of contents
(TOC) produced via generated text for an element, not those used to contribute
to PDF bookmarks on online TOCs
• Repeating titles
To display all the SFEs configured for your stylesheet in the Elements list, activate
the View ▶ Styler Formatting Elements menu option.
Since the SFEs available for a stylesheet are predefined for that stylesheet, you are
not permitted to create new SFEs or rename existing SFEs in your stylesheet. You
also may not change the style assigned to a SFE, since this is part of its definition
in the stylesheet. You can, however, delete an SFE from the stylesheet or modify
its formatting properties, as you would a normal element.

266 User's Guide

Note that, whilst the generated text constructs listed above generally have their
own property categories, dialog boxes, or menu options in which you can set
certain properties, the SFE allows you to apply a much more detailed control on
the object's appearance in generated text. For example, the Table of Contents
Format and Table of Contents Format Details dialog boxes contain options to
configure the following properties for the table of contents format objects
configured in your stylesheet:
• Table of Contents Format dialog box: indent setting for levels, and display of
age numbers, leaders and space
• Table of Contents Format Details dialog box: settings for display of labels,
numbering and spacing for individual entries
When you work with the Styler Formatting Elements _sfe:TocXXX, however,
you have access to all the options available to regular elements for the setting of
formatting properties. There is an SFE for each individual component of each
table of contents format object, which allows you even greater control over its
appearance when used in generated text. Each SFE displays the same formatting
property categories as a regular element in the Elements list:
• Text properties: see Text Category on page 787 for information
• Indent settings: see Indent Category on page 795 for information
• Spacing properties: see Spacing Category on page 800 for information
• Breaks: see Breaks Category on page 804 for information
• Generated text: see Generated Text Category on page 818 for information
• Property sets: see Property Sets Category on page 820 for information
• Footnotes: see Footnote Category on page 821 for information
• Side by side placement: see Side by Side Category on page 825 for
information
• PDF tags: see PDF tags Category on page 831 for information
• HTML tags: see HTML tag Category on page 834 for information
• RTF properties: see RTF Category on page 838 for information

Example: Using SFEs to Style a Table of Contents Format Object

This example demonstrates how to set formatting properties for the Book Table
of Contents format object and an override for its second level entries.
Note that this process will only have an effect for inline tables of contents (TOC)

Working with Elements in Your Stylesheet 267

produced via generated text for an element, not those used to contribute to PDF
bookmarks on online TOCs (see Table of Contents Overview on page 352 for
further information).
1. In Arbortext Editor, open the file transport.xml located at
Arbortext-path/samples/styler.
2. Note that the toc element generates a table of contents at the beginning of the
document, before the first chapter.
3. Choose Styler ▶ Edit Stylesheet to open the associated stylesheet for edit. This
is a read only stylesheet so you will need to save a local copy if you want to
make amendments.
4. In the Elements list, highlight the toc everywhere context. Navigate to the
Generated text category for the context. You will see in the After-text field that
the context is set to use the Book Table of Contents object to generate a
table of contents.
5. Still in the Elements list, highlight the SFE _sfe:TocBook_Table_of_
Contents. Refer to the Description tab and you will see that the purpose of
this element is to wrap the Book Table of Contents table of contents
format object.
6. In the Text category for the context, set the Font family field to Arial and the
Text color field to Blue. Here you have selected a default font style and color
for the whole table of contents.
7. Back in the Elements list, highlight the SFE _sfe:TocEntry2_Book_
Table of Contents. Refer to the Description tab and you will see that the
purpose of this element is to wrap all second level entries in a table of contents
based on the Book_Table_of_Contents object.
8. In the Text category for the element, set the Text color field to Red. Here you
have set a font color for the second level table of contents entries only, which
will override the font color setting specified for all other text in the table of
contents in the _sfe:TocEntry2_Book_Table of Contents element.
9. In the Spacing category for the element, set the value of the Preferred option
in the Spacing before field to 40pt. Here you have specified that second level
table of contents entries should be separated from the preceding first level
element by 40pt.
10. Choose Print ▶ Preview. In the Print Preview window, refer to the table of
contents at the beginning of the document and note that most of the entries are
colored blue, with the exception of the second level entries which are colored
red. There is a large space between second level entries and their preceding
first level entry.

268 User's Guide

User Formatting Elements
User Formatting Elements (UFE) are elements that you define in your stylesheet
and insert into generated text to control the formatting of the generated text they
enclose. Once created, you configure UFEs in the same way as Styler Formatting
Elements (SFE), but their intended use is slightly different. An SFE is associated
with one particular type of element, although Arbortext Styler might add new
occurrences of the same SFE for each occurrence of the object it styles in the
document. A UFE, however, is used to create a set of formatting properties that
can be applied to any type of element in generated text. Note also that, while there
is a finite number of SFEs configured for the stylesheet and you are not permitted
to create new ones, you can create and manage as many UFEs as you wish to
support the various formatting requirements for your stylesheet.
To display all the UFEs configured for your stylesheet in the Elements list,
activate the View ▶ User Formatting Elements menu option.
You can work with a UFE in exactly the same ways that you can with a regular
element - create, delete, rename, and apply properties and styles. To create a new
UFE, use one of the following methods:
1. In the Elements list, elect to create a new element as usual, by choosing Insert
▶ Element. Name the element with the _ufe: namespace prefix and
Arbortext Styler will recognize it as a User Formatting Element.
2. In the Generated Text Editor, choose the menu option Insert ▶ User Formatting
Element ▶ (new) and add the name of the new UFE in the resulting New User
Formatting Element dialog box. You may carry out this action either to insert
the new UFE as a standalone element in generated text, or to have it wrap
another element for formatting purposes. With this method you can create and
insert the UFE in single process.

Note
You cannot assign the Cross Reference, Graphic, Link or Link Target styles to
a UFE. These styles work with attributes, and you cannot create attributes for
UFEs. You also cannot assign the Document and Division styles to a UFE.

As with Styler Formatting Elements, you have access to all the options available
to regular elements for the setting of formatting properties. The UFE displays the
same formatting property categories as a regular element in the Elements list:
• Text properties: see Text Category on page 787 for information
• Indent settings: see Indent Category on page 795 for information
• Spacing properties: see Spacing Category on page 800 for information
• Breaks: see Breaks Category on page 804 for information

Working with Elements in Your Stylesheet 269

• Generated text: see Generated Text Category on page 818 for information
• Property sets: see Property Sets Category on page 820 for information
• Footnotes: see Footnote Category on page 821 for information
• Side by side placement: see Side by Side Category on page 825 for
information
• PDF tags: see PDF tags Category on page 831 for information
• HTML tags: see HTML tag Category on page 834 for information
• RTF properties: see RTF Category on page 838 for information

Example: Using UFEs to Style an Index Title

This example demonstrates how to set formatting properties for the titles of
indexes in your documents. Note that, while you can set general properties for the
indexes created in your document via the Tools ▶ Format Index menu option, these
steps will create formatting properties that can be applied to the individual
components of an index, as well as to any other element in the stylesheet as
applicable.
1. In Arbortext Editor, open the file transport.xml located at
Arbortext-path/samples/styler.
2. Note that the index element generates an index at the end of the document.
The index is in three column format, and the index title is displayed across all
three columns. This procedure creates a UFE that will format the index title to
appear only in the first column of the index. Note that once the UFE has been
created you can use it to apply the same formatting to any other element in
generated text, where formatting of this type is applicable.
3. Choose Styler ▶ Edit Stylesheet to open the associated stylesheet for edit. This
is a read only stylesheet so you will need to save a local copy if you want to
make amendments.
4. In the Elements list, highlight the index everywhere context and select
Print/PDF from the Outputs to edit list.
5. Navigate to the Generated text category for the context and you will see in the
Before-text and After-text fields that the context is set to generate an index with
a title. The formatting properties for the index heading in Print/PDF output are
contained in the UFEs ufe:one-column and _ufe:toc-heading-
spacing, as shown in the Before-text field. The formatting properties for the
index itself are defined in the index element, as shown in the After-text field.
6. Click the Edit button next to the Before-text field. The Generated Text Editor
opens, displaying the formatting properties for the index heading:

270 User's Guide

7. Highlight the _ufe:one-column element and choose Edit ▶ Delete Markup.
The _ufe:one-column element is removed, leaving the index title, and the
rule and spacing settings.
8. Highlight the remaining markup and choose Insert ▶ User Formatting Element
▶ (new). The New User Formatting Element dialog box opens.
9. Add the name of the new UFE into the Name field, for example three-
column. Note that you do not need to include the namespace prefix in this
field, Arbortext Styler will add this automatically.
10. Click OK to exit the dialog box - you will see that the markup you highlighted
is wrapped in the new tag _ufe:three-column. If you have activated the
Options ▶ Highlight Unstyled Elements menu option, the new tags will be
shown in pink as you have not yet applied a style to the UFE.
11. In the Elements list, select the new UFE. Note that you may need to activate
the View ▶ User Formatting Elements menu option to make UFEs visible in the
list.
12. Give the element a Block style via the Edit ▶ Style menu option.
13. In the Breaks category for the element, set the value of the Columns option in
the Print/PDF and RTF only field to 3.
14. Choose Print ▶ Preview. In the Print Preview window, refer to the index at the
end of the document and note that, whilst the index is in three column format,
the index's title only appears in the first column of the index.

Adding New Elements to Your Stylesheet

Arbortext Styler lets you add declared, undeclared, namespaced, and User
Formatting Elements (UFE) to your stylesheet. You can add new elements
individually or by document, DTD, or schema.

Note
As a default, Arbortext Styler only displays in the Elements list those elements
that have been used in the document. To view all available elements in your
stylesheet, deselect the View ▶ Only Elements in Document menu option.

Working with Elements in Your Stylesheet 271

To Add a Single Element to Your Stylesheet
1. In the Elements list in Arbortext Styler, choose the Insert ▶ Element menu
option. A new unstyled element named NewElement is created in the list.

Note
If you choose this menu option when any of the other list views are active,
you will be taken to the Elements list and the element will be created as
described.

2. Rename the element as required, and press ENTER. The element is moved to
its correct position in the alphabetic list. You can now apply a style and
properties to the new element.
If you want to add a User Formatting Element (UFE) to your stylesheet,
preface the name of the new element with the _ufe: namespace prefix and
Arbortext Styler will recognize the new element as a UFE.
If you want to add a namespaced element to your stylesheet, include the
namespace prefix when you are entering the element name. If Arbortext Styler
does not recognize the prefix you will see the Add Namespace Declaration
dialog box. Complete the namespace declaration in this dialog box for the
element to be valid.
If you need to rename the element, highlight the element and then either select
the Edit ▶ Rename menu choice, press the F2 key, or right-click on the element
and select the Rename menu choice.

Example: Adding Multiple Elements to Your Stylesheet from Your

DTD, Schema, or Document
This example describes how to add to a stylesheet all the remaining elements in a
DTD, schema or document that have not already been included in the stylesheet.
1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/styler.
2. Choose Styler ▶ Edit Stylesheet to open the associated stylesheet for edit. This
is a read only stylesheet so you will need to save a local copy if you want to
make amendments.
3. In the Elements list in Arbortext Styler, select the abstract element.
4. Delete the element from the stylesheet by choosing the Edit ▶ Delete menu
option or pressing the DELETE key. You will see a message advising you that
all references to the element will also be deleted - click Yes to continue with
the deletion.

272 User's Guide

5. Sort the Elements list by style by clicking on the Style column - you will see
that there are currently no unstyled elements in the stylesheet. This step serves
as a baseline with which you can compare the same list later in the procedure,
when new elements have been added.
6. Choose the Insert ▶ Add Elements from Document or Doctype menu option.
The Add New Elements dialog box opens.
7. Select the Include declared elements from this document type and Include
namespaced elements from this document options.

Note
If Include declared elements from this document type is selected, the
Include declared elements from this document is selected by default.

8. Click OK. A message displays indicating how many new elements were added,
if any. The message indicates if there were no new elements to add.

To locate the elements that were added, sort the Elements list by style again,
and look for elements that have the Unstyled style (ensure that the menu

Working with Elements in Your Stylesheet 273

 option View ▶ Only Elements in Document is deselected). You will see that the
abstract element has been reintroduced to the stylesheet.

Keeping Elements Together

Arbortext Styler provides the ability to keep elements, as well as element content,
together across line, page, and column boundaries. This is referred to as keeps.
You can specify a priority level for a keeps rule, from 1 (lowest) to 7 (highest), to
indicate to Arbortext Styler whether or not it should keep the elements together
when a line, column, or page break occurs.
If Arbortext Styler cannot honor keep settings for a block of elements on a line,
page, or column, then it discards all keeps rules with a 1 priority level, and then
determines new break points. If Arbortext Styler cannot determine a break after
discarding 1 priority level keeps, it discards all priority level 2 keeps. Arbortext
Styler continues to evaluate and discard priority level keep-together rules until it
finds an acceptable break point.

Note
We recommend that you apply a priority level to a child element that is higher
than the priority level of its parent element. This allows Arbortext Styler to
apply a keeps rule to the child element if it discards the keep on the parent
element.

Arbortext Styler is more likely to ignore low- to medium-range priority levels (1-
4) than those in the high range (5-6) if there is an overset. An element context
with a keeps priority level 7 never breaks.

Keep Elements Together

1. In the Elements list in Arbortext Styler, select the element context to which
you want to apply a keeps rule.
2. Expand the Breaks category. Go to the Keeps sub-category.
3. In the Keep scope field, specify a scope for the keep-together rule. There are
three options:
• in same column: element must not break across columns or pages
• on same page: element can break across columns but not across pages
• on same line: element must remain on one line
4. Select a value from one of the other three other drop down lists in the Keep
properties group. The value you select here will both assign a type of keep and
the strictness of the keep rule.

274 User's Guide

 • Keep content together: any content within the element will always be
displayed as a single block, without breaking onto the next page, even if
the whole element has to be started on a new page.
• Keep with next element: the selected element and the element that
succeeds it in the document will never be separated by a line, page or
column break.
• Keep with previous element: the selected element and the element that
precedes it in the document will never be separated by a line, page or
column break.
Arbortext Styler is more likely to ignore low to medium range priority levels
(1-4) than those in the high range (5-6) if there is an overset. An element
context with a 7 priority level keep-together rule will never break.
5. Click OK to save the change and exit the dialog box.

Widow and Orphan Control

You can specify when to keep elements together at the top or bottom of a page or
column. An orphan is the first line of a paragraph left at the bottom of a page or
column when the rest of the paragraph starts in the next page or column. A widow
is the last line of a paragraph carried over to the top of a page or column when the
rest of the paragraph fits into the previous page or column. Arbortext Styler lets
you specify the minimum number of lines to display at the top and bottom of
pages or columns, so that widows and orphans do not occur.
1. In the Elements list in Arbortext Styler, select the element context for which
you want to control widows or orphans.
2. Expand the Breaks category. Go to the Keeps sub-category.
3. In the Widow and orphan control (print/PDF and RTF only) field, choose one of
the following settings from the Number of lines to keep at top of page or
column list to control widows:

• <Derive> - Obtains the value from a property set, context, ancestor, or

default.
• Any number - Does not prevent page or column breaks between lines of the
element's content. Widow lines are permitted.
• 2 or more - Specifies that no less than two lines of the element's content
can display at the top of a page or column.
• 3 or more - Specifies that no less than three lines of the element's content
can display at the top of a page or column.
4. Choose one of the following settings from the Number of lines to keep at
bottom of page or column list to control orphans:

Working with Elements in Your Stylesheet 275

 • <Derive> - Obtains the value from a property set, context, ancestor, or
default.
• Any number - Does not prevent page or column breaks between lines of the
element's content. Orphan lines are permitted.
• 2 or more - Specifies that a page or column break can only occur after two
or more lines of the element's content.
• 3 or more - Specifies that a page or column break can only occur after three
or more lines of the element's content.
If a page or column break occurs in the middle of a table, each table row is
considered as a line. When you make settings in the Number of lines to keep at top
of page or column or Number of lines to keep at bottom of page or column fields in
the context of table these define the number of table rows to control. Widow and
orphan control will work correctly within a table that breaks over pages.
If the Structure type field in the Breaks category has been set to Inline for an
element, the only Keep value to have any effect for that element is Keep content
together. It should also be noted that this setting will only have an effect if the
Keep scope field is set to on same line.

Run-In Titles
Arbortext Styler provides the ability for you to create a title that starts a new line
but that runs immediately into the element that follows it, rather than appearing as
a separate block. For example, you may wish to create a run-in title that is
grouped with the paragraph that follows it in the document, and have the title
displayed at the beginning of the paragraph, rather than above it, as shown below:
This feature is not supported for property sets.

Example of Block Title

Example of Run-In Title

Note that the display of run-in titles is only supported in FOSI output, so will only
be visible in Editor view and print/PDF output published with FOSI. It should also
be noted that certain elements do not permit a title to run into them, for example
elements styled as Table or List.

276 User's Guide

Example: Creating Run-In Titles
Here you will set the title of a formalpara element to run directly into the first
para element in the formalpara, as shown in the graphic above.
1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/styler.
2. Choose Styler ▶ Edit Stylesheet to open the associated stylesheet for edit. This
is a read only stylesheet so you will need to save a local copy if you want to
make amendments.
3. Navigate to the first chapter in the document, and note that the second element
in the chapter is a formalpara element that contains a title and a para.
4. Back in Arbortext Styler, select the title element in the Elements list.
5. Choose Insert ▶ Context to create a new condition for the title element. The
New Context dialog box opens.
6. Click the New Parent button and select formalpara from the drop down list.
7. Click OK to save the context and exit the dialog box. The new context title
in formalpara appears for the title element.
8. Navigate to the Breaks category for the context and select With following
from the Run-in drop down list in the FOSI only field. A message appears,
reminding you to set the “Run in with preceding” option for the element into
which the title should run. Click OK to exit the message (select the Do not tell
me this again in this session option to turn off reminders for the current
Arbortext Styler session).
9. Select the para element in the Elements list.
10. Choose Insert ▶ Context to create a new context for the para element.
11. In the New Context dialog box, click New Parent and select formalpara
from the drop down list.
12. Highlight para in the tree and select first from the Position field.
13. Click OK to save the context and exit the dialog box. The new context first
para in formalpara appears for the para element.
14. With the context selected, navigate to the Breaks category for the context and
select With preceding from the Run-in drop down list in the FOSI only
field. A message appears, reminding you to set the “Run in with following”
option for the element into which the title should run. Click OK to exit the
message (select the Do not tell me this again in this session option to turn off
reminders for the current Arbortext Styler session).
15. Choose Preview ▶ Print (FOSI). In the Print Preview window that appears, note
the new appearance of the formalpara in the first chapter of the sample

Working with Elements in Your Stylesheet 277

 document. The title of the formalpara now runs directly into the first
paragraph.

Elements and Document Types

You can configure a stylesheet to support a single document type, or set it up to be
shared across multiple document types. The Elements list displays the elements
that are defined in the stylesheet. The Arbortext Styler UI provides options with
which you can view whether elements in the stylesheet belong to the current
document type:
• Tools ▶ List Elements Not in Document Type — opens the Elements Not in
Document Type Window on page 952 to provide a list of elements in the
stylesheet that do not belong to the current document type.
• View ▶ Only Elements in Document Type — filter the Elements list to display
only those elements that belong to the current document type.

Configuring a Graphic Element

Defining a Role for an Attribute of a Graphic Element
Use the Graphic Details dialog box to configure the roles that the attributes of a
graphic element should perform. Refer to Graphic Details Dialog Box on page
978 for information about the available roles.
For example, an attribute with a role of View for a graphic element can be used to
hold the number of a page from a PDF that is to be inserted as a graphic. It can
also define the default view presented for an intelligent graphic (for example,
CGM, ISO, PVZ). Follow the steps to configure an attribute to perform the View
role:
1. Assign the Graphic style to the required graphic element if you have not
already done so, or edit the style for the element, using the Edit ▶ Style ▶
Graphic option.
2. In the Graphic Details dialog box that opens, select the attribute to which the
View role will be assigned in the Attributes list.
3. Select the View role from the Attribute role field.
Note that the Role field in the Attributes list now displays the selected role for
the selected attribute.
4. Click OK to save the changes and exit the dialog box.

278 User's Guide

 11
Creating Contexts
Contexts Overview .................................................................................................. 280
Context Priority ....................................................................................................... 282
Working with Contexts ............................................................................................. 283
Using XPath in Contexts .......................................................................................... 288
Contexts Walk-Through ........................................................................................... 291

This section describes how to manage element contexts in your stylesheet.

279
Contexts Overview
Most elements have just one set of formatting properties. However, you can apply
different properties to an element based on the context in which the element
occurs. Arbortext Styler associates formatting properties with element contexts,
rather than directly with elements.
For example, you can use contexts to change the formatting of a title element.
A title in the context of a book can be formatted differently than a title in
the context of a chapter.

Note
You must apply a style to an element before you can apply contexts to it.

Contexts are similar to templates in XSL stylesheets and elements-in-context (e-i-

cs) in FOSI stylesheets. They are also similar to style rules in Cascading Style
Sheets (CSS), but unlike CSS, Arbortext Styler does not combine properties for
multiple contexts. Instead, it processes only one context for a given occurrence of
an element within a document.
When you apply styles to the elements in your stylesheet, Arbortext Styler creates
contexts for elements based on these styles, and also assigns default properties
(such as font characteristics, spacing, and indentation).
Every element in a stylesheet has one context, the everywhere context (for
example, para everywhere). The formatting specified for this context applies
to all occurrences of the element within a document if the element has no other
contexts configured. Once you create more than one context for an element, the
everywhere context changes to everywhere else (for example, para
everywhere else). The formatting specified for the everywhere else
context applies to occurrences of the element that do not correspond to a
configured context.
You can select an element context from within Arbortext Styler. You can also
click inside an element in the document and the appropriate context is highlighted
in Arbortext Styler: the Arbortext logo displays next to the context string and the
context icons are highlighted in green:

280 User's Guide

If an element only has one context, the element is selected along with the context.
You can configure element contexts based on parent and ancestor elements. For
example, you can create the context para in abstract anywhere in
front, which applies to occurrences of para whose immediate parent is
abstract. In this context, the parent of abstract can be any element, as long
as front is its ancestor.
Each of the following situations match the para in abstract anywhere in
front context:
<front>
<intro>
<abstract>
<para>

<front>
<abstract>
<para>

<front>
<preface>
<section>
<abstract>
<para>

Note
You can include User Formatting Elements and Styler Formatting Elements
when creating contexts. Refer to Elements Overview on page 264 for more
information.

You can further refine the elements to which a context applies by specifying a
position or XPath predicate for any of the elements in a context specification.
Refer to Using XPath in Contexts on page 288 for further information.

Creating Contexts 281

Arbortext Styler validates contexts against the DTD or schema in use by the
current document.
You can make a context's formatting properties vary based on the presence of
attribute values for the context, by assigning conditions to them. Refer to
Conditions Overview on page 298 for more information on conditions.

Context Priority
The order of contexts is significant. Contexts are displayed in Arbortext Styler in
priority order, highest priority first. Unlike conditions, in which all true conditions
are applied to an element, only one context is applied to an element. Initially,
Arbortext Styler assigns a priority to each context and, in general, more specific
contexts have a higher priority than less specific contexts. For example, title
in chapter is more specific than title anywhere in body, so title in
chapter has a higher priority.
When you add positions or XPath predicates to contexts, Arbortext Styler isn't
always able to determine which context takes priority. In such cases, you can alter
the priority by reordering contexts. You may also reorder the contexts if you wish
to override Style's default priority assignation based on complexity.

To Reorder Contexts
• In the Elements list select the context whose priority you wish to change.
• Click the up or down arrows in the Arbortext Styler toolbar to increase or
decrease the priority of the context respectively.

Note
Be careful when reordering contexts. Reordering contexts changes their
priority and thus affects formatting.

282 User's Guide

In addition, you must specify a context's priority if you edit an element’s source
and add new contexts, or if you export a FOSI or XSL stylesheet to which you add
e-i-cs or templates.

Working with Contexts

This section describes how to create, edit, and delete an element context.

To Create a Context for an Element

1. In Arbortext Styler, elect to display in the Elements list either the elements
that are permitted by your doctype or all elements included in the stylesheet by
checking or unchecking the View ▶ Only Elements in Document menu option.
2. Choose Options ▶ Show Contexts as XSL if you want to view contexts in XSL
syntax. For example, if you create a context for title within chapter, the
XSL version displays as chapter/title whilst the default text version
would display as title in chapter.
3. Select from the Elements list the element for which you wish to create a
context. Note that the element must have had a style applied before you can
create the context. Choosing an element selects the element and all its
contexts.
4. Choose Insert ▶ Context to display the Context dialog box. The selected
element displays in the Context window.
5. Click New Ancestor if you want to specify that the element has to occur inside
an ancestor element, then select an element from the drop down list of valid
ancestors. The selected ancestor is displayed two levels above the original
element, with an intervening asterisk, or wildcard, that signifies that there
could be any number of elements in between the element and the ancestor (or
no elements between them).
Click New Parent if you want to specify that the element has to occur
immediately within a specific element, then select an element from the drop
down list of valid parents. The parent is displayed one level above the
immediate element.

Creating Contexts 283

 Note
If you are creating a context for a UFE, you may see the warning dialog
box shown below if you try to assign a parent element that is not another
UFE or a SFE:

Since UFEs are used to format items in generated text, those items will
also be wrapped with a SFE element that marks generated text, such as
_sfe:BeforeOrAfterText. As such the element that appears to be
the parent of the UFE may not be its direct parent. For example, if you
insert a UFE to format a generated title in a division based on a chapter
element, the hierarchy for the title in that element will be as shown below.
<chapter>
<_sfe:BeforeOrAfterText>
<_ufe:Title>Introduction</_ufe:Title>
</_sfe:BeforeOrAfterText>
</chapter>
The chapter element is therefore an ancestor of the UFE, not its direct
parent. You should create the context _ufe:Title anywhere in
chapter.

You can repeat this step for any of the elements in your context specification
(the original element, or any parent or ancestor). That is, you can specify a
parent or ancestor for a parent or ancestor. To do this, select the element in the
context window, and click New Ancestor or New Parent.
6. Select a Position to further refine the context by specifying, for any element in
the context specification, its position relative to sibling elements of the same
type. Select the element you want to qualify with a position, then select a
position from the Position drop down list.
If you select XPath Predicate from the list, you will be presented with the
XPath Predicate dialog box, in which you must enter a valid XPath predicate.

284 User's Guide

 Note
You must understand XPath and its syntax to use this option. Refer to the
World Wide Web Consortium (W3C) web site (http://www.w3.org/TR/
xpath) for information on the XPath standard.
Refer to Using XPath in contexts on page 288 for some guidelines on
including XPath predicates to define position information.

7. Select At top level if you want the context to apply only when the highest
ancestor or parent element of the context is the top-level element in the
document.
8. Click OK to save the new context and exit the Context dialog box. The context
is added to the selected element in order of priority, from highest to lowest (the
more specific the context, the higher its priority).

Note
Be careful when reordering contexts. Reordering contexts changes their
priority and thus affects formatting.

To Edit a Context
1. In Arbortext Styler, choose the context you want to edit from the Elements list.
2. Choose the Edit ▶ Edit Context menu option to display the Context dialog box.
3. Select the parent, ancestor, or wildcard element you want to edit and click
Edit.
4. Select from the drop down menu the element with which you want to replace
the highlighted parent, ancestor, or wildcard element. Repeat as necessary.
5. Click OK when you are finished to save your change and exit the Context
dialog box.

To Delete a Context
1. In Arbortext Styler, choose the context you want to delete from the Elements
list, then choose Edit ▶ Delete.

Creating Contexts 285

 Note
You can select multiple contexts for deletion.

2. A message asks you if you want to delete the selected item. Select Yes to
delete the context.

Example: Formatting Left and Right Indents for a Context

The following example describes how to format left and right indents. You can
add left, right, hanging, and block indent formatting to block styled elements
(note: indents are not permitted for elements styled as inline, i.e. where the
Structure type option in the Breaks category is set to Inline).

Note
If an element configured in the DTD or schema to have the xml:space=
”preserve” attribute set is added to the stylesheet during either a New
Stylesheet operation, or by choosing Insert ▶ Add Elements from document or
Doctype, its style will be set automatically to Preformatted. Arbortext Styler
will not allow the style to be changed. When an element’s style is
Preformatted, it has a value of Preformatted for the Alignment field in the
Indent category and you will not be able to change this setting.

1. Open the transport.xml document located at Arbortext-path/

samples/styler.
2. Choose File ▶ Save As to create a local copy of transport.xml.
3. Choose Styler ▶ Edit Stylesheet to open the associated stylesheet for edit. This
is a read only stylesheet so you will need to save a local copy if you want to
make amendments.
4. In Arbortext Styler, click on the para element.
5. Choose Elements ▶ New Context to display the Context dialog box.
6. In the Context dialog box, click New Parent, select important from the list,
and press ENTER.
7. Click OK.
8. Select the para in important context from the Elements list, then go to
the Indent category.
9. Set Alignment to Left if it isn't already set.
10. Set Left to 2.00in, and set Relative to to Left margin.

286 User's Guide

11. Choose Preview ▶ Print.
12. In the Print Preview window, locate the “Important Note” within the Moon
Rover section. Note that the content of the para within the important
element is now indented from the left side.
13. In Arbortext Styler, select the para in important context from the
Elements list, and then go to the Indent category.
14. Set Alignment to Left if it isn't already set.
15. Set Right to 2.00in, and set Relative to to Right margin.
16. Choose Preview ▶ Print.
17. In the Print Preview window, locate the “Important Note” within the Moon
Rover section. Note that the content of the para within the important
element is now indented from the right side, as well as the left. This is often
referred to as a block indent.
18. In Arbortext Styler, select the important everywhere context from the
Elements list, and then go to the Indent category.
19. Set the value in the Left field to 1in, but change Relative to to Left
margin.
20. Set the value in the Right field to 1in, but change Relative to to Right
margin.
21. Select the para in important context from the Elements list, and then go
to the Indent category.
22. Leave the current value in the Left field, but change Relative to to Parent
left indent.
23. Leave the current value in the Right field, but change Relative to to Parent
right indent.
24. Choose Preview ▶ Print.
25. In the Print Preview window, locate the “Important Note” within the Moon
Rover section. Note that the content of the para within the important
element is now indented even more from the right and the left sides.
Changing the Relative to values accounts for the change in indentation. Instead
of calculating the left and right indents of the para in important context
based on the left and right margins, the left and right indents were calculated
based on its parent element's (important everywhere) left and right
margins. So the left and right indents of the para in important context (2
inches) were added to the left and right indents of the important
everywhere context (1 inch) to obtain the value that was applied (3 inches).

Creating Contexts 287

Using XPath in Contexts
XPath expressions can be used with contexts as a way of qualifying any given
node in the context selector. If an expression is used in this way it is termed in the
XPath standard as a predicate. When a document is processed the expression is
evaluated and the result converted to a boolean value. If that value is true, then
that node of the context selector is considered to match. If that value is false,
however, the context does not match. A common use of XPath predicates is to test
a location path. Tests of this nature describe a path through the document, usually
relative to the node for which the predicate has been defined. If the element or
attribute described by the path exists, the expression is considered to be true.
Some examples of using predicates in this way are detailed below:
• Match a specified element within a specified parent, where that parent
contains a specified child
The example context title in chapter will match a title whose parent is
a chapter. If you then add the XPath predicate .//table to the chapter node,
position matching will search for a title whose parent is a chapter that includes
a table among its descendants. The context will now be shown in the Elements
list as title in chapter[.//table].
• Match a specified element within a specified parent, where that parent has any
value for a specified attribute
Using the example context title in chapter again, if you add the XPath
predicate @role to the chapter node, position matching will search for a title
whose parent is a chapter that has any value defined for the role attribute. The
context will now be shown in the Elements list as title in
chapter[@role].
• Match a specified element within a specified parent , where that parent has a
specified value for a specified attribute
Using the example context title in chapter again, if you add the XPath
predicate @role='bold' to the chapter node, position matching will search
for a title whose parent is a chapter that has the value “bold” defined for the
role attribute. The context will now be shown in the Elements list as title
in chapter[@role=”bold”].
• Match a specified element that contains text content, where the element
appears within a specified parent
Using the example context title in chapter again, if you add the XPath
predicate text() to the title node, position matching will search for a title
that contains text content, and whose parent is a chapter. The context will now
be shown in the Elements list as title[text()] in chapter.

288 User's Guide

To include an XPath predicate for position matching in a context, select XPath
predicate from the Position drop down menu in the Edit Context dialog box,
and type the predicate. Note - square brackets will be added automatically when
the predicate is saved so they must not be included when typing the string.

Creating Contexts 289

 Note
You may encounter anomalies in the display of a context defined using XPath
in this way, if you are publishing with FOSI. If the source element is
subsequently declared in the generated text of another element, the context of
the source element defined with XPath cannot be processed by FOSI. You will
be presented with a warning message. To overcome this, if it is your intention
that the particular context of the source element that includes the XPath
predicate is the one that should be processed in the generated text of the other
element, include the XPath test in a condition of the original element, rather
than a context.
For example, in your stylesheet you could define a table element with three
contexts, each one of which uses an XPath predicate to set the font size of the
table content based on the value of the pgwide attribute of the table (for
example, the context table[@pgwide=90]) You might then decide that
you want the title of your book to include a table, and set the generated text of
the title in book context to always output a table, based on the Insert ▶
Markup ▶ Table menu option. If you then publish your document for print via
FOSI you will see warning messages advising you that each of the contexts of
the table element that contain the XPath predicate will be ignored for the table
output in the title in book context, for example:
[A31450] ERROR: Cannot evaluate XPath expression in
stylesheet. An XPath Predicate is used in a Styler context
for an element that occurs in generated text. (The
predicate may have been generated by Styler to represent a
position qualifier on a parent or ancestor.) This context
will be ignored in FOSI-based outputs.

Element: table. XPath expression: table[@pgwide=90].

To overcome this anomaly, create conditions based on XPath tests for the
table, rather than contexts. For example, the condition If XPath
expression (@pgwide=90) is true for the table will provide the same
output for the table based on the pgwide attribute, but will not cause errors
during publishing when the table element is used in generated text for the title
in the book. If, however, the context with the XPath predicate is not the one
that should be output in the generated text anyway, and its omission by FOSI
has no bearing on the required output of your document, you may simply
ignore the error message.

290 User's Guide

 Note
With DITA document types, predicates should only be attached to the element
defined by the context. The use of general contexts such as image
anywhere in topic[@outputclass=’tpdr’] should be avoided. They
will not work in Edit view, and Arbortext Styler will not indicate that the
context matches when you position the cursor in the edit window inside an
element that should match. They will also not match in print/PDF output
generated by the FOSI print engine.
Instead, use a context such as image[ancestor::topic/
@outputclass=’tpdr’].

To Test an XPath Predicate in Arbortext Editor

Note
This method of testing predicates does not work if the predicate contains
position(), or its shortcut form (just a number), or last(). However,
these functions will function correctly when used in predicates in Arbortext
Styler.

It often takes multiple attempts to define the correct the correct XPath expression
to meet your requirements. It is much quicker to develop and test expressions
Arbortext Editor than in Arbortext Styler - the steps below explain how:
1. Open your document in Arbortext Editor and place the cursor inside the
element whose position you are trying to test with the XPath predicate.
2. In the Arbortext Editor command line, enter the command eval oid_
xpath_boolean(oid_caret(), "self::node()[...]") -
replacing ... with the expression you wish to use for the predicate.
3. Look at the resulting value in the Eval Output window - if the value is 1, the
test is true. If a value of 0 returned, the test is false.

Contexts Walk-Through
This example walks you through the steps to create and modify a context.

Creating Contexts 291

Example: Working with Contexts
1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/styler.
2. Choose File ▶ Save As to create a local copy of transport.xml.
3. Choose Styler ▶ New Stylesheet.
4. In the Elements list, locate the para element. If need be, give it a Paragraph
style from the Style list, accessed via the Edit ▶ Style menu option.
5. Highlight the para element and choose Insert ▶ Context.
6. In the Context dialog box, click New parent and select abstract from the
drop down list as the parent element.
7. Click OK to save the context and exit the Context dialog box. The para
element now includes the context para in abstract. Any formatting
properties you specify for the para in abstract context are applied to a
para element only when it is the child element of an abstract element.
8. With the para in abstract context selected, specify the following settings
in the Text category:
• Font size: 10
• Italic: Yes
• Text color: Red
9. Choose Preview ▶ Arbortext Editor.
10. In Arbortext Editor, scroll to the top of the document and note that the content
of the para element within the abstract element now displays in 10 point,
red, italic text.
11. In Arbortext Editor, click in the para within the abstract element.
In Arbortext Styler, note that the para in abstract context is selected and
the icon for the context is green and has an Arbortext logo. This indicates that
the context has been selected in Arbortext Editor.
12. With the para in abstract context selected, choose Edit ▶ Edit Context.
13. Select the abstract parent and click Delete. note that the context in the
window changes back to para everywhere else.
14. Click New ancestor then select chapter. chapter now displays as the first
element in the Context window, followed by an asterisk, which is a wildcard
character. The asterisk indicates that the context applies to para elements
anywhere within a chapter element.
15. Click OK to save the change and exit the Context dialog box. The para
element now includes the context para anywhere in chapter.
16. Choose Preview ▶ Arbortext Editor.

292 User's Guide

17. In Arbortext Editor, scroll to the top of the document and note that the content
of the para element within the abstract element is no longer red and
italic. The formatting of this para element is now obtained from Arbortext
Styler default settings.
Scroll further down in the document, and note that the content of para
elements within chapter elements displays in red, 10 point, italic text. Also
note that the content of primary index terms within para elements within
chapter elements displays in red, 10 point, italic text. The primary index
term derives its formatting from the para anywhere in chapter context.
18. In Arbortext Styler, select the para anywhere in chapter context then
choose Edit ▶ Edit Context.
19. In the Context dialog box, select the asterisk (*) then click Delete. By deleting
the asterisk, the chapter element becomes the parent of the para element.
20. Still in the Context dialog box, click on para then select first from the
Position list. Note that the description field at the top of the window now says
first para in chapter.
21. Click OK to save your change and exit the Context dialog box. The para
element now includes the context first para in chapter. Any
formatting you specify for this context applies only to the first para element
within a chapter element.
22. Choose Preview ▶ Arbortext Editor.
23. In Arbortext Editor, scroll through the document and note that only the content
of the first para element within a chapter element displays in 10 point,
red, italic text. All other para elements obtain their formatting from
Arbortext Styler defaults.
24. In Arbortext Styler, select the listitem in itemizedlist context then
choose Edit ▶ Edit Context.
25. In the Context dialog box, click on listitem then select XPath
Predicate from the Position list.
26. Type @userlevel in the XPath Predicate dialog box then click OK to save
the predicate. Click OK again to save the change to the context and exit the
Context dialog box. This creates the listitem[@userlevel] in
itemizedlist context. Any formatting you specify for this context is
applied only to listitem elements that have a userlevel attribute.
27. With the listitem[@userlevel] in itemizedlist context selected,
specify the following settings in the Text category:
• Font size: 20
• Text color: Lime green
28. Choose Preview ▶ Arbortext Editor.

Creating Contexts 293

29. In Arbortext Editor, scroll through the document and note that only one para
element in the document is lime green — the only one that is nested within a
listitem and has a userlevel attribute specified. The para therefore
obtains its formatting from the listitem[@userlevel] in
itemizedlist context. Formatting for all other para elements in the
document is obtained from Arbortext Styler defaults.
30. In Arbortext Styler, select the para element then choose Insert ▶ Context.
31. In the Context dialog box, click New parent then choose listitem from the
drop down list. The context description changes to para in listitem.
32. Click New ancestor then choose chapter from the drop down list. The
context description changes to para in listitem anywhere in
chapter.
33. Click OK to save the new context and exit the Context dialog box. The context
para in listitem anywhere in chapter is added as the first context
in the list of para contexts because it is the most specific of all the configured
contexts.
34. With the para in listitem anywhere in chapter context selected,
specify the following settings in the Text category:
• Font size: 16
• Text color: Yellow
• Underline: Yes
35. Choose Preview ▶ Arbortext Editor.
36. In Arbortext Editor, scroll through the document and note that the content of
all para elements within listitem elements display in 16 point, yellow ,
underlined text.
37. In Arbortext Styler, select the para in listitem anywhere in
chapter context, and choose Edit ▶ Delete. the context is deleted from the
list of contexts for the para element.
38. With the para element still selected, choose Insert ▶ Context.
39. Click New parent then choose listitem from the drop down list.
40. Click OK to save the new context and exit the Context dialog box. The para
element now includes the context para in listitem.
41. With the para in listitem context selected, specify the following settings
in the Text category:
• Font size: 16
• Text color: Orange

294 User's Guide

42. Choose Preview ▶ Arbortext Editor.
43. In Arbortext Editor, scroll through the document and note that the content of
all para elements within listitem elements no longer display in 16 point,
yellow, underlined text. Note that in fact they are also not shown in orange
text, as you would expect by the presence of the para in listitem
context. This is the result of context priorities - examine the list of contexts for
the para element and note that there are contexts with higher priorities than
this one for para elements in listitem elements. It is these contexts that
will lend their formatting to any paragraphs that appear in a list item.

Creating Contexts 295

 12
Creating Conditions
Conditions Overview................................................................................................ 298
Working with Conditions........................................................................................... 300
Conditions Walk-Through......................................................................................... 303
Creating If, Else/If, and Else Conditions..................................................................... 306
Nesting Conditions .................................................................................................. 309
Nested and If, Else/If, and Else Conditions in Exported Stylesheets............................. 317
Using XPath in Conditions........................................................................................ 318
Using Conditions to Change a Document's Page Size ................................................ 320

This section describes how to use conditions to create particular sets of

circumstances under which properties can be applied to elements.

297
Conditions Overview
With Arbortext Styler, you can make formatting properties conditional by
assigning conditions to element contexts. This allows you to apply different
formatting properties to the same element context depending on the circumstances
under which the context appears. The circumstances are determined by the results
of tests carried out against the content of the document to which the stylesheet
applies.
A condition consists of a set of tests and an associated set of formatting properties.
Tests based on the following can be included in a condition:
• Attribute value of the current element or any of its ancestors
• Content of the current element or any of its ancestors
• XPath expressions to support more complex tests
• Position of the element in an HTML chunk
When the tests specified for the context match for the context exactly as they are
described, the formatting properties associated with the condition overlay the
existing formatting properties given to the context itself.
The emphasis element can be used to illustrate a simple example of conditional
formatting. Initially, you can format emphasis as italic in all contexts. If you
want to change the formatting of emphasis from italic to bold, you can add an
attribute test that checks the role attribute on the emphasis element. If role=
“bold” (true), then bold formatting is applied to the font.

Note
In this case, you must explicitly turn off the italic property in the Text category
for the context (set it to no) if you do not want emphasis to be formatted as
bold italic.

See Working with conditions on page 300 for further information.

Conditions are listed in the Elements list in Arbortext Styler, shown below the
context to which they apply. Conditions are identified by the presence of the
condition icon , which changes to include a red strikethrough bar if the
condition's position relative to its siblings is invalid.
You may also use Arbortext Styler's Validate Stylesheet feature, accessed via the
Tools ▶ Validate Stylesheet menu option, to check your stylesheet. Any invalid
conditions present in the stylesheet will be written to the Arbortext Styler Log.

298 User's Guide

 Note
Conditions are not identified by number for the context to which they apply,
simply by their type. For example, a condition previously described as #1 If
attribute “arch” includes the whole word “print” will simply be
shown as If attribute “arch” includes the whole word “print”.

In certain circumstances it is useful to take advantage of the ability to create If,

Else If or Else conditions, and nest those conditions within one another. The
format and purpose of each of these condition types is explained below:
• If condition - a general condition type, made up of one or more condition
tests. An If condition can either be used as an individual condition or as part
of a group. In the latter case it is evaluated as the first condition of a group,
with any sibling Else if and Else conditions in the group being processed
as alternatives if the If condition returns false.
• Else if condition - takes the same form as the If condition, with the added
requirement that it must follow a sibling If or Else If condition in a group
to be valid. The Else If condition is only evaluated if the sibling If or
Else If conditions preceding it in a group return false.
• Else condition - has no condition tests associated with it, and simply forms
the final alternative to be processed when all If and Else If conditions in a
group have returned false.
Groups of conditions may be arranged within the scope of another condition, in
which case they are evaluated only if the parent condition has returned true. When
conditions are arranged in this way they are referred as nested conditions.
Toolbar buttons allow you to move conditions with relation to other conditions in
a group:
- move up
- move down
- increase nesting level
- decrease nesting level
For further information, please refer to Creating If, Else/If, and Else Conditions on
page 306 and Nesting Conditions on page 309.
Because Arbortext Styler applies the formatting properties of all true conditions to
an element context, the order of single level conditions is important. So, for
example, if an element context has two conditions that are true, and the first one
specifies Arial and the second condition specifies Helvetica, Helvetica will be
applied.

Creating Conditions 299

Working with Conditions
This section describes how to create, edit, and delete a condition.

To Create a Single Condition for an Element Context

1. In Arbortext Styler, select an element context from the Elements list.
2. Choose Insert ▶ Condition to display the Condition dialog box. The selected
context displays in the read-only Condition for field.
3. Click one of the New... buttons to open the required dialog box:
• New Attribute Test: opens the New Attribute Test dialog box with the name
of the selected element in the Current Element field
• New Content Test: opens the New Content Test dialog box with the name of
the selected element in the Current Element field
• New XPath Test: opens the New XPath Test dialog box
• New Chunk Test: opens the Start of HTML Chunk Test dialog box

Note
Start of HTML chunk tests should only be created for conditions that
are intended to apply properties in chunked HTML outputs (EPUB,
HTML Help, and Web). Tests of this nature will return a value of false
in conditions specified for Arbortext Editor, print/PDF, HTML File or
RTF outputs.

4. Create the required test and click OK from within the relevant dialog box to
save the change. A description of that test will be added to the list of tests in
the Tests: field of the Condition dialog box.
5. Repeat steps 3 and 4 as required, if you wish to create multiple tests for the
condition.
6. If you have created more than one test, choose either All tests are true (AND)
or Any test is true (OR) to confirm how many if the tests must match for the
condition to be true. If you select All tests are true, Arbortext Styler will only
apply the condition's associated formatting properties when all the tests in the
Tests list are true. If you select Any test is true, Arbortext Styler applies the
condition's formatting properties if at least one test in the Tests list is true.
7. Click OK when you have finished creating tests to save your changes and exit
the Condition dialog box.
8. The condition is listed under the context’s name in the Elements list, for
example If attribute “arch” is not assigned any value.

300 User's Guide

To Edit a Condition
1. In Arbortext Styler, choose the condition you want to edit from the Elements
list.
2. Choose Edit ▶ Edit Condition to open the Condition dialog box.
3. Select the test you want to edit from the Tests: list and click Edit.
4. Edit the test as necessary, and click OK when you are finished.
5. Click OK when you have finished creating tests to save your changes and exit
the Condition dialog box.

To Delete a Condition
1. In Arbortext Styler, choose the condition you want to delete from the Elements
list, and select the Edit ▶ Delete menu option.

Note
You can select multiple conditions for deletion.

2. A message displays to confirm that you want to delete the selected item.
Choose Yes to delete the condition.

To Delete a Test from a Condition

1. In Arbortext Styler, choose from the Elements list the condition whose test
you want to delete, then click Edit ▶ Edit Condition.
2. In the Tests list, select the test you want to delete and click DELETE. Repeat
this process for each test you want to delete.

Note
You will not be prompted to confirm the deletion.

You cannot delete all tests in a condition. You must have a least one test in a
condition to close the Condition dialog box.
3. Click OK when you have finished deleting tests to save your changes and exit
the Condition dialog box.

Creating Conditions 301

Example: Formatting a Block Indent Using a Condition
The following example describes how to apply left and right indents (a block
indent) using a condition. You can add left, right, hanging, and block indent
formatting to block styled elements (note: indent formatting is not permitted for
elements styled as inline, i.e. where the Structure type option in the Breaks
category is set to Inline).

Note
If an element configured in the DTD or schema to have the xml:space=
”preserve” attribute set is added to the stylesheet during either a New
Stylesheet operation, or by choosing Insert ▶ Add Elements from document or
Doctype, its style will be set automatically to Preformatted. Arbortext Styler
will not allow the style to be changed. When an element’s style is
Preformatted, it has a value of Preformatted for the Alignment field in the
Indent category and you will not be able to change this setting.

1. Open the transport.xml document located at Arbortext-path/

samples/styler.
2. Choose File ▶ Save As to create a local copy of transport.xml.
3. Choose Styler ▶ Edit Stylesheet to open the associated stylesheet for edit. This
is a read only stylesheet so you will need to save a local copy if you want to
make amendments.
4. In Arbortext Editor, click in the para element within the abstract
element, and choose Edit ▶ Modify Attributes.
5. Type block in the role field, and then click OK. Note that the para element
now has a role=”block” attribute.
6. In Arbortext Styler, select the para everywhere else context, and then
choose Insert ▶ Condition.
7. In the New Condition dialog box, click New Attribute Test to open the New
Attribute Test dialog box.
8. Make the following settings in the dialog box:
• Test attribute of: Current element
• Attribute name: role
• Attribute value: Comparison = block
9. Click OK, and then click OK in the Condition dialog box.
Note that the para everywhere else context now has the following
condition: If attribute “role” = “block”.

302 User's Guide

10. Select the condition you just created in the Elements list, and go to the Indent
category.
11. Set Alignment to Left if it isn't already set.
12. Set Left to 2.00in, and set Relative to to Left margin.
13. Set Right to 2.00in, and set Relative to to Right margin.
14. Choose Preview ▶ Print.
15. In the Print Preview window, note that only the content of the para element
within the abstract element is indented from both the right and the left
sides. All other para elements are not indented because they did not meet the
condition role=”block”.

Conditions Walk-Through
This example walks you through the process of creating and modifying
conditions.

Example: Working with Conditions

1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/styler.
2. Choose File ▶ Save As to create a local copy of transport.xml.
3. In Arbortext Editor, highlight the first occurrence of the text Cruise Ship
and give it an emphasis tag.
4. Highlight the first occurrence of the text Moon Rover and give it an
emphasis tag. Add a role attribute to this tag with a value of “italic”, so the
element name reads emphasis role=“italic”,
5. Highlight the first occurrence of the text Satellite and give it an
emphasis tag. Add a role attribute to this tag with a value of “bold”, so the
element name reads emphasis role=“bold”,
6. Highlight the first occurrence of the text Train and give it an emphasis
tag. Add a role attribute to this tag with a value of “underline”, so the element
name reads emphasis role=“underline”.
7. Choose Styler ▶ New Stylesheet to create a new stylesheet.
8. Select the emphasis element in the Elements list. Give the element an Inline
style by selecting the style from the Style list accessed via the Edit ▶ Style
menu option.
9. With the emphasis element still selected, choose Insert ▶ Condition.

Creating Conditions 303

10. In the Condition dialog box, click New Attribute Test to open the Attribute Test
dialog box. Ensure that emphasis is shown as the Current Element in the
Test attribute of field.
11. Choose role from the Attribute Name: list.
12. Choose Not assigned a value as the Attribute Value: setting, click OK, then
click OK to save the new condition and exit the Condition dialog box. You
have created a condition with which to apply formatting to the text “Cruise
Ship”, whose emphasis attribute was not given a specific value in step 4.
13. Highlight the condition you just created (If attribute ”role” is not
assigned any value) in the Elements list. In the Text category, set the
value for the Italic field to Yes.
14. Choose Preview ▶ Arbortext Editor.
15. In Arbortext Editor, note that the first occurrence of the text “Cruise Ship” is
now italicized.
16. In Arbortext Styler, highlight the condition you just created (If attribute
”role” is not assigned any value) in the Elements list. Elect to edit
the condition via the Edit ▶ Edit Condition menu option.
17. Click New Attribute Test to open the Attribute Test dialog box. Ensure that
emphasis is shown as the Current Element in the Test attribute of field.
18. Choose role from the Attribute Name: list.
19. Choose Comparison = as the Attribute Value operator, and type italic in the
associated text box. Click OK to save the new test and exit the Attribute Test
dialog box.
20. Select Any test is true for the value of the Condition is true if field. Note that
the word “OR” is added after the first test in the Tests list. This means that the
properties associated with this condition are applied to the content of an
emphasis element if the role attribute on an emphasis tag either has no
value or has a value of italic.
21. Click OK to save the new condition and exit the Condition dialog box.
22. Choose Preview ▶ Arbortext Editor.
23. In Arbortext Editor, note that the phrases “Cruise Ship” and “Moon Rover”
are now italicized.
24. In Arbortext Styler, select the condition you created (If attribute “role”
is not assigned any value or...) in the Elements list, and then
choose Edit ▶ Edit Condition.
25. Change the value of the Condition is true if field to All tests are true. Note that
the word “AND” is added after the first test in the Tests list. This means that
the properties associated with this condition are applied to the content of an

304 User's Guide

 emphasis element only if the role attribute on an emphasis tag has both
no value and a value of italic. Click OK to save the change and exit the dialog
box.
26. Choose Preview ▶ Arbortext Editor.
27. In Arbortext Editor, note that the phrases “Cruise Ship” and “Moon Rover”
are no longer italicized. That is because it is not possible to have a role
attribute that both has no value and is set to italic.
28. In Arbortext Styler, again select the condition you created in the Elements list,
and then choose Edit ▶ Edit Condition.
29. Change the value of the Condition is true if field back to Any test is true, and
then click OK.
30. Select the emphasis element in the Elements list, and then choose Insert ▶
Condition.
31. In the Condition dialog box, click New Attribute Test to open the Attribute Test
dialog box. Ensure that emphasis is shown as the Current Element in the
Test attribute of field.
32. Choose role from the Attribute Name: list.
33. Choose Comparison = as the Attribute Value, and type bold in the associated
text box.
34. Click OK to save the test then click OK to save the condition and exit the
Condition dialog box.
35. Highlight the condition you just created (If attribute “role” = “bold”)
in the Elements list. In the Text category, set the value for the Bold field to
Yes.
36. Choose Preview ▶ Arbortext Editor.
37. In Arbortext Editor, note that “Cruise Ship” and “Moon Rover” are italicized,
and “Satellite” is bold.
38. In Arbortext Styler, select the emphasis element in the Elements list and
choose Insert ▶ Condition.
39. In the Condition dialog box, click New Attribute Test to open the Attribute Test
dialog box. Ensure that emphasis is shown as the Current Element in the
Test attribute of field.
40. Choose role from the Attribute Name: list.
41. Choose Comparison = as the Attribute Value, and type underline in the
associated text box.
42. Click OK to save the test then click OK to save the condition and exit the
Condition dialog box.

Creating Conditions 305

43. Highlight the condition you just created (If attribute “role” =
“underline”) in the Elements list. In the Text category, set the value for the
Underline field to Yes.
44. Choose Preview ▶ Arbortext Editor.
45. In Arbortext Editor, note that “Train” is now underlined.
46. Still in Arbortext Editor, click inside the first itemizedlist element. Give
the element a role attribute with a value of column.
47. In Arbortext Styler, select the itemizedlist everywhere context for
the itemizedlist element, and choose Insert ▶ Condition.
48. Click New Attribute Test to open the Attribute Test dialog box. Ensure that
itemizedlist is shown as the Current Element in the Test attribute of field.
49. Choose role from the Attribute Name list.
50. Choose Comparison = as the Attribute Value operator and type column in the
associated text box.
51. Click OK to save the test, then click OK to save the condition and exit the
Condition dialog box.
52. Highlight the condition you just created (If attribute “role” =
“column”) in the Elements list and go to the Breaks category.
53. Specify Page in the Start new field.
54. Select 2 from the Columns list.
55. Choose Preview ▶ Print (XSL-FO).
56. In the Print Preview window, note that the itemizedlist to which you
added the role=”column” attribute value now starts at the top of a page. Add
five new sample entries to your itemized list in Arbortext Editor, preview the
document for print again and you will see that the list is arranged over two
columns.

Creating If, Else/If, and Else Conditions

This section describes how to create If, Else If and Else conditions. Using
conditions of this nature reduces the need to explicitly test every possible
combination of condition tests and allows you to work with more robust and
concise statements.
Suppose you have a list item element with a role attribute that specifies the text
style to be applied to its contents. As an example, you could want to set the
following four conditions for the context:

306 User's Guide

• If role=”normal” or if role does not have a value, the contents of the list item
should be displayed in normal text.
• If role=”italic”, the content should be displayed in italic text.
• If role=”bold”, the content should be displayed in bold text.
• If role has any other value, the contents should be shown in red text.
In order to achieve the desired formatting of the list, you can specify conditions
for the required context of the list item element.

Example: Creating If, Else/If, and Else Conditions

1. In Arbortext Editor, open the file transport.xml located at
Arbortext-path/samples/styler.
2. Choose File ▶ Save As to create a local copy of transport.xml.
3. Choose Styler ▶ Edit Stylesheet to open the associated stylesheet for edit. This
is a read only stylesheet so you will need to save a local copy if you want to
make amendments.
4. Locate the first itemizedlist in the document. Set the attributes for the
listitem entries as shown below (note that the value of the attribute on the
last listitem is deliberately misspelled):

5. In Arbortext Styler, select the listitem in itemizedlist context of the

listitem element in the Elements list.
6. Choose the Insert ▶ Condition menu option. The New Condition dialog box
opens.
7. Ensure that If is selected in the Condition type field. Click the New Attribute
Test button to open the New Attribute Test dialog box.
8. Ensure that the Current element option is set to listitem in the Test
attribute of field. Select role from the Attribute name field, and set the Attribute
value field to Comparison = normal.
9. Click OK to save the condition and exit the dialog box. The test appears in the
Tests area of the New Condition dialog box.
10. Again ensuring that If is selected in the Condition type field, click the New
Attribute Test button.

Creating Conditions 307

11. In the New Attribute Test dialog box, ensure that the Current element option is
set to listitem in the Test attribute of field. Select role from the Attribute
name field, and set the Attribute value field to Not assigned any value.
12. Click OK to save the test and exit the dialog box. The test appears in the Tests
area of the New Condition dialog box, separated from the previous test by the
word “AND”.
13. In the Condition is true if field, select Any test is true. The two tests are now
separated by the word “OR”, indicating that a particular set of formatting
properties should be applied if either of these tests return true.
14. Click OK to save the condition and exit the dialog box. The condition is now
displayed for the listitem in itemizedlist context in the Elements
list, described as If attribute “role=”normal” or attribute
“role” is not assigned any value.
15. Choose the Insert ▶ Condition menu option to set up the next condition.
16. In the New Condition dialog box, ensure that Else If is selected in the
Condition type field. Elect to create a new attribute test.
17. In the New Attribute Test dialog box, ensure that the Current element option is
set to listitem in the Test attribute of field. Select role from the Attribute
name field, and set the Attribute value field to Comparison = italic.
18. Click OK to save the test and exit the dialog box.
19. Click OK to save the condition and exit the New Condition dialog box. The
condition is now displayed for the listitem in itemizedlist context
in the Elements list, described as Else if attribute “role”=”italic”.
20. Choose the Insert ▶ Condition menu option to set up the next condition.
21. In the New Condition dialog box, ensure that Else If is selected in the Condition
type field. Elect to create a new attribute test.
22. In the New Attribute Test dialog box, ensure that the Current element option is
set to listitem in the Test attribute of field. Select role from the Attribute
name field, and set the Attribute value field to Comparison = bold.
23. Click OK to save the test and exit the dialog box.
24. Click OK to save the condition and exit the New Condition dialog box. The
condition is now displayed for the listitem in itemizedlist context
in the Elements list, described as Else if attribute “role”=”bold”.
25. Choose the Insert ▶ Condition menu option to set up the next condition.
26. In the New Condition dialog box, ensure that Else is selected in the Condition
type field. All options in the New Condition dialog box are disabled, since the
formatting properties for this condition apply in all other cases and as such do
not need tests to verify a match.

308 User's Guide

27. Click OK to save the condition and exit the New Condition dialog box. The
condition is now displayed for the listitem in itemizedlist context
in the Elements list, described as Else.

28. The next step is to set up the formatting properties for each of the conditions
you have created. Highlight each condition in turn in the Elements list, and
specify the characteristics shown below in the Text category:
• If attribute “role”=”normal” or attribute”role” is not
assigned any value - Set Font size to 12pt
• Else if attribute “role”=”italic” - Set Font size to 12pt and
Italic to Yes.
• Else if attribute “role”=”bold” - Set Font size to 12pt and Bold
to Yes.
• Else - Set Font size to 12pt and Text color to Red.
29. Choose Preview ▶ Print. In the Print Preview window, note how the text for
each list entry has been displayed based on its individual condition. Note
specifically that the first two entries have been shown in normal text, as a
result of the If attribute “role”=”normal” or attribute”role”
is not assigned any value condition, and that the final entry has been
shown in red text, as a result of the Else condition. In the latter case you have
identified an attribute value name that has been accidentally misspelled.

Nesting Conditions
This section describes how to build a set of nested conditions, providing an
example of an instance in which nested conditions could be used.
Suppose you have a list whose constituent elements include the following
attributes (note that these elements and their attributes are included in the
axdocbook doctype):
• itemizedlist element:
○ attribute role - possible values large and small specify whether the list
should be indented by 0pt or 24pt, respectively. If the value of role is not
specified, its value defaults to small and all the list items are indented by
the measure specified for small, i.e. 0pt

Creating Conditions 309

 ○ attribute mark - possible values arrow and number specify whether the
entries in the list should be marked with an arrow character or numbered,
respectively.
• listitem element:
○ attribute override - if set, overrides the list marker set for list entries by the
mark attribute on itemizedlist. If the attribute is not set, the list
marker for the entry defaults to the symbol specified by the mark attribute
on itemizedlist.
If neither the mark attribute on the itemizedlist element nor the override
attribute on the listitem element have been specified, the list entries should be
displayed in red text and marked with an asterisk. In this way the document writer
can identify when the list item has not had an important attribute specified.
Using the available attributes to create single, flat conditions would involve the
creation of maintenance of 12 conditions and 33 tests to ensure all possible
attribute combinations are captured. With nested If, Else If and Else
conditions, however, the combinations can be managed in ten conditions and eight
tests:
• If the role attribute on itemizedlist is set to small, or has no value, draw
list entries with an indent of 0pt
1. When condition 1 applies, and the override attribute on a listitem
element has any value, use the value of override as the list item marker
and draw the list entry with an indent of 0pt
2. When condition 1 applies, and the mark attribute has a value of arrow,
mark the list item with a arrow and draw it with an indent of 0pt
3. When condition 1 applies, and the mark attribute has a value of number,
mark the list item with a number and draw it with an indent of 0pt
4. When condition 1 applies, and the override or mark attributes have not
been specified, mark the list item with an asterisk and draw it in red text
with an indent of 0pt
• If the role attribute on itemizedlist is set to large, draw list entries with
an indent of 24pt
1. When condition 2 applies, and the override attribute on a listitem
element has any value, use the value of override as the list item marker
and draw list entry with an indent of 24pt
2. When condition 2 applies, and the mark attribute has a value of arrow,
mark the list item with a arrow and draw it with an indent of 24pt

310 User's Guide

 3. When condition 2 applies, and the mark attribute has a value of number,
mark the list item with a number and draw it with an indent of 24pt
4. When condition 2 applies, and the override or mark attributes have not
been specified, mark the list item with an asterisk and draw it in red text
with an indent of 24pt
To create these conditions, follow the steps detailed below. Note that all
conditions are created for the listitem in itemizedlist context.

Example: Creating Nesting Conditions

1. In Arbortext Editor, open the file transport.xml located at
Arbortext-path/samples/styler.
2. Choose Styler ▶ Edit Stylesheet to open the associated stylesheet for edit. This
is a read only stylesheet so you will need to save a local copy if you want to
make amendments.
3. Locate the itemizedlist element in the Elements list - note that is of the
style List-Bulleted, which outputs its list entries with a bullet marker at a set
indent. We will override these defaults with the conditional formatting for the
list items in the list.
4. Locate the listitem in itemizedlist context in the Elements list.
5. Choose Insert ▶ Condition to create a new condition for the context. The New
Condition dialog box opens. Ensure that If is selected in the Condition type
field.
6. Click the New Attribute Test button. The New Attribute Test dialog box opens.
7. Elect to test the attribute of the Ancestor of the current element, and select
itemizedlist from the dropdown menu.
8. Select role from the Attribute name drop down menu, and set the Attribute
value field to match Comparison=small.
9. Click OK to save the test and exit the dialog box. The test now appears in the
Tests area of the New Condition dialog box.
10. Click the New Attribute Test button again, to create a new test in the New
Attribute Test dialog box.
11. Elect to test the attribute of the Ancestor of the current element, and select
itemizedlist from the dropdown menu.
12. Select role from the Attribute name drop down menu, and set the Attribute
value field to match Not assigned any value.
13. Click OK to save the test and exit the dialog box. The test now appears in the
Tests area of the New Condition dialog box, separated from the previous test
by the word “AND”.

Creating Conditions 311

14. In the Condition is true if field, select Any test is true. The two tests are now
separated by the word “OR”, indicating that a particular set of formatting
properties should be applied if either of these tests return true.

15. Click OK to save the condition and exit the dialog box. The condition is now
displayed for the listitem in itemizedlist context in the Elements
list, described as If attribute “role” of element
“itemizedlist”=”small” or attribute “role” of element
“itemizedlist” is not assigned any value.
16. Navigate to the Generated text category to set the formatting properties for this
condition. Leave the Numbers and Bullets option set to Bullet. Click the Details
button to open the Bullet dialog box, in which you can set the default indent
for the list.
17. Set the bullet to indent at 0pt, then set the text following the bullet to tab to
16pt. Specify that following lines should indent to 16pt.
18. Click OK to save the formatting properties and exit the dialog box.
19. Choose Insert ▶ Condition to create the next condition.
20. In the New Condition dialog box, ensure that If is selected in the Condition type
field. Elect to create a new attribute test.
21. Elect to test the attribute of the current element, and select override from the
Attribute name dropdown menu.
22. Set the Attribute value field to match Assigned any value.
23. Click OK to save the test and exit the dialog box. The test now appears in the
Tests area of the New Condition dialog box.

312 User's Guide

24. Click OK to save the condition and exit the dialog box. The condition is now
displayed for the listitem in itemizedlist context in the Elements
list, described as If attribute “override” is assigned any value.
25. Navigate to the Generated text category to set the formatting properties for this
condition. Set the Numbers and Bullets option set to None. Move to the Add-
before field, and click the Edit button to open the Generated Text Editor. Since
you are creating a non-default marker for the list entry, you must set the
marker and the following space via generated text.
26. Choose InsertAttribute Content. The Insert Attribute Content dialog box opens.
27. Select (Current Element) from the Element drop down list, and override
from the Attribute to insert menu. Here you have specified that when the
override attribute is present, its value should be used as the marker for the list
item for which it is set.
28. Still in the Generated Text Editor, choose Insert ▶ Leaders, Rule or Space. The
Insert Leaders, Rule or Space dialog box opens.
29. Select Space in the Type field, then set a Specified Length of 12pt.
30. Click OK to save the settings and exit the dialog box.
31. Click OK to save the gentext settings and exit the Generated Text Editor.
32. Navigate to the Indent category to set the indent for the list entry - since you
have created a non-default marker for the entry you cannot use the Bullet
dialog box to set the indent.
33. Set the Alignment field to Left, the Left Indentation to 16pt relative to its
Parent left indent, and the First Line Indentation to 0pt relative to its Parent
first line indent.

34. Choose Insert ▶ Condition to create the next condition.

35. In the New Condition dialog box, ensure that Else if is selected in the Condition
type field. Elect to create a new attribute test.

Creating Conditions 313

36. Elect to test the attribute of the Ancestor of the current element, and select
itemizedlist from the dropdown menu.
37. Select mark from the Attribute name drop down menu, and set the Attribute
value field to match Comparison=arrow.
38. Click OK to save the test and exit the dialog box. The test now appears in the
Tests area of the New Condition dialog box.
39. Click OK to save the condition and exit the dialog box. The condition is now
displayed for the listitem in itemizedlist context in the Elements
list, described as Else if attribute "mark” of element
“itemizedlist”=”arrow”.
40. Navigate to the Generated text category to set the formatting properties for this
condition. Leave the Numbers and Bullets option set to Bullet. Click the Details
button to open the Bullet dialog box, in which you can set the default indent
and bullet character for the list item.
41. Set the bullet character to an arrow, by selecting it from the Insert Symbol
dialog box that appears when you click the Character button.
42. Set the bullet to indent at 0pt, then set the text following the bullet to tab to
16pt. Specify that following lines should indent to 16pt.
43. Click OK to save the formatting properties and exit the dialog box.
44. Choose Insert ▶ Condition to create the next condition.
45. In the New Condition dialog box, ensure that Else if is selected in the Condition
type field. Elect to create a new attribute test.
46. Elect to test the attribute of the Ancestor of the current element, and select
itemizedlist from the dropdown menu.
47. Select mark from the Attribute name drop down menu, and set the Attribute
value field to match Comparison=number.
48. Click OK to save the test and exit the dialog box. The test now appears in the
Tests area of the New Condition dialog box.
49. Click OK to save the condition and exit the dialog box. The condition is now
displayed for the listitem in itemizedlist context in the Elements
list, described as Else if attribute "mark” of element
“itemizedlist”=”number”.
50. Navigate to the Generated text category to set the formatting properties for this
condition. Set the Numbers and Bullets option to Number. Click the Details
button to open the List Item Number dialog box, in which you can set the
default indent and numbering for the list item.
51. Leave the default numbering style as shown.
52. Set the number to align to the left and indent at 0pt, then set the text following
the number to tab to 16pt. Specify that following lines should indent to 16pt.

314 User's Guide

53. Click OK to save the formatting properties and exit the dialog box.
54. Choose Insert ▶ Condition to create the next condition.
55. In the New Condition dialog box, ensure that Else is selected in the Condition
type field. All options in the New Condition dialog box are disabled, since the
formatting properties for this condition apply in all other cases and as such do
not need tests to verify a match.
56. Click OK to save the test and exit the dialog box. The test now appears in the
Tests area of the New Condition dialog box.
57. Click OK to save the condition and exit the dialog box. The condition is now
displayed for the listitem in itemizedlist context in the Elements
list, described as Else.
58. Navigate to the Generated text category to set the formatting properties for this
condition. Leave the Numbers and Bullets option set to Bullet. Click the Details
button to open the Bullet dialog box, in which you can set the default indent
and bullet character for the list item.
59. Set the bullet character to an asterisk, by selecting it from the Insert Symbol
dialog box that appears when you click the Character button.
60. Set the bullet to indent at 0pt, then set the text following the bullet to tab to
16pt. Specify that following lines should indent to 16pt.
61. Navigate to the Text category and set the Text color field to Red.
62. Click OK to save the formatting properties and exit the dialog box.
63. You now have five sibling conditions for the listitem in
itemizedlist context, as shown below:

If you wish to group the conditions so their formatting properties are only
applied when a particular combination of attributes is encountered, nest some
of the conditions as shown in the next step. The steps show how to nest the
conditions relating to the override and mark attributes within a group whose
matching capability is led by the presence of the role=small or no value.
64. Highlight conditions 2–5 in the above list, and click the Increase Level toolbar
button . You will see that the selected conditions are moved one place to the
right in the Elements list, thus making them child conditions of the condition
If attribute “role” of element “itemizedlist”=”small” or

Creating Conditions 315

 attribute “role” of element “itemizedlist” is not assigned
any value”.

Now conditions 2–5 will only be matched once condition 1 has been matched.
65. The next step is to create another group of conditions, with the difference that
its matching capability is led by the presence of the role=”large” attribute. To
accomplish this, repeat steps 4–64 to set up conditions as defined in the list
below:
• 1) Else if attribute “role” of element “itemizedlist”=
”large”
• 1.1) If attribute “override” is assigned any value
• 1.2) Else if attribute “mark” of element “itemizedlist”=
”arrow”
• 1.3) Else if attribute “mark” of element “itemizedlist”=
”number”
• 1.4) Else
Note that condition 1 should be an Else If condition, rather than If as in
the first set, to indicate that it is an alternative if the first condition in the first
set does not match.
Use all the same settings for these conditions as you used in the other set, the
only change being the size of the indent applied under each of the conditions.
Set the bullet to indent at 24pt, then set the text following the bullet to tab to
40pt. Specify that following lines should indent to 40pt.
66. You now have two groups of conditions, as shown below:

316 User's Guide

67. A summary of the conditions you have created and the associated formatting
properties they apply is shown below:
if role = small or role has no value
if override has value
use value of override for marker and small indent for
list entry
else if mark=arrow
use arrow marker and small indent for list entry
else if mark=number
use number marker and small indent for list entry
else
use asterisk marker, red text and small indent for
list entry
else if role =large
if override has value
use value of override for marker and large indent for
list entry
else if mark=arrow
use arrow marker and large indent for list entry
else if mark=number
use number marker and large indent for list entry
else
use asterisk marker, red text and large indent for
list entry

Nested and If, Else/If, and Else Conditions

in Exported Stylesheets
Nested conditions are not supported natively in FOSI or XSL. For this reason,
when a stylesheet is exported to XSL or FOSI any nested and/or If, Else If
and Else conditions will be flattened to a single layer.
Nested and/or If, Else If and Else conditions are converted into a series of
single top layer conditions, some with additional tests that make the new condition
equivalent to the original nested condition. Note the use of the ifSense=”false”
attribute on the Tests element to provide the additional testing that brings the
new condition in line with the original one:
The flattened conditions can then be translated directly into XSL using standard
XSL language features.

Creating Conditions 317

To translate the flattened conditions into FOSI attribute tests, you may take
advantage of the testgroup construct in the FOSI definition. The construct can
occur in an attribute test (att element) where a specval or fillval can occur and
contains any combination of specval and fillval attributes. The testrgoup
construct is useful when you want to map a Tests ifSense=”false” element
in the flattened style file into a FOSI attribute test, as it is mapped into
testgroup sense=”false”. Furthermore, using a testgroup element with
a logic value that differs from that held by the att element would allow you to
test a set of specval and fillval attributes, related by “and” or “or”, in a single
attribute test. The testgroup element is available for use in any FOSI instance,
whether it is generated by Arbortext Styler or created elsewhere.

Using XPath in Conditions

XPath expressions can be used as tests when creating conditions. When a
document is processed the expression is evaluated and the result converted to a
boolean value. If that value is true, the condition is considered to match. If that
value is false, the condition does not match.
Some examples of using expressions in this way are detailed below. The
assumption with these examples is that each condition includes a single test, based
on the XPath expression shown:
• Element with a specified ancestor
The expression ancestor::doc will return true for an element that has an
ancestor element named <doc>.
• Element with a specified ancestor, where that ancestor contains a specified
child
The expression ancestor::doc/docinfo will return true for an element
that has ancestor element named <doc>, where that ancestor has a child
element named <docinfo>.
• Element with a specified ancestor, where that ancestor contains a specified
child and that child includes a specified attribute
The expression ancestor::doc/docinfo@lang will return true for an
element that has an ancestor element named <doc> where that ancestor has a
child element named <docinfo>. The specified child contains the attribute
lang.
• Element within a specified ancestor, where that ancestor contains a specified
child and that child includes a specified attribute with a specified value
The expression ancestor::doc/docinfo@lang=”es” will return true
for an element that has an ancestor element named <doc> where that ancestor

318 User's Guide

 has a child element named <docinfo>. The specified child contains the
attribute lang, which has been given the value “es”.
• Element that contains text
The expression text() will return true for an element that contains text.
You may also use XPath to create a test that will evaluate the result of an ACL or
a JavaScript script.
To add an XPath expression as a condition, select New XPath Test in the Condition
dialog box, and type the expression in the resulting field.

Note
Expressions that contain position() or last() cannot be tested in this
way. Expressions of this type are not permitted inside XPath tests of
conditions with FOSI outputs in Arbortext Styler. Use the preceding-
sibling or following-sibling axes instead to create comparable
tests.
For example:
• The expression count(preceding-sibling::para)=1, when used as
a condition of the para element, will test that the para is the second para in its
parent
• The expression count(following-sibling::para)=0 is a viable
alternative to position()=last()

The use of certain XPath expressions can cause increased processing times. Please
refer to XPath Performance on page 1078 for information and suggested
alternatives.

Using Arbortext Editor to Test an XPath Expression

It often takes multiple attempts to define the correct XPath expression to meet
your requirements. It is much quicker to develop and test expressions Arbortext
Editor than in Arbortext Styler - the steps below explain how:
1. Open your document in Arbortext Editor and place the cursor inside the
element whose context will contain the condition.
2. In the Arbortext Editor command line, enter the command eval oid_
xpath_boolean(oid_caret(), "self::node()[...]") -
replacing ... with the expression you wish to use for the XPath test.
3. Look at the resulting value in the Eval Output window - if the value is 1, the
test is true. If a value of 0 returned, the test is false.

Creating Conditions 319

Using Conditions to Change a
Document's Page Size
This section walks you through an example of creating a condition that changes
the page size for a print or PDF document if a particular attribute is specified for
the document.

Example: Creating a Condition that Changes a Document's Page Size

1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/styler.
2. Choose File ▶ Save As to create a local copy of transport.xml.
3. Choose Styler ▶ New Stylesheet to create a new stylesheet.
4. In the Page Sets list, choose the menu option Insert ▶ Page Set. The Page Sets
list opens, with a new page set object named NewPageSet created in the list.
5. Type Page Set 11x17 as the Page set name then go to the Page size
category.
6. Choose 11x17 from the Page size drop down list.
7. In the Page Sets list, insert a second new page set via the Insert ▶ Page Set
menu option.
8. Type Page Set 7x9 as the Page set name then go to the Page size category.
9. Choose Custom from the Page size drop down list, then set Width to 7in and
Height to 9in.
10. In the Elements list, select the book everywhere context and go to the
Breaks category.
11. Choose Page Set 11x17 from the Name drop down list in the Page set
field.
12. In the Elements list, select the book everywhere context and insert a
condition with the Insert ▶ Condition menu option.
13. In the Condition dialog box, click New Attribute Test to open the Attribute Test
dialog box. Ensure that book is shown as the Current Element in the Test
attribute of field.
14. Choose role as the Attribute Name.
15. Choose Comparison = as the Attribute Value operator then type small in
the associated text box.
16. Click OK to save the test and OK to save the condition and exit the Condition
dialog box.
17. Highlight the condition you just created (If attribute “role” =
“small”) in the Elements list and go to the Breaks category.

320 User's Guide

18. Set Start new to Page, and Name in the Page set group to Page Set 7x9.
The condition you have created will advise Arbortext Styler to size the
transport.xml document using the Page Set 11x17 page set, unless
the attribute emphasis role=”small” has been specified for the document. In
the latter case the document will be sized according to the Page Set 7x9
page set.
19. Choose Preview ▶ Print.
In the Print Preview window, note that the page size of the document is now
11in x 17in.
20. In Arbortext Editor, give the book element a role attribute with a value of
“small”.
21. In Arbortext Styler, choose Preview ▶ Print (XSL-FO) again.
In the Print Preview window, note that the page size of the document is now
7in x 9in.

Creating Conditions 321

 13
Cutting, Copying, and Pasting
Cut, Copy, and Paste Overview ................................................................................ 324
Cutting, Copying, and Pasting Elements.................................................................... 324
Cutting, Copying, and Pasting Contexts .................................................................... 325
Cutting, Copying, and Pasting Conditions.................................................................. 327
Cutting, Copying, and Pasting Property Sets ............................................................. 328
Cutting, Copying, and Pasting Page Sets .................................................................. 329
Cutting, Copying, and Pasting Tables of Content........................................................ 330
Cutting, Copying, and Pasting Custom Tables ........................................................... 331
Cutting, Copying, and Pasting Cross References....................................................... 332
Cutting, Copying, Pasting, and Deleting Properties .................................................... 333

This section describes how to move objects within or between stylesheets using
cut, copy, and paste actions.

323
Cut, Copy, and Paste Overview
Arbortext Styler enables you to cut, copy, and paste the following stylesheet
components from their respective list views in the Arbortext Styler UI:
• Elements
• Contexts
• Conditions
• Property sets
• Page sets
• Headers and footers
• Tables of contents
• Custom tables
• Cross references
It is also possible to copy sets of formatting properties for use with another object.
Except for formatting properties, cutting, copying, and pasting these components
is supported through operations on the Edit menu, associated keyboard shortcuts,
toolbar buttons, and the shortcut menu. For formatting properties, cut, copy, paste
and delete is supported through operations on the Edit ▶ Properties menu.
If you have multiple Arbortext Styler sessions running, you can cut, copy, and
paste between different sessions. You can also cut or copy a component in an
Arbortext Styler session, close the application, start a new Arbortext Styler
session and paste the component into the stylesheet active in the new session.

Cutting, Copying, and Pasting Elements

Arbortext Styler enables you to cut, copy, and paste elements through operations
on the Edit menu, associated keyboard shortcuts, toolbar buttons, the shortcut
menu and the shortcut menu. Note that if you cut or copy an element you include
all the element's contexts and, by association, conditions in the cut or copy action.
You cannot cut or copy multiple elements in a single operation.
The following procedure demonstrates how to copy and paste an element. Cutting
and pasting is a similar operation, but the cut element is removed from the
Elements list.

Copying and Pasting an Element

1. In Arbortext Editor, open your document and use the Styler menu to open a
stylesheet.
2. In Arbortext Styler, select the element you want to copy in the Elements list.
3. Select Edit ▶ Copy to copy the element.

324 User's Guide

 You can also use CTRL+C or the Copy toolbar button for this operation.
4. Select Edit ▶ Paste to paste the element.
You can also use CTRL+V or the Paste toolbar button for this operation.
Arbortext Styler pastes a copy of the element into the Elements list, after the
currently selected element. The name of the element is the original element
name with _copy_1 (or another number if more than one copy is made)
appended. The new element is highlighted for renaming.
5. Rename the element, if desired.
For example, you might not need to rename the pasted element if you are
modifying the original element and want to keep the copy to preserve the
original state of the element for reference.

Note
Definitions are always pasted into the root module. If the copied element
was in a different module, or if it was cut instead of copied, then _copy_
1 will not have been appended to the element's name. If they are in
different modules, multiple definitions can have the same name. However,
definition names must be unique in each individual module.
If you have copied a namespaced element from a different module, and
that module declares a namespace that also exists in the current module but
with a different prefix, you will see that the element's namespace prefix
will change when the paste action to the current module is completed.

Cutting, Copying, and Pasting Contexts

Arbortext Styler enables you to cut, copy, and paste element contexts through
operations on the Edit menu, associated keyboard shortcuts, toolbar buttons, and
the shortcut menu. Note that if you cut or copy a context you include all the
context's conditions in the cut or copy action. You cannot cut or copy multiple
contexts in a single operation.
The following procedure demonstrates how to copy and paste an element context.
Cutting and pasting is a similar operation, but the cut context is removed from the
Elements list.

Cutting, Copying, and Pasting 325

Copying and Pasting an Element Context
1. In Arbortext Editor, open your document and use the Styler menu to open a
stylesheet.
2. In Arbortext Styler, click on the plus sign ( + ) beside the element with the
context you want to copy in the Elements list.
The element's contexts are displayed.
3. Select the element context you want to copy.
4. Select Edit ▶ Copy to copy the context.
You can also use CTRL+C or the Copy toolbar button for this operation.
5. Select the element where you want to paste the context in the Elements list.
You can paste the context in the same element, if desired.
6. Select Edit ▶ Paste to paste the context.
You can also use CTRL+V or the Paste toolbar button for this operation. Note
the following:
• If you selected a different element in which to paste the context, Arbortext
Styler pastes a copy of the context into that element's list of contexts. The
context is the same, but the name changes to reflect the new parent
element. If desired, you can use the Edit ▶ Edit Context operation or edit
the context's properties to modify the pasted context.
• If you pasted the context into the same element, the New Context dialog
box opens as this is a duplicate context. Change the pasted context as
desired and close the dialog box. If desired, you can edit the context's
properties to modify the pasted context.
• If you have copied a context of a namespaced element from a different
module, and that module declares a namespace that also exists in the
current module but with a different prefix, you will see that you will see
that in some cases the context's namespace prefix will change when the
paste action to the current module is completed. As a rule, anywhere the
element name is used in the context's selector will be replaced by the
destination element. Note, though, that a change of namespace prefix
could happen for other namespaced elements in the selector. For example,
the selector abc:title in efg:para could become abc1:title
in section. Arbortext Styler changed the prefix abc to abc1 but the
efg prefix doesn't appear when pasted because it simply gets replaced
with the destination element.

326 User's Guide

Cutting, Copying, and Pasting Conditions
Arbortext Styler enables you to cut, copy, and paste conditions in element contexts
through operations on the Edit menu, associated keyboard shortcuts, toolbar
buttons, and the shortcut menu. Note that if you cut or copy a condition you
include any conditions nested as children of the condition in the cut or copy
action. You can cut, copy, and paste multiple conditions in a single operation.
The following procedure demonstrates how to copy and paste one or more
conditions in an element context. Cutting and pasting is a similar operation, but
the cut condition or conditions are removed from the Elements list.

Copying and Pasting a Context Condition

1. In Arbortext Editor, open your document and use the Styler menu to open a
stylesheet.
2. In Arbortext Styler, click on the plus sign ( + ) beside the element with the
context condition or conditions you want to copy in the Elements list.
The element's contexts and associated conditions are displayed.
3. Select the condition or conditions you want to copy.
You can use CTRL or SHIFT to select multiple conditions.
4. Select Edit ▶ Copy to copy the condition or conditions.
You can also use CTRL+C or the Copy toolbar button for this operation.
5. Select the element context where you want to paste the condition or conditions
in the Elements list.
You can paste conditions in the same element context, if desired.
6. Select Edit ▶ Paste to paste the condition or conditions.
You can also use CTRL+V or the Paste toolbar button for this operation. Note
the following:
• Arbortext Styler pastes a copy of the condition or conditions into the
selected element context. A pasted condition is identical to the original
condition, even the name, regardless of where it is pasted. If the paste
operation creates an invalid condition, however, this condition will be
marked as such with a red strikethrough. If desired, you can use the Edit ▶
Edit Condition operation or edit the condition's properties to modify a
pasted condition.
• If you have copied a condition with a namespaced element and/or attribute
from a different module, and that module declares a namespace that also
exists in the current module but with a different prefix, you will see that
the condition's namespace prefix will change when the paste action to the
current module is completed.

Cutting, Copying, and Pasting 327

Cutting, Copying, and Pasting Property
Sets
Arbortext Styler enables you to cut, copy, and paste property sets through
operations on the Edit menu, associated keyboard shortcuts, toolbar buttons, and
the shortcut menu. You cannot cut or copy multiple property sets in a single
operation.
The following procedure demonstrates how to copy and paste a property set.
Cutting and pasting is a similar operation, but the cut property set is removed from
the Property Sets list.

Copying and Pasting a Property Set

1. In Arbortext Styler, select the Property Sets list to display the property sets
configured for the stylesheet.
2. Select the property set you want to copy.
3. Select Edit ▶ Copy to copy the property set.
You can also use CTRL+C or the Copy toolbar button for this operation.
4. Select Edit ▶ Paste to paste the property set.
You can also use CTRL+V or the Paste toolbar button for this operation.
Arbortext Styler pastes a copy of the property set into the Property Sets list,
after the currently selected property set. The name of the new property set is
the original property set name with _copy_1 (or another number if more than
one copy is made) appended. The new property set is highlighted for
renaming.
5. Rename the property set, if desired.
For example, you might not need to rename the pasted property set if you are
modifying the original property set and want to keep the copy to preserve the
original state of the property set for reference.

Note
Definitions are always pasted into the root module. If the copied property set
was in a different module, or if it was cut instead of copied, then _copy_1 is
not appended to the property set's name. If they are in different modules,
multiple definitions can have the same name. However, definition names must
be unique in each individual module.

328 User's Guide

Cutting, Copying, and Pasting Page Sets
Arbortext Styler enables you to cut, copy, and paste page sets through operations
on the Edit menu, associated keyboard shortcuts, toolbar buttons, and the shortcut
menu. You cannot cut or copy multiple page sets in a single operation.
The following procedure demonstrates how to copy and paste a page set. Cutting
and pasting is a similar operation, but the cut page set is removed from the Page
Sets list.

Copying and Pasting a Page Set

1. In Arbortext Styler, select the Page Sets list to display the page sets
configured for the stylesheet.
2. Select the page set you want to copy.
3. Select Edit ▶ Copy to copy the page set.
You can also use CTRL+C or the Copy toolbar button for this operation.
4. Select Edit ▶ Paste to paste the page set.
You can also use CTRL+V or the Paste toolbar button for this operation.
Arbortext Styler pastes a copy of the page set into the Page Sets list, after the
currently selected page set. The name of the new page set is the original page
set name with _copy_1 (or another number if more than one copy is made)
appended. The new page set is highlighted for renaming.
5. Rename the page set, if desired.
For example, you might not need to rename the pasted page set if you are
modifying the original page set and want to keep the copy to preserve the
original state of the page set for reference.

Note
Definitions are always pasted into the root module. If the copied page set was
in a different module, or if it was cut instead of copied, then _copy_1 is not
appended to the page set's name. If they are in different modules, multiple
definitions can have the same name. However, definition names must be
unique in each individual module.

Cutting, Copying, and Pasting 329

Cutting, Copying, and Pasting Tables of
Content
Arbortext Styler enables you to cut, copy, and paste tables of contents format
objects through operations on the Edit menu, associated keyboard shortcuts,
toolbar buttons, and the shortcut menu. You cannot cut or copy multiple table of
contents format objects in a single operation.
The following procedure demonstrates how to copy and paste a table of contents
format object. Cutting and pasting is a similar operation, but the cut TOC is
removed from the Tables of Contents list.

Copying and Pasting a Table of Contents Format Object

1. In Arbortext Editor, open your document and use the Styler menu to open a
stylesheet.
2. In Arbortext Styler, select the Tables of Contents tab to display the table of
contents format objects configured for the stylesheet.
3. Select the table of contents you want to copy in the Tables of Contents list.
4. Select Edit ▶ Copy to copy the TOC.
You can also use CTRL+C or the Copy toolbar button for this operation.
5. Select Edit ▶ Paste to paste the TOC.
You can also use CTRL+V or the Paste toolbar button for this operation.
Arbortext Styler pastes a copy of the TOC into the Tables of Contents list,
after the currently selected TOC. The name of the new TOC is the original
TOC name with _copy_1 (or another number if more than one copy is made)
appended. The new TOC is highlighted for renaming.
6. Rename the TOC, if desired.
For example, you might not need to rename the pasted TOC if you are
modifying the original TOC and want to keep the copy to preserve the original
state of the TOC for reference.

Note
Definitions are always pasted into the root module. If the copied TOC was in a
different module, or if it was cut instead of copied, then _copy_1 is not
appended to the TOC's name. If they are in different modules, multiple
definitions can have the same name. However, definition names must be
unique in each individual module.

330 User's Guide

Cutting, Copying, and Pasting Custom
Tables
Arbortext Styler enables you to cut, copy, and paste custom table objects through
operations on the Edit menu, associated keyboard shortcuts, toolbar buttons, and
the shortcut menu. You cannot cut or copy multiple custom tables in a single
operation.
The following procedure demonstrates how to copy and paste a custom table
object. Cutting and pasting is a similar operation, but the cut table is removed
from the Custom Tables list.

Copying and Pasting a Custom Table Object

1. In Arbortext Editor, open your document and use the Styler menu to open a
stylesheet.
2. In Arbortext Styler, select the Custom Tables tab to display the custom table
objects configured for the stylesheet.
3. Select the table you want to copy in the Custom Tables list.
4. Select Edit ▶ Copy to copy the table.
You can also use CTRL+C or the Copy toolbar button for this operation.
5. Select Edit ▶ Paste to paste the table.
You can also use CTRL+V or the Paste toolbar button for this operation.
Arbortext Styler pastes a copy of the table into the Custom Tables list, after the
currently selected custom table. The name of the new custom table is the
original custom table name with _copy_1 (or another number if more than
one copy is made) appended. The new custom table is highlighted for
renaming.
6. Rename the custom table, if desired.
For example, you might not need to rename the pasted custom table if you are
modifying the original custom table and want to keep the copy to preserve the
original state of the custom table for reference.

Note
Definitions are always pasted into the root module. If the copied custom table
was in a different module, or if it was cut instead of copied, then _copy_1 is
not appended to the custom table’s name. If they are in different modules,
multiple definitions can have the same name. However, definition names must
be unique in each individual module.

Cutting, Copying, and Pasting 331

Cutting, Copying, and Pasting Cross
References
Arbortext Styler enables you to cut, copy, and paste cross reference objects
through operations on the Edit menu, associated keyboard shortcuts, toolbar
buttons, and the shortcut menu. You cannot cut or copy multiple cross references
in a single operation.
The following procedure demonstrates how to copy and paste a cross reference
object. Cutting and pasting is a similar operation, but the cut cross reference is
removed from the Cross References list.

Copying and Pasting a Cross Reference Object

1. In Arbortext Editor, open your document and use the Styler menu to open a
stylesheet.
2. In Arbortext Styler, select the Cross References tab to display the cross
reference objects configured for the stylesheet.
3. Select the table you want to copy in the Cross References list.
4. Select Edit ▶ Copy to copy the cross reference.
You can also use CTRL+C or the Copy toolbar button for this operation.
5. Select Edit ▶ Paste to paste the cross reference.
You can also use CTRL+V or the Paste toolbar button for this operation.
Arbortext Styler pastes a copy of the cross reference into the Cross References
list, after the currently selected cross reference. The name of the new cross
reference is the original cross reference name with _copy_1 (or another
number if more than one copy is made) appended. The new cross reference is
highlighted for renaming.
6. Rename the cross reference, if desired.
For example, you might not need to rename the pasted cross reference if you
are modifying the original cross reference and want to keep the copy to
preserve the original state of the cross reference for reference.

Note
Definitions are always pasted into the root module. If the copied cross
reference was in a different module, or if it was cut instead of copied, then
_copy_1 is not appended to the cross reference's name. If they are in
different modules, multiple definitions can have the same name. However,
definition names must be unique in each individual module.

332 User's Guide

Cutting, Copying, Pasting, and Deleting
Properties
Arbortext Styler enables you to cut, copy, paste, and delete sets of formatting
properties via the Edit ▶ Properties menu. The properties of the following objects
can be cut, copied, and pasted between other objects:
• Contexts
• Conditions
• Property sets

Copying and Pasting Properties

1. In Arbortext Editor, open your document and use the Styler menu to open a
stylesheet.
2. In Arbortext Styler, click on the plus sign ( + ) beside the element with the
context or condition properties you want to copy in the Elements list. The
element's contexts and associated conditions are displayed.
If you wish to copy the properties configured for a property set, select that
property set in the Property Sets list and proceed to the next step in this
procedure.
3. In the Elements list, select the context or conditions for which you want to
copy the associated properties.
4. Select Edit ▶ Properties ▶ Copy to copy the selected context or condition's
properties.
5. In the Elements list, select the element context or condition to which you wish
to paste the copied properties.
6. Select Edit ▶ Properties ▶ Paste. The Paste Properties dialog box opens.
7. Indicate the property uses for which you would like to replace the properties
for the selected context or condition in the Paste Properties dialog box and
close the dialog box.
Arbortext Styler pastes the copied properties into the selected uses.

Cutting and Pasting Properties

1. In Arbortext Editor, open your document and use the Styler menu to open a
stylesheet.
2. In Arbortext Styler, click on the plus sign ( + ) beside the element with the
context or condition properties you want to cut in the Elements list.
The element's contexts and associated conditions are displayed.

Cutting, Copying, and Pasting 333

 If you wish to cut the properties configured for a property set, select that
property set in the Property Sets list and proceed to the next step in this
procedure.
3. Select the object for which you want to cut the associated properties.
4. Select Edit ▶ Properties ▶ Cut. All properties for the selected object are reset to
0 or no value.
5. Select the element context or condition to which you want to paste the cut
properties in the Elements list.
6. Select Edit ▶ Properties ▶ Paste. The Paste Properties dialog box opens.
7. Indicate the property uses for which you would you like to use the cut
properties for the selected context or condition in the Paste Properties dialog
box and close the dialog box.
Arbortext Styler pastes the cut properties into the selected use(s).

Moving Element Properties to a Property Set

In this procedure, properties for an element context or condition are moved to a
new property set that is referenced by the original context or condition.
1. In Arbortext Editor, open your document and use the Styler menu to open a
stylesheet.
2. In Arbortext Styler, click on the plus sign ( + ) beside the element with the
context or condition properties you want to move in the Elements list.
The element's contexts and associated conditions are displayed.
3. Select the context or condition for which you want to move the associated
properties.
4. Select Edit ▶ Properties ▶ Cut. All properties for the selected object are reset to
0 or no value.
5. Select the Property Sets list to display a list of the property sets current
configured for the stylesheet.
6. Select Insert ▶ Property Set to create a new property set.
7. Enter the name of the new property set in the Property Set field.
8. Select Edit ▶ Properties ▶ Paste. the properties of the selected property set are
reset to the values cut from the original context or condition.
9. Select the Elements list to display elements configured for the stylesheet. Note
that the element from which you cut the properties is still selected in the list,
although it has no formatting properties specified.

334 User's Guide

10. Go to the Property sets category.
11. Select the new property set in the list of Available property sets and click Add
to add it to the list of Used property sets.
Be sure to set the Outputs to edit field appropriately before doing this step, to
ensure that the property set is only used for the element in certain output
circumstances.
Note that if the selected context or condition has properties for multiple uses and
you want each of those uses to reference a property set, you must repeat steps 6
through 13 to create a property set for each of those uses.

Deleting Properties
1. In Arbortext Editor, open your document and use the Styler menu to open a
stylesheet.
2. In Arbortext Styler, open the Elements list. Click on the plus sign ( + ) beside
the element with the context or condition whose properties you want to cut.
The element's contexts and associated conditions are displayed.
Note that you could also view and select a property set for this operation.
If you wish to delete the properties configured for a property set, select that
property set in the Property Sets list and proceed to the next step in this
procedure.
3. Select the object for which you want to delete the associated properties.
4. Select Edit ▶ Properties ▶ Delete. Arbortext Styler deletes the properties for the
selected uses.

Cutting, Copying, and Pasting 335

 14
Creating Headers and Footers
Headers and Footers Overview ................................................................................ 338
Creating a Header or Footer..................................................................................... 338
Adding Content to a Header or Footer ....................................................................... 341
Inserting Division References in Headers and Footers................................................ 343
Adding Page Numbers to Headers and Footers ......................................................... 345

This section describes how to manage headers and footers via your stylesheet.

337
Headers and Footers Overview
The process by which to add headers and/or footers to your document has three
principal steps:
1. Create Page Region objects for each type or format of header or footer you
may wish to reference in your document.
Identify the page regions as headers or footers by defining their position on the
page in the Position category for the Page Regions list.
Add any text content, graphics, numbering, fills or other information to each
object as required
2. Reference the page region(s) from a page type to create a page layout.
3. Reference the page type that includes the required header and/or footer from
the relevant page set.
From within a page set you specify the page type (layout) that should be used
for documents with single- or double-sided pages. You can also configure
different page types to be used at certain positions within the final document,
for example a page layout for the first page that differs from the rest of the
pages in the page set, or a page type that defines regions containing no content
for blank pages.

Creating a Header or Footer

To create a header or footer, create a Page Region object and define its position as
a header or footer for the page in the Position category. You may then add text or
graphical content as required.
To be identified as header or footer, regions must have certain characteristics:
Header
• Same left and right margins as the page body
• Does not overlap the page body
• Top aligned
Footer
• Same left and right margins as the page body
• Does not overlap the page body
• Bottom aligned
Once you have created the page region you can reference it from the relevant page
set by including it in one of the page types configured for the page set. In this way
you can ensure that different pages in a page set display different page layouts,
including headers or footers.

338 User's Guide

Example: Creating Headers and Footers for a Single-Sided Page Set
The example given below defines different header and footer page region objects
for the first and body pages of a single sided page set. Refer to Creating a Page Set
on page 182 for information on how to set up a page set.
The headers and footers described in this example only contain text. You can also
include graphics in headers or footers.
1. Before creating your header and footer page regions, ensure that the page
types that will provide page layout for the first page and the body pages of
your page set exist in the Page Types list .
Configure your page set so that the relevant page types are selected in the
Right and left pages and First page fields in the Page types category. You will
need to deselect the Double sided option.
2. In the Page Regions list , use the Insert ▶ Page Region menu option to
create two new page region objects. Name them firstpage—header and
bodypage-header.
3. Select firstpage-header, then navigate to the Position category of the
properties area.
4. Set the fields in the category to define the size of the page region and place it
at the top of the page as a header. For example, for a Letter sized page:
• Region reference point: Top Left
• X position: 1in from page left
• Y position: 0.5in from page top
• Width: 6.5in absolute measure
• Height: 1in absolute measure

Here you have created a 1in high region, placed 1in from the left and right
edges of the page and 0.5in from the top of the page.
5. Navigate to the Text category. In the Type field, select Generated to indicate
you want the header to display text that is not the main content of the
document.
6. Choose Insert ▶ Generated Content to create a new Generated Content object.
Use the Edit button to open the Generated Text Editor. Add the header text
First page header in the center cell of the Generated Content object and
format it as required.
Navigate back to the Text category of the Page Regions list. Choose the
Generated Content object you have just created from the list in the Generated

Creating Headers and Footers 339

 Content field. Add any alignment and padding requirements in the Vertical
alignment and Interior padding fields.
7. Navigate to the Page Types list. Select the Page Type object that will provide
page layout for the first page of your page set. Use the Add button in the
properties area to add the firstpage-header page region to the list in the
Page region (front to back) field. Use the up and down arrows to move the
region to the required place in the list to ensure it is output in the correct order
with other page regions.
You have now specified that the page region firstpage-header will be
output as a header on the first page of your page set.
8. Repeat steps 3–7 for the bodypage-header page region, giving it the text
content Header for body pages.
Assign the bodypage-header page region to the page type you selected to
provide page layout for the right and left pages of your page set.
You have now specified that the page region bodypage-header will be
output as a header on the body pages of your page set.
9. Navigate back to the Page Regions list and create two more new page region
objects. Name them firstpage-footer and bodypage-footer.
10. Select firstpage-footer, then navigate to the Position category in the
properties area.
11. Set the fields in the category to define the size of the page region and place it
at the bottom of the page as a footer. For example, for a Letter sized page:
• Region reference point: Bottom right
• X position: 1in from page right
• Y position: 0.5in from page bottom
• Width: 6.5in absolute measure
• Height: 1in absolute measure

Here you have created a 1in high region, placed 1in from the left and right
edges of the page, and 0.5in from the bottom of the page.
12. Navigate to the Text category. In the Type field, select Generated to indicate
you want the footer to display text that is not from the document source.
13. Choose Insert ▶ Generated Content to create the Generated Content object that
defines the footer text.
Create the footer text First page footer in the right cell of the Generated
Content object and use the Insert ▶ Page Number menu option to output the
page number in the left cell. Format both fields as required.

340 User's Guide

 Navigate back to the Text category of the Page Regions list. Choose the
Generated Content object you have just created from the list in the Generated
Content field. Add any alignment and padding requirements in the Vertical
alignment and Interior padding fields.
14. Navigate to the Page Types list. Select the Page Type object that will provide
page layout for the first page of your page set. Add the firstpage-
footer page region to the list in the Page region (front to back) field. Use the
up and down arrows to move the region to the required place in the list to
ensure it is output in the correct order with other page regions.
Refer to Page Types List on page 772 for information on region order.
You have now specified that the page region firstpage-footer will be
output as a footer on the first page of your page set.
15. Repeat steps 10–14 for the bodypage-footer page region, giving it the
text content Footer for body pages.
Assign the bodypage-footer page region to the page type you selected to
format the right and left pages of your page set.
You have now specified that the page region bodypage-footer will be
output as a footer on the body pages of your page set.
16. Preview your document via the Preview ▶ Print menu option to review these
changes. You will see that each element in the document that references your
page set displays one header and footer on the first page, then a different
header and footer on all subsequent pages. The headers and footers are
positioned according to the settings you made for the page regions in the
Position category.

Adding Content to a Header or Footer

Generated Content objects define generated text content for a page region. You
will most likely use this kind of content for a header or footer. Choose the Insert ▶
Generated Content menu option to create a new Generated Content object.
Once you have created and configured the Generated Content object, you
reference it from the page region that represents your header or footer. You will
subsequently reference the page region from the page type that provides the layout
for the pages on which you want your footer to appear.
It is possible to include the following items in a Generated Content object. They
are all configured using the Generated Text Editor, accessed via the Edit button in
the properties area of the Generated Contents list:
• Graphic: use the Insert ▶ Graphic menu option.
• Markup: use the Insert ▶ Markup menu option.

Creating Headers and Footers 341

• Symbols: use the Insert ▶ Symbol menu option.
• Tables: use the Insert ▶ Table menu option
• Division references: use the Insert ▶ Division Reference menu option
• Page numbers: use the Insert ▶ Page Number and Insert ▶ Final Page Number
menu options
• Element and attribute content: use the Insert ▶ Element Content and Insert ▶
Attribute Content menu options
• Leaders, rules, and space fills: use the Insert ▶ Leaders, Rule or Space menu
option

Example: Adding Content to a Header

The procedure below details how to create a header that contains basic content
made up of some static text and a logo.

1. In the Generated Contents list , use the Insert ▶ Generated Content menu
option to create a new Generated Content object. Name it bodypage-
header.
2. Highlight bodypage-header, and click the Edit button in the list's
properties area to open the Generated Text Editor. Add the text Header for
test document in the center cell of the table.
3. Highlight the text you have just typed and choose the Format ▶ Font menu
option in the Generated Text Editor. The Modify Font dialog box opens.
4. In the dialog box, set the Bold field to Yes and the Color field to Red. Click
OK to save the changes and exit the dialog box. The text is now surrounded by
a _font tag pair.
5. Place your cursor in the right hand cell of the table. Choose the Insert ▶
Graphic menu option to open a directory browser with which you can navigate
to the logo you wish to display in the header.
6. Navigate to the required logo. Click Open to insert the graphic into the right
header cell, preceded by a _gentextgraphic tag.
7. Highlight the graphic, including the _gentextgraphic tag, and click Edit
▶ Modify Attributes to open the Modify Attributes dialog box for the graphic.
8. Scale the graphic if required. Click OK to save the changes and exit the dialog
box.
When a graphic is resized, it may cause a resize of the table cells. The text
may not be centred next to the logo. This will be corrected in the next step.
9. Highlight the text in the middle cell, including its _font tags, and choose the
Table ▶ Table Properties menu option. The Table Properties dialog box opens.
Click on the Cell tab.

342 User's Guide

10. Set the vertical justification of the cell to Centered. Click OK to save the
change and exit the dialog box. The text is now centered vertically in the
middle cell of the table.
11. Choose File ▶ Apply and Close to save the new header configuration and exit
the Generated Text Editor. You will see that the read only field in the
properties area of the Headers list describes the generated text settings you
have made for your header object.
12. Navigate to the Page Regions list. Select the page region that represents your
header and go to the Text category.
13. In the Type field, select Generated.
14. In the Generated Content field, select the Generated Content object you have
just created.
15. Add any alignment or padding for the content in the region.
You have now completed the creation of content for your header.
16. If you have not already done so, assign the page region representing your
header to the page type representing the layout of the pages that should display
your header.
17. Assign the page type to the relevant page set, if you have not already done so.
18. Choose the Preview ▶ Print menu option. You will see that the header is
displayed on the relevant pages of the previewed document.

Inserting Division References in Headers

and Footers
You can insert division references, such as chapter title, in Generated Content
objects. This is especially useful when referenced from page regions that represent
headers and footers. This allows you to set the division information that displays
in headers and footers to change dynamically as the divisions change in a
document.

Example: Inserting a Division Reference in a Header

The example given below adds a division reference to a header region. The
number of the current chapter will display in the header. The example assumes
that the stylesheet is configured to include numbered divisions, for example
numbered chapters.

1. In the Generated Contents list , create a new Generated Content object and
name it divnumbered-header.

Creating Headers and Footers 343

 Refer to Adding Content to a Header or Footer on page 341 for an example of
how to create content for a header or footer.
2. Highlight divnumbered-header then click the Edit button in the
properties area to open the Generated Text Editor. Place your cursor in the
middle cell of the table, then choose Insert ▶ Division Reference. The Insert
Division Reference dialog box opens.
3. Select chapter in the All divisions field. Select the required cross reference
format from the Cross reference format list. Click OK to save the changes and
exit the dialog box. Arbortext Styler will add the object
DivisionReference into the cell.

Note that the All divisions field displays a list of all the divisions configured
for your stylesheet, if applicable. For example, if your stylesheet defines three
levels of the section element, the following entries will appear in the field:
section, section in section, and section in section in
section. You are permitted to select any of these recursive divisions to form
the target of your division reference.
4. Add any text you would like to appear either side of the division reference.
5. Choose File ▶ Apply and Close to save the change and exit the Generated Text
Editor. You will see that the read only field in the properties area of the
Generated Contents list describes the generated text settings you have made
for the Generated Content object.
You have now configured the content for your Generated Content object.
6. Assign the Generated Content object divnumbered-header to the page
region representing your header.
7. If you have not already done so, assign the page region representing your
header to the page type representing the layout of the pages that should display
your header.
8. Assign the page type to the relevant page set, if you have not already done so.
9. Choose the Preview ▶ Print menu option. You will see that the header is
displayed on the relevant pages of the previewed document.

Inserting a Division Reference to a Title that Contains Footnotes

If you insert a division reference into your header or footer where the target title
contains footnotes, you may encounter error messages of the form shown below
when publishing your document:
[A12531] ERROR: Styldesc counter variable "cnt__footnote_default_footnotes.cnt"
is modified in the pagedesc.

344 User's Guide

You will also see the footnote reference in the header, but generally no footnote
will appear on the page.
To avoid this situation, create the context footnote anywhere in
_sfe:xxxx for the relevant generated text element. Navigate to the Footnote
category for the context and check the Element is not footnote related property.
This will delete the generated context for Footnote body and will set the value of
Hidden to No for the context, which is now the only context. Reset the value of
Hidden to Yes here to avoid the error.
For example, if you create the context footnote anywhere in
_sfe:HeaderOrFooter, it will be matched for footnotes in headers and
footers and the footnote reference will not appear when the title appears in a
header or footer. As another example, you could create the context footnote
anywhere in _sfe:Gentext. In this case you will ensure that footnote
references will be hidden when the title appears in headers, footers, tables of
contents, and cross references.
This issue will only occur if you are publishing print/PDF output via the FOSI
engine.

Adding Page Numbers to Headers and

Footers
You can add page numbers to page regions representing headers or footers. Page
numbers can appear either alone or within a string, for example x of y pages
(where x is the current page number and y is the total number of pages in the
document).
Arbortext Styler can generate compound page numbers (for example, 1-1 as the
page number for the first page in the first chapter in your document, 1–2 for the
second page in the first chapter, etc.), using a division number and a page number.
This is done by changing the format of the page numbering accordingly. Once set,
the compound format will be used wherever page numbers are referenced, e.g. in
tables of contents, indexes, and cross-references as well as headers and footers.
You can then insert these compound numbers in headers and footers as usual. To
use a division number as part of the compound page number the division must
start a page set, and restart the page numbering.

Example: Adding Page Numbers to a Header

The example given below adds the page number to a header region. The page
number will display in the header of pages formatted by the relevant page set.

1. In the Generated Contents list , create a new Generated Content object and
name it numbered-header.

Creating Headers and Footers 345

 Refer to Adding Content to a Header or Footer on page 341 for an example of
how to create content for a header or footer.
2. Highlight numbered-header then the Edit button to open the Generated
Text Editor. Place your cursor in the right hand cell of the header table, then
choose Insert ▶ Page Number. Arbortext Styler will add the object
FormattedPageNumber into the cell.
3. Add any text you would like to appear with the page number.
4. Choose File ▶ Apply and Close to save the change and exit the Generated Text
Editor. You will see that the read only field in the properties area of the
Generated Contents list describes the generated text settings you have made
for your Generated Content object.
You have now configured the content for your Generated Content object.
5. Assign the Generated Content object numbered-header to the page region
representing your header.
6. If you have not already done so, assign the page region representing your
header to the page type representing the layout of the pages that should display
your header.
7. Assign the page type to the relevant page set, if you have not already done so.
8. Preview your document via the Preview ▶ Print menu option to review these
changes.
In the Print Preview window, note that the page number displays in the top
right-hand corner of every page formatted by the page set.
9. To ensure numbering restarts at 1 in every occurrence of a division, for
example a chapter, go to the Elements list and access the Breaks category for
the division element formatted by the page set.
10. In the Page set field, choose the Initial option in the Page number list.
11. Preview your document via the Preview ▶ Print menu option to review these
changes.
In the Print Preview window, note that the number 1 now displays in the top
right-hand corner of the first page of the selected division, followed by
consecutive page numbers until the next occurrence of the division is reached.

346 User's Guide

x of y pages Numbering
Example: Adding the String X Of Y Pages to a Footer
The example given below adds the current page number to a footer, in the form x
of y pages.

1. In the Generated Contents list , create a new Generated Content object and
name it numbered-footer.
Refer to Adding Content to a Header or Footer on page 341 for an example of
how to create content for a header or footer.
2. Highlight numbered-footer then click the Edit button to open the
Generated Text Editor for the footer. Place your cursor in the right hand cell of
the footer table, then choose Insert ▶ Page Number. Arbortext Styler will add
the object FormattedPageNumber into the cell.
3. After FormattedPageNumber object, add a space, the word of and
another space, then choose Insert ▶ Final Page Number. The Final Page Number
dialog box opens.
4. Select Document to add the number of the last page of the entire document.
Click OK to exit the dialog box.
Arbortext Styler will add the object FinalPageNumber into the cell.
5. After the FinalPageNumber object, add a space and the word pages.

6. Choose File ▶ Apply and Close to save the change and exit the Generated Text
Editor. You will see that the read only field in the properties area of the
Generated Contents list describes the generated text settings you have made
for your footer.
You have now configured the content for your Generated Content object.
7. Assign the Generated Content object numbered-footer to the page region
representing your footer.
8. If you have not already done so, assign the page region representing your
footer to the page type representing the layout of the pages that should display
your footer.
9. Assign the page type to the relevant page set, if you have not already done so.
10. Choose Preview ▶ Print.

Creating Headers and Footers 347

 In the Print Preview window, note that the phrase x of y pages displays in
the bottom right-hand corner of every page formatted by the specified page
set.

Compound Page Numbers

Example: Creating Compound Page Numbers in a Header
The example given below adds a compound page number to a header region. The
number will take the form of the chapter number, followed by the number of the
page within the chapter, e.g. 1–1, 1–2, etc. The example assumes that a page set
has already been assigned to format the chapters in your document.

1. In the Generated Contents list , create a new Generated Content object and
name it cmpdnumbered-header.
Refer to Adding Content to a Header or Footer on page 341 for an example of
how to create content for a header or footer.
2. Highlight cmpdnumbered-header then click the Edit button in the
properties area to open the Generated Text Editor. Place your cursor in the
middle cell of the header table, then choose Insert ▶ Page Number. Arbortext
Styler will add the object FormattedPageNumber into the cell.
3. Choose File ▶ Apply and Close to save the change and exit the Generated Text
Editor. You will see that the read only field in the properties area of the
Generated Contents list describes the generated text settings you have made
for your header.
4. Assign the Generated Content object cmpdnumbered-header to the page
region representing your header.
5. If you have not already done so, assign the page region representing your
header to the page type representing the layout of the pages that should display
your header.
6. Assign the page type to the page set that formats chapters, if you have not
already done so.
7. Still in the Page Sets list, open the Page numbers category for the page set that
will format chapters.
8. Click the Edit button to edit the Format field. Arbortext Styler opens the Page
Number Format editor.
9. Place your cursor before the number object that already appears in the editor,
then choose the Insert ▶ Page Set Starting Division Number menu option.
Arbortext Styler inserts an icon with the section symbol, §, to represent the
division number.

348 User's Guide

10. Type a dash (-) between the division number and page number symbols.

11. Choose Preview ▶ Print.

In the Print Preview window, note that compound page numbers display in the
headers of each chapter.

Creating Headers and Footers 349

 15
Working with Tables of Contents
Table of Contents Overview...................................................................................... 352
Creating a Basic Table of Contents Format Object ..................................................... 355
Styling an Element to Generate a Table of Contents................................................... 357
Customizing the Content of a TOC............................................................................ 360
Applying Non-Standard Formatting to a Table of Contents .......................................... 370

This section describes how to manage tables of contents via your stylesheet.

351
Table of Contents Overview
Arbortext Styler supports three types of table of contents (TOC).
• Inline TOC: Setting an element or elements to generate an inline table of
conditions at any location in the output document.
• PDF bookmarks: Using a table of contents format object to contribute entries
as autogenerated bookmarks in PDF output - see Use for PDF bookmarks in
Tables of Contents List on page 774 for further information
• Online TOC: Using a table of contents format object to contribute entries to an
online TOC for chunked HTML outputs - see Use for chunked HTML outputs (
EPUB, HTML Help, and Web) in Tables of Contents List on page 774 for further
information.
The online TOC is the TOC that appears in the left hand frame of the browser
window when viewing the chunked HTML content.
All three types of TOC are configured using the same base method. The difference
in setting up the TOCs comes when you are defining where in final output the
TOC should occur. A summary of the process is given below:

1. Create a table of contents format object in the Tables of Contents list - this
object defines an overall TOC configuration:
• The scope of the TOC within the output document
• The element contexts that should form its entries and the levels at which
they should appear - any contexts of the title element can be included in a
TOC. See Customize Table of Contents Dialog Box on page 937 for
further information.
Note that settings of this type will not affect the online TOC for chunked
HTML outputs.
• Any custom numbering or generated text that should be applied to each
entry
• The overall appearance of the TOC - placement of numbers, indentation of
entries, and so on. See Table of Contents Format Details Dialog Box on
page 1052 for further information.
You can maintain as many TOC format objects as you like in your stylesheet.

352 User's Guide

 Note
If you subsequently specify that this table of contents format object should
be used to generate an online TOC in chunked HTML output (see step 2
below), any special TOC entry formatting properties set will not apply to
TOCs when you publish your document for EPUB, HTML Help, or Web.
In these outputs the main (left hand frame) TOC is generated by the
chunker, which only makes reference to those settings that determine
which titles should be included. The titles will appear in the TOC as they
appear in the body of the document — special formatting is ignored.

Settings made in the Customize Table of Contents and TOC Format Details
dialog boxes may not have an effect in your document, if it is published to a
particular output format. The following table shows which TOC features affect
which outputs.
Editor Print/ PDF RTF All EPUB,
PDF book- HTML HTML
marks outputs Help, or
(inline Web
TOCs)3 (Web
TOCs)4
Customize TOC dialog box setting:
Titles to • • • • • •
include
Level1 • • x x5 • x
Custom • • •2 • • x
content
TOC • • • • • •
condition

All TOC • • x x5 • x
Format
Details
dialog
box
settings

1
The levels assigned to titles affect the formatting, not the position in the
hierarchy.

Working with Tables of Contents 353

 2
Print output via the XSL-FO engine does not reflect custom content
settings. Print output via FOSI and PTC APP engines does take these into
account.
3
Inline TOCs appear in the document content.
4
The Web TOC is the separate TOC that appears in the left frame of the
browser window.
5
Microsoft Word formats TOCs in exported RTF. You can control the
format by using named styles.
2. Specify whether the table of contents format object will contribute entries to
PDF bookmarks or online TOCs. If so, check one of the following options for
the object in the properties area of the Table of Contents list:
• Use for PDF bookmarks - you can select this checkbox for more than one
table of contents format object in the same stylesheet. The resulting
bookmark list in the output PDF will contain all the titles that are
configured to appear in all table of contents format objects in the stylesheet
that have Use for PDF bookmarks checked. Duplicate TOC entries are
removed.
• Use for chunked HTML outputs (EPUB, HTML Help, and Web) - you can
select this checkbox for more than one table of contents format object in
the same stylesheet. The resulting online TOC will contain all the titles
that are configured to appear in all table of contents format objects in the
stylesheet that have Use for chunked HTML Outputs checked. Duplicate
TOC entries are removed.
When generating TOCs for EPUB output with this option, only titles at
levels 1–3 in the document hierarchy will be included.
3. For an inline table of contents, style an element in your document to output the
table of contents - in the first instance, assign the Table of Contents style to the
element. The next step is to set its generated text to reference the required
table of contents format object and output the table of contents in the format
set by that object.

354 User's Guide

Creating a Basic Table of Contents
Format Object
Table of content format objects are created and managed via the Tables of
Contents list . Note that if you select this menu option when any other list is
active, you will be taken to the Tables of Contents list.
The procedure detailed below describes the steps involved in creating your table
of contents format object:
1. In the Tables of Contents list, click Insert ▶ Table of Contents. A new table of
contents format object is added to the list, with the name
TableOfContents.
2. Click the object again and rename it as required. You will see a message
asking you to confirm that you wish to rename the object, since the name
change will filter through to all references in all modules of the stylesheet.
Click OK to complete the rename action.
3. In the Scope field, set the element level for which the table of contents should
apply, or leave the default setting of Whole Document to create a document
level table of contents.
4. Elect whether the table of contents object will contribute entries to PDF
Bookmark or online TOCs:
• PDF output: check the Use for PDF bookmarks option to specify that
entries from this table of contents format object are to be included as
bookmarks in PDF output
• Chunked HTML output: check the Use for Chunked HTML outputs (EPUB,
HTML Help, and Web) option to specify that entries from this table of
contents format object are to be included in the online TOC in chunked
HTML output
Note that table of contents format objects may also be included as inline
TOCs, as described in Styling an Element to Generate a Table of Contents on
page 357. A single table of contents format object may be included in more
than one location. If more than one object is selected to be included as a PDF
bookmark or online TOC in chunked HTML output, all the entries from the
different objects will be merged, and any duplicates removed.
5. Set the types of title that should be extracted from the document as entries for
the table of contents - as a general setting you can elect to include all division
titles configured for your stylesheet, by checking the Division titles option.
You can also click the Customize button to open the Customize Table of
Contents dialog box, where you can individually select the element contexts

Working with Tables of Contents 355

 that should form each level of your TOC. In the list you will see all elements
that have the Title style applied in the stylesheet.
From this dialog box you may also configure any custom numbering or
generated text that should be applied to each entry. See Customizing the
Content of a TOC on page 360 for further information.
6. If you have elected to include Division titles in your table of contents, set the
level to which the table of contents will reach in the Number of levels field.
The range is 1 to 10; with 3 being the default. The levels refer to the
hierarchical elements that have been assigned the Division style. For example,
if you have only mapped the chapter element to the Division style only the
chapter titles will appear in the table of contents, even if you choose to
display 3 levels. If, on the other hand, you have applied the Division style to
the chapter, sect1, sect2, sect3, and sect4 elements, then you need
a setting of 5 levels to produce a table of contents that includes all these
elements.
Note that any include/exclude settings made for division titles in the
Customize Table of Contents dialog box will override the level setting here.
See Customize Table of Contents Dialog Box on page 937 for further
information.
7. Click the Format... button to open the Table of Contents Format dialog box,
where you can define the display of your TOC.
When you have finished setting up your table of contents format object, you can
include it in several locations:
• To generate an inline TOC: reference the table of contents format object from
an element given the Table of Contents style in the Elements list. The selected
element will produce the table of content as its generated text. See Styling an
Element to Generate a Table of Contents on page 357 for further information.
• To contribute its entries as bookmarks in PDF output - ensure the Use for PDF
bookmarks option is selected for the object in step 4
• To contribute its entries in an online TOC for chunked HTML outputs- ensure
the Use for Chunked HTML outputs (EPUB, HTML Help, and Web) option is
selected for the object in step 4

356 User's Guide

Styling an Element to Generate a Table of
Contents
This section describes how to style an element so it generates a table of contents
in your document's final output. There are two examples listed - the first one uses
the default table of contents element in a document type whilst the second shows
you how to specify that any element in your document type can be used to output
a table of contents.

Example: Styling a toc Element to Generate a Table of Contents

1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/styler.
2. Choose Styler ▶ New Stylesheet to create a new stylesheet.
3. In Arbortext Styler, select the chapter element in the Elements list.
4. Choose Division as the style for the element, via the Edit ▶ Style menu option.
Click OK in the Division Details dialog box to accept 1 as its division level.
Here you have specified that chapter elements should constitute the divisions
in your document, and that they should be classed as level 1 in the document's
division hierarchy.
5. Select the toc element in the Elements list.
6. Choose Table of Contents as the element's style. The Table of Contents Details
dialog box opens.
7. Select the table of contents format object that contains the formatting you
require. If the list is blank, you will need to create a new object.
8. Click OK to save the change and exit the dialog box. The selected table of
contents format object is now associated with the toc element.
Note that the description of the toc element and its Generated text properties
confirm that it is associated with the selected table of contents format object,
in this case Chapter Table of Contents:

9. Choose Preview ▶ Print.

Working with Tables of Contents 357

 In the Print Preview window, note that the table of contents displays after the
first paragraph in the document.
You can create table of contents format objects and associate them with elements
other than a toc element. This is helpful if your document type doesn't include a
table of contents element.

Example: Styling a Block Element to Generate a Table of Contents

This example continues from the previous one, using the transport.xml
sample file and the new stylesheet created in that example. Here the element
authorblurb will be defined as a Table of Contents element and used to
generate a table of contents based on the titles of sect1 elements.
1. In Arbortext Editor, locate the title element after the second chapter
element.
2. Insert an authorblurb tag directly after the title element, before the
first formalpara element.
3. In Arbortext Styler, create a new table of contents format object via the Insert
▶ Table of Contents menu option. Name the object chapter and make the
following changes:
• Set the Scope to chapter. This creates a table of contents that will list all
occurrences of the selected element(s) from the chapter in which it
appears.
• Deselect the Division titles option to specify that Arbortext Styler should
not use the titles of all the divisions in your document (e.g. chapters) as
table of contents entries.
• Click the Customize button to open the Customize Table of Contents dialog
box.
• In the dialog box, check the Include box for the title in sect1
context.
Here you have confirmed that the chapter Table of Contents object
should use all title in sect1 contexts in the chapter as its entries.
4. Back in the Elements list, select the authorblurb element.
5. Apply the Table of Contents style to the element. The Tables of Contents
Details dialog box opens.
6. Select the chapter table of contents format object from the Select a table of
contents list then click OK to exit the dialog box. The Description tab for the
element and its Generated text properties show that the table of contents
format object has been applied as generated text:
7. Choose Preview ▶ Print.

358 User's Guide

 In the Print Preview window, note that the chapter-level table of contents
displays after the title of the second chapter.
You can modify a table of contents by adding division levels, changing its
appearance, or adding generated text to a table of contents.

Example: Modifying a Table of Contents Format

This example continues from the previous one, using the transport.xml
sample file and the new stylesheet created in that example.
1. In the Elements list, select the sect1 element.
2. Apply the Division style to the element via the Edit ▶ Style menu option. The
Division Details dialog box opens.
3. Set the Division Level to 2 then click OK to exit the dialog box.
4. Choose Preview ▶ Print and review the document-level table of contents. You
will see that an entry for the sect1 title is now displayed.
5. In Arbortext Styler, create a new table of contents format object via the Insert
▶ Table of Contents menu option. Name the object chapter2 and make the
following changes:
• Set the Scope to chapter to create an alternative chapter-level table of
contents format.
• Deselect the Division titles option to specify that Arbortext Styler should
not use the titles of all the divisions in your document (e.g. chapters) as
table of contents entries.
• Click the Customize button to open the Customize Table of Contents dialog
box.
• In the dialog box, check the Include box for the title in sect1
context.
Here you have confirmed that the chapter Table of Contents object
should use all title in sect1 contexts in the chapter as its entries.
• Choose Format... to open the Table of Contents Format dialog box.
• Deselect the Leader dots option. Note how the display in the Print/PDF
preview window changes.
• Click OK to save the change and exit the dialog box.
6. In the Elements list, select the authorblurb element and choose the
Generated text category.
7. Choose the Edit button for the After-text field to open the Generated Text
Editor.
8. Place your cursor next to the Table of Contents element and choose Edit
▶ Modify Attributes. The Modify Table of Contents dialog box opens.

Working with Tables of Contents 359

9. Choose the chapter2 table of contents format object then click OK to exit
the dialog box.
10. Choose File ▶ Apply and Close to exit the Generated Text Editor. You will see
that the Description tab for the element and its Generated text properties show
that the setting has changed to use the chapter2 object as generated text:
11. Choose Preview ▶ Print and review the chapter-level table of contents. You
will see that leader dots no longer appear in the entries.

Customizing the Content of a TOC

This topic contains tips on customizing the content of your table of contents
(TOC), by basing the TOC on elements other than the standard title contexts,
using conditions to define the titles that should be included, and specifying the
format of the entries.

Note
Special formatting properties that specify that a title should look different in a
TOC to how it looks in the body of the document are ignored in chunked
HTML outputs (EPUB, HTML Help, and Web). These online TOCs are
generated by the chunker, which only makes reference to those settings that
determine which titles should be included

Example: Including Generated Titles in a Table of Contents

This procedure describes how to build your table of contents from titles that are
not defined in specific title elements, but rather are generated automatically for the
semantic divisions in your document. For example, your DTD may define the
elements introduction, subject, description, and summary as fixed
divisions that must occur in a certain order in the document. These elements do
not contain a child title element and as such must each generate their own title to
appear at the beginning of the division.
1. In Arbortext Styler, create an individual generated text setting for each of the
semantic division elements so that they will generate their own title in the
absence of a specific title element. Refer to Generating Titles for Divisions
Without Title Elements in Labeling and Numbering Divisions on page 483 for
further information.
If the divisions are already set up in this way, proceed to step 2.
By generating titles using this method, you are creating a substitute title
element for each of the divisions by managing a context of a single UFE in

360 User's Guide

 each division. It is this pseudo element that will be extracted and included in
the final TOC.
2. For the element that is set to generate your table of contents for the whole
document, refer to its entry in the Elements list . Proceed to its Generated
text category, and note which TOC object it will use the to format the TOC. If
this has not been done, make this setting now using the guidelines contained in
Styling an Element to Generate a Table of Contents on page 357.
3. Proceed to the Tables of Contents list and select the relevant TOC format
object. In its properties area, click the Customize button to open the Customize
Table of Contents dialog box.
4. In the contexts list in the dialog box, check the Include option for each context
of the UFE that wraps the title in your divisions. Here you have requested that
the pseudo title elements for your divisions should be extracted and included
in the TOC.
5. Click OK to exit the Customize Table of Contents dialog box.
6. Choose Preview ▶ Print to test your TOC settings. You should see that the titles
of the divisions are included in the TOC, with their page numbers, as usual.

Example: Controlling TOC Entries Based on Conditions

This procedure describes how to specify the conditions that must be matched for a
division's title to be included in a table contents (TOC). When creating conditions
for TOCs, you have access to the same types of test as when creating conditions
for elements or contexts:
• Attribute test
• Content test
• XPath test
• Start of HTML chunk test
This example is based on the sample document transport.xml, located in
your Arbortext Editor environment at Arbortext-path/samples/styler,
and its associated stylesheet.
1. In the document, note that the toc element appears before the first chapter to
generate the table of contents for the whole document. Refer to the toc
everywhere else context in the Elements list in Arbortext Styler, and
go to its Generated text category. You will see that it is set to use the Book
Table of Contents TOC object to format the TOC.
2. Go to the Tables of Contents list and select the Book Table of
Contents object.

Working with Tables of Contents 361

 Click the Customize button in the properties area of the list to open the
Customize Table of Contents dialog box.
3. Click the Add button next to the Condition each title must match field. The
Table of Contents Condition dialog box opens.
4. Use the functionality of the dialog box to create conditions based on the test
type you require. The next four steps of the procedure each give an example of
the available tests. For each one, click the button that relates to the type of test
then use the dialog box that opens to create the test.
5. Attribute test - this example will create a test based on the toc=”yes” attribute
being set for a division
a. Click the New Attribute Test button to open the Attribute Test dialog box.
b. Configure the following settings in the dialog box:
• Test attribute of : parent
• Attribute name: toc
• Comparison: = yes

Click OK to save the setting and exit the dialog box.

c. The TOC Condition dialog box displays the test attribute “toc”=
”yes”
6. Content test - this example will create a test based on the presence of text in a
division title, i.e. excluding those titles that have no content from the TOC
a. Click the New Content Test button to open the Content Test dialog box
b. Configure the following settings in the dialog box:
• Element whose content to test : current element
• Test type: includes
• Test depth: top level
• Content to test for: text content

Click OK to save the setting and exit the dialog box.

c. The TOC Condition dialog box displays the test element includes
text content at top level.
7. XPath test - this example will extract titles both of chapters that have the toc=
”yes” attribute set and of sections that include the contents=”1” attribute
a. Click the New XPath Test button to open the XPath Test dialog box.
b. Enter the XPath expression in the Enter an XPath expression field:
parent::chapter/@toc='yes' or parent::section/@contents='1'

Click OK to save the setting and exit the dialog box.

362 User's Guide

 c. The TOC Condition dialog box displays the test XPath expression
(parent::chapter/@toc='yes' or parent::section/@contents='1') is true

8. Start of HTML chunk test - this example will extract titles whose parent
division appears at the top of an HTML chunk

Note
Only use HTML chunk tests in TOC conditions if the TOC is used for
chunked HTML outputs and is not used in any other outputs. HTML
chunk tests are always false in other outputs.

a. Click the New Chunk Test button to open the Start of HTML Chunk Test
dialog box.
b. Configure the following settings in the dialog box:
• At start of HTML chunk
• Element to test: Parent element

Click OK to save the setting and exit the dialog box.

9. Note that you can define as many tests of any of these types in the TOC
Condition dialog box. Select All tests are true or Any test is true to define
which of the listed tests should be matched.
10. Click OK to exit the dialog box. The condition any title must match field in the
Custom Content dialog box shows a summary of the condition(s) that must be
matched in order for the title contexts given the Include setting to be included
in the TOC.
11. Click OK to exit the dialog box.
12. Choose Preview ▶ Print. In the print preview window, note that the titles that
match the condition(s) you described in the Custom Content dialog box are
included in the TOC.

Example: Changing a Title's Punctuation in its TOC Entry

This procedure describes how to amend the punctuation of a second level division
title when it appears in a table of contents (TOC), by specifying that a period
should come after the final section number in its compound numbering. The title
itself, when appears in the body of the document, will not include the period,
neither will those titles in the TOC that are based on first level divisions.

Working with Tables of Contents 363

This example is based on the sample document transport.xml, located in
your Arbortext Editor environment at Arbortext-path/samples/styler,
and its associated stylesheet.
1. In the document, note that the toc element appears before the first chapter to
generate the table of contents for the whole document. Refer to the toc
everywhere else context in the Elements list in Arbortext Styler, and
go to its Generated text category. You will see that it is set to use the Book
Table of Contents TOC object to format the TOC.
2. Navigate to the Tables of Contents list and select the Book Table of
Contents object.
3. Click the Customize button in the properties area of the list to open the
Customize Table of Contents dialog box.
4. Navigate to the title in sect1 context in the contexts list in the dialog
box, and click its Add button to open the Custom Content dialog box. Click the
Edit button next to the Number field to open the Custom Number generated text
editor. You will see that the field contains an ElementLabelAndNumber
element, which defines the title's numbering in the TOC.
5. Place your cursor after the ElementLabelAndNumber element and enter a
period. Choose File ▶ Apply and Close to save the changes to the number and
exit the editor.
6. Note that the additional period is displayed in the Number field in the Custom
Content dialog box. Click OK to exit the Custom Content dialog box.
7. Note that the Add button for the title in sect1 context in the Customize
Table of Contents dialog box has now changed to Edit as you have added some
custom content. Click OK to exit the Customize Table of Contents dialog box.
8. Choose PreviewPrint. In the print preview window, note that the TOC entry for
the title of the only sect1 element in the document contains the additional
period, making it 2.1. Employee information - for internal use only. The titles
in the TOC that are based on chapter elements in the document do not display
the additional period. If you refer back to the title of the sect1 element in the
body of the document you will see that it does not contain the additional
period either.

Example: Changing a Title's Numbering Scheme in its TOC Entry

This procedure describes how to amend the numbering of division titles when they
appear in a table of contents (TOC), by specifying that they should be bulleted or
hyphenated rather than numbered. The titles themselves, when they appear in the
body of the document, will be numbered based on a compound numbering
scheme.

364 User's Guide

This example is based on the sample document transport.xml, located in
your Arbortext Editor environment at Arbortext-path/samples/styler,
and its associated stylesheet.
1. In the document, note that the toc element appears before the first chapter to
generate the table of contents for the whole document. Refer to the toc
everywhere else context in the Elements list in Arbortext Styler, and
go to its Generated text category. You will see that it is set to use the Book
Table of Contents TOC object to format the TOC.
2. Navigate to the Tables of Contents list and select the Book Table of
Contents object.
3. Click the Format button in the properties area of the list to open the Table of
Contents Format dialog box. Note in the preview window that the TOC is
currently set to generate compound numbers based on its divisions, i.e. 1,
1.1, 1.1.1, etc. Close the dialog box.
4. Click the Customize button in the properties area of the list to open the
Customize Table of Contents dialog box.
5. Navigate to the title in chapter context in the contexts list in the dialog
box, and click its Add button to open the Custom Content dialog box. Click the
Edit button next to the Number field to open the Custom Number generated text
editor. You will see that the field contains an ElementLabelAnd Number
element, which defines the title's numbering in the TOC.
6. Delete the ElementLabelAnd Number tag. Choose the Insert ▶ Symbol
menu option to insert a symbol, select the Bullet character and click Insert.
Close the Insert Symbol dialog box. The Custom Number editor now contains a
bullet character.
7. Click File ▶ Apply and Close to save the numbering setting and exit the editor.
Note that the bulleted numbering setting is displayed in the Number field in the
Custom Content dialog box.
8. Click OK to exit the Custom Content dialog box. Note that the Add button for
the title in chapter context in the Customize Table of Contents dialog
box has now changed to Edit as you have added some custom content.
9. Repeat steps 5–8 for the title in sect1 context, adding a hyphen
character (-) as the symbol for its number symbol.
10. Choose Preview ▶ Print. In the print preview window, note that the TOC
contains bulleted chapter titles, and section titles numbered with a hyphen. If
you refer to the same titles in the body of the document, however, you will see
that they are numbered according the original compound numbering scheme.
11. If you want to format the positioning of the bullet and hyphen characters,
navigate to the Book Table of Contents object and click the Format

Working with Tables of Contents 365

 button to open the Table of Contents Format dialog box. You can make the
required settings for indentation and alignment for each level of the TOC here.

Example: Including Additional Generated Text in a TOC Entry

This procedure describes how to supplement an entry in a TOC with additional
generated text extracted from another element. In this case, we will add the title of
the chapter to the title of sections in that chapter, when the section titles appear in
the TOC. When the section appears in the body of the document its title will not
include the chapter information.
This example is based on the sample document transport.xml, located in
your Arbortext Editor environment at Arbortext-path/samples/styler,
and its associated stylesheet.
1. In the document, note that the toc element appears before the first chapter to
generate the table of contents for the whole document. Refer to the toc
everywhere else context in the Elements list in Arbortext Styler, and
go to its Generated text category. You will see that it is set to use the Book
Table of Contents TOC object to format the TOC.
2. Navigate to the Tables of Contents list and select the Book Table of
Contents object.
3. Click the Customize button in the properties area of the list to open the
Customize Table of Contents dialog box.
4. Navigate to the title in sect1 context in the contexts list in the dialog
box, and click its Add button to open the Custom Content dialog box. Click the
Edit button next to the Text field to open the Custom Text generated text editor.
You will see that the field contains an ElementContent element, which
defines the title's text label in the TOC.
5. Place your cursor before the ElementContent element, and choose the
Insert ▶ Element Content menu option to add content from a second element.
The Insert Element Content dialog box opens.
6. Configure the following settings in the dialog box:
• Select the by name and occurrence-within-ancestor option
• Name: title
• Occurrence: 1st
• Within: chapter
• Insert: Only content

Click OK to save the setting and exit the dialog box.

7. Add a separator between the two ElementContent elements if required,
for example a colon. Click File ▶ Apply and Close to save the generated text

366 User's Guide

 and exit the editor. The Text field in the Custom Content dialog box now
displays the updated generated text setting for the title's TOC label.
8. Click OK to exit the dialog box.
9. Click OK to exit the Customize Table of Contents dialog box.
10. Choose Preview ▶ Print. In the print preview window, note that the only second
level entry in the TOC is shown as 2 Water - the Cruise Ship: Employee
information - for internal use only. Here the title is made up of the title of the
chapter to which the sect1 element belongs, followed by the sect1's own
title, separated by a colon.
11. Refer to the sect1 element in the body of the document - you will see that it
still displays just its own title.

Create Lists of Tables and Graphics

This procedure describes how to create a list of tables and a list of graphics n your
document. You will also set tables and graphics from the document to be
numbered according to two separate numbering schemes, so that their numbers in
the lists in which they appear are consecutive. The lists will be generated from
two separate table of contents format objects, one that includes titles in table
elements as its entries, and one that includes titles in graphic elements. The lists
will have different titles, produced in the document via generated text.
This example is based on the sample document transport.xml, located in
your Arbortext Editor environment at Arbortext-path/samples/styler,
and its associated stylesheet. Some of the steps may have already been completed
for you - if so, skip to the next step.
1. In the Elements list, set the title element to be of Title style via the Edit ▶
Style menu option.
2. Set the figure element to be of Formal Block style. Arbortext Styler creates
a context for the title in a figure, i.e. title in figure, and sets it to
generate a number.
3. Select the title in figure context and copy and paste it.
4. In the New Context dialog box that opens, select the figure node in the
hierarchy and select XPath Predicate in the Position list.
5. Enter the predicate ./informaltable in the field in the XPath Predicate
dialog box. Here you have specified that this context will only match titles in
figures that contain an informaltable element. Once you have saved the
change and exited the dialog boxes, the context title in figure[./
informaltable] will appear in the Elements list.
6. Navigate to the Generated text category for the context. Set the context to be
numbered by selecting the Number option in the Numbers and bullets field.

Working with Tables of Contents 367

7. Click the Details button in the Numbers and Bullets field to open the relevant
title numbering dialog box and configure the numbering for the title.
8. Select (new) in the Custom counter field, and enter a name for the counter
that will count occurrences of a table figure, e.g. figure-table. Click OK
to exit the New custom counter dialog box.
9. Make any other changes to the formatting of the number you desire, for
example add the text Table followed by a space in the Label field. Click OK
to exit the title numbering dialog box.
10. Repeat steps 3–9 to create a context of the title element that will only
match titles in figures that contain graphics. Use the XPath predicate
./graphic, create the custom counter figure-graphic, and set the
label Graphic in the title numbering dialog box.
11. You have now configured Arbortext Styler to number tables and graphics
according to two separate numbering schemes. The next step is to create two
tables of contents in your document, one to include all titles of informal tables
and the other to include all titles of graphics.
12. Create a new table of contents format object called “List of Tables”, and set it
to include formal block titles only. In the Formal block element field, select
figure from the drop down list.
13. Click the Customize button to open the Customize Table of Contents dialog
box. The dialog box contains a list of all element contexts configured in the
stylesheet but only figure-related contexts are selected for inclusion in the
table of contents. Deselect all other figure contexts except title in
figure [./informaltable]. Here you have specified that the table of
contents “List of Tables” should only include titles of figures that contain
informaltable elements. Click OK to exit the dialog box.
14. In the Elements list, create a new context of the toc element. Set the context
to match the second occurrence of the toc element in the book element,
using the XPath predicate 2 for the toc node in the New Context dialog box.
When finished, the context toc[2] in book will appear in the Elements list.
15. Navigate to the Generated text category for the context. Click the Edit button
next to the After-text field to open the Generated Text Editor. Select Insert ▶
Table of Contents and select the List of Tables TOC object from the list in the
Insert Table of Contents dialog box. Click File ▶ Apply and Close to exit the
Generated Text Editor.
16. Create the context title in toc[2] in book for the title element. In
the Generated text category for the context, set the title text List of
Tables to appear before element content.
You have now configured a table of contents that will generate a list of tables
in your document.

368 User's Guide

17. Repeats steps 12–13 to create a table of contents format object called List
of Graphics, which includes only the figure context title in
figure[./graphic].
18. Repeat steps 14–15 to create the context for the third occurrence of the toc
element in the book, i.e. toc[3] in book, and assign the List of
Graphics TOC object to that context.
19. Repeat step 16 to create the title in toc[3] in book context, and set it
to generate the title List of Graphics.
20. In the transport.xml document, add two more toc elements after the
existing one at the beginning of the document. Add a title child element for
each toc element.
21. Back in Arbortext Styler click Preview ▶ Print to generate a preview of the
printed document. You will note that the document now contains three tables
of contents -Contents, List of Tables, and List of Graphics.
If you want to generate lists that contain entries, add figure elements with
titles in your document, and give them graphic or informaltable
children. You will note two things when you regenerate the print preview:
a. The titles of the graphic and informaltable elements will be
numbered, and counted according to their separate counting schemes.
b. The List of Tables and List of Graphics lists will include links to titles of
these figures.

Including a Title that Contains Footnotes

If you elect to include a title that contains footnotes in your table of contents, you
may encounter error messages of the form shown below when composing your
document:
[A12531] ERROR: Styldesc counter variable "cnt__footnote_default_footnotes.cnt"
is modified in the pagedesc.

You will also see the footnote reference in the title, and a footnote will appear on
the page.
To avoid this situation, create the context footnote anywhere in
_sfe:xxxx for the relevant generated text element, and set the value of the
Hidden field in the Text category to Yes for that context. For example, if you
create the context footnote anywhere in _sfe:Table of Contents, it
will be matched for footnotes in tables of contents and neither the footnote
reference nor footnote will appear when the title appears in the table of contents.
As another example, you could create the context footnote anywhere in
_sfe:Gentext. In this case you will ensure that footnote references will be
hidden when the title appears in headers, footers, tables of contents, and cross
references.

Working with Tables of Contents 369

Applying Non-Standard Formatting to a
Table of Contents
This section contains tips on using Arbortext Styler to format your table of
contents in ways that may not be achievable through the properties area of the
Table of Contents list alone.

Example: Displaying TOC Numbering to the Left of the Table of

Contents Entries
By default, Arbortext Styler does not support the display of TOC numbering to the
left of the TOC entries, but this can be achieved by editing the .style file
directly once a standard TOC is in place in the document. The steps in the
following procedure will produce a TOC with the page numbers right aligned to
the left of the TOC entry text.
1. Add a table of contents element to the relevant place in your document and
add the basic formatting you require. This step can be skipped if a suitably
formatted TOC already exists in your document.
2. In Arbortext Styler, navigate to the Table of Contents list and select the
TOC object whose numbering you wish to change.
3. Click the Format... button to open the Table of Contents Format dialog box.
4. Make the following changes:
• Select the Show page numbers option
• Select the Right align page numbers option
• Set the value of Text right indent: to 0pt.
• Set the value of Minimum space or leaders before page number: to 0pt
• Deselect the Leader dots option.
• Deselect the Indent levels option.

370 User's Guide

5. Click the Details... button to open the Table of Contents Format Details dialog
box.
6. Enter the following settings for each level of the TOC - change the level in the
Level to edit: drop down menu:

• Select the Not numbered option.

• Set the value of the Indent following lines field so that second and
subsequent lines of a long TOC entry will start at the required horizontal
position in the TOC.

Working with Tables of Contents 371

 Click OK to exit the Table of Contents Format Details dialog box.
7. Click OK to exit the Table of Contents Format dialog box.
8. In the Elements list, set your Arbortext Styler interface to include Styler
Formatting Elements (SFE) in the Elements list, by selecting the View ▶ Styler
Formatting Elements menu option.
9. Select the element _sfe:TocPage_xxx, where xxx is the name of the
TOC whose numbering you are editing. In this case, the example TOC is
named Document.
10. Elect to edit the FOSI source of the SFE element by selecting Edit ▶ Edit
Element Source ▶ FOSI.
11. Insert a usetext element after the suppress sup=”0” element in the
source. Set the attributes of the new element as follows:
• source=”@xpt,ypt”, where:
○ xpt is the distance from the left edge of the document at which you
want the page numbers to align
○ ypt is the space that should be drawn between the page number and the
TOC entry text
Note that (x+y) should equal the value set for Indent following lines in step
6 above.
• placemnt=”after”

372 User's Guide

12. Click File ▶ Apply and Close to save the change and exit the Edited Source
Editor. The SFE, and its Description entry for FOSI, are now marked in orange
to advise that the element contains source edits. Note the presence of the
Edited Source column in the Elements list - use the View ▶ Configure
Columns option to activate the display of the column in your window if
required.

Working with Tables of Contents 373

13. Close the stylesheet in Arbortext Styler and open the .style file directly in
Arbortext Editor
14. Find the TableofContents tag whose tocName attribute matches the
name of the table of contents whose numbering you are editing. Note that
Arbortext Editor will have replaced any spaces in the name of the table of
contents with underscores.
15. Locate the TocTitleContexts element in TableofContents.
16. For each TocTitleContext element in TocTitleContexts, carry out
the following actions:
• Move the _sfe:TocPage_xxx element and its contents to be the first
element inside the _sfe:TocEntryN_xxx element, where N is a
number between 1 and 5. There should be one _sfe:TocEntryN_xxx
element for each level you have elected to display in your TOC. Note that,
again, xxx is the name of the TOC whose numbering you are editing: in
the case “Document”.
• Ensure the attributes of the Space element are set to:
○ leaderType=”space”
○ lenType=”fit”
○ minLen=0pt
Note that if you did not uncheck the Indent levels box in step 4, these
elements may be named LeaderDots - once you have set the
leaderType=”space” attribute, however, the name will change.

17. Save the changes to your stylesheet and close it.

18. Once you have saved the changes to your stylesheet, choose File ▶ Print
Preview in Arbortext Editor.

In the Print Preview window, note that the each entry of the TOC has its page
number displayed to the left of the TOC entry text, and that there are no leader
dots separating the two.

374 User's Guide

Working with Tables of Contents 375
 16
Generating Indexes
Indexing Overview................................................................................................... 378
Creating an Index with Element Model Index Terms ................................................... 379
Creating an Index with Attribute Model Index Terms ................................................... 381
Creating a Index with Nesting Element Model Index Terms ......................................... 382
Creating See and See-Also Index Terms ................................................................... 384
Configuring Alternative Sorting of Index Terms........................................................... 386
Configuring Multiple Indexes for a Document............................................................. 388
Modifying the Appearance of an Index ...................................................................... 390
Modifying Index Parameters..................................................................................... 392
Including Elements not Styled as Index Terms in an Index .......................................... 393
Context Matching of Elements in Index Terms............................................................ 395
Generating a Sorted Inline List ................................................................................. 396

This section describes how to manage indexes via your stylesheet.

377
Indexing Overview
A summary of the process to create an index is given below:
1. Create the index definition object that will format your index and define its
scope. Refer to Indexes List on page 777 for information.
2. Configure the element that will output the index in your output. Set its
parameters, for example the index definition object that will format it, and the
language to which it should be sorted. Refer to the Index Details Dialog Box
on page 985 for further information.
3. Configure the elements that define index terms, based on one of the models
listed below. Select the index definition object and define the roles each of the
elements will perform in the index term.
There are three methods for designating content as index terms for an index,
depending on the type of document you are working with:
• If your document type includes a set of index term elements, such as
primary, secondary, and tertiary, with a wrapper element such
as indexterm that encloses them, you will use the Element Model for
creating an index. See Creating an Index with Element Model Index Terms
on page 379 for information.
• Some document types, such as the CALS, allow for only one index
element, and you specify that the attributes of that element will form the
content of that index. Here you will create the index according to the
Attribute Model. See Creating an Index with Attribute Model Index Terms
on page 381 for information.
• Other document types, such as the Darwin Information Typing
Architecture (DITA), allow for only one index element and nest that
element to determine whether it is a primary, secondary, or tertiary index
entry. In this case you will follow the Nesting Element Model. See
Creating a Index with Nesting Element Model Index Terms on page 382
for information.
• You may also create See, See Also index terms or request that index
terms should be included under a non-alphabetic heading. Refer to
Creating See and See-Also Index Terms on page 384 and Configuring
Alternative Sorting of Index Terms on page 386 for further information.
A single index can contain index terms from different models. You can also
create index terms that might show up in multiple indexes.
Arbortext Styler provides flexibility when creating indexes:
• You can configure multiple indexes for a single document. You can scope the
indexes to appear within certain parts of the document, and include the index

378 User's Guide

 terms defined in that part, for example chapter or section level indexes. Refer
to Configuring Multiple Indexes for a Document on page 388 for further
information.
• An index can include elements not styled as its index terms. Refer toIncluding
Elements not Styled as Index Terms in an Index on page 393 for further
information.
• You can also specify the language to which your index content should be
sorted. Specify the language to be used in the Index Details Dialog Box on
page 985.

Limitations in Indexing
The following output limitations should be noted when working with indexes:
• The index-see-also element is supported in all outputs. For RTF output,
you must manually enter the text See Also, or equivalent, as content of the
index term to ensure it is output correctly. This is a limitation of MS Word.
This can be accomplished via an output property in the definition of the
_sfe:IndexSeeAlso element.
• The index-sort-as element is not supported for RTF output. This is a
limitation of MS Word.
• Indexes are not displayed in EPUB output.

Creating an Index with Element Model

Index Terms
Document types that provide several elements for use with indexing use the
Element Model for creating index terms. For example, you might use primary,
secondary, tertiary, and seealso elements all wrapped with an
indexterm element to mark terms to be used in your index and use the index
element to generate and format the index itself.
The following examples demonstrate how to create and modify an Element Model
index term. Repeat the procedure as required to configure different elements as
index terms.

Example: Creating an Element Model Index Term

1. In Arbortext Editor, open the axdindex.xml document located at
Arbortext-path/samples/styler. Note that the document defines
index terms (using the indexterm element as a wrapper, and the primary

Generating Indexes 379

 and secondary elements as content holders) at the start of the majority of
the sect1 elements.
2. Choose Styler ▶ New Stylesheet to create a new stylesheet.
3. In Arbortext Styler, select the indexterm element in the Elements list.
4. Give the element the Index Term (Element Model) style from the Style list,
accessed via the Edit ▶ Style menu option. The Index Term (Element Model)
Details dialog box opens.

If you want to include index terms only under certain conditions, some extra
configuration is required. Refer to Conditional Inclusion of an Index Term in
an Index on page 394 for information.
5. On the Indexes tab, note that the index definition object Main Index is already
selected. The index term you’re styling will belong to all indexes set to be
formatted with this index definition object.
Create and select an alternative index definition object if required. Refer to
Indexes List on page 777 for further information.
6. On the Roles tab, configure the roles that the primary and secondary
elements should perform in the final index entry. Roles specify the level at
which each element’s content is output in the index entry.
Select each element in turn in the Available elements list, and click Add to
move it to the Index term elements list. Select a role for the element from the
Element role field.

For example:
• primary - Level 1 term
• secondary - Level 2 term
7. Choose OK to save the style and exit the dialog box.
8. Note that styles have been applied to the three elements as follows:
• indexterm - Index Term (Element Model)
• primary - Inline, Hidden
• secondary - Inline, Hidden
9. In Arbortext Editor, place your cursor directly to the left of the book element
at the end of the document. Insert an index element if one does not already
exist.
10. Back in Arbortext Styler, select the index element in the Elements list. Give
the element the Index style from the Style list, accessed via the EditStyle menu
option.

380 User's Guide

11. In the Index Details dialog box on page 985, select the index definition object
that will format the index from the Index drop down list. Set the language in
which the index will be sorted from the Language field.
12. Choose Preview ▶ Print and navigate to the end of the document to view the
new index.
If you want to change the look of your index, refer to Modifying the Appearance
of an Index on page 390 for guidelines.

Creating an Index with Attribute Model

Index Terms
Some document types provide a single index term element. For example,
documents based on the CALS model contain only the indxflg and index
elements. The indxflg element is set as the index term element while the
index element is used to generate the index itself in the document. In these cases
you can extract the value of selected attributes in the element to form index term
content, and assign a role to each attribute to specify the level at which its value
should be output in the index entry.
The following example demonstrates how to create and modify an index using the
Attribute Model.

Example: Creating an Index with Attribute Model Index Terms

1. In Arbortext Editor, open the calsindex.sgm document located at
Arbortext-path/samples/styler. Note that the document includes
various indxflag elements throughout its content, each with a ref1 attribute
defining a piece of index entry content.
2. Choose Styler ▶ New Stylesheet to create a new stylesheet.
3. In Arbortext Styler, deselect the View ▶ Only Elements in Document option to
display in the Elements list all elements permitted by the doctype.
4. In Arbortext Styler, select the indxflag element and give it the Index Term
(Attribute Model) style from the Style list, accessed via the Edit ▶ Style menu
option. The Index Term (Attribute Model) Details dialog box on page 986 opens.
5. On the Indexes tab, note that the index definition object Main Index is already
selected. The index object is created and selected automatically when your
stylesheet is updated. The index term you’re styling will belong to all indexes
set to be formatted with this index definition object.
Create and select an alternative index definition object if required. Refer to
Indexes List on page 777 for further information.

Generating Indexes 381

6. On the Roles tab, configure the roles that the ref1. ref2, ref3, and ref4
attributes should perform in the final index entry. Roles specify the level at
which each attribute’s content is output in the index entry.
Select each attribute in turn in the Available attributes list, and click Add to
move it to the Index term attributes list. Select a role for the attribute from the
Attribute role field.

For example:
• ref1 - Level 1 term
• ref2 - Level 2 term
• ref3 - Level 3 term
• ref4 - Level 4 term
7. Click OK to save your settings and exit the dialog box.
8. In Arbortext Editor, place your cursor directly to the left of the rear element
at the end of your document. Insert an index element if one does not already
exist.
9. Back in Arbortext Styler, select the index element in the Elements list and
give it the Index style from the Style list, accessed via the Edit ▶ Style menu
option.
10. In the Index Details dialog box on page 985, select the index definition object
that will format the index from the Index drop down list. Set the language in
which the index will be sorted from the Language field.
11. Select Preview ▶ Print to view the new index in your document.

Creating a Index with Nesting Element

Model Index Terms
Some document types that provide a single index term element usually require
you to nest that element to indicate whether it is a primary, secondary, or tertiary
index term. For example, documents based on the Darwin Information Typing
Architecture (DITA) model contain only the indexterm element. To indicate
that an index term is a secondary index term in DITA, you would nest a second
indexterm element inside a primary indexterm element. Similarly, you
would nest a tertiary indexterm inside the secondary indexterm element.
Arbortext Styler allows you to configure multiple elements as index term elements
and set those index term elements to specify the elements that perform the other
roles in an index term. This allows you to include multiple index models in your
output.

382 User's Guide

The following example demonstrates how to create and modify an index using the
Nesting Element Model. The index will contain three levels of nested index term,
representing primary, secondary, and tertiary terms.

Example: Creating a Nesting Model Index (DITA)

1. In Arbortext Editor, open an existing DITA document, or create a new one
based on one of the DITA document types shipped with Arbortext Editor.
Insert some index terms based on three levels of nested indexterm element.
2. Choose Styler ▶ Edit Stylesheet to edit the associated stylesheet. If you are
working with a sample document type the stylesheet may be of read only
status and you will need to save a local copy if you wish to make amendments.
3. In Arbortext Styler, select the indexterm element and give it the Index
Term (Nesting Element Model) style from the Style list, accessed via the Edit ▶
Style menu option. If the element already has that style assigned, choose to
edit the style via the Edit ▶ Edit Style Details menu option. The Index Term
(Nesting Element Model) dialog box opens.

If you want to include index terms only under certain conditions, some extra
configuration is required. Refer to Conditional Inclusion of an Index Term in
an Index on page 394 for information.
4. On the Indexes tab, note that the index definition object Main Index is already
selected. The index term you’re styling will belong to all indexes set to be
formatted with this index definition object.
Create and select an alternative index definition object if required. Refer to
Indexes List on page 777 for further information.
5. Back in Arbortext Styler, select in the Elements list the element that will
output the index in your document. Give the element the Index style from the
Style list, accessed via the Edit ▶ Style menu option. The Index Details dialog
box on page 985 opens.
6. In the Index Details dialog box, select the index definition object that will
format the index from the Index drop down list. Set the language in which the
index will be sorted from the Language field.
7. In Arbortext Editor, insert the element that should output the index at the
required location in your document.
8. Back in Arbortext Styler, select Preview ▶ Print. In the Print Preview window,
note that the entries in your index have been output in three levels as expected.

Generating Indexes 383

Creating See and See-Also Index Terms
You can include index-see and index-see-also elements to provide
information for your index:
• index-see: outputs an index term that points a user to a different entry in
the index
• index-see-also: outputs an index term that both generates its own page
reference and points a user to a different entry in the index
This process describes steps to set up index-see and index-see-also
elements in an index that you have already created. The example assumes the use
of a document type based on the DITA model. Index terms are based on the
Nesting Element Model on page 382.

Example: Creating See and See-Also Index Terms

1. In your DITA document, enter nested indexterm and index-see
elements as shown in the example below:

2. Here you have specified the following types of index markup:

• indexterm: standard index terms that can be nested to provide a multi-level
index entry
• index-see: an index term that points a user to a different entry in the index
3. Choose Styler ▶ Edit Stylesheet to edit the associated stylesheet.
4. In Arbortext Styler, select the indexterm element and edit its style via the
Edit ▶ Edit Style Details menu option. The Index Term Details (Nesting Element
Model) dialog box opens.
5. On the Roles tab, configure the role that the index-see element should
perform in the final index entry. Roles specify the level at which an element’s
content is output in the index entry.
Select the index-see element in the Available elements list, and click Add
to move it to the Index term elements list. Select the See role for the element
from the Element role field.
6. Choose OK to save the style and exit the dialog box.
7. Note that indexterm and index-see elements now have the following
styles:

384 User's Guide

 • indexterm - Index Term (Nesting Element Model)
• index-see - Inline, Hidden
8. Back in Arbortext Styler, select Preview ▶ Print. In the Print Preview window,
note that the entries in your index have been output in three levels as expected.
Note also the see entry:

9. Repeat steps 4 and 5 for the index-see-also element, giving it the role of
See also.

Here you have set up your see-also elements, which specify an alternative
subject that you can refer to for information on a subject that is listed in the
index.
10. Back in Arbortext Editor, add a second paragraph of text after the first one,
and mark it up with index entries as shown below:

Here you have specified the following types of index markup:

• index-see-also: an index term that both generates its own page reference
and points a user to a different entry in the index
11. Preview your document for print again, and note the new index entries:

Generating Indexes 385

Configuring Alternative Sorting of Index
Terms
You can include index-sort-as elements to provide information for your
index. This element applies a sort characteristic to an index term, defining the
group in which it should appear. This setting will override an index term’s default
alphabetic placement in the index.
A common use for sorting of this nature is to disregard leading punctuation in the
index term, or convert leading digits to their names.
This process describes steps to set up index-sort-as elements in an index
that you have already created. The example assumes the use of a document type
based on the DITA model. Index terms are based on the Nesting Element Model
on page 382.

Example: Configuring Alternative Sorting

1. In your DITA document, enter nested indexterm and index-sort-as
elements as shown in the example below:

386 User's Guide

 Here you have specified that the index entry Styling DITA documents should
be indexed under the heading “D”, rather than the heading “S” as it would
appear with regular sorting.
2. Choose Styler ▶ Edit Stylesheet to edit the associated stylesheet.
3. In Arbortext Styler, select the indexterm element and edit its style via the
Edit ▶ Edit Style Details menu option. The Index Term Details (Nesting Element
Model) dialog box opens.
4. On the Roles tab, configure the roles that the index-sort-as element
should perform in the final index entry. Roles specify the level at which an
element’s content is output in the index entry.
Select the index-sort-as element in the Available elements list, and click
Add to move it to the Index term elements list. Select the Sort as role for the
element from the Element role field.
5. Choose OK to save the style and exit the dialog box.
6. Note that indexterm and index-sort-as elements now have the
following styles:
• indexterm - Index Term (Nesting Element Model)
• index-sort-as - Inline, Hidden
7. Select Preview ▶ Print. In the Print Preview window, note that the index now
contains two principal entries under the “D” heading:

Generating Indexes 387

Configuring Multiple Indexes for a
Document
You may wish to include multiple indexes in a single document. The example
below walks through how to configure multiple indexes in a document. The
indexes are made up of index terms based on different elements.
In this example, it is assumed that a maintenance manual needs a general index
and a parts name index. The general index appears at the end of the document, and
a parts index will appear in every section of the document.
It is also assumed that the document includes a partslist element that
includes child partname elements. A partsindex element inserts the parts
index.
The first part of the process is to configure the general index, and scope it for the
whole document. Refer to Creating an Index with Element Model Index Terms on
page 379 for full guidelines on how to set up an index with Element Model index
terms.
1. In Arbortext Styler, select the indexterm element. Assign it the Index Term
(Element Model) style, or edit the style if this has already been done.
2. In the Index Term (Element Model) Details dialog box, select the index
definition object representing the index the index terms will belong to, for
example Main Index.
3. On the Roles tab, configure roles for the primary and secondary index term
elements. Exit the dialog box.
4. Select the index element. Assign it the Index style, or edit the style if this has
already been done.
5. In the Index Details dialog box, select the same index definition object in the
Index field. Exit the dialog box.
6. In the Indexes list, select the index definition object you have referenced in
previous steps. In the General category, ensure that the Scope field is set to
(Whole document).
Next, configure the parts index, and scope it to appear at section level.
1. Create a new index definition object that will represent the parts indexes in
your document. Choose Insert ▶ Index to create the new object and name it
appropriately, for example Parts Index.
In the General category, set the Scope field to the required section element. In
the Format category, configure the required styling for the index.
2. Select the context of the partname element in its parent partslist, for
example partname anywhere in partlist.

388 User's Guide

 It is assumed that the partname element has the Inline style, and has been
configured as a cell in a custom table model.
3. In theGenerated text category for the context, add generated text before
element content. Insert a new UFE, for example _ufe:partname_
indexterm. Insert the element content of the current element into the UFE.
Exit the Generated Text Editor.
4. Select _ufe:partname_index in the Elements list. Give it the Index Term
(Nesting Element Model) style.
5. In the Index Term (Nesting Element Model) Details dialog box, select the index
definition object representing the parts index, i.e. Parts Index. Exit the
dialog box.
6. Select the partslist element in the Elements list. Give it the Index style.
7. In the Index Details dialog box, select the Parts Index index definition
object in the Index field. Exit the dialog box.
8. If there is no specific element that inserts a parts index, you could also elect to
insert the index at the end of each section. Select the section element and add
generated text after element content. Choose Insert ▶ Index. In the Index
Details dialog box, select the Parts Index index definition object in the
Index field. Exit the dialog box.
9. Preview your document for print or PDF. You will see two types of index - a
parts index at the end of each section, plus a document index in the location
specified in the first process.

Conditional Inclusion of an Index Term in an Index

To include index terms in an index only when a specific condition matches,
configure index terms in a slightly different way. For example, you may want to
include a chapter title as an index term when the chapter is in Spanish:
1. Configure the index term elements and their roles as usual, based on one of the
Element, Nesting Element or Attribute models.
2. Style the element given the Index Term (Model) style as Hidden.
3. Create the contexts and/or conditions where the element is to be included in an
index. For example, title in chapter IF attribute “xml:lang”of
parent element = ”es”.
4. For this title in chapter context, insert an index term element in the Add
Before generated text.
5. Set the generated index term to include the current element content.

Generating Indexes 389

Modifying the Appearance of an Index
As a general rule, changes to the format of an index are carried out in the Format
category of the Indexes list for an index definition object. Settings made here will
apply to any index set to be formatted with the specified index definition object.
The procedure described below gives you a specific example of how to make
changes to page numbering, heading and generated text settings for an index, and
give the index a title. This procedure will apply to indexes based on any of the
three Arbortext Styler index models.

Example: Modifying the Appearance of an Index

In this example, you will change the appearance of the numbers in index entries
and remove character headings for the index groups. You will also change the
format of the generated title.
1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/Styler.
2. Choose Styler ▶ Edit Stylesheet to open the associated stylesheet. This is a read
only stylesheet so you will have to save a local copy to make changes.
3. In Arbortext Styler, navigate to the Indexes list and select the index
definition object that will style your index. Navigate to the Format category.
4. Choose Space separated from the Page or reference number position list.
Refer to the Arbortext Editor preview and Print/PDF preview windows for a
preview of how the index will appear in final output, noticing that the two
previews differ slightly.
5. Deselect the Display character headings option and again note the format
changes in the preview windows.
6. Choose Preview ▶ Print to view the changes in the index.
7. In Arbortext Styler, select the element with the Index style that is set to
generate the index in the document. Go to the Generated text category.
8. Click on the Edit button for Before-text. The Generated Text Editor opens.
9. Type MAIN before the title INDEX. Note the _ufe:generated_title
element that wraps the title. You can format this further in the next steps. Click
OK to close the Generated Text Editor.
10. In the Elements list, select _ufe:generated_title.
11. In the Text category, set the Font family field to Serif, the Text size field to
16, the Bold field to No, and the Text color field to #FF0000 (red).
12. Choose Preview ▶ Print to view the changes to the title.

390 User's Guide

SFEs Controlling the Formatting of Indexes
The following Styler Formatting Elements (SFE) control the formatting of the
parts of an index.
• _sfe:Index_index object name - the index generated by the index
definition object.
• _sfe:IndexAlphaGroup_index object name - the group heading
and all index entries for an alphabetic group
• _sfe:IndexEndPage_index object name - the text of the last page
number in a merged number range, e.g. 1–3
• _sfe:IndexEntry_index object name - index entries (any level)
• _sfe:IndexGroupHead_index object name - the heading for a
group of index entries
• _sfe:IndexHeading_index object name - the indexed text of an
index entry
• _sfe:IndexLocators_index object name - the page numbers (or
other locators) in an index entry
• _sfe:IndexPage_index object name - the text of a single page
number (or other locator)
• _sfe:IndexPostGroup_index object name - any group head and
index entries that follow alphabetic entries
• _sfe:IndexPreGroup_index object name - any group head and
index entries that precede alphabetic entries
• _sfe:IndexRangeGroup_index object name - any group head and
index entries for a group that encompasses a range of characters
• _sfe:IndexSee_index object name - the text of a See reference in an
index entry
• _sfe:IndexSeeAlso_index object name - the text of a See Also
reference in an index entry
• _sfe:IndexSubGroupHead_index object name - the heading for a
sub group of index entries (Chinese modes 1 and 3 only)
Your stylesheet will contain one set of index SFEs for each index definition
object. They are suffixed with the name of the index definition object they belong
to. An index definition object’s SFEs will stay with it if it is moved or copied.
In addition, a stylesheet will have one SFE that will wrap all indexes -
_sfe:Index.
To make the index SFEs visible in Arbortext Editor, activate the View ▶ Tags in
Generated Text option in Arbortext Styler.

Generating Indexes 391

Indentation of Index Entries and Numbers
In distributed stylesheets, two Styler Formatting Elements (SFE) control the
position of index entries and their numbers in relation to margins and each other:
• _sfe:Index_index object name: sets the position of the whole index
entry, including the page number
• _sfe:IndexEntry_index object name everywhere else: sets the
position of the text part of the index entry.
If you wish to prevent text in index entries from overhanging the number,
configure the _sfe:IndexEntry_index object name everywhere
else context with a positive right indent value and its Relative To field set to
Parent right indent. In this case, Parent right indent is that set for the
_sfe:Index_index object name element. This setting will also place
the second and following lines in a long index entry in alignment with the first
line.
If you wish to change the right indent of the index entries including the
numbers, change the right indent of _sfe:Index_index object name.

Modifying Index Parameters

The element given the Index style that is designed to generate the index holds the
index parameters in its generated text. To modify these parameters, take the
following steps:
1. Select the element that generates in the index in the Elements list.
2. Go to the Generated text category for the element, for the output format for
which you wish to change the index's parameters.
3. Click the Edit button next to the After-text field. The Generated Text Editor
opens.
4. Place your cursor to the right of the Index tag and click Edit ▶ Modify
Attributes. The Modify Index dialog box on page 1000 opens, in which you can
update the parameters of the index as required.

Index Parameters for Chinese, Pinyin Indexing

PTC APP. FOSI , and XSL-FO publishing engines support a default Pinyin mode
for indexing. It is listed as zh-Latn-pinyin (Chinese, Pinyin) in the Language field
of the Modify Index dialog box and conforms to the Pinyin_DA (diff-after)
method. English and Chinese terms are grouped under different headings, with
Chinese entries given after English ones.

392 User's Guide

If it is desired for Chinese entries to appear before English ones, type pinyin_
DB in the Language field instead of picking zh-Latn-pinyin (Chinese, Pinyin) from
the drop down list.
If you are working with the FOSI engine, you may specify other variants of Pinyin
indexing by setting different index parameters in the dialog box:
• Language field

Enter Pinyin_SA or Pinyin_SB.

See Chinese transliterated index control for further information.
• Advanced Parameters field

Enter chinese_mode=2 or chinese_mode=3 to select alternate ways of

grouping the index entries.
The support for indexing variants in the PTC Arbortext publishing engines is
summarized in the table below:
Engine Language
Pinyin_DA Pinyin_DB Pinyin_SA Pinyin_SB
PTC APP • •
FOSI • • • •
XSL-FO • • • •
Engine Advanced Parameters
chinese_mode=2 chinese_mode=3
PTC
APP
FOSI • •
XSL-FO • •

Including Elements not Styled as Index

Terms in an Index
You can include elements that do not have an Index Term (Model) style in an
index. For example, you may wish to see chapter titles in your index. A summary
of the process is given below (the process assumes that index terms are configured
to the Element Model):
1. In Arbortext Styler, select the context that you wish to see in an index, for
example title in chapter.
2. In the Generated text category for the context, add generated text before
element content.

Generating Indexes 393

3. In the Generated Text Editor, choose Insert ▶ Markup. Insert the relevant index
term element, for example indexterm.
4. In the primary index term element, choose Insert ▶ Element Content. Accept
the default settings for Current Element. Exit the Generated Text Editor.
5. Preview your document. You will see that chapter titles are included in your
index, as well as index terms from the body of the document.
Alternatively, you could insert a UFE into the generated text of the title in chapter
context. Give the UFE the Index Term (Element Model) style then insert the UFE
(s) into the title’s generated text as detailed below:
• Insert a UFE with a child UFE that represents the level 1 index term.
• To complete the index term model insert child UFEs representing level 2, level
3, see, and see-also index terms.
• If you have a sort key, you can use the Attribute Modifier in the generated text
editor to set an attribute in any of the index term UFEs.

Conditional Inclusion of an Index Term in an Index

To include index terms in an index only when a specific condition matches,
configure index terms in a slightly different way. For example, you may want to
include a chapter title as an index term when the chapter is in Spanish. Note that
this example assumes the use of the Element Model for index terms:
1. Create a UFE that will represent the main index term, for example
_ufe:indexterm. Give it the Index Term (Element Model) style.
Configure the roles for the index term elements in your document type, for
example primary and secondary. Associate the UFE with the required
index definition object.
2. Style the index term elements used in your document type as Inline. For
example, style indexterm, primary, and secondary in this way.
3. Set the child index term elements, for example primary and secondary,
to be Hidden in output.
4. Create the contexts and/or conditions where the element is to be included in an
index. For example, title in chapter IF attribute “xml:lang”of
parent element = ”es”.
5. For contexts or conditions that are to be included as index terms, for example
title in chapter IF attribute “xml:lang”of parent element
= ”es”, configure the generated text to insert the UFE that represents the main
index term before element content, for example _ufe:indexterm.
In the UFE, insert child index term elements, for example primary and
secondary, and set them to insert content as required.

394 User's Guide

Context Matching of Elements in Index
Terms
When an index term contains child elements, those elements are processed inside
the index for generated text and regular formatting. Note the following points
regarding this processing:
• The context of the element that Arbortext Styler selects to use in the index is
based on the element hierarchy in the index, not in the body of the document.
• The index term element, and its ancestors, are not part of the processing
hierarchy. For example, when working with Element Model index terms,
primary and secondary are part of the hierarchy but indexterm is not.
• All child index term elements will always be descendants of _sfe:Index_
index object name, the SFE that controls the formatting of the index
generated by an index definition object.
You may encounter occurrences of an element that match in the body of the
document but do not match in the index, and vice versa, or that match in both or
neither. This may affect formatting or generated text settings you wish to make for
an element that is used in an index term.
For example, refer to the index term markup given below:
<chapter>
<ixterm><one><two>Text</two></one></ixterm>
</chapter>
The table below shows how contexts would match in the body of the document
and in the index:
Match in body of
Context document Match in index
one everywhere yes yes
one in ixterm yes no
one anywhere in _sfe: no yes
Index_index object name
two everywhere yes yes
two in one yes yes
two in one anywhere in yes no
chapter
two in one anywhere in no yes
_sfe:Index_index object
name
You may encounter the example situations given below. Please find some
suggestions for overcoming these issues:

Generating Indexes 395

• A context will match for both document and index, but you want formatting or
generated text configured for that context not to appear in an index.
For example, the context two in one in the table above.
Create a new context two in one anywhere in _sfe:Index_index
object name and ensure it appears before the two in one context in the
list of contexts configured for the element two. Apply the required formatting
or generated text to this new context.
• A context will not match for index, but you want formatting or generated text
configured for that context to be reflected in its entry in the index.
For example, the context one in ixterm in the table above.
Create a new context one anywhere in _sfe:Index_index object
name and with the same properties as one in ixterm.

Generating a Sorted Inline List

This section contains instructions on generating a sorted, inline list of values,
where the values are the attribute values of a particular element. The list is auto
generated using Arbortext Styler's indexing functionality. For example, here we
will demonstrate how to collect the values of the class attribute from the
trademark elements contained in the body of a document, remove duplicates,
sort them alphabetically and output them with some generated text in the form of a
trademark declaration sentence at the end of the document.
In this example, the trademark element has a class attribute which has four
possible values, each one generating a specific character, as follows:
• trademark class=”copyright”: output copyright symbol
• trademark class=”registered”: output registration mark
• trademark class=”service”: output service mark
• trademark class=”trade” (or no value): output trademark
Some sample markup, which shows the appearance of the element when its
attribute is set, is given below:

The object of this procedure is to produce a sorted list of these trademarks as

shown below:

396 User's Guide

Set Generated Text for the Attribute Values of the Selected Element
The first step in creating the list is to set the generated text for each value of the
attribute that has been identified as the basis of the list. Once this has been done
the required character will appear in the body of the document when text is
surrounded by the relevant element markup.
1. Using the InsertCondition menu option, create four conditions for the
trademark everywhere context, one for each possible value of the class
attribute. Use the New Attribute Test option in the Condition dialog box to enter
a test relating to the value of the class attribute for each condition:
• "class"="copyright"
• "class"="registered"
• "class"="service"
• "class"="trade" or no value
2. For each condition, include an After-text generated text for the particular class
attribute of the trademark element that the condition represents. Here you
will specify the character(s) that will be output in your document after the
content of the trademark element, when it has a class attribute defined:
• "class"="copyright" - ©
• "class"="registered" - ®
• "class"="service" - (sm)
• "class"="trade" or no value - ™

Create and Configure the UFEs to Contain Index Entries

Before an index can be output, you must create a set of User Formatting Elements
(UFE) that will contain the index entries intended to make up this particular type
of list. Create a wrapper that will hold all the index entry data, then one each for
primary and secondary index terms.
1. Create three UFEs via the Insert ▶ Element menu option. Give them
explanatory names so they can be easily identified in the Elements list, for
example _ufe:tm-wrapper, _ufe:tm-primary, and _ufe:tm-
secondary.
2. Give _ufe_tm-wrapper the Index Term (Element Model) style in the Style
dialog box, accessed via the Edit ▶ Style menu option. The Index Term
(Element Model) Details dialog box opens.
3. On the Roles tab, assign the appropriate role to each UFE in the dialog box.

Generating Indexes 397

 • _ufe:tm-wrapper - Wrapper
• _ufe:tm-primary - Level 1 term
• _ufe:tm-secondary - Level 2 term
4. Note that the Index Term (Element Model) style has been applied to the three
elements.
5. Click OK to save the changes and exit the dialog box.

Create and Configure the UFE to Contain the Index

The UFE that contains the index will define the order and format in which the
index entries will be displayed. It will be specified as the output of the particular
element in your document that should display the index.
1. Create a UFE using the Insert ▶ Element menu option. Give it an explanatory
name so it can be easily identified in the Elements list. Here we have used
_ufe:trademarklist.
2. Give the UFE the Index style in the Style dialog box, accessed via the Edit ▶
Style menu option.
3. In the Index Details dialog box on page 985, select the index definition object
that will format the index from the Index drop down list. Set the language in
which the index will be sorted from the Language field.
4. Specify the final output location for the list by inserting
_ufe:trademarklist in generated text in one of the elements in your
source document. Here the list will be output before element content in the
legalnotice everywhere context. In the Generated text category for the
legalnotice element, include an Before-text generated text entry.
5. In the Generated Text Editor, select Insert ▶ User Formatting Element and
select _ufe:trademarklist. When you close the Generated Text Editor
and save your change, the setting will be reflected in the Before-text field for
the legalnotice context:
6. Insert a legalnotice element into your document if it does not already
exist.

Set Indexing Functionality to Create the List

A sorted list uses indexing functionality to generate its content. Indexing
functionality is set to produce a non-default index, i.e. a list based on attribute
values of a certain element, with the list's entries sorted alphabetically and
duplicates removed before output. Since the indexing functionality is non
standard, default indexterm elements cannot be used to form the list's structure.
UFEs that simulate the structure of an indexterm are used instead - these were

398 User's Guide

created in the previous section. Note, however, that the index formatting for
output is still applied to the default indexing elements. This is described in the
next section.
Generated text sets the display of the list:
1. For each condition of the trademark everywhere context, include
Before-text generated text to set the content of the _ufe:tm-primary UFE
to be the string Suppressed. The word to be used here is not important, this
step ensures that all index entries for the list are collected under a single
heading. The index now looks similar to the example shown below (note that
it is still in index form as the specific formatting that makes the index into a
list has not yet been applied):

Use Insert ▶ User Formatting Element to insert the _ufe:tm-wrapper and

_ufe:tm-primary UFEs, then enter the text Suppressed into the
_ufe:tm-primary UFE:
2. For each condition of the trademark everywhere context, include
Before-text generated text to set the content of the _ufe:tm-secondary
UFE to be the content of the trademark element. This ensures that the list
entries all appear on the same level under the “Suppressed” heading.
Use Insert ▶ User Formatting Element to insert the _ufe:tm-secondary
UFE.
Use Insert ▶ XPath String to add the XPath test that identifies the content.

Generating Indexes 399

 Each context of the trademark element should now have the same
generated text setting:

Set Index Output Format for the List

Default Styler Formatting Elements (SFE) are already defined in Arbortext Styler
to provide output formatting for an index. Since the index must be in the form of a
sorted list, these standard SFEs must be modified to give the required display.
Currently the list, if it were to be generated at this stage, would still be in the form
of an index, but with all entries grouped under the same heading “Suppressed”:

The object of this final section is to apply the formatting to output the index as a
trademark citation:

400 User's Guide

To perform the steps listed in this section, ensure the menu option View ▶ Styler
Formatting Elements is activated - SFEs will not be available for selection from
the Elements list if this has not been done.
1. To suppress output of the alpha header “S”, hide the
_sfe:IndexGroupHead_index object name SFE by setting the
Hidden field to Yes in the Text category.
2. To remove the dot fill between the index entry and the page locators, delete the
generated text object LeaderDots from the _sfe:IndexLocators_
index object name SFE, via the Generated Text Editor. You should also
hide this SFE from output (as shown in step 1), which ensures duplicates are
removed from the list.
3. To suppress output of the page locators, hide the _sfe:IndexPage_index
object name and _sfe:IndexEndPage_index object name SFEs
by setting the Hidden field to Yes .
4. To configure the output of the content of the index entries, use the
_sfe:IndexHeading_index object name SFE, which formats the
text content of the index entry. You will need two contexts for this SFE:
• _sfe:IndexHeading_index object name in
_sfe:IndexEntry_index object name in
_sfe:IndexEntry_index object name - this context matches the
secondary level index entries that contain the text content of the
trademark element. You will most likely need to create this context, via
the Insert ▶ Context menu option.
Set this SFE context to an Inline structure in the Breaks category.
• _sfe:IndexHeading_index object name everywhere else -
this context matches the primary level index entries , i.e. Suppressed.
You should not have to create this context, but you do need to suppress its
output by setting the Hidden field to Yes (as shown in step 1).
5. To configure the output of the index entries themselves, use the
_sfe:IndexEntry_index object name SFE. Create contexts of the
SFE and specify the generated text that should be added to each type of index
entry in the list to link them together in the list and produce the trademark
citation sentence:
ABC , PTC , Windchill , and XYZ are trademarks of PTC Inc.
(first) (middle) (middle) (last)

All the contexts listed below should be given an Inline structure in Breaks
category to ensure they do not start a new line.

Generating Indexes 401

 • first: create context first_sfe:IndexEntry_index object name
in _sfe:IndexEntry_index object name and set generated text
as follows:
○ no generated text required - the comma after the entry will be
generated via the “middle” context
• middle: create context _sfe:IndexEntry_index object name in
_sfe:IndexEntry_index object name, if it does not already
exist, and set generated text as follows:
○ before element content: add a comma and a space to provide a
separator between the first entry and the first “middle” entry, and
between all other “middle” entries in the list
• last: create context last_sfe:IndexEntry_index object name
in _sfe:IndexEntry_index object name and set generated text
as follows:
○ before element content: add single word and with a command and
space before, and a space after, to provide a separator between the last
“middle” entry and the last entry
○ after element content: add the string that completes the list: in this case
are trademarks of PTC Inc. (with a space in front).
6. To enable the alpha header “Suppressed” to form a part of the list structure but
still remain hidden, leave the context _sfe:IndexEntry_index object
name everywhere else in place but do not change its existing formatting.
Ensure this context has a Block structure by setting this in the Breaks category,
and set the right indent to 0 in the Indent category. These last two steps will
ensure that the list entries do not overlap each other in the final output.
Publish your document as normal. The list will appear in the nominated element
selected in Create and configure the UFE to contain the index.

402 User's Guide

 17
Styling Custom Tables
Custom Table Styling Overview ................................................................................ 404
Creating and Styling a Custom Table ........................................................................ 405
Generating Custom Table Cells via XPath ................................................................. 411
Reordering Columns in Custom Tables ..................................................................... 415
Using Background Color in Custom Tables ................................................................ 417

This section describes how to manage custom tables via your stylesheet.

403
Custom Table Styling Overview
When you style elements to be displayed as a custom table in Arbortext Styler,
you enable the elements that define that table to be edited using Arbortext Editor's
Table Editor, as well as to be formatted as a table in other outputs. See Custom
table overview in Arbortext Editor help for details on custom tables.
If you are developing a modular stylesheet, it is recommended that you keep the
custom table definition and the elements that are part of the custom table in the
same module. This helps prevent the accidental deletion of part of the custom
table definition and similar errors. You can use the Tools ▶ Validate Stylesheet
feature to troubleshoot problems with custom tables.
The basis of a custom table is the Custom Table style and the Custom Table
object, listed in the Custom Tables list . Note that you only apply the Custom
Table style to the element that is designated the base element for the custom table
in Arbortext Styler. Once other elements are subsequently assigned a role in a
custom table, Arbortext Styler creates a context for those elements with the
assigned role in the Style column of the Elements list. For example, an element to
which you have assigned the Row role for a custom table would have the
following style for its context: Row in custom table. The Custom Table
object contains the role definitions for the elements that make up your custom
table, plus any formatting properties you wish to have applied.

Note
An element's role in a custom table in specific contexts supersedes any
semantics normally associated with the element's assigned style. For example,
assume that you apply the Link style to an element and also assign it a role in
a custom table other than Table. When that element is in the context of the
custom table, the element does not act as a link.

You can format any number of elements as custom tables in your document type.

Note
You can also designate elements to comprise a custom table for editing and
formatting using the document type configuration file (.dcf file). See
Defining custom tables in Arbortext Editor help for details. However, when
you are using a stylesheet, the styling of those elements in the stylesheet
overrides the settings in the .dcf file.
See Document Type Configuration Files in Arbortext Editor online help for
further information about document type configuration files.

404 User's Guide

Limitations of Custom Table Support
These custom table features are not supported if you are publishing with an PTC
APP template (.3f) exported from an Arbortext Styler stylesheet (.style):
• Reordering of columns
• Generated content
For general information, see Limitations of custom table support in Arbortext
Editor help.

Creating and Styling a Custom Table

There are two ways in which to create a custom table object in your stylesheet:
• Create a new custom table object
Use the Insert ▶ Custom Table menu option in Arbortext Styler to create a
completely new custom table object in the Custom Tables list.
You must then configure every element that should take a role in the table,
starting with the table element itself. In this instance, only elements that have
the style Unstyled are available for selection when defining the table's
elements and their roles.
• Style a non-table object as a custom table
Apply the Custom Table style to the element that should form the basis of your
table. Arbortext Styler will automatically create a new Custom Table object in
the Custom Tables list, with the styled element specified as performing the role
of table.
You must then configure the rest of the elements that should form the custom
table. With this method you can use any element that exists in the stylesheet to
perform a role in your table, regardless of its assigned style, provided it is
permitted as a child of the element that performs the immediate parent role.
An element's role in a custom table in specific contexts supersedes the
element's assigned style.
When you style a custom table, note the following points:
• The table and row elements must be specified, otherwise the table is invalid.
When a custom table is not valid, an error message is displayed at the bottom
of the Elements tab for the table. The error message can be one of the error
messages pertaining to custom tables when validating the stylesheet, or a
message of the format The “Row" element must be specified.
Additionally, the entry for an invalid custom table in the Custom Tables list
will be displayed in red text with a red line through the icon, as shown below:

Styling Custom Tables 405

• You can optionally specify cell elements. If they are not specified, the content
model of the row element is used to identify valid cells.

Note
If cells are defined, they must either be styled inline or be configured as
cells in the custom tables dialog box to ensure the correct effects. See
Custom Tables - Cells Category on page 863 for information.

• You can also identify elements as the table title or header row, although this is
optional.
• You can generate cells for the table via XPath.
• You can assign multiple elements to the table, cell, or header cell role. The
other custom table roles can only be assigned to one element for each custom
table.
• You may specify an order for columns that differs from the order in which the
cell elements appear in the document.

Example: Creating a New Custom Table Object

This example is detailed using the standard DocBook doctype as a basis.
1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/styler.
The next three steps describe the insertion of an authorgroup element in
the sample document. If an authorgroup is already in place, proceed to
step 5.
2. Place the cursor after the abstract element at the beginning of the
document.
3. Insert the markup necessary to create an authorgroup with a child
author. Add the children firstname and surname to the author
element.
4. Type some content in the firstname and surname elements. Notice that
the authorgroup is simply shown as tags and text.
5. Choose Styler ▶ New Stylesheet to create a new stylesheet. Accept the default
properties in the Stylesheet Properties dialog box that opens, and click OK to
create the new stylesheet.

406 User's Guide

6. Choose the Insert ▶ Custom Table menu option. The Custom Tables list
opens, if it is not already active, with a new custom table object
CustomTable highlighted in the list. The object is crossed through in red
since it currently contains errors - the required table and row elements have
not yet defined. Rename the new object as required.
7. Refer to the Elements category in the bottom half of the Arbortext Styler
window. The Show possible table elements option is checked. The window
advises you that you have not yet specified the element that forms the basis of
the table. The elements that are permitted to perform the role of table are listed
in the Available Elements list - you can see that the list contains every element
that currently has the style Unstyled.

8. Select the element that should form the basis of the table from the Available
Elements list, in this case the authorgroup element.
9. Click Add to add the element to the Custom table elements list. Arbortext
Styler automatically assigns the role of Table to this element.
Note that the advice window at the bottom of the window now tells you that
you need to specify the required Row element for this custom table.
Navigate to the Elements list and locate the authorgroup element. You
will see that the element has been assigned the style Custom Table.
10. Navigate back to the Custom Tables list and refer to the Available Elements list
for your custom table. It now contains a list of those elements in the stylesheet
that are permitted as children of the authorgroup element. Choose
author and click Add to add it to the Custom table elements list. In the
Custom table elements list, click on the Role dropdown list and select Row.

Styling Custom Tables 407

 Navigate to the Elements list and locate the author element. You will
see that a new context author in authorgroup has been created, with the
style Row in custom table.
11. Back in the Custom Tables list, refer to the Available Elements list for your
custom table object. It now contains a list of those elements in the stylesheet
that are permitted as children of the author element. Choose firstname
and click Add to add it to the Custom table elements list. In the Custom table
elements list, click on the Role dropdown list and select Cell.

A new context firstname anywhere in authorgroup has been

created in the Elements list, and the context has been assigned the style Cell
in custom table.
12. Choose surname from the list and click Add to add it to the Custom table
elements list. In the Custom table elements list, click on the Role dropdown
list and select Cell.
A new context surname anywhere in authorgroup has been created in
the Elements list, and the context has been assigned the style Cell in
custom table.
The definition of roles within your table is now complete. Note that the
message area at the bottom of the Elements tab is blank, indicating that there
are no further steps to be completed to create a valid table.

13. If required, you can also use the other property categories in the Custom
Tables list to format your custom table:

• Cells category on page 863 — generate cells via XPath and confirm cell
order.
• Header Cells category on page 864 — generate header cells via XPath and
confirm header cell order.

408 User's Guide

 • Format category on page 866 — control the column widths of the custom
table and how the table rules are displayed.
You can configure the default column widths and table rules in the
stylesheet and also designate attributes on the element to which you
assigned the Table role to control the column widths or table rules. If you
designate attributes to control the column widths or table rules, you can
use those attributes as needed to override the default configuration for
column widths and table rules.
• Background Color category on page 869 — configure the background
color for the rows of the custom table. You may use a single color or set
repeating patterns.
14. Choose Preview ▶ Arbortext Editor. You will see that the original
authorgroup is now displayed as a table.
You can now edit the table in Arbortext Editor. Inserting a new row will
automatically insert a new author containing a firstname and surname.
You can see how the authorgroup element forms the basis of the table by
choosing View ▶ Tables ▶ Table Markup.

Example: Styling an Existing Non Table Element as a Custom Table

This example is detailed using the standard DocBook doctype as a basis. The steps
described in the example show how to change a glosslist element from its
default format to a custom table.
1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/styler.
The next three steps describe the insertion of a sample glosslist element
in the sample document so if your glosslist is already in place, proceed to
step 5.
2. Place the cursor inside a para element.
3. Insert the markup necessary to create a glosslist with a glossentry
that contains a glossterm and a glossdef.
4. Type some content in the glossterm and glossdef elements.
5. Choose Styler ▶ Edit Stylesheet to open the associated stylesheet for edit. This
is a read only stylesheet so you will need to save a local copy if you want to
make amendments.
6. Select the glosslist element and give it the Custom Table style.
The Custom Tables list opens, with a new Custom Table object glosslist
highlighted in the list. The object is crossed through in red since it currently
contains errors - a required row element has not yet defined for the table. In

Styling Custom Tables 409

 the bottom area of the window, the glosslist object is assigned the Table
role in the Custom Table Elements list.
7. Select glossentry from the Available Elements list in the Elements
category and click Add to add it to the Custom table elements list. Click on the
Role dropdown list and select Row.

The Available Elements list is populated with elements that can be used for
cells in the new row.
8. Click back to the Elements list and locate the glossentry element. You
will see that a new context glossentry in glosslist has been created,
and that the context has been assigned the style Row in custom table.
9. Back in the Custom Tables list, select glossterm from the Available
Elements list and click Add to add it to the Custom table elements list. Click
on the Role dropdown list and select Cell.
10. Click back to the Elements list and locate the glossterm element. You will
see that a new context glossterm anywhere in glosslist has been
created, and that the context has been assigned the style Cell in custom
table.
11. Back in the Custom Tables list, select glossdef from the Available Elements
list and click Add to add it to the Custom table elements list. Click on the Role
dropdown list and select Cell.
12. Click back to the Elements list and locate the glossdef element. You will
see that a new context glossdef anywhere in glosslist has been
created, and that context has been assigned the style Cell in custom
table.
13. Note that, if required, you can also use the other property categories in the
Custom Tables list to format your custom table:

• Cells category on page 863:

• Header Cells category on page 864:
• Format category on page 866: control the column widths of the custom
table and how the table rules are displayed.
You can configure the default column widths and table rules in the
stylesheet and also designate attributes on the element to which you
assigned the Table role to control the column widths or table rules. If you
designate attributes to control the column widths or table rules, you can
use those attributes as needed to override the default configuration for
column widths and table rules.
• Background Color tab on page 869: configure the background color for the

410 User's Guide

 rows of the custom table. You may use a single color or set repeating
patterns.
14. Choose Preview ▶ Arbortext Editor. You will see that the original glosslist
is now displayed as a table.
You can now edit the table in Arbortext Editor. Inserting a new row will
automatically insert a new glossentry containing a glossterm and
glossdef. You can view the table markup by choosing View ▶ Tables ▶ Table
Markup.

Generating Custom Table Cells via XPath

This section describes how to use XPath expressions to create cells for a custom
table where no table cell elements appear in the document model. You may also
create header rows for the custom table in this way.
The example assumes the use of a PartList element, which has the following
content model:
<!ELEMENT PartList (Part+)>
<!ELEMENT Part (Number, Description, Weight, Height, Width)>
In addition, the Weight element has an attribute unit, and the Part element has
an attribute type.

Example: Generating custom table cells and header rows via XPath
Using this example you will create a custom table based on the PartList
element, with rows based on the Part element. The columns in the rows are
based on the following document elements and attributes:
• Number
• The type attribute of the Part element
• Weight
• The unit attribute of the Weight element
• Description
You will also generate header rows for the table.
1. In your source document, add a PartList element, with Part elements as
its children. Create child elements Number, Description, and Weight
for Part. Give the elements some content.
Give a value to the type attribute of the Part element.
Give a value to the unit attribute of the Weight element.
2. Open your stylesheet for edit.

Styling Custom Tables 411

3. In the Custom Tables list, create a new custom table object where the
PartList element takes the Table role.
4. In the Elements category for the Custom Tables list, create roles in the custom
table for the child elements of Partlist:
• Part: Row
• Number: Cell
• Weight: Cell
• Description: Cell
5. Navigate to the Cells category.
6. In the Generated Cells field, click the New button. The New Generated Cell
dialog box opens. See New Generated Cell dialog box on page 977 for
information.
7. Enter a generated cell definition that will extract the content of the type
attribute of the Part (current row) element:
• Name: user defined, e.g. Part-type
• XPath: @type

Click OK to exit the dialog box. The generated cell definition Part-type
appears in the Generated Cells field and at the end of the Cell Order field.
8. Create a second generated cell definition using the Generated Cell dialog box
as above. Configure it to extract the content of the unit attribute of the
Weight element:
• Name: user defined, e.g. Weight-unit
• XPath: Weight@unit

Click OK to exit the dialog box. The generated cell definition Weight-unit
appears at the end of the Generated Cells and Cell Order fields.
9. In the Cell order field, select Part-type and use the up arrow to move it to
the second position in the list. Select Weight-unit and move it up to follow
Weight.
The order of the columns is now:
• Number
• Part-type
• Weight
• Weight-unit
• Description

412 User's Guide

 Note that the Specified button has been selected for you. This occurs
automatically when you enter the first generated cell definition.
10. You may want to generate header rows for the tables too. The next steps will
generate the following headers for the columns:
• Part Number
• Part Type
• Weight
• Unit Weight
• Description
11. Navigate to the Header Cells category for your custom table. Click the New
button next to the Generated Header Cells field to open the New Generated
Header Cell dialog box. See New Generated Header Cell dialog box on page
977 for information.
12. In the Name field, enter a name of your choice to identify the header cell
definition.
13. In the XPath field, enter the text you want to output in the header cell,
surrounded by single quotes.
If you want to localize the generated text in the header cells, use the following
alternative process to configure it:
a. Enter an empty string in the XPath field, i.e. ' ', then click OK to exit the
New Generated Header Cell dialog box.
b. Navigate to the SFE generated for the header cell, i.e.
_sfe:GeneratedHeaderCell_xxx_yyy. See SFEs created for
generated cells on page 414 for further information on SFEs.
c. Enter the required generated text for the header cell as the generated text
for the SFE.
Refer to Maintaining Translations of Generated Text on page 528 for
information on translating generated text.
14. Click OK to exit the dialog box.
15. Repeat these steps until you have generated header cell definitions that will
provide a header title for each of the columns defined in the Cells category, for
example:
Column in Header
Cells Name XPath
Number number 'Part Number'
Part/type type 'Part Type'
Weight weight 'Weight'

Styling Custom Tables 413

 Column in Header
Cells Name XPath
Weight/unit unitweight 'Unit Weight'
Description description 'Description'
16. If necessary, use the up and down arrows in the Header cell order field to
reorder the header cell definitions.
17. Preview your document for print. You will see that the columns in the
PartList custom table are ordered in the correct way, and contain the
content of the specified elements and attributes.

SFEs created for generated cells

Arbortext Styler automatically creates SFEs to support generated cell definitions.
This allows you to configure font properties and other properties that can normally
be configured for table cell elements:
• For generated cells: _sfe:GeneratedCell_xxx_yyy
• For generated header cells: _sfe:GeneratedHeaderCell_xxx_yyy
• For generated header rows: _sfe:GeneratedHeaderRow_yyy
Note that this SFE only includes the custom table name suffix since you do not
supply a name for a generated header row definition.
Where xxx is replaced by the value of the Name field from the Cells or Header
Cells property categories for the generated cell definition and yyy is replaced by
the name of the custom table.
These SFEs are always kept in the same module as the custom table they
correspond to. They cannot be deleted, moved or copied to different modules by
themselves. When the custom table definition is deleted, moved or copied, the
SFEs are also deleted, moved or copied. If the custom table is renamed, or if the
generated cell or header cell is renamed, the corresponding SFE is also renamed.
This includes renaming references to the SFE, for example in the selector of a
context.

Support for cell generation in custom tables

The table below shows support for table cell generation in available output
formats with a .style stylesheet.
Output Support
Editor view Generated cells are not shown
Print / PDF via PTC APP Supported
Print / PDF via FOSI Supported
Print / PDF via XSL-FO Supported

414 User's Guide

Output Support
All HTML outputs Supported
RTF Supported

Bear in mind these general guidelines when working with custom tables:
• Column reordering using generated cells is not supported in any format of
stylesheet exported from Arbortext Styler.
• If all cells within the table row of a custom table are generated, the table will
always be shown in markup form in Editor view. It will not be displayed as a
table.

To test an XPath expression for generating table cells

It often takes multiple attempts to define the correct the correct XPath expression
to meet your requirements. It is much quicker to develop and test expressions
Arbortext Editor than in Arbortext Styler - the steps below explain how:
1. Open your document in Arbortext Editor.
2. Expose the table markup via the View ▶ Tables ▶ Markup menu option.
3. To test an expression that will generate a cell and its content, place the cursor
just inside a row element and enter this command in the command line:
eval oid_xpath_string(oid_caret(), 'your xpath expression here')

The command will return the string that will become the generated cell’s
content.
4. To test an expression that will generate a header cell and its content, place the
cursor inside the header row element and use the command shown above. If
there is no header row element, place the cursor just inside the table element
and use the command.

Translatable generated text for generated header cells

Reordering Columns in Custom Tables

This section describes how to reorder the columns in the body of a custom table.
The example assumes the use of a PartList element, which has the following
content model:
<!ELEMENT PartList (Part+)>
<!ELEMENT Part (Number, Description, Weight, Height, Width)>

Styling Custom Tables 415

Example: Reorder the columns in a custom table
Using this example you will style the PartList element as a custom table, and
create the custom column order Number, Weight, Description for the table
in output. Note that this column order differs from the order of the cell elements in
the content model.
1. In your source document, add a PartList element. Create child elements
Number, Description, and Weight. Give the elements some content.
2. Open your stylesheet for edit.
3. In the Elements list , assign the Custom Table style to the PartList
element.
The Custom Tables list opens, with a new Custom Table object PartList
highlighted in the list. Note that the PartList element has been assigned the
role of Table role in the Elements category.
The custom table object is crossed out. It is not valid until you have defined a
row element.
4. Add Part to the Custom table elements list. Assign it the role of Row.
5. Add Number to the Custom table elements list. Assign it the role of Cell.
6. Repeat the previous step for Weight and Description.
7. Go to the Cells category. Note that the Document order radio button is checked
in the Cell order field. Cells will appear in the table in the order they occur in
the source document.
8. Click the Specified radio button. Note that the Number, Weight, and
Description elements appear in the Cell order list, in the order in which
you added them to the custom table model.
9. Use the up arrow button to move the Description element above the
Weight element in the list.
10. Choose Preview ▶ Print. You will see that the PartList element is now
displayed as a table. It contains the columns Number, Description, Weight in
that order.
11. Back in the Custom Tables list, go back to the Cells category. Click the
Document Order radio button
12. Preview the document for print again. Note that the columns are displayed in
the order in which the cells occur in the source document, i.e. Number,
Weight, Description.

Support for reordering of columns in custom tables

The table below shows support for table cell reordering in available output
formats with a .style stylesheet.

416 User's Guide

Output Support
Editor view Cells are always shown in document
order
Print / PDF via APP Supported
Print / PDF via FOSI Supported
Print / PDF via XSL-FO Supported
All HTML outputs Supported
RTF Supported

Note
Column reordering is not supported in any format of stylesheet or template
exported from Arbortext Styler.

Using Background Color in Custom

Tables
This section describes how to apply background color to the body of a custom
table. There are two examples listed - the first one will apply a single background
color to the table while the second shows you how to create a pattern of
alternating and repeating colors to the rows in the table.
If your custom table includes a header row and you want to give that a
background color, use the color picker in the Header row background color field in
the Background color category on page 869 for the Custom Tables list. This can be
a different color to that configured for the body of the table.

Example: Apply a background color to a custom table

Using this example you will apply a background color of Yellow to the body of a
custom table.
1. From the Custom Tables list , select the Custom Table object whose
background color you wish to configure.
2. Go to the Background color category.
3. In the Body rows background color repeating pattern field, configure the
following settings:
• Number of rows: 1
• Color: click the color picker and select Yellow.

Styling Custom Tables 417

 You will need to click the Add Component button to access the fields.
4. Preview your document for print or PDF. You will see that any elements styled
via the selected Custom Table object will display a background color of
yellow throughout their body.

Example: Apply a pattern of repeating background colors to a custom

table
Using this example you will create a repeating background color pattern
consisting of a single row colored white followed by two rows colored blue.

1. From the Custom Tables list , select the Custom Table object whose
background color you want to configure.
2. Go to the Background color category.
3. In the Body rows background color repeating pattern field, configure the
following settings for the default component:
• Number of rows: 1
• Color: click the color picker and select White.
You will need to click the Add Component button to access the fields.
4. Click Add Component again. A second set of Number of rows and color fields
appears.
5. For this second component, configure the following settings:
• Number of rows: 2
• Color: click the color picker and select Blue.
6. Preview your document for print or PDF. You will see that any elements styled
via the selected Custom Table object will display the background color pattern
you have configured, and that this pattern will repeat in tables consisting of
more than three body rows.

Support for row background color in custom tables

The table below shows support for background color in available output formats.
Output Support
Editor view Supported*
Print / PDF via APP Supported
Print / PDF via FOSI Supported*
Print / PDF via XSL-FO Supported*
All HTML outputs Supported*
RTF Supported*

418 User's Guide

* The Restart pattern after page or column break option is not available in this
output format.

Styling Custom Tables 419

 18
Formatting Footnotes and
Endnotes
Footnotes Overview................................................................................................. 422
Creating and Modifying an Inline Model Footnote....................................................... 425
Creating and Modifying a Reference Model Footnote ................................................. 431
Creating and Modifying a Hybrid Model Footnote ....................................................... 434
Formatting the Reference Mark in a Footnote ............................................................ 439
Endnotes Overview ................................................................................................. 448
Creating and Modifying an Inline Model Endnote ....................................................... 449
Creating and Modifying a Reference Model Endnote .................................................. 454

This section describes how to manage footnotes and endnotes via your stylesheet.

421
Footnotes Overview
The method you use to develop footnotes in Arbortext Styler depends on your
particular document type, since the elements available in your document type and
the model your document type uses for footnotes determine how footnotes can be
formatted. Note that footnote formatting can only be applied to element contexts -
you cannot apply footnote formatting to property sets or conditions.
Arbortext Styler recognizes the following four types of footnote-related elements:
• Footnote Content and Reference - This type of element contains the footnote
body and occurs at the reference location. It generates a unique reference mark
and the associated footnote on the page in the document where the element is
located. If you want to cross reference this type of footnote, it must contain an
ID equivalent attribute.
• Footnote Cross Reference - This type of element is a reference to an existing
Footnote Content and Reference element. It uses an IDREF, IDREFS, or
CDATA attribute to reference the existing footnote and generates the same
reference mark as the referenced footnote. It does not generate a footnote.
• Footnote Content - This type of element just contains the footnote body and
must be referenced through an ID equivalent attribute. It does not generate
either a reference mark or a footnote at the place it occurs in the document.
The element can occur anywhere in the document.
• Footnote Reference - This type of element references a Footnote Content
element through an IDREF, IDREFS, or CDATA attribute. It generates both a
unique reference mark and the referenced footnote on the page in the
document where the reference element is located. If you want to generate
multiple unique instances of the same footnote, this element could also
reference a Footnote Content and Reference element.

Note
While you can use a IDREFS attribute to reference a footnote, each
footnote reference element should only reference a single footnote.

These elements can be combined to develop the following types of footnote

models:
• Inline Model - This model uses a Footnote Content and Reference element to
generate footnotes where they appear in the document. A variation on this
model enables cross references to the same footnote using a Footnote Cross
Reference element. Another variation enables multiple unique copies of a

422 User's Guide

 footnote by assigning an ID equivalent attribute to the Footnote Content and
Reference element and referencing that element with a Footnote Reference
element.
• Reference Model - This model uses a Footnote Content element to contain the
footnote body and a Footnote Reference element to generate the footnote
where the reference element appears in the document.
• Hybrid Model - This model sometimes uses the Inline Model and sometimes
uses the Reference model. It contains a Footnote Content and Reference
element with an ID equivalent attribute and a Footnote Reference element.
How the model operates depends on whether the ID equivalent attribute in the
Footnote Content and Reference element has a value assigned. If it does not
have a value assigned, the model operates as an Inline Model footnote and
generates both the reference mark and footnote at the location of the element.
If the ID equivalent attribute does have a value assigned, then the model
operates as a Reference Model footnote and must be referenced by the
IDREF, IDREFS, or CDATA attribute of the Footnote Reference element. This
model is used in the Darwin Information Typing Architecture (DITA)
document types.

Output Support for Footnotes

Footnotes appear as follows in these types of output:
• Arbortext Editor - For Inline Model footnotes, the footnote and reference mark
appear where the footnote element is located in the document.
For models where the footnote is referenced, the reference mark appears in the
document where the reference element is located. The reference mark only
appears in superscript when no tags are displayed. When you click on the
reference element or mark, the cursor moves either to the associated footnote
body element or the next reference element depending on which appears next
in the document. The referenced footnote body element appears at its location
in the document, unless your have your Arbortext Editor preferences set not to
show hidden content. Clicking on the beginning tag of the footnote body
element moves the cursor to the next reference element that appears in the
document.
• Print/PDF - Reference marks and footnotes appear on individual pages.
• HTML File - Reference marks appear in the body of the file and link to the
associated footnotes. Footnotes are collected at the end of the file.
• HTML Help - Reference marks appear in the individual help topics and link to
the associated footnotes. Footnotes are collected in their own help topic at the
end of the document.
• Web - Reference marks appear in the individual HTML files and link to the
associated footnotes. Footnotes are collected in their own HTML file at the
end of the document.

Formatting Footnotes and Endnotes 423

Note the following limitations in support for footnotes:
• Relative XPath expressions in generated text evaluated in the footnote area are
not supported in print/PDF output generated by the PTC APP engine.
The XPath expression must start navigation from the root of the document.
Duplicate footnotes will be merged when publishing to Arbortext Editor, print/
PDF, and RTF outputs. A single reference will be output. Two different methods
for identifying duplicates are used:
1. Publishing via FOSI and XSL-FO engines: if both content and marker are
identical
2. Publishing via PTC APP engine: if content is identical

Note
Duplicates are not merged when publishing to HTML outputs.

Footnote Contexts
Footnote formatting can only be applied to element contexts. There are three
contexts associated with an element that is styled as a Footnote, and (optional)
formatting applied to each of these contexts will affect different parts of the
footnote or its content:
1. Original context (for example, footnote everywhere else) -
Formatting applied to the original footnote context only affects the associated
reference mark.
2. Special footnote context (for example footnote everywhere
(Footnote Area Properties) - This context is created automatically
by Arbortext Styler when an element is given the Footnote style to specify that
it is responsible for footnote generation. The context is, however, removed if
the element is not intended to generate a footnote, only a reference mark.
Formatting applied to this special context only affects the footnote itself, not
the reference mark, including the footnote text content if no formatting has
been applied to the special footnote paragraph context. You can apply different
formatting for the footnote area context to different properties. For example,
you could format the footnote area differently for Print/PDF and HTML outputs.
3. Special footnote paragraph context (for example para (first in
parent) anywhere in footnote) - This context is created
automatically by Arbortext Styler when an element is given the Footnote style.
The context is given the Inline style to ensure that the first paragraph (i.e. that
which contains the footnote content) in the element given the Footnote style

424 User's Guide

 will appear on the same line as the footnote marker in the footnote area. If you
set formatting for this context, its properties will be reflected in the footnote
content.
Element and User Formatting Element contexts that are associated with footnotes
have the following special icons in the Elements list:
• - Represents an element context that is associated with footnote content.
• - Represents a User Formatting Element context that is associated with
footnote content.
• - Represents an element context associated with footnote content that is in a
read-only module.
• - Represents a User Formatting Element context associated with footnote
content that is in a read-only module.
Footnote area contexts have the following restrictions:
• The contexts cannot have conditions.
• The contexts cannot be edited via the Edit ▶ Edit Context menu option.
• The contexts cannot be moved up or down. If you move the original context
associated with the footnote context up or down, the footnote context moves
with the original context.
• The contexts cannot be cut, copied, or deleted. If you cut. copy, or paste the
original context associated with the footnote context, the footnote context is
affected as well.
• The Footnote category is not available and shows the same values as the
original context.
• The Generated text category has Number selected by default. This setting
cannot be changed. You can select the Details button to bring up the Footnote
Number dialog box.

Creating and Modifying an Inline Model

Footnote
Some document types use a single element to both generate the footnote reference
mark and contain the body text of the footnote. This Footnote Content and
Reference element generates both the reference mark and the footnote on the page
in which the element appears in the document.
You can use a Footnote Cross Reference element to reference the same footnote.
This element would generate the same reference mark as the Footnote Content and
Reference element, but would not generate a footnote. For this variation to work,
the Footnote Content and Reference element must have an ID equivalent attribute
and the Footnote Cross Reference element must have an IDREF, IDREFS, or
CDATA attribute.

Formatting Footnotes and Endnotes 425

You can also use a Footnote Reference element to reference the same footnote.
This element would generate both a different reference mark and a copy of the
footnote at the location the element appears in the document. For this variation to
work, the Footnote Content and Reference element must have an ID equivalent
attribute and the Footnote Reference element must have an IDREF, IDREFS, or
CDATA attribute.
The examples shown in the section are based on the axdocbook doctype, for
example the Arbortext Styler sample document transport.xml, located at
Arbortext-path/samples/styler.

Example: Creating an Inline Model Footnote

1. In Arbortext Editor, open your document and use the Styler menu to open a
new stylesheet.
2. In Arbortext Styler, select the footnote element in the Elements list.
3. Assign the Footnote style to that element via the Edit ▶ Style menu option.
4. In the Footnote category, note that the option Generates reference mark and
footnote is checked by default. Leave this option checked to specify that the
footnote defines both content and reference mark. Note also that, with the
inclusion of this parameter, a new context with the (Footnote Area
Properties) suffix has been created for the footnote element - this is
where you can add formatting properties specific to the footnote.
Note also that a new context for the para element, para (first in its
parent) anywhere in footnote has also been created, with a Structure
Type of Inline (see the Breaks category). This special context is added so
that Arbortext Styler can make sure that the first paragraph (i.e. that which
contains the footnote content) in a footnote element is marked as inline and
will appear on the same line as the footnote number in the footnote area. If you
set formatting for this context, its properties will be reflected in the footnote
content.
5. Select the regular context of the footnote element.
6. Refer to the Description tab of your Arbortext Styler interface - you can see
that the footnote element is described as Inline, Footnote
(content and reference).
7. Refer to the Generated text category for the footnote element. Note that it
is set to generate a number in the Before-text field.
8. In Arbortext Editor, add a footnote element to the place in the document
where you wish the footnote reference to appear. In the footnote tag, add
the text that should appear as the body of the footnote.
9. Back in Arbortext Styler, choose Preview ▶ Print. In the print preview window,
note that the number 1 has been placed as a footnote reference in the place in

426 User's Guide

 the document where you inserted the original footnote element. At the bottom
of the page that contains the footnote reference, note that the footnote appears.

Modifying an Inline Model Footnote

1. To set general formatting options for the footnotes in your document, select
Tools ▶ Format Footnotes in Arbortext Styler to open the Footnotes dialog
box.
2. Use the options on the Footnotes dialog box to determine the width, style, and
scope of your footnotes. You can also specify the amount of space to leave
above footnotes and whether there should be a separator rule between the
footnotes and the document body text.
You may use this dialog box to elect to have footnote numbering restart within
the scope of specified contexts. When Arbortext Styler encounters one of the
contexts you have listed in the Contexts that restart footnote numbering field it
will restart footnote numbering at 1, with numbering continuing consecutively
until it reaches either another listed context or the end of the document.

Note
If you elect to have footnote numbering start at a particular level of nested
element, numbering will be restarted at all contexts of that element at the
same level. For example, if you specify that numbering should restart at
the section in section context, it will also restart when Arbortext
Styler encounters any similar contexts at the same level, for example:
• section in section
• first section in section
• not first section in section
• section in section in preface

3. Click OK to save your changes and exit the Footnotes dialog box.
4. Select the regular context for the footnote element in the Elements list.
5. Assign the desired formatting properties for the footnote reference mark. You
can assign different properties to different types of output by selecting options
from the Outputs to edit list.

Formatting Footnotes and Endnotes 427

6. Select the special (Footnote Area Properties) context for the
footnote element in the Elements list.
7. Assign the desired formatting properties for the footnote body. You can assign
different properties to different types of output by selecting options from the
Outputs to edit list.

Example: Creating a Cross Reference to an Inline Model Footnote

1. In Arbortext Styler, select the footnoteref element in the Elements list.
2. Assign the Footnote style to that element via the Edit ▶ Style menu option.
3. Note that a new context with the (Footnote Area Properties) suffix
has been created for the footnoteref element. Note also that, in the
Footnote category for the regular footnoteref context, the option
Generates reference mark and footnote is checked by default. These are default
settings that you will change in the next steps.
4. Select the regular context for the footnoteref element in the Elements list.
5. In the Footnote category, select the Element references footnote and generates
reference mark option. Here you are specifying that the cross reference is
pointing to a footnote and will generate a reference mark.
6. Select the linkend attribute from the Reference attribute drop down menu.
Here you are specifying the particular IDREF, IDREFS, or CDATA attribute
on the target footnote element to which the cross reference should point.
7. Uncheck the Generates footnote option. Here you are advising Arbortext
Styler that the cross reference will not produce any footnote text of its own.
You use this setting since the cross reference links to an existing footnote
created elsewhere. Note that the special (Footnote Area Properties)
context for the footnoteref element is removed from the Elements list
since this element defines only the footnote reference and not a footnote body.
Note also that a new context for the para element, para (first in its
parent) anywhere in footnoteref, with a Structure Type of Inline
(see the Breaks category), has also been created. This special context is added
so that Arbortext Styler can make sure that the first paragraph in the
footnoteref is marked as inline and hence will appear on the same line as
the footnote number in the footnote area.
8. Refer to the Description tab for the footnoteref element - you can see that
the element is described as Inline, Footnote (cross reference).
9. Select the regular context for the footnoteref element in the Elements list
and assign the desired formatting properties for the reference mark.
10. With the context still selected, navigate to the Generated text category. Note
that the Before element content field contains details of the cross reference you

428 User's Guide

 have created, plus a note of the cross reference format you are using. Click the
Edit button next to the field to open the Generated Text Editor.
11. Place your cursor before the CrossReference element and enter the text
See footnote page followed by a space.
12. Select the CrossReference element and choose Edit ▶ Modify Attributes.
The Modify Cross Reference dialog box appears.
13. In the Cross reference format field, select the name of the cross reference
format object that defines the type of cross reference you wish to generate
(note that you can also create a new cross reference format object if a suitable
one does not already exist). For this example, select Page. Here you have
specified that the cross reference will generate the page number upon which
the footnote appears.

14. Click File ▶ Apply and Close to save the changes and exit the Generated Text
Editor.
15. In Arbortext Editor, create a footnote in the document as described in the
section Creating an Inline Model footnote above, preferably on a page other
than the first one. Give its id attribute the value footnote1.
16. Locate the first paragraph in the abstract element at the beginning of the
document and insert a footnoteref element in the place in the text at
which you wish the cross reference to appear. In the Modify Attributes dialog
box that appears when you insert the element, give the element the target
attribute linkend=”footnote1”.
17. In Arbortext Styler, choose Print ▶ Preview. In the print preview window, you
will see that the generated text See footnote page x has been inserted in
superscript in the place in the document where you inserted the
footnoteref element. If you click the page number shown in the link you
will be taken to the page in the document that contains the original footnote.

Example: Creating a New Footnote Using the Content of an Existing

Inline Model Footnote
1. In Arbortext Styler, select the footnoteref element in the Elements list.
2. Assign the Footnote style to that element via the Edit ▶ Style menu option.

Formatting Footnotes and Endnotes 429

3. In the Footnote category, note that the option Generates reference mark and
footnote is checked by default - this is a default setting that you will change in
the next steps. Note also that, with the inclusion of this parameter, a new
context with the (Footnote Area Properties) suffix has been created
for the footnoteref element - this is where you can add formatting
properties specific to the footnote body text.
Note also that a new context for the para element, para (first in its
parent) anywhere in footnoteref has also been created, with a
Structure Type of Inline (see the Breaks category). This special context is
added so that Arbortext Styler can make sure that the first paragraph (i.e. that
which contains the footnote content) in a footnote element is marked as
inline and hence will appear on the same line as the footnote number in the
footnote area. If you set formatting for this context, its properties will be
reflected in the footnote content.
4. Select the regular context for the footnoteref element in the Elements list.
5. In the Footnote category, select the Element references footnote and generates
reference mark option. Leave the Generates footnote option selected. Here you
are specifying that the cross reference is pointing to a footnote and will
generate a reference mark. You are also confirming that the footnote reference
will generate some footnote content as well, and you will give details of the
existing footnote that will provide this content in later steps of this procedure.
6. Select linkend in the Reference attribute drop down menu. Here you are
specifying the particular IDREF, IDREFS, or CDATA attribute on the target
footnote element that will generate the content of this footnote reference.
7. Refer to the Description tab for the regular context of the footnoteref
element - you can see that the context is described as Inline, Footnote
(reference).
8. Select the regular context for the footnoteref element in the Elements list
and assign the desired formatting properties for the reference mark.
9. Select the special (Footnote Area Properties) context for the
footnoteref element in the Elements list and assign the desired formatting
properties for the footnote body.
10. With the regular context selected, navigate to the Generated text category.
Note that it is set to generate a number in the Before-text field.
11. In Arbortext Editor, create a footnote in the document as described in the
section Creating an Inline Model footnote above, preferably on a page other
than the first one. Give its id attribute the value footnote1.
12. Locate the first paragraph in the abstract element at the beginning of the
document and insert a footnoteref element in the place in the text at
which you wish the footnote reference mark to appear. In the Modify Attributes

430 User's Guide

 dialog box that appears when you insert the element, give the element the
target attribute linkend=”footnote1”.
13. In Arbortext Styler, choose Preview ▶ Print. In the print preview window, you
will see that the first paragraph of the abstract element in the document
contains a footnote reference numbered 1, with a footnote at the bottom of the
page. Navigate to the page upon which you created the original footnote and
you will see that the same footnote still appears, but now with the number 2.
You can see that the footnote on the first page has extracted and output the
content of the original footnote.

Creating and Modifying a Reference

Model Footnote
Some document types use two elements for footnotes:
• The Footnote Content element just contains the footnote body text and can
appear anywhere in the document. This element must have an ID attribute, or
equivalent.
• The Footnote Reference element references the Footnote Content element.
This element generates the reference mark and associated footnote at the place
in the document where it appears. This element must have an IDREF,
IDREFS, or CDATA attribute.
The examples shown in the section are based on the axdocbook doctype, for
example the Arbortext Styler sample document transport.xml, located at
Arbortext-path/samples/styler.

Example: Creating a Reference Model Footnote

1. In Arbortext Editor, open your document and use the Styler menu to open a
new stylesheet.
2. In Arbortext Styler, select the footnote element in the Elements list.
3. Assign the Footnote style to that element via the Edit ▶ Style menu option.
4. In the Footnote category, note that the option Generates reference mark and
footnote is checked by default. Note also that a new context with the
(Footnote Area Properties) prefix has been created for the
footnote element - these are default settings that you will change in the
next steps.
Note also that a new context for the para element, para (first in its
parent) anywhere in footnote has also been created, with a Structure
Type of Inline (see the Breaks category) - this special context is added so
that Arbortext Styler can make sure that the first paragraph (i.e. that which

Formatting Footnotes and Endnotes 431

 contains the footnote content) in a footnote element is marked as inline and
hence will appear on the same line as the footnote number in the footnote area.
If you set formatting for this context, its properties will be reflected in the
footnote content.
5. Select the regular context for the footnote element in the Elements list.
6. In the Footnote category, uncheck the Generates reference mark and footnote
option. Note that the special (Footnote Area Properties) context for
the footnote element is removed from the Elements list. Here you have
specified that the footnote element will simply generate the content of the
footnote, with a separate element producing the reference mark.
7. Refer to the Description tab for the context - you can see that the footnote
element is described as Inline, Footnote (content).
8. Select the footnoteref element in the Elements list.
9. Assign the Footnote style to that element via the Edit ▶ Style menu option.
10. In the Footnote category, note that the option Generates reference mark and
footnote is checked by default and that a new context with the (Footnote
Area Properties) prefix has been created for the footnoteref
element - these are default settings that you will change in the next steps.
11. Select the regular context for the footnoteref element in the Elements list.
12. In the Footnote category, select the Element references footnote and generates
reference mark option. Make sure that the Generates footnote checkbox is
checked.
13. Select the linkend attribute from the Reference attribute drop down menu.
Here you are specifying the particular IDREF, IDREFS, or CDATA attribute
on the target footnote element that will generate the content of this
footnote reference.
14. Refer to the Description tab of your Arbortext Styler interface - you can see
that the footnoteref element is described as Inline, Footnote
(reference).
15. Refer to the Generated text category for the regular context of the
footnoteref element. Note that it is set to generate a number in the Before-
text field.
16. In Arbortext Editor, locate the first paragraph in the abstract element at the
beginning of the document and insert a footnoteref element in the place
in the text at which you wish the footnote reference mark to appear. In the
Modify Attributes dialog box that appears when you insert the element, give the
element the target attribute linkend=”footnote1”.
17. Also in Arbortext Editor, create a footnote in the document by inserting a
footnote element anywhere the element is permitted, preferably on a page

432 User's Guide

 other than the first one. Give its id attribute the value footnote1. In the
footnote tag, add the text that should form the footnote content.
18. Back in Arbortext Styler, choose Preview ▶ Print. In the print preview window,
note that the number 1 has been placed as a footnote reference in the place in
the document where you inserted the original footnoteref element. At the
bottom of the page that contains the footnote reference, note that the footnote
appears, even if you placed the footnote element that contains the footnote
content in a page other than the first one.

Modifying a Reference Model Footnote

1. To set general formatting options for the footnotes in your document, select
Tools ▶ Format Footnotes in Arbortext Styler to open the Footnotes dialog
box.
2. Use the options in the Footnotes dialog box to determine the width, style, and
scope of your footnotes. You can also specify the amount of space to leave
above footnotes and whether there should be a separator rule between the
footnotes and the document body text.
You may use this dialog box to elect to have footnote numbering restart within
the scope of specified contexts. When Arbortext Styler encounters one of the
contexts you have listed in the Contexts that restart footnote numbering field it
will restart footnote numbering at 1, with numbering continuing consecutively
until it reaches either another listed context or the end of the document.

Note
If you elect to have footnote numbering start at a particular level of nested
element, numbering will be restarted at all contexts of that element at the
same level. For example, if you specify that numbering should restart at
the section in section context, it will also restart when Arbortext
Styler encounters any similar contexts at the same level, for example:
• section in section
• first section in section
• not first section in section
• section in section in preface

3. Select the regular context for the footnoteref element in the Elements list.
4. Assign the desired formatting properties for the footnote reference mark. You
can assign different properties to different types of output using the Outputs to
edit list.

Formatting Footnotes and Endnotes 433

5. Select the special (Footnote Area Properties) context for the
footnoteref element in the Elements list.
6. Assign the desired formatting properties for the footnote body. You can assign
different properties to different types of output using the Outputs to edit list.

Creating and Modifying a Hybrid Model

Footnote
Some document types enable you to sometimes use the Inline Model footnote and
sometimes use the Reference model. The Darwin Information Typing Architecture
(DITA) document types use this method, where the footnote model used depends
on the presence of a particular attribute. This is called the Hybrid Model. The
Hybrid Model contains a Footnote Content and Reference element with an ID
equivalent attribute and a Footnote Reference element. How the model operates
depends on whether the ID equivalent attribute in the Footnote Content and
Reference element has a value assigned. If it does not have a value assigned, the
model operates as an Inline Model footnote and generates both the reference mark
and footnote at the location of the element. If the ID equivalent attribute does have
a value assigned, then the model operates as a Reference Model footnote and must
be referenced by the IDREF, IDREFS, or CDATA attribute of the Footnote
Reference element.
To support this model in Arbortext Styler, you must use an XPath predicate
element context to determine which type of footnote model should be used in a
document. The following example uses a DITA document type. Arbortext Editor
contains support for the DITA attributes by default. If you want to use the hybrid
footnote model and your document type does not have an ID attribute defined in
the document type for the Footnote Content and Reference element, you must
define a chosen attribute as an ID equivalent. To do this, use the idAttribute
attribute on the Options element in the document type's document type
configuration file (.dcf file) to define the attribute as an ID.
See Document Type Configuration Files in Arbortext Editor online help for further
information about document type configuration files.
The following examples use a DITA document type to illustrate how to create and
modify a Hybrid Model footnote based on the id and href attributes. Note that
Arbortext Editor contains support for the DITA attributes by default.

Example: Creating a Hybrid Model Footnote (DITA)

1. In Arbortext Editor, open a DITA document and use the Styler menu to open a
new stylesheet.
2. In Arbortext Styler, select the fn element in the Elements list.

434 User's Guide

3. Assign the Footnote style to the fn element via the Edit ▶ Style menu option.
Note that a new context with the (Footnote Area Properties) suffix
has been created for the fn element - this is where you can add formatting
properties specific to the footnote body. Note also that the description of the
regular context for the element is given as Footnote (content and reference).
Note also that a new context for the p element, p (first in its parent)
anywhere in fn has also been created, with a Structure Type of Inline
(see the Breaks category). This special context is added so that Arbortext
Styler can make sure that the first paragraph (i.e. that which contains the
footnote content) in a fn element is marked as inline and hence will appear on
the same line as the footnote number in the footnote area. If you set formatting
for this context, its properties will be reflected in the footnote content.
4. With the fn element still selected, choose the Insert ▶ Context menu option to
create a new context.
The New Context dialog box opens.
5. From the Position list, select XPath Predicate.
The XPath Predicate dialog box opens.
6. Enter @id in the XPath Predicate dialog box then click OK to exit the dialog
box. The context fn[@id] appears in the New Context window. Click OK to
save the context and exit the dialog box.
The context fn[@id] now appears in the Elements list. This context will
match if the id attribute on the fn element contains a value.
Note that a special context fn[@id] (Footnote Area Properties)
has also been created, and that the description of the regular context fn[@id]
is Footnote (content and reference). You will change these default
settings in the next steps.

7. Select the fn[@id] context in the Elements list. Note that it is set to Hidden
in the Text category - this is because the element itself should not be displayed
if the id attribute is present, it should merely be identified as a container for
footnote content.

Formatting Footnotes and Endnotes 435

8. In the Footnote category, deselect the Generates reference mark and footnote
option. You will see that the special context fn[@id] (Footnote Area
Properties) disappears, and the description of the fn[@id] context
changes to Inline, Footnote (content). Here you have specified that,
if its id attribute contains a value, the fn element will generate the footnote
content only, and another element will produce the footnote and reference
mark.
9. Select the xref element in the Elements list.
10. Assign the Cross Reference style to the xref element via the Edit ▶ Style
menu option.
The Cross Reference Details dialog box opens.
11. Select href as the target attribute of the cross reference in the Reference
attribute field. Set the required cross reference format option, for example
Number, then click OK to save the change and exit the dialog box. Here you
have specified that the reference mark for the footnote will output the footnote
number.
12. With the xref element still selected, select Insert ▶ Context to create a new
context.
The New Context dialog box opens.
13. Select XPath Predicate from the Position list.
The XPath Predicate dialog box opens.
14. Enter @type='fn' in the XPath Predicate field then click OK to close the
dialog box. The context xref[@type='fn'] appears in the New Context
dialog box. Here you have specified that the xref element will match when
its type attribute has a value of fn.
15. Click OK to save the new context and close the New Context dialog box.
16. Select the xref[@type='fn'] context in the Elements list.
17. In the Footnote category, select the Element references footnote and generates
reference mark option. Make sure the Generates footnote checkbox is checked.
You will see that a special context xref[@type='fn'] (Footnote
Area Properties) has been created and the description of the
xref[@type='fn'] context is now Footnote (reference).
Here you are specifying that, when the cross reference is of type “fn”, it will
generate a reference mark. You are also confirming that the footnote reference
will generate a footnote as well, and you will give details of the element that
will provide the content for the footnote in the next step.
18. Select the href attribute from the Reference attribute list to confirm the correct
target of the cross reference.

436 User's Guide

 Here you are specifying the particular IDREF, IDREFS, or CDATA attribute
on the xref element that will point to the target element that contains the
content of this footnote reference.
19. Refer to the Description tab for the xref[@type='fn'] context - you can
see that the context is described as Footnote (reference).
20. Select the xref[@type='fn'] context in the Elements list and assign the
desired formatting properties for the reference mark. For example, give it a
Text color of Red in the Text category. Then you can ascertain when the
reference mark has been generated by the xref element because the id
attribute on the fn element contains a value (Reference Model), rather than by
the fn element itself (Inline Model).
21. Select the special (Footnote Area Properties) context for the fn
element in the Elements list and assign the desired formatting properties for
the footnote body.
22. With the xref[@type='fn'] context selected, navigate to the Generated
text category - note that it is set to generate a number in the Before-text field.
Thus the reference mark for the footnote will be output in the form of the
footnote number when the xref generates the footnote.
23. In Arbortext Editor, create a footnote in the document by inserting an fn
element anywhere the element is permitted, preferably on a page other than
the first one. Add the text that should form the footnote content.
24. In Arbortext Styler, choose Preview ▶ Print. In the print preview window, note
that the footnote marker has been generated in the place where the fn element
was inserted and the footnote appears at the bottom of the page. The footnote
marker is displayed in black text as this footnote is working from the Inline
Model - the fn element has generated both footnote and marker.
25. Change the fn element you added previously to include the target attribute
id=”footnote1”.
26. Carry out the print preview operation again. You will see that no footnote or
reference is generated. Since the fn element now has a value for the id
attribute the footnote should be generated using the Reference Model.
However, since the document contains no xref element with an equivalent
IDREF attribute, the footnote cannot be generated.
27. In the first paragraph in the topic, insert an xref element in the place in the
text at which you wish the footnote reference mark to appear. Give it attributes
and values as shown below:

Formatting Footnotes and Endnotes 437

 Attribute Value
href #topicID/footnote1
type fn
28. In Arbortext Styler, choose Preview ▶ Print again. In the print preview
window, note that the reference marker appears at the place in the document
where you inserted the xref element. The marker is in red text as it has been
generated by the xref element, following the Reference Model. At the
bottom of the page that contains the footnote reference, note that the footnote
now appears.
It is possible to designate an attribute that can be used to specify the character to
be used as the superscript reference marker for the footnote. You may enter a
particular value for the callout attribute for the footnote element, and if this
attribute value is present the character will be used as the superscript reference
marker for the footnotes. Permitted values for the attribute are numbers, alpha
characters or graphics. The procedures below explain how to incorporate this
feature in the Inline and Reference footnote models, which you can combine to
form the Hybrid footnote model as described in the previous section.

Example: Modifying a Hybrid Model Footnote

1. To set general formatting options for the footnotes in your document, select
Tools ▶ Format Footnotes in Arbortext Styler to open the Footnotes dialog
box.
2. Use the options in the Footnotes dialog box to determine the width, style, and
scope of your footnotes. You can also specify the amount of space to leave
above footnotes and whether there should be a separator rule between the
footnotes and the document body text.
You may use this dialog box to elect to have footnote numbering restart within
the scope of specified contexts. When Arbortext Styler encounters one of the
contexts you have listed in the Contexts that restart footnote numbering field it
will restart footnote numbering at 1, with numbering continuing consecutively
until it reaches either another listed context or the end of the document.

438 User's Guide

 Note
If you elect to have footnote numbering start at a particular level of nested
element, numbering will be restarted at all contexts of that element at the
same level. For example, if you specify that numbering should restart at
the section in section context, it will also restart when Arbortext
Styler encounters any similar contexts at the same level, for example:
• section in section
• first section in section
• not first section in section
• section in section in preface

3. Select the regular context for the fn element in the Elements list.
4. Assign the desired formatting properties for the footnote reference mark. You
can assign different properties to different types of output using the Outputs to
edit list.
5. Select the special (Footnote Area Properties) context for the fn
element in the Elements list.
6. Assign the desired formatting properties for the footnote body. You can assign
different properties to different types of output using the Outputs to edit list.
7. Select the xref[@type='fn'] context for the xref element in the
Elements list.
8. Assign the desired formatting properties for the footnote reference mark. You
can assign different properties to different types of output using the Outputs to
edit list.
9. Select the xref[@type='fn'] (Footnote Area Properties)
context for the xref element in the Elements list.
10. Assign the desired formatting properties for the footnote body. You can assign
different properties to different types of output using the Outputs to edit list.

Formatting the Reference Mark in a

Footnote
Here you will find examples and instructions on how to use various types of
reference mark in your footnote. The following information is included:

Formatting Footnotes and Endnotes 439

• Output a reference mark based on an attribute value: Inline Model footnote
• Output a reference mark based on an attribute value: Reference Model
footnote
• Generate a combination of numbered footnotes and footnotes with reference
marks based on attribute values, in the same document
• Restart footnote numbering at a particular element

Example: Output a reference mark based on an

attribute value: Inline Model footnote
In this example we work in a DocBook document, with its permitted footnote
element footnote. The value of the label attribute should be output as the
footnote reference mark.
Note that this procedure also applies for DITA document types. You will use
different footnote elements and attributes.
1. In Arbortext Editor, open a DocBook document and use the Styler menu to
open a new stylesheet.
2. In Arbortext Styler, select the footnote element in the Elements list.
3. Assign the Footnote style to the footnote element via the Edit ▶ Style menu
option.
4. Choose Insert ▶ Context to create a new context for the fn element.
The New Context dialog box opens.
5. From the Position list, select XPath Predicate.
The XPath Predicate dialog box opens.
6. Enter @label in the XPath Predicate dialog box then click OK to exit the
dialog box. The context footnote[@label] appears in the New Context
window. Click OK to save the context and exit the dialog box.
The context footnote[@label] now appears in the Elements list. Leave
the footnote setting in the Footnote category as Element contains footnote text,
and Generates reference mark and footnote. The description of the regular
context for footnote[@label] reads Footnote (content and
reference).
Note that a special context footnote[@label] (Footnote Area
Properties) has also been created.
This context will match if the label attribute on the footnote element
contains a value.

440 User's Guide

7. Select the footnote[@label] (Footnote Area Properties)
context in the Elements list.
8. Navigate to the Generated text category for the context. In the Numbers and
Bullets field, select the Details button where Number is selected. The Footnote
Number dialog box opens.
9. Click the Edit button next to the XPath override for current level field. The Edit
XPath Override for Current Level dialog box opens.
10. Select XPath expression returns a string in the Expression type field, then add
the expression @label in the Expression field. Click OK to exit the dialog
box. Here you have specified that the value of the label attribute should be
used as the marker for the footnote, rather than the default numbering.
11. Click OK to exit the Footnote Number dialog box.
12. You may wish to add formatting to the footnote before you generate it. The list
below describes the stylesheet items that relate to each part of the footnote:
• Reference mark: add formatting properties to the footnote[@label]
context of the fn element.
• Footnote body: add formatting properties to the footnote[@label]
(Footnote Area Properties) context of the footnote element.
This context also has the property set Footnote font assigned, which
you can edit as necessary.
• Footnote number: apply formatting properties via the Numbering Details
dialog box, accessed by clicking the Details button for numbering, in the
Generated text category for the footnote[@label] (Footnote
Area Properties) context.
13. In Arbortext Editor, create a footnote in the document by inserting a
footnote element anywhere the element is permitted. Set the value of the
label attribute to the # character. Add the text that should form the footnote
content.
14. In Arbortext Styler, choose Preview ▶ Print. In the print preview window, note
that the footnote you added is marked by the # character, and the footnote is
placed at the bottom of the page as usual, with the same character marking it.

Example: Output a reference mark based on an

attribute value: Reference Model footnote
Here we assume the use of a DocBook document, with its permitted footnote
element footnote. The value of the label attribute should be output as the
footnote reference mark.

Formatting Footnotes and Endnotes 441

Note that this procedure also applies for DITA document types. You will use
different footnote elements and attributes.
1. In Arbortext Editor, open a DocBook document and use the Styler menu to
open a new stylesheet.
2. In Arbortext Styler, select the footnote element in the Elements list.
3. Assign the Footnote style to the footnote element via the Edit ▶ Style menu
option. Note that a new context with the (Footnote Area Properties)
suffix has been created for the footnote element.
4. In the Footnote category for the footnote everywhere context, deselect
the Generates reference mark and footnote option. You will see that the special
context footnote everywhere (Footnote Area Properties)
disappears, and the description of the footnote everywhere context
changes to Inline, Footnote (content). Here you have specified that
the footnote element will generate the footnote content only, and another
element will produce the footnote and reference mark.
5. Select the xref element in the Elements list.
6. Assign the Cross Reference style to the xref element via the Edit ▶ Style
menu option.
The Cross Reference Details dialog box opens.
7. Select linkend as the target attribute of the cross reference in the Reference
attribute field. Set the required cross reference format option, for example
Number, then click OK to save the change and exit the dialog box. Here you
have specified that the reference mark for the footnote will output the footnote
number.
8. With the xref element still selected, select Insert ▶ Context to create a new
context.
The New Context dialog box opens.
9. Select XPath Predicate from the Position list.
The XPath Predicate dialog box opens.
10. Enter @role='fn' and id(@linkend)/@label in the XPath Predicate
field then click OK to close the dialog box. The context xref[@role='fn'
and id(@linkend)/@label] appears in the New Context dialog box.
Here you have specified that the xref element will match when its role
attribute has a value of fn and its linkend attribute points to an element that has
a label attribute specified.
11. Click OK to save the new context and close the New Context dialog box.
12. Select the xref[@role='fn' and id(@linkend)/@label] context
in the Elements list.

442 User's Guide

13. In the Footnote category, select the Element references footnote and generates
reference mark option. Make sure the Generates footnote checkbox is checked.
You will see that a special context xref[@role='fn' and
id(@linkend)/@label] (Footnote Area Properties) has been
created and the description of the xref[@role='fn' and
id(@linkend)/@label] context is now Footnote (reference).
Here you are specifying that, when the cross reference is of role “fn” and its
linkend attribute points to an element that has a label attribute, it will generate
a reference mark. You are also confirming that the footnote reference will
generate a footnote as well, and you will give details of the element that will
provide the content for the footnote in the next step.
14. Select linkend from the Reference attribute list to confirm the correct reference
attribute of the cross reference.
Here you are specifying the particular IDREF, IDREFS, or CDATA attribute
on the xref element that will point to the target element that contains the
content of this footnote reference.
15. Refer to the Description tab for the xref[@role='fn' and
id(@linkend)/@label] context - you can see that the context is
described as Footnote (reference).
16. Select the xref[@role='fn' and id(@linkend)/@label] context
in the Elements list and assign the desired formatting properties for the
reference mark.
17. Select the special (Footnote Area Properties) context for the
footnote context in the Elements list and assign the desired formatting
properties for the footnote body.
18. Select the xref[@role='fn' and id(@linkend)/@label]
(Footnote Area Properties) context in the Elements list, then
navigate to the Generated text category. Note that it is set to generate a number
in the Add before element content field.
19. In the Numbers and Bullets field, select the Details button where Number is
selected. The Footnote Number dialog box opens.
20. Click the Edit button next to the XPath override for current level field. The Edit
XPath Override for Current Level dialog box opens.
21. Select XPath expression returns a string in the Expression type field, then add
the expression id(@linkend)/@label in the Expression field. Click OK
to exit the dialog box. Here you have specified that the value of the label
attribute on the element targeted by the linkend attribute on the xref element
should be used as the marker for the footnote, rather than the default
numbering.

Formatting Footnotes and Endnotes 443

22. Click OK to exit the Footnote Number dialog box.
Note that the value of the Add before element content field is now S..
23. In Arbortext Editor, create a footnote in the document by inserting a
footnote element anywhere the element is permitted, preferably on a page
other than the first one. Give it attributes and values as shown below, and add
the text that should form the footnote content.
Attribute Value
label Alpha character, e.g. #
id ID, e.g. fn1

24. In the first paragraph in the topic, insert an xref element in the place in the
text at which you wish the footnote reference mark to appear. Give it attributes
and values as shown below:
Attribute Value
linkend footnote ID, e.g. fn1
Follow standard cross reference syntax for the
document type to identify the relevant footnote
object. This example is written following DocBook
guidelines.
role fn
25. In Arbortext Styler, choose Preview ▶ Print again. In the print preview
window, note that the reference marker for the footnote appears at the place in
the document where you inserted the xref element, and is marked with the
callout character, e.g. #. The footnote appears at the bottom of the page that
contains the footnote reference, and is marked with the callout character.

Example: Generate a combination of numbered

footnotes and footnotes with reference marks based
on attribute values
Here you will output two types of footnote in the same DocBook document -
numbered footnotes and footnotes whose reference mark is generated from the
value of the footnote element’s label attribute.
Note that this procedure also applies for DITA document types. You will use
different footnote elements and attributes.
1. In Arbortext Editor, open a DocBook document and use the Styler menu to
open a new stylesheet.
2. In Arbortext Styler, select the footnote element in the Elements list.

444 User's Guide

3. Assign the Footnote style to the footnote element if this has not already
been done.
4. Create two contexts of the footnote element, with details as shown below:
Context Description Footnote properties
footnote[@label] Footnotes that include a Element contains
value for the label footnote text
attribute Generates reference
mark and footnote
footnote everywhere All other footnotes Element contains
else footnote text
Generates reference
mark and footnote
You should now see four contexts of the fn element, as listed below:
• footnote[@label]
• footnote[@label] (Footnote Area Properties)
• footnote everywhere else
• footnote everywhere else (Footnote Area Properties)
5. Select the footnote everywhere else (Footnote Area
Properties) context in the Elements list.
6. Navigate to the Generated text category for the context. In the Numbers and
Bullets field, select the Details button where Number is selected. The Footnote
Number dialog box opens.

Note that the footnote context is set to be numbered. Leave this setting as it is.
7. Select the footnote[@label] (Footnote Area Properties)
context in the Elements list.
8. Navigate to the Footnote Number dialog box , as described above.
9. Click the Edit button next to the XPath override for current level field. The Edit
XPath Override for Current Level dialog box opens.
10. Select XPath expression returns a string in the Expression type field, then add
the expression @label in the Expression field. Click OK to exit the dialog
box. Here you have specified that the value of the label attribute should be
used as the marker for the footnote, when it has been specified.
11. Click OK to exit the Footnote Number dialog box. Note that the value of the
Add before element content field is now S..
12. In Arbortext Editor, create four footnotes in permitted locations in your
DocBook document, with the details as shown below:

Formatting Footnotes and Endnotes 445

13. In Arbortext Styler, choose Preview ▶ Print. In the Print Preview window, note
that the footnotes have been given reference marks as shown below:

You can see that the four footnotes have been counted together. In the next
step you will exclude the footnotes with character markers from the counting
scheme, thus outputting the two numbered footnotes with markers 1 and 2.
14. Select the footnote everywhere else (Footnote Area
Properties) context in the Elements list. Navigate to the Generated text
category.
15. Navigate to the Footnote Number dialog box , as described above, and click
the Edit button next to the XPath override for current level field. The Edit XPath
Override for Current Level dialog box opens.
16. Select the XPath expression returns a string option, and enter the expression
shown below in the Expression field:
count(preceding::footnote[not(@label)])+1

Click OK to exit the dialog box. Here you have specified that the numbering
count for numbered footnotes should not include those that have the label
attribute specified.
17. Repeat the Preview ▶ Print action. You will see now that the reference marks
for the two numbered footnotes are now 1 and 2. They have been counted in
isolation from the footnotes marked with characters:

446 User's Guide

Restart footnote numbering at a particular element
The Footnotes dialog box contains a field in which you can set the scope for
footnote numbering, once you have configured the footnotes:
1. Select the Tools ▶ Format Footnotes menu option. The Footnotes dialog box
opens.
2. From the Available contexts list, select the element at which footnote
numbering should restart, for example chapter.
3. Click the Add>> button to add the element to the Contexts that restart footnote
numbering list.
4. Click OK to exit the dialog box.
Now when you preview or compose your document, you will see that footnote
numbering starts at 1 with in the scope of the chosen element - in the example
shown above, within each chapter.

Note
There are limitations to restarting footnote numbering when you are working
with RTF output. Please refer to Differences in Output Support on page 1084
for information.

If your document is set up to output two types of footnote, for example both
numbered footnotes and footnotes whose reference mark is generated from the
value of an attribute, you may need to adjust the settings for the non-numbered
footnotes if you want to also implement the numbering restart option detailed
here. If you wish to exclude the non-numbered footnotes from the counting
scheme in each scoped element, you cannot use an XPath expression to set this (as
described in Generate a combination of numbered footnotes and footnotes with
reference marks based on attribute values above) in addition to selecting the
numbering restart option. You must use a FOSI source edit to achieve the same
effect.
For example, suppose you have two footnotes contexts set up in your stylesheet:
• footnote[@label]: footnotes that include a value for the label attribute -
marked with the value of the label attribute
• footnote everywhere else: all other footnotes - numbered

Formatting Footnotes and Endnotes 447

To exclude footnote[@label] footnotes from scoped footnote counting
schemes:
1. Select the footnote element in the Elements list in Arbortext Styler,
highlighting all contexts and conditions of the element.
2. Choose the Edit ▶ Edit Element Source ▶ FOSI menu option to open the FOSI
Editor. Confirm that you wish to edit the element’s source when asked.
3. Locate the tag e-i-c gi="footnote" xpath=
"footnote[@label]".
4. Within that tag, locate the first enumerat child tag.
5. Set the increm attribute in this tag to a value of 0 (zero).
6. Repeat the previous steps for all enumerat attributes configured for the e-i-c
gi="footnote" xpath="footnote[@label]" context.
7. Click File ▶ Apply and Close to save your changes and exit the editor.
8. When you preview or compose your document, you will see that footnotes
marked with the label attribute value are excluded from the counting scheme
within the scoping element.

Endnotes Overview
The method you use to develop endnotes in Arbortext Styler depends on your
particular document type, since the elements available in your document type and
the model your document type uses for endnotes determine how endnotes can be
formatted. In general terms, you must determine the element in the document that
is to be used as the scope for a set of endnotes. You must also determine where a
collection of endnotes should appear in your document, usually at the end of the
scoping element.
Arbortext Styler recognizes the following two types of endnote models:
• Inline Model - This model uses an Endnote element that both contains the
endnote body and generates the endnote reference mark at the place in the
document where the element is located.
• Reference Model - This model uses an Endnote element and an Endnote
Reference element. The Endnote element contains the endnote body: it can
appear anywhere in the document and must have an ID equivalent attribute.
The Endnote Reference element generates the endnote reference mark at the
place in the document where the element is located. It references the Endnote
element through an IDREF, IDREFS, or CDATA attribute.

448 User's Guide

Creating and Modifying an Inline Model
Endnote
Some document types use a single Endnote element to both generate the endnote
reference mark and contain the body text of the endnote. This element generates
the endnote mark at the place the element appears in the document. You must
determine which element in the document to use as the scope for a set of endnotes.
You must also determine where a collection of endnotes should appear in your
document.
The examples shown in the section are based on the axdocbook doctype, for
example the Arbortext Styler sample document transport.xml, located at
Arbortext-path/samples/styler.
The following procedures explain how to work with the chapter element as the
scope for the endnote collection and place the collection at the end of a chapter.
Here the footnote element is designated as the element that will be configured
and formatted as an Endnote.

Setting the Style of the Endnote Element

1. In Arbortext Editor, open your document and use the Styler menu to open a
new stylesheet.
2. In Arbortext Styler, select the footnote element in the Elements list.
3. Assign the Inline style to that element via the Edit ▶ Style menu option.

Setting the Endnote Scope and Numbering

1. With the footnote element still selected in the Elements list, select Insert ▶
Context to create a new context for the element. The New Context dialog box
opens.
2. Click the New ancestor button and pick the chapter element from the list of
elements. Click OK to save the context and exit the New Context dialog box.
The context footnote anywhere in chapter is created in the Elements
list.
3. With the context footnote anywhere in chapter selected in the
Elements list, go to the Text category. Set the Hidden option to Yes. Here you
have specified that the content of the footnote element will not be output at
the position at which the element appears in the document. Later procedures
will specify where the text should actually be used.
4. Go to the Generated text category. Select the Number option then click the
Details button. The Number Details dialog box opens.
5. In the Number Details dialog box, click the Restart button.

Formatting Footnotes and Endnotes 449

6. In the Numbering Restart dialog box, select the chapter everywhere
context as the scope for endnote numbering. Click OK to save the setting and
exit the dialog box. Here you have specified that the numbering for an endnote
collection will always start at 1 for each chapter.
7. If you want punctuation to appear after the number in the endnote, but not in
the endnote reference mark that appears in the body of the document, enter it
in the Suffix (does not appear in references) field in the dialog box. For
example, if you want an endnote to read 1. Text for footnote but the reference
mark to simply show 1 (i.e. with no period), enter the period character in the
Suffix (does not appear in references) field.

Do not add any punctuation to the Number format, as these settings are for the
reference mark that is located inline at the reference location. Punctuation is
generally not used for a reference mark.
8. In the Number Details dialog box, you have the option to change the Number
style if you wish. Make any changes you require to this field then click OK to
save the settings and exit the dialog box.

Styling the Endnote Reference Mark

1. With the footnote anywhere in chapter context still selected in the
Elements list, click the Edit button in the Generated text category to add
generated text before element content.
2. In the Generated Text Editor, highlight the ElementLabelAndNumber
element and select Insert ▶ User Formatting Element ▶ (new).
3. In the New User Formatting Element dialog box, enter reference-mark.
Click OK to save the change and exit the dialog box. The
ElementLabelAndNumber element is wrapped by the
_ufe:reference-mark element.
4. Select File ▶ Apply and Close to save the change and exit the Generated Text
Editor.
5. In the Elements list, select _ufe:reference-mark and assign the Inline
style via the Edit ▶ Style menu option.
If you cannot see User Formatting Elements in the Elements list, make sure
that the View ▶ User Formatting Elements option is activated.
6. In the Text category, select Superscript in the Super/Subscript field. Here you
have ensured that the reference mark for each note in the chapter is output in
superscript style.

450 User's Guide

Creating a Test for the Endnote Element in the Scoping Element
1. In the Elements list, select the chapter element. Ensure it is correctly styled
as a Division if this has not already been done.
2. Select Insert ▶ Condition to create a new condition for the element.
3. In the New Condition dialog box, select the New Content Test button.
4. In the New Content Test dialog box, select the Current Element, Includes, and
At any level options. Select footnote in the Content to test for list. Click OK
to save the test and exit the dialog box.
5. Click OK to save the condition and exit the dialog box.
This creates a new condition If element includes “footnote” at any
level for each context of the chapter element.

Setting the Location and Style of the Endnote Collection

1. With the condition you just created still selected in the Elements list, go to the
Generated text category. Click the Edit button to add generated text after
element content.

Note
If the chapter element had multiple contexts, the previous procedure
will have created multiple conditions – one for each context. In this case,
you can use copy and paste to apply the formatting properties set in this
procedure to all of those conditions, as follows:
• Select the first condition you added.
• Follow steps 1-9 of this procedure for that condition.
• With that condition still selected in the Elements list, select the Edit ▶
Properties ▶ Copy menu option.
• Select each of the other conditions in turn and for each one select the Edit ▶
Properties ▶ Paste menu option to apply the copied formatting properties.

2. In the Generated Text Editor, select Insert ▶ User Formatting Element ▶ (new).
3. In the New User Formatting Element dialog box, enter endnotes-title.
Click OK to close the dialog box.
4. In the Generated Text Editor, enter the title text for your endnote collection in
the _ufe:endnotes-title element. Use the Format ▶ Font menu option
to style the title text as required.
5. Move the cursor after the _ufe:endnotes-title element and select
Insert ▶ User Formatting Element ▶ (new).

Formatting Footnotes and Endnotes 451

6. In the New User Formatting Element dialog box, enter endnotes. Click OK to
close the dialog box.
7. Move the cursor inside the _ufe:endnotes element and select Insert ▶
Element Content.
8. In the Insert Element Content dialog box, select to insert the Element and
content of the footnote element for an Occurrence of All within chapter.
Click OK to save the changes and exit the dialog box.

Note that in the sample generated text markup shown above, a new line has
been included before and after the text in the content of the
_ufe:endnotes-title element, via the Format ▶ New Line menu option.
This improves the appearance of the Endnote collection at the end of the
chapter.
9. In the Generated Text Editor, select File ▶ Apply and Close to save the
generated text setting and exit the editor.
10. Select the _ufe:endnotes-title element in the Elements list and assign
the Block style via the Edit ▶ Style menu option. Make any desired changes to
the formatting properties of the User Formatting Element, for example you can
reference some of the title-related property sets available from the Property
sets category.
11. Select the _ufe:endnotes element in the Elements list and style it as
desired. Since it is just a container for the endnote collection, just assigning
the Block style to the element via the Edit ▶ Style menu option is usually
sufficient.

Adding Endnotes to the Endnote Collection

1. Select the footnote element in the Elements list and select the Insert ▶
Context menu option to create a new context for the element.
2. In the New Context dialog box, check the User formatting elements (with _ufe:
prefix) option in the Include in ancestor and parent lists field. Click the New
Ancestor button then select _ufe:endnotes from the list of elements.
Click OK to save the new context and exit the dialog box. The context
footnote anywhere in _ufe:endnotes is shown in the Elements list.

452 User's Guide

3. In the Breaks category for the context, select Block from the Structure type
list.
4. In the Generated text category, select the Number option and click the Details
button.
5. In the Number Details dialog box, select the Restart button.
6. In the Numbering Restart dialog box, select the _ufe:endnotes
everywhere context as the scope for endnote numbering. Click OK to save
the setting and exit the dialog box.
7. In the Number Details dialog box, add any desired punctuation to the Number
format. For example, add a period after the number. If necessary, change the
Number style to match the style used earlier for the footnote anywhere
in chapter context. Leave Keep number at beginning of line checked. Set
the other Number position controls as desired.
Here you have specified the appearance of the endnotes when they appear in
the endnote area at the end of the chapter.
If your document type includes paragraph-type elements as the children of the
element designated as the Endnote element, the following additional steps are
required to ensure the paragraphs that contain the Endnote content appear
correctly in the Endnote collection.

Styling Paragraphs in Endnotes

1. In the Elements list, select the para element.
2. Select Insert ▶ Context to create a new context for the selected paragraph
element.
3. In the New Context dialog box, set Position to first.
4. Click the New parent button. Select footnote from the list then click OK to
save the new context and exit the dialog box. The context first para in
footnote appears in the Elements list.
5. With the new context selected in the Elements list, go to the Breaks category.
Set Structure type to Inline.
This procedure prevents unnecessary line breaks within endnotes.

Generating the Endnote Collection for a Chapter

The steps shown here give an example of how to set up an Endnote collection to
appear at the end of the first chapter in a document, using all the element settings

Formatting Footnotes and Endnotes 453

set up in the previous procedures. As with the previous procedures, we are
working with the Arbortext Styler sample document transport.xml, located
at Arbortext-path/samples/styler.
1. In Arbortext Editor, add a footnote element at the end of the para element
child of the first formalpara element at the beginning of chapter 1. Add
some arbitrary text that will form the endnote content in the para element in
the footnote tag.
2. Again in Arbortext Editor, add another footnote element at the end of the
para element child of the second formalpara element at the end of
chapter 1. Again, add some arbitrary text in the para element in the
footnote tag.
3. In Arbortext Styler, choose Preview ▶ Print. In the print preview window, note
the following:
• An endnote reference mark, numbered 1, appears at the end of the first
paragraph in the chapter.
• An endnote reference mark, numbered 2, appears at the end of the last
paragraph in the chapter.
• The two endnotes are grouped at the end of the chapter, under the heading
“Notes”.

Creating and Modifying a Reference

Model Endnote
Some document types use two elements for endnotes:
• The Endnote element just contains the endnote body text and can appear
anywhere in the document. This element must have an ID attribute, or
equivalent.
• The Endnote Reference element references the Endnote element through an
IDREF, IDREFS, or CDATA attribute. This element generates the endnote
reference mark at the place in the document where it appears.
You must also determine which element in the document to use as the scope for a
set of endnotes and where a collection of endnotes should appear in your
document.
The examples shown here are based on the axdocbook doctype, for example the
Arbortext Styler sample document transport.xml, located at Arbortext-
path/samples/styler.

454 User's Guide

The procedures explain how to work with the chapter element as the scope for
the endnote collection and place the collection at the end of a chapter. Here the
footnote element is designated as the element that will be configured and
formatted as an Endnote, and the footnoteref element is used as the Endnote
Reference element.

Styling the Endnote and Endnote Reference Elements

1. In Arbortext Editor, open your document and use the Styler menu to open a
new stylesheet.
2. In Arbortext Styler, select the footnote element in the Elements list.
3. Assign the Hidden style to that element via the Edit ▶ Style menu option. This
will ensure that the endnote content, defined in the footnote element, is not
shown in the body of the document where the footnote element appears.
4. Select the footnoteref element in the Elements list.
5. Assign the Inline style to that element via the Edit ▶ Style menu option. Since
the Endnote Reference element usually does not have any content, it does not
need to be hidden.

Setting the Endnote Scope

1. With the footnoteref element still selected in the Elements list, select the
Insert ▶ Context menu option to create a new context for the element.
2. In the New Context dialog box, click the New ancestor button and pick
chapter from the list of elements. Click OK to save the new context and exit
the dialog box. The context footnoteref anywhere in chapter is
created in the Elements list.

Styling and Numbering the Endnote Reference Mark

1. With the footnoteref anywhere in chapter element context still
selected in the Elements list, go to the Generated text category. Click the Edit
button to add generated text before element content.
2. In the Generated Text Editor, select Insert ▶ User Formatting Element ▶ (new).
3. In the New User Formatting Element dialog box, enter reference-mark.
Click OK to save the new UFE and exit the dialog box.
4. Select File ▶ Apply and Close to save the generated text and exit the dialog
box.
5. In the Elements list, select _ufe:reference-mark and assign the Inline
style via the Edit ▶ Style menu option. Here you have specified that the
reference mark will appear inline with previous content in the document.

Formatting Footnotes and Endnotes 455

 If you cannot see User Formatting Elements in the Elements list, make sure
the View ▶ User Formatting Elements setting is activated.
6. With the _ufe:reference-mark element still selected in the Elements
list, go to the Text category. Select the Superscript setting in the Super/
Subscript field. Here you have ensured that the reference mark for each note in
the chapter is output in superscript style.
7. Still with _ufe:reference-mark selected in the Elements list, go to the
Generated text category. Select the Number option then click the Details
button.
8. In the Number Details dialog box, select the Restart button.
9. In the Numbering Restart dialog box, select the chapter everywhere
context as the scope for endnote numbering.
10. In the Number Details dialog box, you have the option to change the Number
style. Make any changes you require here then click OK to save the settings
and exit the dialog box.
Do not add any punctuation to the Number format, as these settings are for the
reference mark that is located inline at the reference location. Punctuation is
generally not used for a reference mark.
11. Click OK to save the setting and exit the dialog box. Here you have specified
that the numbering of endnote reference marks in a chapter will restart at 1 in
each chapter.

Creating a Test for the Endnote Reference Element in the Scoping

Element
1. In the Elements list, select the chapter element. Ensure it is correctly styled
as a Division if this has not already been done.
2. Select Insert ▶ Condition to create a new condition for the element.
3. In the New Condition dialog box, click the New Content Test button.
4. In the New Content Test dialog box, select the Current Element, Includes, and
At any level options. Select footnoteref in the Content to test for field.
Click OK to save the test and exit the dialog box.
5. Click OK to save the new test and exit the New Condition dialog box.
This creates a new condition If element includes “footnoteref” at
any level for each context of the chapter element. Here you have
specified the condition which, when matched for a chapter, will output an
endnote collection (defined in procedures below) and look for endnotes to
include there.

456 User's Guide

Setting the Location and Style of the Endnote Collection
1. With the condition you just created still selected in the Elements list, go to the
Generated text category. Click the Edit button to add generated text after
element content.

Note
If the chapter element had multiple contexts, the previous procedure
will have created multiple conditions – one for each context. In this case,
you can use copy and paste to apply the formatting properties set in this
procedure to all of those conditions, as follows:
• Select the first condition you added.
• Follow steps 1-9 of this procedure for that condition.
• With that condition still selected in the Elements list, select the Edit ▶
Properties ▶ Copy menu option.
• Select each of the other conditions in turn and for each one select the Edit ▶
Properties ▶ Paste menu option to apply the copied formatting properties.

2. In the Generated Text Editor, select Insert ▶ User Formatting Element ▶ (new).
3. In the New User Formatting Element dialog box, enter endnotes-title.
Click OK to save the UFE and exit the dialog box.
4. In the Generated Text Editor, enter the title text for your endnote collection in
the _ufe:endnotes-title element. Use the Format ▶ Font menu option
to style the title text as required.
5. Move the cursor after the _ufe:endnotes-title element and select
Insert ▶ User Formatting Element ▶ (new).
6. In the New User Formatting Element dialog box, enter endnotes. Click OK to
save the UFE and exit the dialog box.
7. Move the cursor inside the _ufe:endnotes element and select Insert ▶
Element Content.
8. In the Insert Element Content dialog box, select to insert the Element and
content of the footnoteref element for a Specific occurrence of All
occurrences within chapter. Click OK to save the setting and exit the dialog
box.

Formatting Footnotes and Endnotes 457

 Note that in the sample generated text markup shown above, a new line has
been included before and after the text in the content of the
_ufe:endnotes-title element, via the Format ▶ New Line menu option.
This improves the appearance of the Endnote collection at the end of the
chapter.
9. In the Generated Text Editor, select File ▶ Apply and Close to save the
generated text and exit the editor.
10. In the Elements list, select the _ufe:endnotes-title element and assign
the Block style via the Edit ▶ Style menu option. Make any desired changes to
its formatting properties, for example you can reference some of the title-
related property sets available from the Property sets category.
11. Select the _ufe:endnotes element and style it as desired. Since it is just a
container for the endnote collection, just assigning the Block style to the
element via the Edit ▶ Style menu option is usually sufficient.

Adding Endnotes to the Endnote Collection

1. Select the footnoteref element in the Elements list and select the Insert ▶
Context menu option to create a new context for the element.
2. In the New Context dialog box, check the User formatting elements (with _ufe:
prefix) option in the Include in ancestor and parent lists field. Click the New
Ancestor button then select _ufe:endnotes from the list of elements.
Click OK to save the new context and exit the dialog box. The new context
footnoteref anywhere in _ufe:endnotes appears in the Elements
list.
3. With the new context selected, navigate to the Breaks category. Select Block
from the Structure type list.
4. Go to the Generated text category. Select the Number option and click the
Details button.
5. In the Number Details dialog box, select the Restart button.
6. In the Numbering Restart dialog box, select the _ufe:endnotes
everywhere context as the scope for endnote numbering. Click OK to save
the setting and exit the dialog box.

458 User's Guide

7. In the Number Details dialog box, add any desired punctuation to the Number
format. For example, add a period after the number. If necessary, change the
Number style to match the style used earlier for the footnoteref
anywhere in chapter context. Leave Keep number at beginning of line
checked. Set the other Number position controls as desired. Click OK to save
the changes and exit the dialog box.
If you want punctuation to appear after the number in the endnote, but not in
the endnote reference mark that appears in the body of the document, enter it
in the Suffix (does not appear in references) field in the dialog box. For
example, if you want an endnote to read 1. Text for footnote but the reference
mark to simply show 1 (i.e. with no period), enter the period character in the
Suffix (does not appear in references) field.
8. Go to the Generated text category. Click the Edit button to add generated text
before element content.
9. In the Generated Text Editor, place your cursor after the number element.
select Insert ▶ Element Content.
10. In the Insert Element Content dialog box, make the necessary selections to
insert the Element content of the footnote element If ID matches IDREF.
Select linkend as the footnoteref IDREF attribute in the Name of IDREF
attribute on footnoteref element field. Click OK to save the test and exit the
dialog box.
11. Select File ▶ Apply and Close to save the generated text and exit the editor.
12. Style the footnoteref element in _ufe:endnotes context as desired
for the endnotes collection.
If your document type includes paragraph-type elements as the children of the
element designated as the Endnote element, the following additional steps are
required to ensure the paragraphs that contain the Endnote content appear
correctly in the Endnote collection.

Styling Paragraphs in Endnotes

1. In the Elements list, select the para element.
2. Select Insert ▶ Context to create a new context for that paragraph element.
3. In the New Context dialog box, set Position to first.
4. Click the New parent button. Select footnote from the list then click OK to
save the context and exit the dialog box. The context first para in
footnote appears in the Elements list.
5. With the new context selected in the Elements list, go to the Breaks category.
Set Structure type to Inline.
6. With the new context selected in the Elements list, select Edit ▶ Copy and Edit
▶ Paste.

Formatting Footnotes and Endnotes 459

 The Edit Context dialog box opens.
7. Select the footnote parent element node with a single click and select
Delete.
8. Select New ancestor and type in the name of the footnoteref element.
footnoteref may not appear in the ancestors list since strictly speaking it
is not permitted as an ancestor of the para element, according to the DTD.
9. Select OK to close the dialog box.
If a message box appears warning you that the context is not valid according
to the DTD, select OK to close that box as well.
The new context para (first in its parent) anywhere in
footnoteref appears in the Elements list, copied with the same settings as
the first para in footnote context.
This procedure prevents unnecessary line breaks within endnotes.

Generating the Endnote Collection for a Chapter

The steps shown here give an example of how to set up an Endnote collection to
appear at the end of the first chapter in a document, using all the element settings
set up in the previous procedures. As with the previous procedures, we are
working with the Arbortext Styler sample document transport.xml, located
at Arbortext-path/samples/styler.
1. In Arbortext Editor, add a para element and a footnote child element after
the itemizedlist element at the beginning of chapter 1. Add some
arbitrary text, that will form the endnote content, in the para element in the
footnote tag. Set the id attribute of the footnote element to a value of
footnote1.
2. Add a para element and a footnote child element after the formalpara
element at the end of chapter 1. Add some arbitrary text, that will form the
endnote content, in the para element in the footnote tag. Set the id
attribute of the footnote element to a value of footnote2.
3. Add a footnoteref element between the word “discussed” and the point
character in the first para of chapter 1. Set the linkend attribute of the
footnoteref element to a value of footnote1.
4. Add a footnoteref element between the word “construction” and the point
character in the last para of chapter 1. Set the linkend attribute of the
footnoteref element to a value of footnote2.
5. In Arbortext Styler, choose Preview ▶ Print. In the print preview window, note
the following:

460 User's Guide

 • An endnote reference mark, numbered 1, appears between the word
“discussed” and the point character in the first para of chapter 1
• An endnote reference mark, numbered 2, appears between the word
“construction” and the point character in the last para of chapter 1
• The two endnotes are grouped at the end of the chapter, under the heading
Notes.

Formatting Footnotes and Endnotes 461

 19
Adding Generated Text
Generated Text Overview......................................................................................... 464
Adding Generated Text to Elements.......................................................................... 465
Inserting Element and Attribute Content in Generated Text ......................................... 468
Numbering List Items............................................................................................... 474
Adding Bullets to List Items ...................................................................................... 479
Labeling and Numbering Divisions............................................................................ 483
Labeling and Numbering Formal Blocks .................................................................... 491
Advanced Formatting of Titles and Numbering........................................................... 495
Non Standard Numbering with XPath........................................................................ 506
Inserting Leaders, Rules, and Space Fills in Generated Text....................................... 507
Inserting Markup in Generated Text .......................................................................... 509
Inserting Graphics in Generated Text ........................................................................ 511
Inserting Symbols in Generated Text......................................................................... 513
Inserting Tables in Generated Text............................................................................ 514
Adding User Formatting Elements to Generated Text ................................................. 517
Using XPath Expressions in Generated Text.............................................................. 518
Creating Repeating Titles......................................................................................... 522
Adding Change Bars ............................................................................................... 524
Maintaining Translations of Generated Text ............................................................... 528

This section describes how to manage generated text such as titles, numbering,
and list markers via your stylesheet.

463
Generated Text Overview
Generated text is content that is automatically added to elements in a document in
Arbortext Editor. Generated text is defined and configured in Arbortext Styler.
For example, you might want to add the word Chapter and a chapter number
before the content of chapter titles.
Generated text refers to:
• Text, graphics, and symbols that display before and after element content - see
Adding Generated Text to Elements on page 465 for information.
• Change bars - see Adding Change Bars on page 524 for information.
• Headers and footers - see Adding Headers and Footers to a Page Set on page
198 for information.
• Numbers and bullets - see Numbering List Items on page 474 for information.
• Numbering and titles - see Advanced Formatting of Titles and Numbering on
page 495 for information.
• Cross reference text - see Cross Reference and Linking Overview on page 550
for information.
• Repeating titles - see Creating Repeating Titles on page 522 for information.
• Tables of contents - see Styling an Element to Generate a Table of Contents on
page 357 for information.
• Indexes - see Indexing Overview on page 378 for information.
You can configure generated text in Arbortext Styler using the Generated Text
Editor, which can be accessed from:
• The Add Text Before and Add Text After fields on the Generated text property
categories for elements, contexts, conditions, and property sets.
• The Edit button for the Format field in the Page numbers category for page
sets.
• The Edit button in the properties area for headers and footer objects.
• The Edit button in the properties area for custom table objects.
When you have created generated text for an element or context, you have the
option to translate it. Arbortext Styler sees each piece of generated text configured
in your stylesheet as a translation unit. You can specify whether a translation unit
should be translated, or if it should be left in its source language when the
document is output.
Please refer to Maintaining Translations of Generated Text on page 528 for
information on how to implement translations of generated text.
Please refer to Managing Translation Units on page 532 for information on
managing translation units and their translation status in your stylesheet

464 User's Guide

Adding Generated Text to Elements
Explicit Settings
You can add text to elements that will be automatically generated when the
document is composed or displayed in Arbortext Editor, for example the word
Chapter and a chapter number before the content of chapter titles.

Note
Arbortext Styler allows you to automatically generate numbers for title and
listitem elements.

Example: Adding Generated Text Before and After an Element

The procedure below describes how to add generated square brackets around a
piece of text, and a hyphen when the element includes a specified attribute.
1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/styler.
2. Choose the menu option Styler ▶ Edit Stylesheet to open the associated
stylesheet for edit. This is a read only stylesheet so you will need to save a
local copy if you want to make amendments.
3. In Arbortext Editor, add a para element after the Introduction chapter
title.
4. Click inside the para element and add a cmdsynopsis element.
5. Click inside the cmdsynopsis element and add an arg element.
6. Type argument inside the arg element.
7. With the arg in cmdsynopsis context selected in the Elements list in
Arbortext Styler, click on the Generated text category.
8. Click Edit next to the Before-text field.
The Generated Text Editor opens.
9. In the Generated Text Editor window, type a left square bracket ([).
10. Choose File ▶ Apply and Close to save the generated text and exit the editor.
The left bracket will now appear in the Before-text field.
11. Click Edit next to the After-text field.
12. In the Generated Text Editor window, type a right square bracket (]).
13. Choose File ▶ Apply and Close to save the generated text and exit the editor.
The right bracket will now appear in the After-text: field.

Adding Generated Text 465

14. With the arg in cmdsynopsis context still selected in the Elements list,
click on the Text category. Set Text size to 18 and Text color to Red. This will
make the word “argument” more visible in the output.
Note that the Description field for the context contains a full description of the
font and generated text settings you have specified:

15. Choose Preview ▶ Print.

In the Print Preview window, note that the word “argument” in the first
paragraph of the document is now preceded and followed by square brackets.
16. In Arbortext Editor, click in the arg element, and elect to modify the
element's attributes.
17. Set the attribute choice="opt" then click OK to exit the Modify Attributes
dialog box.
18. In Arbortext Styler, select the arg in cmdsynopsis context in the
Elements list.
19. Select the Insert ▶ Condition menu option to create a new condition for the
context.
20. Click New Attribute Test in the Condition dialog box to open the Attribute Test
dialog box.
21. Select choice from the Attribute Name list, then select the Includes whole
word option.
22. Type opt in the field to the right of the Includes whole word option.
Click OK to save the test and exit the Attribute Test dialog box.
23. Click OK to save the new condition and exit the Condition dialog box.
The context arg in cmdsynopsis now includes the condition If
attribute “choice” includes the whole word “opt”.
24. In the Elements list, select the condition you just created, and go to the
Generated text category.
25. Choose the Edit button for Before-text.

466 User's Guide

26. In the Generated Text Editor window, type a hyphen ( - ) to the right of the left
square bracket.
27. Choose File ▶ Apply and Close to save the changes to generated text and exit
the editor.
28. Choose Preview ▶ Print.
In the Print Preview window, note that the word “argument” is now preceded
by a square bracket and a hyphen.

With Property Sets

You can create Before-text and After-text generated text for property sets. A
generated text setting can be maintained in a single location and can be applied to
any number of elements, contexts, or conditions with a single click for each.
The following limitations apply to the support for generated text for property sets:
• Numbering and bullets are not available.
• You cannot configure repeating titles.
• Insert ▶ Cross Reference, Insert ▶ Element Number, and Insert ▶ Element Label
and Number are not available in the Generated Text Editor.
• With the exception of PTC APP source, property set edited source will not
contain generated text.
• Element and context edited source that contains generated text originating
from a property set will not reflect changes made in the generated text after the
edited source was created.
This does not apply for PTC APP source edits.
Generated text is resolved as a single property, with explicit generated text settings
taking precedence over that applied to the same context with a property set. If
there is generated text defined for a context, any generated text in referenced
property sets will not be included.

Adding Generated Text 467

Inserting Element and Attribute Content
in Generated Text
You can use the content of elements or attribute values as generated text - the
following sections contain examples and instructions on how to accomplish this.

Example: Inserting Element Content in Generated Text

This example describes how to output the title of the parent chapter before a table
in your document.
1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/styler.
2. Choose the menu option Styler ▶ Edit Stylesheet to open the associated
stylesheet for edit. This is a read only stylesheet so you will need to save a
local copy if you want to make amendments.
3. In Arbortext Styler, select the informal table everywhere context
under the informaltable element. Go to the Generated text category.
4. Click Edit next to Before-text.
5. In the Generated Text Editor window, choose Insert ▶ Element Content. The
Insert Element Content dialog box opens.
6. Select title from the Of list, to specify that this is the element whose
content should be inserted as generated text.
7. Choose Specific occurrence of, and then choose 1st from the Occurrence list
and chapter from the Within list. Here you have defined that the generated
text for the informaltable element should be anything that appears in the
first title in a chapter.
8. Click OK to save the setting and close the dialog box. You will see that the
generated text editor contains a single ElementContent element.
9. Choose File ▶ Apply and Close to save the generated text setting and exit the
editor. You will see that the Generated text area contains details of your
generated text setting in the Before-text field:

10. Choose Preview ▶ Print.

In the Print Preview window, note that the first table in the document is now
preceded by the text “Water - The Cruise Ship”, which is the title of the
chapter in which the table appears.

468 User's Guide

 Note
Be aware that if the element you select has a setting of Hidden in the Text
category, its content cannot be output in generated text.

Example: Inserting Attribute Content in Generated Text

This example describes how to output the value of the id attribute of the first title
in a chapter as the title of the first chapter in the document.
1. In Arbortext Editor, select the title element in the first chapter and apply
the attribute id="INTRO".
2. Delete the text in the first title element in the first chapter. Note that the
number of the chapter remains in the title, since this is generated text
configured for the title element.
3. In Arbortext Styler, select the title element, and then choose Insert ▶
Context to create a new context for the element. The Context dialog box
appears.
4. In the Context dialog box, click New parent, and select chapter as the parent
element of the title element.
5. With chapter still selected, choose first from the Position list.
6. Click OK to save the context and exit the dialog box. The context title in
first chapter is now displayed in the Elements list.
7. Select the title in first chapter context you just created, and go to
the Generated text category.
8. Click Edit next to Before-text.
9. In the Generated Text Editor window, choose Insert ▶ Attribute Content. The
Insert Attribute Content dialog box opens.
10. Select title from the Element list and id from the Attribute to insert list.
11. Choose Specific occurrence, and then choose 1st from the Occurrence list
and chapter from the Within list. Here you have defined that the generated
text for the title in first chapter context should be the value of the id
attribute of the first title in a chapter.
12. Click OK to save the setting and close the dialog box. You will see that the
generated text editor contains a single AttributeContent element.
13. Choose File ▶ Apply and Close to save the generated text setting and exit the
editor. You will see that the Generated text area contains details of your
generated text setting in the Before-text field:

Adding Generated Text 469

14. With the title in first chapter context still selected, go to the Text
category. Set Italic to Yes to request that the title of the first chapter be written
in italic text.
15. Choose Preview ▶ Print.
In the Print Preview window, note that the title of the first chapter now says
“INTRO” in italic text, i.e. the value of its id attribute.

Example: Setting an Attribute Value in Gentext to the Value of a

Different Attribute from the Source Document
When creating generated text for an element in your document, it is possible to
assign a value to an attribute of an element in the generated text by extracting the
value from another element in the document. Using the Insert ▶ Advanced ▶
Attribute Modifier menu option in the Generated Text Editor you can elect to
extract the value of any attribute on any element in the source document, and use
it as the value of the selected attribute on the element in your generated text. Note
that the value you use does not need to be the value of the same attribute in
another element: you can elect to use the value of any attribute. For example, you
could use the value of a fileref attribute as the value of the id attribute on your
chosen gentext element. The process will give you the opportunity to create
dynamic documents whose display changes based on its content.
For example, this process can be used to extract the value for a pathname attribute
for a graphic in generated text - in the procedure below we will extract the value
of the fileref attribute of a graphic in a chapter and use that value as the value of
the pathname attribute for a graphic in the same chapter's title, where the title
graphic is to be produced via generated text. In this way the title of the chapter is
set to always show the same graphic as is contained in the chapter itself, without
the author having to specifically code the graphic for every chapter.
1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/styler.
2. Choose the menu option Styler ▶ Edit Stylesheet to open the associated
stylesheet for edit. This is a read only stylesheet so you will need to save a
local copy if you want to make amendments.
3. In the Elements list, highlight (or create) the element or context for which the
generated text should apply: in this instance, the title in last chapter
context.
4. In the Generated text category for the context, click Edit to add generated text
before the element content. The Generated Text Editor opens.
5. Using the Insert ▶ Graphic menu option, insert a graphic element. You will be
asked to select the filename of the graphic that is to be inserted - for the

470 User's Guide

 purposes of demonstration, select an arbitrary graphic from your filesystem.
Once you have done this the graphic will be inserted into the Generated Text
Editor, wrapped in a _gentextgraphic tag.
6. Check the Modify Attributes dialog box for the _gentextgraphic element.
You will see that the filename has been inserted into the pathname attribute for
the _gentextgraphic element, rather than the fileref attribute as it appears
in the original graphic element. Since your are simply using this graphic as
an example, delete this attribute value, then click OK to exit the dialog box.
The Generated Text Editor now contains a singleton _gentextgraphic
element and no graphic:
7. In the Generated Text Editor window, place your cursor to the right of the
_gentextgraphic element and select the Insert ▶ Advanced ▶ Attribute
Modifier menu option. The Attribute Modifier dialog box opens.

Note
The menu item is only enabled if the first tag to the left of the cursor is an
element (an element from the user’s document type, an undeclared
element, a SFE or a UFE) or a _gentextgraphic.

8. In the dialog box, select pathname from the Attribute Name drop down list, to
specify that the attribute you extract from the graphic in the source document
should be used as the value of the pathname attribute in the gentext graphic.

9. Click OK to save the change and exit the dialog box. Arbortext Styler inserts
an AttributeModifier element into the generated text, with the attribute
pathname included but not given a value. You will set the value of the attribute
in the next steps, by using the value of a different attribute from an alternative
element in the source document.

Adding Generated Text 471

10. Place your cursor in the AttributeModifier element and select Insert ▶
Attribute Content. The Insert Attribute Content dialog box opens.
11. Select By XPath to confirm that you will use an XPath expression to find the
attribute that contains the value you require.
12. In the Expression field, type the XPath expression that will resolve to the
element that contains the attribute whose value you need. The example below
specifies that Arbortext Styler should find the graphic in the first para in
the chapter parent of the current element (title in chapter):
parent::chapter/para[1]/graphic
13. In the Attribute to insert field, type fileref. Here you have confirmed that
the value of the fileref attribute on the element defined in the XPath expression
should be used as the value of the pathname attribute of the graphic in the
chapter title.

472 User's Guide

 Note that you will not be able to select the attribute name from the drop down
list in the Attribute to insert field. The XPath expression is not resolved at this
stage and as such Arbortext Styler cannot determine a list of attributes for the
target element.
14. Click OK to save the XPath expression and close the dialog box. The
Generated Text Editor window now contains three objects: the
_gentextgraphic object, the Attribute Modifier object, and the
AttributeContent object that contains the XPath expression.

15. Click File ▶ Apply and Close to save the generated text and exit the Generated
Text Editor. The Before-text field in the Generated text category now contains
details of the generated text setting.
16. Click Preview ▶ Arbortext Editor - the graphic that appears in the last chapter
of the document now also appears in the title of that last chapter.

Note
If the XPath expression you entered in the attribute content generator fails, or
would be false if evaluated as a boolean expression, the target attribute's value
will not be changed.

For purposes of speed, it is useful to test your XPath expression in Arbortext

Editor before you use it in the Generated Text Editor. Use the following steps:
1. In Arbortext Editor, place the cursor to the right of the element that forms the
starting point of the XPath expression that you wish to test.
2. On the Arbortext Editor command line, type: eval oid_xpath_
string(oid_caret(), "EXPR") replacing EXPR with the expression
you wish to use. For example, to confirm that your XPath expression will
extract the value of the fileref attribute on the graphic in the first para in
the chapter parent of a chapter title, place the cursor in the chapter title
element and enter the following in the command line:

Adding Generated Text 473

 eval oid_xpath_string(oid_caret(), "parent::chapter/
para[1]/graphic@fileref")
3. The value of the graphic tag’s fileref attribute will be displayed in the
Arbortext Styler Eval Output window if the original XPath expression was
correct.

Numbering List Items

You can use generated text to automatically number list items. The procedure
described below demonstrates how to number the entries in an itemizedlist
element.
Refer to Limitations of List Item Numbering on page 478 for a summary of
differences in support for list item numbering in certain outputs.

Example: Numbering List Items

1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/styler
2. Choose Styler ▶ Edit Stylesheet to open the stylesheet currently associated with
the document for edit. This is a read only stylesheet so you will need to save a
local copy if you want to make amendments.
3. In Arbortext Editor, click within the para element within the first
listitem element in the first chapter (item “Cruise Ship”).
4. In Arbortext Styler, with the para element selected in the Elements list,
choose Insert ▶ Context to create a new context for the element. The New
Context dialog box opens.

474 User's Guide

5. Click New Parent and select listitem from the drop down list. Click OK to
save the new context and exit the Context dialog box.
6. With the para in listitem context selected in the Elements list, go to the
Breaks category.
7. Set Structure type to Inline.
8. Select the listitem in itemizedlist context in the Elements list.
9. In the Generated text category, select the Number option in the Numbers and
bullets field.
10. Click the Details button to open the List Item Number dialog box.
11. The Number format reflects the style selected in the Number style field. For
example, to use roman numbers, select I, II, III, ... in the Number
style field, and an I displays in the Number format field.
12. Select Right in the Alignment field to right align numbers.
13. Specify .2in in the Align at field.
14. To left align the content of a list item when the content wraps lines, choose
Tab in the Follow number and suffix with field, and specify the same value (for
example, .5in) in both the Tab to and Indent following lines fields.

Adding Generated Text 475

15. Click OK to save the numbering settings and exit the dialog box.
16. Choose Preview ▶ Print.
In the Print Preview window, note that list items are now preceded by roman
numerals, which are right aligned.

You can also specify output-specific numbering for lists.

476 User's Guide

Example: Defining Output-Specific Numbering for List Items
Here we will use the same type of standard list numbering as defined in
Numbering list items above, but will change its numbering setting to alphanumeric
format when the source document is published to HTML.
1. In Arbortext Styler, select the listitem in itemizedlist context in the
Elements list.
2. Select HTML File from the Outputs to edit list.
3. Go to the Generated text category, and then click Details next to the Number
option. The List Item Number dialog box opens.
4. Select A, B, C,... as the Number style; note that an A displays in the
Number format field.
5. Set Alignment to Left, and enter 0in into the Align at field.
6. Select Tab from the Follow number and suffix with drop down list. Enter
0.25in into the Tab to field.
7. Enter 0in into the Indent following lines field.

Adding Generated Text 477

8. Click OK to save the numbering and exit the dialog box.
9. Choose Preview ▶ Print.
In the Print Preview window, note that list items are still preceded by right-
aligned roman numerals.

10. Choose Preview ▶ HTML File.

In the browser, note that list items are now preceded by uppercase alpha
characters, aligned to the left.

Limitations of List Item Numbering

The table below details some limitations in the numbering available for list items:
Output Limitation
All HTML outputs • Most list item styling properties (such as
alignment, tab after number, labels, punctuation
after number) will be ignored if list items are not
formatted as tables.
Ensure that the Format list items as tables options
in the HTML tab of the Stylesheet Properties
dialog box is selected.
• Support for list item numbering styles varies
greatly by browser. They may change as browsers
change.

478 User's Guide

Adding Bullets to List Items
You can use generated text to automatically number add bullets to list items. The
procedure described below demonstrates how to bullet the entries in an
itemizedlist element.

Example: Adding Bullets to List Items

1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/styler
2. Choose Styler ▶ Edit Stylesheet to open the stylesheet currently associated with
the document for edit. This is a read only stylesheet so you will need to save a
local copy if you want to make amendments.
3. In Arbortext Editor, click within the para element within the first
listitem element in the first chapter (item “Cruise Ship”).
4. In Arbortext Styler, with the para element selected in the Elements list,
choose Insert ▶ Context to create a new context for the element. The New
Context dialog box opens.
5. Click New Parent and select listitem from the drop down list. Click OK to
save the new context and exit the Context dialog box.
6. With the para in listitem context selected in the Elements list, go to the
Breaks category.
7. Set Structure type to Inline.
8. Select the listitem in itemizedlist context in the Elements list.
9. In the Generated text category, select the Bullet option.
10. Click the Details button to open the Bullet dialog box.
11. Click the required bullet style to select it, for example the black diamond.
12. Enter .25em into the Indent at field.
13. To left align the content of a list item when the content wraps lines, choose
Tab in the Follow bullet with field, and specify the same value (for example,
10pt) in both the Tab to and Indent following lines fields.

Adding Generated Text 479

14. Click OK to save the bullet settings and exit the dialog box.
15. Choose Preview ▶ Print.
In the Print Preview window, note that list items are now preceded by the black
diamond bullet.

You can also specify output-specific bullets for list items.

Example: Changing the Bullet Character for List Items

The procedure detailed below describes how to replace one character in the
default list with a new one, and use that new bullet style in an existing bulleted list
setting.
1. In the Elements list, select the listitem in itemizedlist context for
which you set bulleting in the previous section.
2. Select Base (All Outputs) from the Outputs to edit drop down list.
3. Go to the Generated text category, and then click Details next to the Bullet
option. The black diamond bullet is set as the default character for the list item
context.

480 User's Guide

4. Click the Character... button. The Insert Symbol dialog box opens.
5. In the Insert Symbol dialog box, select the symbol you want to see in the
default list - for example the asterisk operator character (character code 2217).
6. Click OK to save the new selection and exit the dialog box. The asterisk
character now appears in the Bullet dialog box, where the black diamond was
previously displayed.
7. Leave the asterisk selected and click OK to exit the Bullet dialog box.
8. Choose Preview ▶ Print.
In the Print Preview window, note that list items are now preceded by an
asterisk.

Note
You can change all five of the default bullet characters in this way if you wish.
Note that any bullets in your document that were set to use the original
characters will have their bullets changed to the new styles automatically once
the changes to the Bullet dialog box have been saved.

You can change the default font characteristics of bullets, thus giving you the
option to apply very specific bullets to match any specific document styling
requirements.

Example: Changing the Font Characteristics of Bullets

The procedure detailed below describes how to change the font of a particular
bullet character in the default list, and use that new bullet style in an existing
bulleted list setting.
1. In the Elements list, select the listitem in itemizedlist context for
which you defined an asterisk bullet character in the previous section.
2. Select Base (All Outputs) from the Outputs to edit drop down list.
3. Go to the Generated text category, and then click Details next to the Bullet
option. The asterisk bullet is set as the default character for the list item
context.
4. Make sure the asterisk character is selected, then click the Font button. The
Modify Font dialog box opens. Note that the asterisk bullet is currently set to
inherit its font name and size from its parent element.
5. In the Modify Font dialog box, select Arial from the Font menu and 24 from
the Size menu, plus any other settings you require.
6. Click OK to save the font setting and exit the dialog box.

Adding Generated Text 481

7. Click OK again to exit the Bullet dialog box.
8. Choose Preview ▶ Print.
In the Print Preview window, note that the asterisk that precedes a list item is
now much larger than the list item text.

Example: Defining Output-Specific Bullets for List Items

Here we will use a standard bulleted list as defined in Adding bullets to list items
above, but will change its bullet setting to round bullets when the source
document is published to HTML.
1. In Arbortext Styler, select the listitem in itemizedlist context in the
Elements list.
2. Select HTML File from the Outputs to edit list.
3. Go to the Generated text category, and then click Details next to the Bullet
option.
4. Select the small, filled, round bullet style.
5. Leave all other settings as were configured for the bullets for all other outputs.

482 User's Guide

6. Click OK.
7. Choose Preview ▶ Print.
In the Print Preview window, note that list items are still preceded by the black
diamond bullets.

8. Choose Preview ▶ HTML File.

In the browser, note that list items are now preceded by small, round, filled
bullets.

You can change the default bullet characters for list items. The bullet dialog
displays 5 default bullet characters, but you have the option to change the
displayed characters by selecting others from the symbols list and using the new
characters in your list.

Labeling and Numbering Divisions

You can use Arbortext Styler to automatically number and label divisions, such as
parts or chapters, in your documents using generated text. Note that Arbortext
Styler can only generate numbers for title elements of division elements. So, for
example, you can configure numbers for a title in chapter context but not
for a chapter in book context.
If you want a division title to be numbered, its equivalent division context must
also be present in the stylesheet, and styled accordingly. Numbering for that title
will not work correctly if the title element appears in the stylesheet without its
associated division. To achieve this, ensure you style your division to the actual
number of levels present in your documents - Arbortext Styler will then create the
title and division contexts for all those levels automatically.

Adding Generated Text 483

Example: Labeling and Numbering Divisions
This procedure describes how to add generated text numbers to the title of each
chapter in your document
1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/styler
2. Choose Styler ▶ New Stylesheet to create a new stylesheet for the document.
Accept the default settings in the Stylesheet Properties dialog box that
appears.
3. In Arbortext Styler, select the chapter element from the Elements list.
4. Assign the Division style to the element via the Edit ▶ Style menu option, if
this is not already set for the chapter. The Division Details dialog box will
open.
5. Set the required division level for the chapter, for example 1 if the document
hierarchy is set up as root element/chapter.
6. Click OK to save the division setting and exit the Division Details dialog box.
7. In the Elements list, select the title in chapter context.
8. Go to the Generated text category, and select Number as the option in the
Numbers and Bullets field.
9. Click the Details button next to the Number option. The Number dialog box
opens.
10. In the Label field, enter Chapter followed by a space (and optionally any
other settings you require). Leave the Label placement field set to Before
number. This is the text that will prefix the number at the beginning of a
chapter title. Note that the text and the number is shown in the Preview
window of the dialog box.
11. Click OK to save the number setting and exit the dialog box. Note that the
Before-text field in the Generated text category displays a preview of your
title's numbering.
12. Choose Preview ▶ Print.
In the Print Preview window, note that chapter titles are now preceded by the
word “Chapter” along with the appropriate chapter number.

Example: Generating Compound Division Numbers

Here we will use a document with standard division numbering as defined in

484 User's Guide

Labeling and numbering divisions above, but will change its generated text setting
to produce compound numbering for its divisions and any child divisions within
those divisions.
1. In Arbortext Editor, add a chapter element after the last chapter in the
document, and specify Compound numbering as its title.
2. Add a sect1 element within the chapter element you just added, and
specify First sect1 as its title.
3. Add a sect2 element within the sect1 element you just added, and specify
First sect2 as its title.
4. In Arbortext Styler, select the sect1 element from the Elements list.
5. Assign the Division style to the element via the Edit ▶ Style menu option, if
this is not already set for the section. The Division Details dialog box will
open.
6. Set the required division level for the section, for example 2 if the document
hierarchy is set up as root element/chapter/sect1.
7. With the sect1 element still selected in the Elements list, go to the Breaks
category.
8. Select No change from the drop down list in the Start new field.
9. Back in the Elements list, select the title in sect1 context
10. Go to the Generated text category.
Note that the Before-text field has a number sign (#) followed by a period
and a 1. The number sign and period indicate that the number of some element
in the previous level and a period will precede the number of the sect1
element, which is indicated by a 1. In the next step you will select the element
whose number will form the first part of the sect1 number.
11. Select the Number option then click on Details button. The Division Title
Number dialog box opens.
12. In the Previous level number field, select chapter from the drop down
menu. Here you have selected that the number of the chapter in which the
sect1 appears will form the first part of the sect1’s number.
Note that the value of the Number format field has now changed from #.1 to
1.1.
13. In the Label field, enter Section followed by a space (and optionally any
other settings you require). Leave the Label placement field set to Before
number. This is the text that will prefix the number at the beginning of a
sect1 title. Note that the text and the number is shown in the Preview window
of the dialog box.

Adding Generated Text 485

14. Click OK to save the numbering setting and exit the dialog box. Note that the
Before-text field in the Generated text category displays a preview of your
sect1 title's numbering.
15. Select the sect2 element from the Elements list.
16. Assign the Division style to the element via the Edit ▶ Style menu option, if
this is not already set for the section. The Division Details dialog box will
open.
17. Set the required division level for the section, for example 3 if the document
hierarchy is set up as root elementchapter/sect1/sect2.
18. With the sect2 element still selected in the Elements list, go to the Breaks
category.
19. Select No change from the drop down list in the Start new field.
20. Back in the Elements list, select the title in sect2 context.
21. Go to the Generated text category.
Note that the Before-text field has a number sign (#) followed by a period and
a 1. The number sign and period indicate that the number of an element in the
previous level and a period will precede the number of the sect2 element,
which is indicated by a 1. In the next step you will select the element in the
previous level that will provide the first part of the sect2’s number.
22. Select the Number option then click on Details button. The Division Title
Number dialog box opens.
23. In the Previous level number field, select sect1 from the drop down list.
Here you have selected that the number of the sect1 in which the sect2 appears
will form the first part of the sect2’s number.
Note that the value of the Number format field has now changed from #.1 to
#.1.1.
24. In the Label field, enter Section followed by a space (and optionally any
other settings you require). This is the text that will prefix the number at the
beginning of a sect2 title. Note that the text and the number is shown in the
Preview window of the dialog box.
25. Click OK to save the numbering setting and exit the dialog box. Note that the
Before-text field in the Generated text category displays a preview of your
sect2 title's numbering.
26. Choose Preview ▶ Print.
In the Print Preview window, go to the last page in the document. The
numbering of Chapter 7 and its subsection titles should look as they do in the
following graphic (note that the styling of the titles and their numbers may
differ depending on the settings specified in the print output version of your
stylesheet):

486 User's Guide

If a title’s number is set to include the previous level number, but the element at
the previous level is not a numbered element, you will see a message similar to
that shown below during publishing:
[A30390] ERROR: Cannot get previous level number. Element "chapter" is not numbere
Double-click on the message to find the element for which Arbortext Styler
attempted to include the previous level number. Instead of the previous level
number, a question mark will appear.

Example: Generating Page X Of Y Numbering for Individual Divisions

The steps contained in this section demonstrate how to generate a “page x of y”
numbering style for the divisions in a document, where y is the total number of
pages in the division.
There are several assumptions and restrictions that accompany numbering of this
type, meaning that the numbering can be achieved in certain specific contexts:
• The numbering will appear in a header or footer of a document intended for
print or PDF output, generated by any of the three available print engines (note
the limitation for FOSI output below).
• FOSI print output based on double sided page output, where there can be
blank pages at the end of a division, may not format correctly
This procedure instructs you how to generate scoped page numbering for divisions
of a document, where the document is split into divisions that are based on the
<preface>, <chapter> and <appendix> elements. Page numbers will restart at 1 for
each of the divisions, and the text Page x of y will appear in the footer for each
division, where x is the page in the division and y is the total number of pages in
the division.
Note that in this procedure, each of the three division elements uses the same page
set so the numbering needs only to be set in the footers for that one page set, with

Adding Generated Text 487

the three scoping divisions declared in the numbering dialog box (see step 8). If
the divisions use different page sets you will need to repeat the procedure
individually for each division and its page set/footers.
1. In Arbortext Editor, open the transport.xml sample document located at
Arbortext-path/samples/styler.
2. Choose Styler ▶ Edit Stylesheet to edit the default stylesheet for the document.
This is a read-only stylesheet so you will need to save a local copy to make
any changes.
3. Place your cursor before the first chapter element in the document, and add
a preface element. Give it a title and add some content.
4. Place your cursor after the last chapter element in the document, and add an
appendix element. Give it a title and add some content.
5. In Arbortext Styler, assign the main body page set to the preface,
chapter, and appendix elements, including the following settings for
each in the Breaks category:
• Start new: Page
• Page set Name: mainbody-page
• Page number: Initial

Note: ensure that the Outputs to Edit field is set to Print/PDF for each element,
as numbering of this type only applies to print and PDF documents.

6. In the Page Sets list , select the main body page set. Navigate to the
Page types category and note that the page set is set to use the main body
right and main body left page types.
7. In the Page types list , select the main body left and main body
right page types. Note that they are set to use the main footer footer
object.
8. In the Page regions list , select the main footer footer object. Go to the
Text category and note that the footer object is set to display content generated
by the page number center Generated Content object.
9. In the Generated Contents list , select the page number center object.
Click the Edit button in the edit pane to open the Generated Text Editor.
10. Carry out the following steps to set the numbering for the footer:
a. Add the text Page, followed by a space, before the
FormattedPageNumber element.
b. Add a space, followed by the text of, followed by another space, after the
FormattedPageNumber element.

488 User's Guide

 c. Select the menu option Insert ▶ Final Page Number to insert the final page
number of the division. The Final Page Number dialog box opens.
d. In the dialog box, select the Division radio button then use the Add button
to move appendix, chapter, and preface from the Available
elements list to the Selected elements list.

Use the CTRL key to select multiple elements.

e. Click OK then File ▶ Apply and Close to complete the numbering.
11. Choose Preview ▶ Print to generate a print preview of the document. You will
see that the footers in the document contain the text Page x of y, with the
numbering being restarted in each division.
Once you have set numbering in this way in the transport.xml document,
you will note that the entries for each division in the table of contents at the
beginning of the document are numbered 1. This is intentional. You may need to
customize the content of your table of contents if you want to display more
continuous numbering, for example including numbered sections within the
division. See Customizing the Content of a TOC on page 360 for further
information.

Example: Generating Titles for Divisions Without Title Elements

The procedure shown below describes how to generate titles for the divisions in
your document if they do not contain specific element titles in which the title can
be included or generated. This procedure will work if your document is split into
semantic divisions, i.e. a different element is used for each division in your
document. For example, your DTD may define the elements introduction,
subject, description, and summary as fixed divisions that must occur in a
certain order in the document. These elements do not contain a child title element
and as such must each generate their own title to appear at the beginning of the
division.
It is assumed in this procedure that the introduction, subject,
description, and summary elements have been styled as Division in the
stylesheet.
1. In the Elements list, highlight the introduction element. Navigate to the
Generated text category for the element (or the relevant context, if applicable).
2. In the Before-text field, click the Edit button to open the Generated Text Editor.
Choose the Insert ▶ User Formatting Element menu option to select an existing
User Formatting Element (UFE), or create a new one, to be used to format
titles, for example _ufe:Title.
3. Enter within the UFE tag the title you want to generate for the
introduction element. Click File ▶ Apply and Close to save the generated
text setting and exit the editor. You have now created the title for the
introduction element, and wrapped it in a UFE. In the next step you will

Adding Generated Text 489

 style the UFE as a title, to ensure that the generated text you entered for the
introduction element is treated as a title. Completing this step will enable
you to include the divisions in a table of contents for your document if
required, even though they do not contain an explicit title element. Refer to
Customizing the Content of a TOC on page 360 for information on how to set
up your table of contents in this way.
4. Highlight the _ufe:Title element in the Elements list, and give it the Title
style via the Edit ▶ Style menu option.
5. Create a context for the UFE anywhere within the introduction element.
Note that you must create the context by specifying the introduction
element as the ancestor of the UFE, rather than its direct parent. This is
because you specified that the title of the introduction element is created
via generated text, which generates its own wrapper based on a Styler
Formatting Element (SFE). You then wrapped the title again, this time in the
_ufe:Title UFE for which you are creating the context. This sets the
markup of the title in the introduction element as shown below:
<introduction>
<_sfe:BeforeOrAfterText>
<_ufe:Title>Introduction</_ufe:Title>
</_sfe:BeforeOrAfterText>
</introduction>
If you attempt to create a context of the UFE with the introduction
element as its direct parent, you will be presented with a dialog box asking
you to confirm that you really wish to proceed and giving you the option to
insert introduction as an ancestor instead.

6. Repeat steps 1–3 and 5 for the remaining divisions in your document. In
addition to the semantic division elements with their generated titles, you
should now have one UFE (_ufe:title) and a context of that UFE within
each semantic division element/context.
7. Choose the Preview ▶ Print menu option. In the Print Preview window, note
that your divisions appear in the correct order and that each one has its own
generated title.
8. If you want to number the divisions consecutively as well as creating their
titles, you will need to create a custom counter and assign it to each context of

490 User's Guide

 the _ufe:title UFE you created for the semantic divisions. The following
steps describe how to accomplish this:
9. In the Elements list, select the required context of _ufe:title in the
semantic division. Set it to be numbered by navigating to the Generated text
category and selecting the Number option in the Numbers and Bullets field.
10. Click the Details button to open the Division Title Number dialog box.
11. In the dialog box, navigate to the Custom counter drop down menu. If you are
carrying out the step for the first time in this procedure, create a new counter
by selecting (new) from the menu and entering the name of the custom
counter when prompted, for example semantic-divisions. If you are
repeating the step for subsequent divisions in the same counting sequence,
select your custom counter semantic-divisions in this drop down list.
Exit the dialog boxes to return to the Elements list.
12. Repeat steps 9–11 for the other contexts of _ufe:title in the semantic
divisions that are to be included in the division counting sequence.
13. When previewing or publishing you will now see that the semantic divisions
in the document are now numbered consecutively, as well as including a
generated title each.

Labeling and Numbering Formal Blocks

You can use Arbortext Styler to automatically number and label elements styled as
formal blocks, such as figures and tables, in your documents using generated text.
Note that Arbortext Styler can only generate numbers for title elements of formal
block elements. So, for example, you can configure numbers for a title in
table context but not for a table in chapter context.

Example: Labeling and Numbering Formal Blocks

1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/styler.
2. Choose Styler ▶ Edit Stylesheet to open the stylesheet currently associated with
the document for edit. This is a read only stylesheet so you will need to save a
local copy if you want to make amendments.
3. Specify a number and label for the title in chapter context, if one does
not already exist. Refer to Labeling and Numbering Divisions on page 483 for
detailed instructions.
4. Select the title element in the Elements list.
5. Elect to create a new context for title by choosing the Insert ▶ Context
menu option. The Context dialog box opens.

Adding Generated Text 491

6. Click the New parent button and select table from the drop down list.
7. Click on the New ancestor button and select chapter from the drop down
list. The context field at the top of the table now reads title in table
anywhere in chapter.
8. Click OK to save the new context and close the dialog box.
9. In the Elements list, select the title in table anywhere in chapter
context then go to the Generated text category.
10. Select the Number option then click the Details button in the Numbers and
Bullets field. The Formal Block Title Number dialog box opens.
11. In the Previous level number field, select chapter from the drop down
menu. This steps specifies that the number applied to your table will be
prefixed with the number of the chapter in which it appears.
12. Click the Insert En-dash button to insert a “–” character between the chapter
and table numbers. The Number format field now reads 1–1. Note that if you
want a different character to be used as a separator you can instead type that
character between the two numbers in the Number format field.
13. Type Table followed by a space in the Label field. The Preview window now
reads Table 1–1.

492 User's Guide

14. Click OK to save the numbering settings and exit the dialog box. The Before-
text field in the Generated text category now reads Table 1–1, a preview of
your table numbering setting.
15. Choose Preview ▶ Print.
In the Print Preview window, note that the table title in chapter 2 is preceded
by the word “Table” along with the number 2–1, meaning “table 1 in chapter
2”.

Adding Generated Text 493

Example: Generating Output-Specific Labels and Numbers for Formal
Blocks
Here we will use a title context with standard numbering as defined in Labeling
and numbering formal blocks above, but will change its number setting to appear
differently when the source document is published to HTML.
1. Highlight the title in table anywhere in chapter context in the
Elements list then go to the Generated text category.
2. Select HTML File from the Outputs to edit list.
3. With the Number option selected, click on the Details button in the Numbers
and Bullets field. The Formal Block Title Number dialog box opens.
4. In the Previous level number field, select (None) from the drop down list.
Delete both the em-dash from the Number format field and the text Table
from the Label field. Note that the Number Format field and the Preview
window show that no additional numbering or text is to be applied to the table
number.

494 User's Guide

5. Click OK to save the numbering setting and exit the dialog box. Note that the
Before-text field reads 1.
6. Choose Preview ▶ Print.
In the Print Preview window, note that the table title in chapter 2 is still
preceded by the number Table 2–1.
7. Choose Preview ▶ HTML File.
In the browser, note that the same table title in chapter 2 is simply numbered 1.

Advanced Formatting of Titles and

Numbering
The following examples will give you an idea how to add further levels of control
the titles and numbering in your document. You will find information on how to
achieve the following effects when creating numbering sequences or outputting
titles for elements:
• Elements numbered in a sequence based on an attribute value on page 495
• Numbered caption or title for a figure on page 496
• Individual numbering sequences based on figure type on page 498
• List numbering started at 0 on page 499
• Asian numbering on page 499
• Chapter numbering start number based on an attribute value on page 500
• Document page numbering start number based on an attribute value on page
502
• Title number placed after the title on page 503
• Punctuation that appears in a title but not in references to the title on page 504
• Separate numbering sequence for nested elements on page 506

Example: Create a Consecutive Numbering

Sequence Based on an Attribute
This example describes how to create consecutively numbered titles for the tables
in a document, where the table will only be counted in the sequence if it contains

Adding Generated Text 495

the attribute role=”number”. If the title does not include the attribute it will not be
numbered and will not be included in the count for the table numbering sequence.
The table is defined in a table element, and its title in a title element.
1. In Arbortext Styler, create or select the title in table context in the
Elements list.
2. If the context is currently set to be numbered, remove that setting.
3. Create a new condition for the context, based on an attribute test that tests for
the presence of the role=”number” attribute and value.
4. Set the condition to be numbered in the Generated text category, by selecting
the Number option in the Numbers and bullets field.
5. Click the Details button in the Numbers and Bullets field to open the relevant
title numbering dialog box and configure the numbering for the title.
6. Click the Restart button in the dialog box to open the Numbering Restart
dialog box. In the Restart numbering at field, select (No restart) then
click OK to exit the dialog box.
7. Make any other changes to the formatting of the number you desire, then click
OK to exit the title numbering dialog box.
8. When previewing or publishing you will now see that all tables whose titles
include the specified attribute will be numbered consecutively, while tables
whose titles do not include the attribute are not included in the numbering
scheme and are not numbered.

Example: Create a Numbered Caption or Title for a

Figure, Output After the Figure
This example describes how to create a numbered title for a figure element that
contains a graphic.

Note
These steps will place the title after the graphic in the final output even though
it occurs before the graphic in the authored document.

1. In Arbortext Styler, set the title in figure context to be hidden in

output, by setting the Hidden field in the Text category to Yes.

496 User's Guide

 Tip
Set Hidden explicitly, not by referencing a property set. This is necessary
for some outputs, including Editor view, to correctly resolve cross
references when titles are hidden and output after the figure.

Note
You must make this setting for all outputs, with the Outputs to edit field set
to Base (all outputs). If you do not hide the context for all outputs, any
cross references to the parent formal block (the figure element) will use
the numbering properties of the hidden title rather than the alternative,
generated title being created in this procedure. Although you are hiding the
element's content from output in its document location, you will be
reinserting it as the content of a User Formatting Element (UFE) in the
same table in a later stage in the procedure. As such it will be included as a
valid title for the table if you do not hide it completely.

2. Select the figure element in the Elements list, and navigate to its Generated
text category. Elect to create generated text to appear after the element's
content by clicking the Edit button next to the After-text field. The Generated
Text Editor opens.
3. Insert a UFE into the generated text by selecting the Insert ▶ User Formatting
Element ▶ (new) menu option, and creating a user-defined UFE, for example
_ufe:figure-title. Note that the UFE is displayed in pink tags, as it is
currently unstyled. See Highlight Unstyled Elements in a Document on page
36 for further information.
4. Inside the UFE, elect to insert the content of the title in figure context
by selecting the Insert ▶ Element Content menu option and configuring the
following settings in the Insert Element Content dialog box:
• Element selection: By name and occurrence-within-ancestor

○ Name: title
○ Occurrence: 1st
○ Within: figure
• Insert: Only content
5. Save the changes and exit the Generated Text Editor
6. Style the UFE as a title by selecting the Edit ▶ Style ▶ Title menu option in the
Elements list.

Adding Generated Text 497

7. Create a context for the UFE in a figure ancestor, i.e. _ufe:figure-
title anywhere in figure.
8. Set the context to be numbered in the Generated text category, by selecting the
Number option in the Numbers and bullets field.
9. When previewing or publishing you will now see that all figure titles are
numbered, and for each figure the title appears after the graphic, even if the
title was entered before the figure in the source document.
If you want to include figure titles configured in this way in a table of contents, or
a list of graphics, for example, ensure that you select the _ufe:figure-title
anywhere in figure title context in the Customize Table of Contents dialog
box, rather than title in figure. For more information on creating a custom
table of contents, please refer to Customizing the Content of a TOC on page 360.

Example: Create Individual Numbering Sequences

Based on Figure Type

Note
If you would like to create separate lists of graphics and lists of tables in your
document, as tables of contents, you will need to set up the figure elements
in a slightly different way. Please refer to the example Create lists of tables
and graphics in Customizing the Content of a TOC on page 360.

This example describes how to create two separate numbering sequences for
figure elements in a document, where a figure can contain either a table
or a graphic. In the final output tables and graphics will be numbered according
to their own numbering scheme, and will display different labels.
1. In the Elements list, set the title element to be of Title style via the Edit ▶
Style menu option.
2. Set the figure element to be of Formal Block style. Arbortext Styler creates
a context for the title in a figure, i.e. title in figure, and sets it to
generate a number.
3. Create a condition for the title in figure context via the InsertCondition
menu option. In the Condition dialog box that appears, click the New Content
Test button to open the Content Test dialog box.
4. In the dialog box, configure the following settings:
• Element whose content to test: Ancestor (figure)
• Test types: Includes

498 User's Guide

 • Test depth: At any level
• Content to test for: graphic

Click OK twice to save the condition and exit the dialog boxes. Here you have
created a condition that the title in figure context will match if the
title is a child of a figure element that also contains a graphic
element.
5. In the Generated text category for the condition, select the Number option in
the Bullets and Numbers field to number the graphic titles. Click the Details
button in the Numbers and Bullets field to open the relevant title numbering
dialog box and configure the numbering for the title.
6. In the title numbering dialog box, make any changes to the formatting of the
number you desire, for example type the text Graphic, followed by a space,
in the Label field. Click OK to exit the title numbering dialog box.
7. Repeat steps 3–4 for a second condition that will match if the title is a
child of a figure element that also contains a table element. In this
instance, you will use the following settings in the Condition dialog box:
• Element whose content to test: Ancestor (figure)
• Test types: Includes
• Test depth: At any level
• Content to test for: table

You can also include a different prefix for the title's output for tables, for
example by typing the text Table followed by a space in the Label field.
8. When previewing or publishing you will now see that tables and figures are
numbered according to separate numbering schemes, and that table titles are
prefixed Table whilst the graphic titles are prefixed Graphic.

Example: Start List Numbering at 0 and Use Asian

Numbering
This example describes how to configure numbering for lists such that the first
entry of each list is numbered zero and an Asian numbering style is used when the
document’s language is Chinese. The list is defined in an orderedlist
element, with child listitem elements making up its entries.

Adding Generated Text 499

 Note
If the stylesheet property Format list items as tables is not selected, support for
list numbering styles in HTML outputs varies by browser. Refer to Numbering
List Items on page 474 for a summary of differences.

1. In the Elements list, select the orderedlist element and give it the List -
Numbered style via the Edit ▶ Style menu option.
2. Select the listitem element and give it the List Item style.
3. For each context of listitem in orderedlist:
a. Select the context
b. Create a condition that tests whether the language of the document is
Chinese, for example by creating an attribute test for the value of the
xml:lang attribute
c. Set the context to be numbered by navigating to the Generated text
category and selecting the Number option in the Numbers and Bullets field.
d. Click the Details button to open the List Item Number dialog box.
e. Select the desired Asian numbering style in the Number style field. For
example, if the value of the xml:lang attribute is ch, select the simp-
chinese-informal numbering style.
f. Click the Start at button to open the Start At dialog box.
g. In the dialog box, select the Fixed value option and enter 0 in the adjacent
field.
h. Save the change and exit the dialog box, then exit the list numbering
dialog box.
4. When previewing or publishing you will now see that lists based on the
orderedlist element all start at 0, and that if the document is set to use the
Chinese languages the numbering of the list is displayed according to the
simp-chinese-informal numbering scheme.

Example: Start Chapter Numbering Based on

Attribute Value
This example describes how to set the number of a chapter to the value of the

500 User's Guide

number attribute declared for the chapter element, for example number=”13”.
If the numbering of a chapter is set in this way, you will be permitted to publish
the chapter as a standalone entity and ensure that its numbering remains correct.
1. In the Elements list, select the chapter element and give it the Division style
via the Edit ▶ Style menu option. Assign the division level as required for the
chapter.
2. Select the title element and give it the Title style.
3. Select the title in chapter context and set it to be numbered by
navigating to the Generated text category and selecting the Number option in
the Numbers and Bullets field.
4. Click the Details button to open the Division Title Number dialog box.
5. Configure numbering as required for the division, ignoring the Start At option
for the time being. Exit the numbering dialog box.
6. In the Elements list, create a condition for the title in chapter context
that tests that the attribute number has any value.
If your DTD or schema assigns a default value to the number attribute you can
skip this step since the attribute will always have a value when it appears.
Otherwise you must create a condition that tests for the attribute having a
value or Arbortext Styler will throw an error when it attempts to apply the
configured numbering and does not encounter a Start At value.
7. Click the Details button to open the Division Title Number dialog box again.
8. Click the Start at button to open the Start At dialog box.
9. In the dialog box, configure the following settings:
• Start at: Attribute
• Element to get attribute from: Parent
• Attribute name: number
10. Save the change and exit the dialog box, then exit the division numbering
dialog box.
11. When previewing or publishing you will now see that chapters based on the
chapter element are numbered according to the value of their number
attribute. If you subsequently publish a chapter as a standalone element, for
example if a document contains a single chapter, you will notice that the
chapter number remains the same.

Adding Generated Text 501

 Note
If you are setting a Start At value for numbering where the numbered element
is identified via a condition, the setting will only be applied if the condition is
true for the first element in the numbering family. Using the example
described above, if the If attribute “number” of parent element
is assigned any value condition is not true for the first title in
chapter context in the document, Start At value(s) will be ignored for every
chapter in the document. Numbering will be applied if configured but it will
start from 1.
This means that you also cannot reset the Start At value partway through the
document, for the same element.

Example: Start Document's Page Numbers Based

on Attribute Value
This example describes how to configure a document such that its page numbers
start at the value of an attribute declared for the root element. The document is
based on a document element, which includes a startpagenum attribute to define
the first page number.
1. In the Elements list, select the document everywhere context.
2. Create a condition for the context that tests that the attribute startpagenum has
any value.
If your DTD or schema assigns a default value to the number attribute you can
skip this step since the attribute will always have a value when it appears.
Otherwise you must create a condition that tests for the attribute having a
value or Arbortext Styler will throw an error when it attempts to apply the
configured numbering and does not encounter a Start At value.
3. Navigate to the Breaks category for the context. In the Page set field, assign a
page set that includes a page number declaration in its header or footer by
selecting the page set's name from the Name menu.
4. Still in the Page set field, click the Start at button to invoke the Page Number
Start At dialog box.
5. In the dialog box, configure the following settings:
• Start at: Attribute
• Element to get attribute from: Current element
• Attribute name: startpagenum

502 User's Guide

6. Save the change and exit the dialog box.
7. When previewing or publishing you will now see that the page numbers for
the document will start at the value given to the startpagenum attribute on
the document element.

Note
There is a limitation in FOSI print/PDF outputs that you can only alter the
page number of the first page of the entire document, as described above. As
such certain implementations of numbering of this type will not work
correctly. For example, if the chapter everywhere context specifies to
set the starting page number to the value of its startpagenum attribute, and if
there are five chapters that all specify that attribute, you would expect each
chapter to start on the page indicated by that chapter's startpagenum attribute.
This will happen if you elect to publish via the XSL-FO and PTC APP
engines. In FOSI outputs the first page of the document, and any other place
where the Breaks category specifies Initial for the page number, will display
whatever the last chapter set as its starting page number.

Example: Place Title Number After the Title

This example describes how to configure a title for a chapter, where the chapter
number is placed after the chapter name.
1. In the Elements list, select the chapter element and give it the Division style
via the Edit ▶ Style menu option. Assign the division level as required for the
chapter.
2. Select the title element and give it the Title style.
3. Select the title in chapter context and set it to be numbered by
navigating to the Generated text category and selecting the Number option in
the Numbers and Bullets field.
4. Click the Details button to open the Division Title Number dialog box.
5. In the Number position field. deselect the Keep number at beginning of line
option.
6. Save the change and exit the dialog box.
7. In the Generated text category for the context, click the Edit button next to the
Before-text field to invoke the Generated Text Editor. Delete the
ElementLabelAndNumber element that appears, then save the change and
exit the editor.

Adding Generated Text 503

8. Still in the Generated text category, click the Edit button next to the After-text
field. In the Generated Text Editor, choose either the Insert ▶ Element Number
or the Insert ▶ Element Label and Number option, depending on the form you
would like your chapter numbering to take.

Note
If you select Element Label and Number, you can configure the
required label for your chapter numbering in the Division Title Number
dialog box in step 4.

9. When previewing or publishing you will now see that the titles of the chapters
in your document display their name, followed by their number (and,
optionally, their assigned label).

Example: Add Punctuation that Appears in Title but

not in References to Title
This example describes how to configure a document's endnotes such that the
reference mark in the body of the document displays only the number of the note,
while the endnote itself contains the number, a period, and the endnote body text,
for example 1. The text for the endnote. The endnote definition is based on the
DocBook footnote and footnoteref elements, which describe the endnote
and reference mark respectively.
The procedure detailed here makes use of the Suffix (does not appear after
references) option, available in numbering dialog boxes, in which you can provide
a suffix for the number of an item. Any characters or text entered in this field will
accompany the number only where the element appears in the document, and will
not be displayed in any references to the numbered item, for example cross
references or tables of content (TOC) entries.
The following options are available if you wish for the suffix to appear in both the
body of the document and references to the numbered element. Note that these
have to be configured separately:
• Cross references: include the suffix in the cross reference format
• Tables of content: use the custom content option for the TOC entry - see
Custom Content Dialog Box on page 936 for further information.
• Running header and footers: reference a cross reference format that configures
the element number with a suffix in the division reference in your header or
footer.

504 User's Guide

Alternatively, if you enter the suffix into the Format field in the relevant
numbering dialog box, the suffix will automatically be included with the number
everywhere it appears, including references.
1. In the Elements list, select the footnote element and give it the Block style
via the Edit ▶ Style menu option.
2. Select the footnote everywhere context and set it to be numbered by
navigating to the Generated text category and selecting the Number option in
the Numbers and Bullets field.
3. Click the Details button to open the Number Details dialog box.
4. In the dialog box, enter a period character (.) into the Suffix (does not appear
after references) field. Set the required indent in the Follow number and suffix
with, Tab to and Indent following lines fields.
5. Click Restart and select chapter in the Numbering Restart dialog box. Here
you have specified that a collection of endnotes should be output for every
chapter. Save the changes and exit the numbering dialog boxes.
6. In the Elements list, select the footnoteref element and give it the Cross
Reference style. In the Cross Reference Details dialog box that appears,
configure the following settings:
• Reference attribute: linkend
• Select a cross reference format: Number

Here you have specified that the reference mark will be output as a number.
Save the changes and exit the dialog box.
7. Select the footnoteref everywhere context, and elect to create
generated text for the context by clicking the Edit button next to the After-text
field in the Generated text category. The Generated Text Editor opens.
8. Wrap the CrossReference tag with a User Formatting Element (UFE) by
highlighting CrossReference and selecting the Insert ▶ User Formatting
Element ▶ (new) menu option. Create a user-defined UFE, for example
_ufe:reference-mark. Note that the UFE is displayed in pink tags, as it
is currently unstyled. See Highlight Unstyled Elements in a Document on page
36 for further information.
The inclusion of a UFE for the footnoteref everywhere context
permits you to add any formatting you wish for the endnote reference mark.
You can also give it a particular style, which allows you to control the
placement of the element in this particular context.
Save the changes and exit the editor.
9. In the Elements list, select the UFE you created and give it the Inline style.

Adding Generated Text 505

10. In the Text category for the element, set it to be superscripted by setting the
Super/Subscript field to Superscript. Use the Offset field to define the
height at which the superscript number will be displayed, if required.
11. When previewing or publishing you will now see that footnote references in
the body of the document are displayed in the form of a superscript number
only, e.g. 1. The endnotes at the end of the chapter will display the number, a
period character and the endnote body text, for example 1. The text for the
endnote.

Separate Numbering Sequence for Nested Elements

If an element can be used in nested sequences, it may be the case that an inner
sequence alters the numbering of members of the outer sequence. In this instance,
number the context(s) that configure the nested (inner) sequence according to a
custom counter. Ensure that the name of the custom counter does not match the
custom counter name (if any) used for the outer sequence.
Refer to the Custom Counter field in the relevant numbering dialog box.

Non Standard Numbering with XPath

This section explores situations in which non standard numbering can be applied
in Arbortext Styler via the inclusion of XPath expressions. In this respect,
numbering can be generated in Arbortext Styler for elements for which numbering
is not usually permitted.

Example: Defining Numbering in Arbortext Styler for Elements not

Permitted Numbering
The steps contained in this example will number every occurrence of a particular
para context in your document.
1. In the Elements list, highlight the para context that should be numbered. In
this instance, the numbering is to be applied to the para everywhere
else context.
2. In the Generated text category, elect to add generated text before the element's
content. The Generated Text Editor opens.
3. In the Generated Text Editor, choose Insert ▶ XPath String. The Insert XPath
String dialog box opens.
4. In the XPath expression field, enter the expression count(preceding-
sibling::ELEMENT)+1, where ELEMENT is the name of the sibling
element that is to be counted. In this instance, the numbering is to be based on
the total number of paragraphs up to the current paragraph so the expression is
count(preceding-sibling::para)+1.

506 User's Guide

5. Click OK to exit the Insert XPath String dialog box. The Generated Text Editor
contains a single XPathString object. If you wish to add punctuation after
the numbering, add them after the XPath string object - the graphic below
shows how to apply a period and a space after the number:

6. Click File ▶ Apply and Close to save your gentext setting and exit the
Generated Text Editor. The Before-text field now shows the XPath expression
that will be used to generate the numbering for your document's paragraphs,
plus the punctuation you included:

7. Choose Preview ▶ Print.

In the Print Preview window, note that every paragraph begins with a number
and a period.

Inserting Leaders, Rules, and Space Fills

in Generated Text
You can use the generated text feature in Arbortext Styler to insert leaders (leader
dots), rules, and space fills. These can all be either a specified length, or they can
be made to fill to the width of the column or page. For example, you may
configure your chapter title to contain a stylistic rule above the title that spans the
page or configure leaders in your table of contents to visually link the title and
page numbers.
Note that these options apply to documents produced in Print/PDF format only.

Adding Generated Text 507

Example: Inserting a Rule in Generated Text
The procedure below describes how to apply a rule that spans the width of the
page before each chapter in your document.
1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/styler.
2. Choose Styler ▶ Edit Stylesheet to open the stylesheet currently associated with
the document for edit. This is a read only stylesheet so you will need to save a
local copy if you want to make amendments.
3. In the Elements list, select the chapter element.
4. Assign the Division style to the element via the Edit ▶ Style menu option, if
this is not already set for the chapter. The Division Details dialog box will
open.
5. Set the required division level for the chapter, for example 2 if the document
hierarchy is set up as part/chapter.
6. Click OK to save the division setting and exit the Division Details dialog box.
7. Still in the Elements list, change your selection to the required context of the
chapter element - for example, the chapter everywhere else
context.
8. Go to the Generated text category.
9. Click the Edit button associated with the Before-text field. The Generated Text
Editor opens.
10. In the Generated Text Editor window, choose the Insert ▶ Leaders, Rules, or
Spaces menu option. The Insert Leaders, Rule or Space dialog box opens.
11. In the Type field select the Rule option, then enter 3pt into the Thickness
field.
12. Select Stretch to fit in the Length field. This instructs that the rule will always
be drawn to the width of the page.

508 User's Guide

13. Click OK to save the settings and exit the dialog box. The Generated Text
Editor now contains a single Rule object.
14. Choose File ▶ Apply and Close to save your generated text setting and exit the
editor. The Before-text field now displays details of the rule you have set.

15. Choose Preview ▶ Print.

In the Print Preview window, note that the title in chapter 1 is preceded by a
rule that spans the width of the page.

Inserting Markup in Generated Text

You can insert markup in generated text.

Adding Generated Text 509

 Note
Generated text includes that produced within header and footer objects. Refer
to Adding Headers and Footers to a Page Set on page 198 for information on
adding headers and footers to your documents.

Example: Inserting Markup in Generated Text

The procedure below describes how to include markup that will format the
generated text in a book title in an italic style.
1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/styler
2. Choose Styler ▶ Edit Stylesheet to open the stylesheet currently associated with
the document for edit. This is a read only stylesheet so you will need to save a
local copy if you want to make amendments.
3. In the Elements list, select the title in book context.
4. Go to the Generated text category.
5. Click the Edit button next to the Before-text field. The Generated Text Editor
opens.
6. In the Generated Text Editor, choose the Insert ▶ Markup menu option. The
Insert Markup dialog box opens.
7. Select emphasis from the available list, then click Insert.
8. Click Close to exit the dialog box. The Generated Text Editor now contains a
single emphasis element.
9. With your cursor inside the emphasis tag, type Book. After the emphasis
tag, add a colon and a space.

10. Choose File ▶ Apply and Close to save the generated text setting and exit the
editor. The Before-text field now contains details of your generated text
setting:

510 User's Guide

11. Choose Preview ▶ Print.
In the Print Preview window, note that the italicized word Book plus a colon
displays before the book title. The markup retains the style specified for the
emphasis element in your stylesheet, so if you change the emphasis tag to
set the role attribute to bold, the word Book will display as bold.

Inserting Graphics in Generated Text

You can insert graphics in generated text. For example, you might want to have a
graphic associated with a warning in your documents.

Note
Graphics in generated text in tables must be configured for a specific type of
element to be visible in XSL outputs (EPUB, HTML File, HTML Help, and
RTF). A generated graphic will not appear if it is configured directly for the
entry context. You must insert a non-table element within the entry
context and configure the generated text for that context, for example p in
entry.

You can provide alternate text for graphics in generated text in PDF (with PTC
APP engine) and HTML outputs, to increase accessibility to content for screen
readers. Please refer to Alternate Text Support for Graphics on page 172 for
information.

Example: Inserting a Graphic in Generated Text

The procedure below describes how to include a graphic in the title of the
formalpara elements in your document.
1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/styler.
2. Choose Styler ▶ Edit Stylesheet to open the stylesheet currently associated with
the document for edit. This is a read only stylesheet so you will need to save a
local copy if you want to make amendments.
3. In the Elements list, select the title in formalpara context.
4. Go to the Generated text category.
5. Click the Edit button next to the Before-text field. The Generated Text Editor
opens.

Adding Generated Text 511

6. Choose the Insert ▶ Graphic menu option. The Locate Graphic File to Reference
dialog box opens.
7. Browse to the cmt.gif file in the Arbortext-path/graphics
subdirectory (or a graphic of your choice), then click Open. The graphic is
inserted in the Generated Text Editor window.

If the graphic selected with this method is located in Arbortext Editor's current
graphics path, then just the filename will be inserted as the value of the
pathname attribute of the _gentextgraphic element. To edit the path,
choose Edit ▶ Modify Attributes for the _gentextgraphic element

Note
This method may generate a path for the graphic that will not work for all
stylesheet users.
It is recommended that you store all graphics referenced in stylesheets in a
directory that is included in all users' graphics path. You can then enter just
the filename as the value of the pathname attribute and the graphics will
appear for all users.

8. Choose File ▶ Apply and Close to save your generated text setting and exit the
editor. The Before-text field in the Generated text category now contains
details of the graphic you have referenced:

9. Choose Preview ▶ Print.

In the Print Preview window, note that the selected logo is inserted before the
title in each formalpara.

512 User's Guide

PDF Graphics
You can insert a page of a PDF as a graphic in generated text. PDF graphics are
supported in PDF output generated by the PTC APP engine (note: not supported
in PTC APP’s print output, or in other output types). When inserting a graphic
element in generated text, select .pdf from the list of file types presented by the
Locate Graphic File to Reference dialog box.
Refer to Bitmap and Vector Graphics in Arbortext Editor Help for information
about PDF graphics.
A single page of a selected PDF is inserted as a graphic. If no page information is
provided, the first page will be extracted and inserted as a default. The value of
any attribute for the graphic element that has the View role will represent a
specific page to be inserted. Refer to Configuring a Graphic Element for further
information on how to configure the graphic element’s attribute.

Graphic Conversion
Graphics that are inserted by the stylesheet must be in a format that needs no
conversion. For example, you may need to convert a CGM graphic to EPS format
and configure the stylesheet to insert the EPS file for output to PDF. You may
need to configure separate generated text for each required output format.

Inserting Symbols in Generated Text

You can insert symbols in generated text. For example, you might want to have a
symbol such as an arrow associated with procedures or warnings in your
documents.

Example: Inserting a Symbol in Generated Text

The procedure below describes how to include an arrow in the title of the note
elements in your document.
1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/styler
2. Choose Styler ▶ Edit Stylesheet to open the stylesheet currently associated with
the document for edit. This is a read only stylesheet so you will need to save a
local copy if you want to make amendments.
3. In the Elements list, select the note element.
4. Assign the Block style to the note element via the Edit ▶ Style menu option.
5. In the Elements list, select the title element.
6. Elect to create a new context for the title element by selecting the Insert ▶
Context. The Context dialog box opens.
7. In the Context dialog box, click New Parent then select note from the list.

Adding Generated Text 513

8. Click OK to save the new context and exit the Context dialog box.
9. Select the title in note context from the Elements list then go to the
Generated text category.
10. Click the Edit button next to the Before-text field. The Generated Text Editor
opens.
11. In the Generated Text Editor window, choose the Insert ▶ Symbol menu option.
The Insert Symbol dialog box opens.
12. In the Font field, select Courier New from the list.
13. Choose a right-pointing arrow from the symbol set, then click Insert.
14. Click Close to exit the dialog box. The Generated Text Editor now displays the
symbol you have inserted, wrapped in a _font object.

15. Choose File ▶ Apply and Close to save the gentext setting and exit the
Generated Text Editor The Before-text field now displays the symbol you have
selected.

16. Choose Preview ▶ Print.

In the Print Preview window, note that the right-pointing arrow is inserted
before a note title.
Also note that the symbol is the same size and color as the text in the title. If
you want the symbol to be a different color or size, you must apply format it
individually in the Generated Text Editor window. Use the settings in the Font
dialog box, accessed via the Format ▶ Font menu option.

Inserting Tables in Generated Text

You can insert tables in generated text. It is useful to use tables as a layout tool, to
align text and graphics side by side in a title, for example.

514 User's Guide

 Note
Generated text includes that produced within header and footer objects. Refer
to Adding Headers and Footers to a Page Set on page 198 for information on
adding headers and footers to your documents.

Example: Inserting a Table in Generated Text

The procedure below describes how to include a graphic and some inline text in
the title of the note elements in your document.
1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/styler.
2. Choose Styler ▶ Edit Stylesheet to open the stylesheet currently associated with
the document for edit. This is a read only stylesheet so you will need to save a
local copy if you want to make amendments.
3. Click on the title in note context in the Elements list.
4. Go to the Generated text category.
5. Click Edit next to the Before-text field. The Generated Text Editor opens.
6. Choose Insert ▶ Table. The Insert Table dialog box opens.
7. Select table in the Wrapper Tags field.
8. In the Table Size field, set Rows to 1 and Columns to 2 .
9. Click OK to exit the dialog box. The Generated Text Editor now displays a two
column table.
10. Place your cursor in the first cell of the table, and choose the Table ▶ Select ▶
Table menu option to select the entire table.
11. Choose the Table ▶ Modify Borders menu option. The Modify Borders dialog
box opens.
12. Change the selection in the Apply To option to Table.
13. Click the None button in the Presets section.
14. Click OK to exit the Modify Borders dialog box. The Generated Text Editor
now contains a table without borders.
15. Place your cursor in the first cell of the table, choose Table ▶ Table Properties,
and select the Column tab in the Table Properties dialog box.
16. In the Width field, select the Fixed option and enter 100.00pt in the Fixed
Width field.
17. Click the Cell tab in the Table Properties dialog box. In the Justification field,
set the Horizontal field to Center and the Vertical field to Top.

Adding Generated Text 515

18. Click OK to exit the Table Properties dialog box.
19. Place your cursor in the second cell of the table, choose Table ▶ Table
Properties, and select the Cell tab in the Table Properties dialog box.
20. In the Justification field, set the Horizontal field to Left and the Vertical field
to Centered.
21. Click OK to exit the Table Properties dialog box.
22. Place your cursor in the first cell then choose Insert ▶ Graphic. The Locate
Graphic File to Reference dialog box opens.
23. Browse to the graphic that you want to be displayed in the first cell of the
table, for example the graphic cmt.gif from the Arbortext-path/
graphics directory.
24. Place your cursor in the second cell and enter the text Source: followed by a
space.
25. After the text, choose the Insert ▶ Element Content menu option. The Insert
Element Content dialog box opens.
26. Select corpauthor from the Of list and ensure that the Element content
option is selected.
27. Choose first from the Occurrence list and (Whole Document) from the
Within list. These two steps will advise Arbortext Styler that the contents of
the corpauthor element should be output in the second cell of the table,
after the specified text.
28. Click OK to exit the dialog box. The Generated Text Editor now shows an
ElementContent object in the second cell, after the text.

29. Select the ElementContent tag in the second cell, and choose the Format ▶
Font menu option. The Modify Font dialog box opens.
30. Set Color to Red. Note that this font color will apply only to the text generated
by the ElementContent object, the rest of the generated text in the title
will inherit its formatting properties from the note element.

516 User's Guide

31. Click OK. The Generated Text Editor will show the table as it has been
configured, with the ElementContent object surrounded by a _font
wrapper:

32. Choose File ▶ Apply and Close to save the gentext setting and exit the editor.
33. Choose Preview ▶ Print.
Note that the title of the first note in the document contains the selected
graphic on the left, and the content of the corpauthor element on the right.

Adding User Formatting Elements to

Generated Text
You can add User Formatting Elements to generated text by choosing Insert ▶ User
Formatting Element in the Generated Text Editor. A User Formatting Element
(UFE) can be used in generated text to apply specialized formatting for generated
text, other than that defined in Arbortext Styler. For example, you may want to
add a UFE to the generated text of the title in chapter context to make a
line appear directly over the contents of the title.

To Add a User Formatting Element to Generated Text

1. In Arbortext Styler, select an element context, and go to the Generated text
category.
2. Choose the Edit button for the Before-text or After-text field.
3. In the Generated Text Editor, choose Insert ▶ User Formatting Element. If you
have not already defined a User Formatting Element, choose (new).
4. Arbortext Styler will automatically insert the UFE you choose. If you have
created a new UFE, select the newly created UFE in the Elements list and use
the property categories to apply style properties. If you do not see the new
UFE in the Elements list, choose the View ▶ User Formatting Elements menu
option to enable their display.

Adding Generated Text 517

Use a UFE to Concatenate Multiple Gentext Options Based on
Attributes
It is possible that you will have an extremely complex generated text requirement
for a single element: for example, an element myelement could have three
attributes, each one with four possible values. If you need to apply different
generated text for each possible value, you would need to maintain 12 conditions
of the myelement element - if this is a commonly used element in your
stylesheet it is likely that it will already have many conditions and contexts
applied to it. If you wish to simplify the generated text setting, you could create a
UFE for each of the three attributes of myelement and attach the conditions to
those, thus not adding to the existing set of the conditions for myelement.
1. In Arbortext Styler, select the everywhere context for myelement,
navigate to the Generated text category, and elect to add generated text before
the element content.
2. In the Generated Text Editor window, insert a UFE via the Insert ▶ User
Formatting Element ▶ (new). Give the UFE the same name as the attribute to
which you wish to apply formatting options.
3. Repeat step 2 to create a UFE for each of the other two attributes of
myelement. Place them in the same order in which generated values should
appear and add whatever space, punctuation, or fixed text is necessary.
4. Click File ▶ Apply and Close to save the changes and exit the Generated Text
Editor.
5. For each UFE, create one condition for each of the possible values of the
corresponding attribute via the Insert ▶ Condition menu option. Each condition
should include an attribute test, which specifies myelement as the required
ancestor, and tests for a particular value of the attribute to which the UFE
relates.
6. For each condition of each UFE, use the Generated text category to define the
generated text that should be inserted when the specific value of the specific
attribute for the myelement element is encountered.

Using XPath Expressions in Generated

Text
You can use XPath expressions to insert the contents of specific elements,
attributes, or entire element node sets in generated text.
You may also embed the output of a script as an XPath string. Please refer to
Accessing Scripts from Arbortext Styler on page 746 for further information.

518 User's Guide

Using XPath to Insert the Contents of Specific Elements or Attributes
1. Select an element context and choose the Generated text category in the
properties area.
2. Choose the Edit button associated with the Before-text or After-text field,
depending on the intended placement of your generated text.
3. In the Generated Text Editor, choose Insert ▶ XPath String.
4. In the Insert XPath String dialog box that opens, provide a valid XPath
expression to insert the content of a specific element or attribute in generated
text. Relative expressions are evaluated relative to the element being styled,
except when you are inserting an XPath expression in the generated text of a
header or footer, where the document element is used as the context node.
Some examples are shown below:
• Content of a specified attribute in a specified element whose parent is a
specified element that is the root of the document
The expression /doc/docinfo/@docno will insert the content of the
docno attribute of the docinfo element, which is a child of the doc
element. In this expression the doc element must be the root of the
document.
• Content of a specified attribute in a specified element that is a child of the
current element
The expression ./docinfo/@docno will insert the content of the docno
attribute of the docinfo element. Here the docinfo element must be a
child of the element for which the generated text is being set.
You must understand XPath and its syntax to use this option. Refer to the
World Wide Web Consortium (W3C) web site (http://www.w3.org/TR/xpath)
for information on the XPath standard.

Note
It is not necessary to substitute &lt; for <, &amp; for &, or &quote;
for ".

Adding Generated Text 519

 Note
The use of certain XPath expressions in generated text can cause increased
processing times. Please refer to XPath Performance on page 1078 for
information and suggested alternatives.

Using Arbortext Editor to Test an XPath Expression for Inserting

Content
It often takes multiple attempts to define the correct the correct XPath expression
to meet your requirements. It is much quicker to develop and test expressions in
Arbortext Editor than in Arbortext Styler - the steps below explain how:
1. Open your document in Arbortext Editor and place the cursor inside the
element whose generated text you are creating.
2. In the Arbortext Editor command line, enter the command eval oid_
xpath_string(oid_caret(), "...") - replacing ... with the
expression you wish to use.
3. Look at the resulting value in the Eval Output window - if the value is 1, the
test is true. If a value of 0 returned, the test is false.

To Insert an Element-Node Set Using an XPath Expression

1. Select an element context and choose the Generated text category in the
properties area.
2. Choose the Edit button associated with the Before-text or After-text field,
depending on the intended placement of your generated text.
3. In the Generated Text Editor, choose Insert ▶ Element Content.
4. In the Insert Element Content dialog box that opens, select the By XPath option
then provide a valid XPath expression in the Expression field. The expression
must result in an element-node set. Relative expressions are evaluated relative
to the element being styled, except when you are inserting an XPath
expression in the generated text of a header or footer, where the document
element is used as the context node.
For example, the expression ancestor::chapter//endnote, when
used in the generated text of an element that is the descendant of a chapter,
will insert copies of all the chapter's endnote elements into that element.
You must understand XPath and its syntax to use this option. Refer to the
World Wide Web Consortium (W3C) web site (http://www.w3.org/TR/xpath)
for information on the XPath standard.

520 User's Guide

 Note
It is not necessary to substitute &lt; for <, &amp; for &, or &quote;
for ".

Using Arbortext Editor to Test an XPath Expression for Inserting

Elements
It often takes multiple attempts to define the correct the correct XPath expression
to meet your requirements. It is much quicker to develop and test expressions in
Arbortext Editor than in Arbortext Styler - the steps below explain how:
1. Open your document in Arbortext Editor and place the cursor inside the
element whose generated text you are creating.
2. In the Arbortext Editor command line, enter the following series of
commands:
a. global xa[]
b. eval oid_xpath_nodeset(oid_caret(), $xa, "..." -
replacing ... with the expression you wish to use. This expression will
return the number of elements matched with your original expression.
c. goto_oid($xa[1]) - this expression will take you to the first element
matched with your original expression. Repeat the command changing the
number in square brackets to identify which match in the list you wish to
be taken to, i.e. goto_oid($xa[2]) for the second match, goto_
oid($xa[3]) for the third, and so on. Here you can use the number
generated with the expression in point 2 to determine how far you need to
proceed with this step.

Note
Certain XPath expressions may cause a considerable increase in the time taken
to process generated text. Please refer to XPath Performance on page 1078 for
information on the types of expression that may be problematic, and some
alternative ways in which generated text can be defined.

Adding Generated Text 521

Creating Repeating Titles
You can use generated text to output repeating titles in your document. A
repeating title repeats the content of a title element when the element breaks
across columns or pages. You can set the title to repeat at the top of the column or
page after it breaks across a column or page, or at the bottom of a column or page
before it breaks.
Note that you can only implement a repeating title for print or PDF output.

Example: Creating a Repeating Title

This procedure describes how to automatically repeat a table's title when the table
breaks across a page. The title will repeat at the top of the following page.
1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/styler
2. Choose Styler ▶ Edit Stylesheet to open the stylesheet currently associated with
the document for edit. This is a read only stylesheet so you will need to save a
local copy if you want to make amendments.
3. In Arbortext Styler, select the table element in the Elements list, and apply
the Formal Block style to it via the Edit ▶ Style menu option.
4. In Arbortext Editor, click in the title for the table “Titanic II's Destinations” in
Chapter 2. Revert to Arbortext Styler and note that the title context that applies
to this title is highlighted in the Elements list.
5. With the context (in this instance title in table anywhere in
chapter) selected in the Elements list, go to the Generated text category in
the properties area.
6. In the Repeat title or continuation text (Print/PDF only) field, set the At top after
break field to Yes.
7. Click the Edit button next to the At top after break list. The Generated Text
Editor opens.
8. Select the default text (cont'd) and replace it with continued.

9. Choose File ▶ Apply and Close to save the generated text setting and exit the
editor. The description of the title in table anywhere in chapter
context contains the property Gentext: Repeating Title (yes) for
the selected output.

522 User's Guide

10. In Arbortext Editor, locate the table titled “Titanic II's Destinations,” copy the
first row of the table, and paste it into the table five or six times.
11. In Arbortext Styler, choose Preview ▶ Print.
In the Print Preview window, note that when the “Titanic II's Destinations”
table splits across pages, the title Titanic II's Destinations continued displays
at the top of the table on the following page.
In Arbortext Styler, choose Preview ▶ HTML File.
In the browser window, note that when the “Titanic II's Destinations” table
splits across pages, the table does not break and hence there is no need for a
title for the table on a following page. This is because the repeating title
feature only applies for print or PDF output.

Controlling Space Before or After Repeating Titles

Print engines take different spacing measures into account when assessing the
space to be output before or after a repeating title:
• Spacing after titles that repeat At top after break
○ PTC APP refers to the Space after settings for both the title and
_sfe:RepeatingTitle. It merges the two values using the normal
rules for vertical space merging:
1. The space with the highest priority setting wins
2. If priorities are the same, the largest space is used, except:
3. If both priorities are the same and have the value force, the two spaces
are added
○ FOSI and XSL-FO refer to the Space after setting for
_sfe:RepeatingTitle.
Space after settings are made in the Spacing category for elements, contexts,
and conditions.
• Spacing before titles that repeat At bottom before break
○ PTC APP refers to the Space after setting for the block immediately
preceding the repeating title and the Space before setting for
_sfe:RepeatingTitleBottom. It merges the two values using the
normal rules for vertical space merging (see above):
○ FOSI and XSL-FO refer to the Space before setting for
_sfe:RepeatingTitleBottom.
Space after and Space before settings are made in the Spacing category for
elements, contexts, and conditions.

Adding Generated Text 523

Adding Change Bars
You can use generated text to indicate when change bars should be applied to your
document in print and PDF output. Your document type determines how you
should configure support for change bars: some document types contain an
element that determines when change bars begin and end. Other document types
use an attribute to indicate revised elements in a document. Change bars can be
generated based on the presence or values of these elements or attributes.

Example: Adding Change Bars Based on an Element

The procedure details below describes how to set the <simpara> element so that
its content is displayed with change bars in your final document.
1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/styler
2. Choose Styler ▶ Edit Stylesheet to open the stylesheet currently associated with
the document for edit. This is a read only stylesheet so you will need to save a
local copy if you want to make amendments.
3. In the Elements list, select the simpara everywhere else context.
4. Go to the Generated text category.
5. Click the Edit button next to the Before-text field. The Generated Text Editor
opens.
6. Select Insert ▶ Begin Change Bar. The ChangeBarBegin element is
inserted.
7. Select File ▶ Apply and Close to save the change and exit the editor.
8. Select the Edit button next to the After-text field. The Generated Text Editor
opens.
9. Select Insert ▶ End Change Bar. The ChangeBarEnd element is inserted.
10. Select File ▶ Apply and Close to save the change and exit the editor.
11. The Generated text property area now displays details of the change bar
settings you have made:
12. In Arbortext Editor, insert the <simpara> element and add some arbitrary
content into the element.
13. Back in Arbortext Styler, select Preview ▶ Print.
In the Print Preview window, note that the content of the simpara element is
flagged with a change bar.
You may set the placement of change bars in the pages formatted by a page set in
the Other category for the Page Sets list.

524 User's Guide

Example: Adding Change Bars Based on an Attribute Value
The procedure below describes how to set the para element so that its content is
displayed with change bars in your final document when it contains the attribute
role=”comment”. This is achieved by setting a condition for the element.
1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/styler.
2. Choose Styler ▶ Edit Stylesheet to open the stylesheet currently associated with
the document for edit. This is a read only stylesheet so you will need to save a
local copy if you want to make amendments.
3. In the Elements list, select the context para everywhere else.
4. Add a condition to the context by selecting the Insert ▶ Condition menu option.
The New Condition dialog box appears.
5. Click the New Attribute Test button. The New Attribute Test dialog box appears.
Ensure that para is listed in the Current element field.
6. In the Attribute Name field, select role from the list. In the Attribute value field,
select the Comparison and = operators, then enter comment into the text field.

7. Click OK button to save the test and exit the dialog box. The New Condition
dialog box shows the new test in the Tests field.
8. Click OK to save the condition and exit the dialog box.
9. Highlight the new condition in the Elements list.
10. Go to the Generated text category.
11. Click the Edit button next to the Before-text field. The Generated Text Editor
opens.

Adding Generated Text 525

12. Select Insert ▶ Begin Change Bar. The ChangeBarBegin element is
inserted.
13. Select File ▶ Apply and Close to save the change and exit the editor.
14. Click the Edit button next to the After-text field. The Generated Text Editor
opens.
15. Select Insert ▶ End Change Bar. The ChangeBarEnd element is inserted.
16. Select File ▶ Apply and Close to save the change and exit the editor.
17. The Generated text area now displays details of the change bar settings you
have made:
Note the default settings for the appearance of the change bars: if you wish to
change these settings, use the instructions contained in the section Modifying
the appearance of change bars.
18. In Arbortext Editor, insert a para element and give it the role=”comment”
attribute. Add some arbitrary content into the element.
19. Back in Arbortext Styler, select Preview ▶ Print.
In the Print Preview window, note that the content of the para element that
includes the role=”comment” attribute is flagged with a change bar.
You may set the placement of change bars in the pages formatted by a page set in
the Other category for the Page Sets list.

Modifying the Appearance of Change Bars

You must modify the attributes of the ChangeBarBegin and ChangeBarEnd
elements in the Generated Text Editor to modify the appearance of change bars.
The ChangeBarBegin element has the following default attributes:
• class – the type of change bar. If you want to maintain more than one type of
change bar, for example if you wish each one to appear differently, you must
set a different class for each type.
• offset – how far the change bar is offset from the text it flags.
• ruleThick – the thickness of the change bar.
Modify these attributes to give them the values you require by selecting them in
the Generated Text Editor and selecting the Edit ▶ Modify Attributes menu option.
You may also add non-default attributes, such as color, by adding the attribute's
name in the New Attribute field and clicking Add. You may then set a value for
that attribute as usual (see the color=”red” attribute in the graphic below):

526 User's Guide

The ChangeBarEnd element only has the class attribute. If you want to
maintain more than one type of change bar you must change the value of this
attribute to match that of the associated ChangeBarBegin element.

Changing the Location of Change Bars

By default, change bars are set to appear to the left of each column of flagged text.
For other placements, use the Change bar placement field in the Other category for
the Page Sets list for a particular page set.
For example, the procedure below describes how to place change bars in the
sample document transport.xml to the right of any flagged text, instead of
the default left hand side. The change will be apparent for change bars that have
been set up to appear in a chapter, whereas the rest of the book will continue with
the default placement.
The change bars will be displayed when a para element with a role=”comment”
attribute is included in the document, as set up in To add change bars based on an
attribute value above. Carry out the tasks included in that procedure if you have
not already done so - there is no need if you have already configured the display
of change bars based on attributes for an element in your stylesheet.
1. If you have not already done so, open the transport.xml document
located at Arbortext-path/samples/styler
2. Choose Styler ▶ Edit Stylesheet to open the stylesheet currently associated with
the document for edit. This is a read only stylesheet so you will need to save a
local copy if you want to make amendments.
3. In the Elements list, select the chapter element.
4. Go to the Breaks category. You will see in the Name field of the Page set
group that the mainbody-page page set is used to format the chapter
elements in your document.

5. Go to the Page Sets list , and select the mainbody-page page set.

Adding Generated Text 527

6. Navigate to the Other category.
7. Select Right in the Change bar placement field.
8. In Arbortext Editor, insert a para element in two locations in your document:
one within a chapter and the other in the book itself, before the first
chapter. Set the attributes of both of these paragraphs to role=”comment” and
include some arbitrary content in both.
9. Back in Arbortext Styler, choose Preview ▶ Print.
In the Print Preview window, note that the change bar for the paragraph
inserted into a chapter is placed on the right of the flagged text, while the bar
for the paragraph in the book is still placed on the left.

Maintaining Translations of Generated

Text
It is common to maintain and output a different language version of generated text
for each different language version of the same document. This section describes
the Arbortext Styler features and process that facilitate managing translated
generated text.
The process includes the following steps:
1. Set source and target languages for generated text in your stylesheet on page
529
The source language is the language in which generated text is authored in
your document. A target language is the language into which generated text
should be translated.
2. Confirm which translation units in your stylesheet are to be translated on page
532
A translation unit is a single piece of generated text.
3. Export generated text for translation on page 537
An export of generated text generates an XLIFF file for each target language
configured for your stylesheet. You can send the XLIFF file(s) to your
translator for translation.
4. Import generated text translations on page 541
During import, the translation of a translation unit in the XLIFF file is
matched with the same translation unit in the source language in the
stylesheet.

528 User's Guide

 You may import the XLIFF file manually or programmatically via API. Refer
to Using ACL to Import XLIFF Files on page 545. for further information.
5. Review the statistics provided on import to give information about the status
of the import on page 544
You will be advised if there are any missing, out of date, or invalid translations
or requests.
You can generate statistics programmatically via API. Refer to Using ACL to
Import XLIFF Files on page 545 for further information.
Translations of generated text are supported in all outputs and by all print engines
in the PTC Arbortext environment. Documents published to HTML will have the
lang attribute set appropriately, based on the language settings configured for the
stylesheet.

Language Settings for Generated Text Translation

To enable a translation of the generated text in your stylesheet, the first step is to
configure the language settings that will support the translation process. Language
definitions are specified in the Language tab of the Stylesheet Properties dialog
box on page 1040. Here you can make two types of language setting that will
support the translation of generated text:
1. Specify the element or attribute that should be analyzed for language
information in all documents to be published via the stylesheet. This can be set
for the whole document, or reviewed at individual element level throughout
the document
2. Specify the source and target languages with which generated text translation
should work:
• Source language: the language in which generated text is authored
• Target language: the languages into which generated text is translated
You must ensure that all modules of a stylesheet have the same generated text
source language. See Managing Translated Generated Text in Stylesheet
Modules on page 547 for information on how this is monitored by Arbortext
Styler.
See Language Settings on page 32 for additional information.
Once you have made these settings, Arbortext Styler will be able to recognize
which language version of generated text should be output on each context that
contains a generated text definition. When it encounters generated text Arbortext
Styler will assess the document language that is in effect for the particular context,
based on the document language specification you made, and output the required
source or translated version.

Adding Generated Text 529

Example
This example describes how to set the language properties for a stylesheet. It will
specify that the default document language of a document is English, and that
language information should be assessed at individual element via the xml:lang
attribute. Further settings will stipulate that generated text is authored in English,
and should be translated into French and Spanish.
1. Refer to the Language tab of the Stylesheet Properties dialog box.
2. In the Default document language field, select en (English) from the drop down
menu.
3. In the Document language specification method field, select the Attribute
option. Enter xml:lang in the Language attribute name field.
4. In the Point of language specification field, select the Any element option.
5. In the Source language field of the Generated text group, select en (English)
from the drop down menu.
6. In the Target Languages field, click the Add button to open the Add Target
Language dialog box. In the Language field, enter fr (French) as the first
required target language. You can select it from the drop down list or enter the
value manually. Click OK to exit the dialog box. You will see that the fr
(French) now appears in the Target Languages field.

Repeat this step for es (Spanish).

7. Click OK to exit the Stylesheet Properties dialog box. Save your stylesheet to
save the language settings.
The next step in setting up translation of generated text is to specify the pieces of
generated text in your stylesheet that will be translated. Refer to Managing
Translation Units on page 532.

Changing the Source Language

Changing the source language for generated text is simple- just add the new value
into the Source Language field of the Stylesheet Properties dialog box. You do
need to be aware of the implications. Arbortext Styler will validate your choice
when you click OK to save the change and exit the Stylesheet Properties dialog
box:
• Changing the value of Source Language to a new value that is not a target
language - this is a valid action and you will see a dialog box that asks you to
confirm it.
• Changing the value of Source Language to a value that is a target language of
any module in the stylesheet - you will see a warning message that the new
value is not valid. All modules in the stylesheet must have the same source

530 User's Guide

 language. Return to the Stylesheet Properties dialog box and make the
necessary changes.
• Replacing the source language with a previous target language that has
complete and current translations - this is a valid action and you will see a
dialog box that asks you to confirm it.
• Replace the source language with a previous target language that is not
completely translated - you will see a warning message that the target
language cannot become the source language because it is not translated. The
new source language must have a full set of translations or generated text for
the document will be incomplete when the language change is made. Return to
the Stylesheet Properties dialog box and make the necessary changes.
Refer to Converting a Target Language into the Source Language on page 531 for
information on changing the source language to one of the target languages
already set.

Converting a Target Language into the Source Language

You may elect to make one of the specified target languages the source language
for generated text. Enter the code of the relevant target language in the Source
Language field, then remove the same code from Target Languages, or replace it
with the code of the original source language. The original source language then
becomes a target language, according to the following rules:
1. The action is only permitted if translations for the new target (previously
source) language exist, and are current and writable. If this is not the case, you
will be prompted to provide the correct translations.
[A23968 Cannot make "es (Spanish)" the source language because it is
not completely translated.
2. You are not permitted to set the source and target languages to the same value.
3. If correct translations for the new target language are available, you will be
presented with a prompt explaining how the changes will affect your
stylesheet:
Changing the source language to "fr (French)".
[A23971] The change will be made in all modules of the stylesheet.
The modules in this stylesheet will not be usable in stylesheets
that have a source language other than "fr (French)".
[A23972] The previous source language "en (English)" will no longer
be a generated text language.

Then you will be asked to confirm that you want to change the generated text
in the stylesheet and its modules to the new source (previously target)
language:
[A23974] Removing "en (English)" as the source language. Do you want to
remove the "en (English)" translations for all generated text in all
modules?

Adding Generated Text 531

 If you confirm the action, the selected target language becomes the source
language and the source language becomes a target language. If you refer to
generated text in the stylesheet, you will see that each field contains generated
text in the new source (previously target) language.
4. The new language value is validated when you exit the Stylesheet Properties
dialog box with the OK button. If the new value of the Source language field is
equal to a target language of any module in the stylesheet, you will see a
message informing you that the new value for Source language is not valid.
If the new value is valid, you will be prompted again to confirm the action.
Click OK to proceed and complete the action.

Removing a Target Language and Associated Translations

You may wish to remove a target language from your stylesheet after it has been
translated. To do this, highlight the required target language in the Target
Languages list on the Language tab of the Stylesheet Properties dialog box, and
click the Delete button. The selected target language will be removed from the
Target Languages list. When you click OK to confirm the change and exit the
Stylesheet Properties dialog box, you will see the first prompt for confirmation:
[A23975] Removing the target language "fr (French)".
Note: You may want to first backup a copy of the translations by
exporting them to a translation file.
Click Cancel if you want to export your translations before proceeding. Click OK
to confirm the action. You will see a second prompt for confirmation:
[A23976] Removing the target language "fr (French)". Do you want to remove
the "fr (French)" translations for all generated text in all modules?
Note: If other stylesheets include any of the modules in this stylesheet
and need the translations they should not be removed.
Click Cancel if you do not want to remove the target language and the
translations. The target language will remain the Target Languages field. Click OK
to confirm the action, remove the language and its translations, and close the
Stylesheet Properties dialog box.

Managing Translation Units

A translation unit is a body of text that will be translated as one item. In Arbortext
Styler, any text you edit in a generated text window is translatable, and the entire
contents of the generated text window is a single translation unit.
Arbortext Styler creates a translation unit when you configure generated text, and
assigns it a unique ID when the generated text is saved. You then have the option
to mark the translation unit for translation, and you can decide this on an
individual unit basis. You can also add a note for the translator. Those translation
units that are marked in the stylesheet as needing translation will be included in
the XLIFF file(s) created when you elect to export generated text for translation.

532 User's Guide

Each unit is exported with its unique ID and its accompanying note. Once the
content of each translation unit has been translated, you import the XLIFF file
back into your stylesheet. During the import process, the presence of the
individual IDs generated for each translation unit on creation enable Arbortext
Styler to match the correct target in the XLIFF file with its original source in the
stylesheet.
You will see a warning message when you attempt to import generated text
translations based on units that are not uniquely identified. This includes modules
that you add to your stylesheet.

Example
In this example you will create a piece of generated text and save it to generate a
translation unit. You will confirm that the translation unit is marked as needing
translation. You will add a note for the translator.
1. In Arbortext Styler create a piece of generated text for an element or context in
your stylesheet. Apply the changes but do not exit the generated text editor
window. Arbortext Styler will create a translation unit and assign it a unique
ID, although you cannot see it.
2. Refer to the Translation ▶ Based on Text Content menu option in the generated
text editor window. You will see that the menu option is suffixed with
Arbortext Styler’s assessment of whether the translation unit needs translation,
for example Based on Text Content (Translate).
3. If you agree with this assessment, exit the menu. If you do not want the
translation unit to be included when you export generated text for translation,
choose the Translation ▶ Do Not Translate menu option. This will remain
checked in the menu until it is manually changed.
Refer to Turning Translations On and Off on page 535 for further information.
4. Choose the Translation ▶ Add Note menu option in the generated text editor
window to open the Add Translation Note dialog box on page 949. Enter your
note and exit the dialog box. Your translation unit will now display an icon
to confirm it is accompanied by a note.
Double click the icon of an existing note to edit it in the Translation Note
dialog box. See Translation Note Dialog Box on page 1055.
5. Apply the changes and exit the generated text window.
The next step in setting up translation of generated text is to export the generated
text for translation. Refer to Exporting Generated Text for Translation on page
537.

Adding Generated Text 533

Keeping Translations Up To Date
If you have already imported translations for your stylesheet, and your translations
are current, you can ensure that your translations do not become out of date by
avoiding the operations listed below. All of them could create new translation
units, or make translations of existing units out of date:
• Assigning a new style to an element
• Adding generated text — this will create a new translation unit even if the
added text and markup matches an existing translation unit.
• Modifying existing generated text
• Adding a new module (unless it is fully translated)
• Pasting an item that was copied or cut from a stylesheet that's not fully
translated
If you have exported generated text for translation, but not yet imported the
translations, you should avoid operations that cause translation units to be
duplicated. In this case the duplicates will be given new IDs and they will not
receive the prepared translation when it is imported into the stylesheet. See
Precautions When Translation Files are Awaiting Import on page 534 for
information.
A stylesheet validation invoked via the Tools ▶ Validate Stylesheet menu option
will report any duplicated IDs for translation units in the stylesheet, including
modules. It will regenerate the IDs automatically when writable.

Note
If Arbortext Styler has regenerated any IDs, you must ensure that you export
your stylesheet for translation again to ensure all the new translation units
needing translation are included. You should also import any outstanding
translations before you add the module or they may not match.

Precautions When Translation Files are Awaiting Import

Translation units must have unique IDs. Arbortext Styler manages the IDs to
ensure translations are allocated to the correct source. However, if you have
exported generated text files for translation, but not yet imported the translations,
you should avoid operations that could cause translation units to be duplicated.
Duplicates will automatically be assigned new IDs which means they will not be
updated by the import of files already exported.
Operations to avoid during this state are:

534 User's Guide

• Copy to module
• Paste objects
• Paste generated text
• Paste Properties
Refer to Adding Modules and Duplicate IDs on page 535 for information on
avoiding duplicate IDs when working with stylesheet modules.

Adding Modules and Duplicate IDs

In rare cases, a module you add to your stylesheet may contain translation units
with IDs that are duplicates of ones in your stylesheet. Arbortext Styler will issue
a warning that it will have to regenerate the module's translation unit IDs and ask
whether you wish to include the module. In most cases you should click Yes when
you see this message. However, if you have exported a translation file including
translations for that module, and not yet imported the translations, you should
click No, and wait until you have imported the translations for the module.

Turning Translations On and Off

Arbortext Styler assesses each translation unit in a stylesheet and decides whether
it should or should not be translated, based on its content:
• Text content other than just spaces: needs translation
• Markup and/or spaces only: does not need translation
Markup refers to generated text generators such as ElementContent (from
the Insert ▶ Element Content option) or a chapter number.
This is the default behavior in Arbortext Styler, and the default setting for
translation units when they are created.
You can decide whether each translation unit should be translated by selecting the
relevant option in the Translations menu in the Generated Text Editor:
1. Translation ▶ Translate
The translation unit representing this piece of generated text will appear in any
XLIFF files exported from Arbortext Styler. See XLIFF files on page 538 for
information.
You could use this option for a piece of generated text that only contains
spaces if spaces are not permitted in the target language. The translator could
remove the spaces in the relevant language translation.
This option could also be useful for a piece of generated text that only contains
markup, if you want to change the order of the markup in a certain language.
For example, the generated text might consist of multiple occurrences of the

Adding Generated Text 535

 ElementContent markup (from the Insert ▶ Element Content option). If
you set this translation unit as requiring translation, the translator could change
the order of the elements in the relevant language translation.
2. Translation ▶ Do Not Translate
You could use this option for text context such as a product name that should
not be translated.
You may also leave or select the default behavior described above, by choosing
the Translation ▶ Based on Text Content option. Leave this option checked to let
Arbortext Styler assess the translation requirements for the current unit. You will
see that the menu option includes the current status in its suffix, for example
Translation ▶ Based on Text Content (Do Not Translate).
If you want to activate/deactivate translation for the translation unit that represents
the label part of an element number, ensure that you access the generated text
editor via the Advanced Edit button in the numbering dialog. Choose the
Translation ▶ Translate, Translation ▶ Do Not Translate, or Translation ▶ Based on
Text Content menu options from here. This will keep the setting separate from that
configured for any other generated text for the same element, which is represented
by a second translation unit.
If you want the translator to apply some non standard translation to a translation
unit, it may be useful to include a note with the translation unit in the XLIFF file.
See Adding Notes to the Translator on page 536 for information.

Adding Notes to the Translator

The menu item Translation ▶ Add Note in the generated text editor launches the
Add Translation Note dialog box, in which you can enter a note to accompany a
translation unit. The note will be included in the entry for the translation unit in
the XLIFF file exported for translation.
If a note already exists for the translation unit, the menu item and dialog box are
titled Edit Note. The menu item is disabled if a translation unit is marked as not
scheduled for translation. The translation unit displays an icon if it has an
accompanying note.
Double click the icon to open the Edit Note dialog box.
Use the Delete Note menu item to remove an existing note. The menu item is
disabled if there is no note for the translation unit.
If you want to add a note to accompany the translation unit that represents the
label part of an element number, ensure that you access the generated text editor
via the Advanced Edit button in the numbering dialog. Choose the Translation ▶
Add Note, Translation ▶ Edit Note, or Translation ▶ Delete Note menu options from
here. This will keep the note separate from that configured for any other generated
text for the same element, which is represented by a second translation unit.

536 User's Guide

Viewing and Modifying Translation of Generated Text
Once you have imported the XLIFF file containing translation of the generated
text, you can view the translation for each language in the Generated Text Editor.
The menu item Translation ▶ Language displays a list of the languages specified in
the stylesheet.
The first language in the list is the source language followed by the target
languages. When you select any language from the list, the translation of the
generated text is displayed in the Generated Text Editor. You can modify the
translation here. Once the changes are saved, these translation units are marked as
current in the stylesheet.
The Language menu item is enabled only if the translation is turned on for the
generated text.

Exporting Generated Text for Translation

Before you export your generated text, you must ensure that you have:
1. Set the source and target languages for your generated text and had these
values validated
See Language Settings for Generated Text Translation on page 529.
2. Confirmed which translation units in the stylesheet should be translated and
added any notes for the translator
See Managing Translation Units on page 532.
The expected output from an export action is an XLIFF file for each selected
target language. The XLIFF file contains information about each translation unit,
its context in the document, its current translation status, and a target version of
the generated text. If it is the first export of generated text for the stylesheet, the
entries for source and target generated text will be the same. If you have already
translated generated text for this stylesheet, the target version will be different for
translation units that were previously translated.
Refer to XLIFF Files on page 538 for a full explanation of the content of an
XLIFF file.
To export generated text for translation:
1. In Arbortext Styler, select the Tools ▶ Export Generated Text menu option to
open the Export Generated Text for Translation dialog box on page 955.
The menu option is not available if you have not specified any target
languages for generated text.
2. In the dialog box, provide the information required to set up the XLIFF files.
If you are re-exporting a stylesheet’s generated text for translation, you may
wish to export only those translation units that have changed since the last

Adding Generated Text 537

 export. Select the Include only generated text that does not have a current
translation option.

Click OK to confirm the settings and begin the export.

3. Your XLIFF file(s) will be exported to the requested destination. If your
stylesheet contains no translations, you will see a notification message and the
file will not be created.
Once you have successfully exported your XLIFF file, you can send it to the
translator for their input.

XLIFF Files
An XLIFF file (type .xlf) is generated for each selected target language when
exporting generated text. A brief explanation of its content is given below:

XLIFF file layout

<?xml version="1.0"?>
<xliff version="1.2" xmlns="urn:oasis:names:tc:xliff:document:1.2">
<file datatype="xsl" date="2010-02-25T12:04:06Z" original="axdocbook.style"
source-language="en" target-language="fr">
<body>
{ multiple trans-unit elements here }
</body>
</file>
<file datatype="xsl" date="2010-02-25T12:04:06Z" original="axdocbook-module.style"
source-language="en" target-language="fr">
<body>
{ multiple trans-unit elements here }
</body>
</file>
</xliff>

file
One for each stylesheet module
date
The date of the XLIFF file was produced, i.e. when the generated text was
exported for translation
original
The name of the stylesheet module
source-language
Extracted from the Source Language field of the Stylesheet Properties dialog
box

538 User's Guide

target-language
Extracted from the Target Languages field of the Stylesheet Properties dialog
box and selected in the Languages to export field of the Export Generated Text
for Translation dialog box

body
Contains the translation units in the file, described in trans-unit elements
trans-unit
One for each translation unit (piece of generated text) marked as needing
translation in the stylesheet

Content of a translation unit in an XLIFF file

The description of a translation unit in the stylesheet is given in a trans-unit
element in the XLIFF file. A summary of the content of a trans-unit is given
below:
<trans-unit id="A10dffbd7-de49-46c5-a657-82e2594945e3">
<source>{1}{2} (continued){1}}</source>
<target state="new">{1}{2} (continued){1}</target>
<note>
This note has been entered by the user to give context to the translator.
</note>
<context-group purpose="information">
<context context-type="numparams">2</context>
<context context-type="paramnotes">{1} = <_ufe:table-title-continuation>
...</_ufe:table-title-continuation></context>
<context context-type="paramnotes">{2} = <_gte:ElementContent/></context>
<context context-type="x-def-name">title in table</context>
<context context-type="x-location">Repeating Title at Top</context>
</context-group>
</trans-unit>

id
The unique ID of the trans-unit in the XLIFF file. This matches the ID of
the translation unit in the stylesheet.Arbortext Styler will match the two IDs
when it imports the translated XLIFF file to place the translation into the
correct translation unit.
source
The content of the source translation unit. Markup in the original generated
text is replaced with parameter markers. Descriptions of the parameters that
represent the markup are described in the context context-type=
”paramnotes” entries later in the XLIFF file.
target
The translation of the generated text content. For elements that have not been
previously translated, the entry for target is the same as for source.

Adding Generated Text 539

 The state attribute describes the current position of the translation unit in the
translation workflow. It will be one of the following values:
• new - has not yet been translated
• needs-translation - has been translated previously, but needs a new
translation as the content of the source translation unit has changed since
the last import of translations
• translated - has been translated and is current
The translator should enter the translation into this field before passing the
XLIFF file back to the stylesheet developer for import into the stylesheet.
Please refer to Guidelines for working with XLIFF files below for some
additional information.
note
The note created for the translation unit in the stylesheet.
See Adding Notes to the Translator on page 536.
context-group
Information about the context to which the generated text applies. This
information can be used by the translator to give context to the required
translation. It can also be used by memory by translation software that
manages translation memory.
The information is listed in a set of context elements.
context
A piece of information about the context of the generated text. There will be
multiple child context elements for each trans-unit.
Each context includes a context-type attribute, which defines the type of
information the context element is describing. It will be one of the
following values:
• numparams - the number of pieces of markup identified for the generated
text in the source.
• paramnotes - the type of markup
• x-def-name - the element in the stylesheet that generated this translation
unit
• x-location - the location in the stylesheet from which this translation
comes
The XLIFF file contains further information about all these attribute values.
Refer to the comments at the beginning of the file.

540 User's Guide

Guidelines for working with XLIFF files
Please refer to the list below for information that you must take into consideration
when working with XLIFF files:
• Arbortext Styler will usually recognize if a translation has changed when the
XLIFF file is imported. It does not always need to refer to the value of the
state attribute for target, although occasionally it may need to prompt for
clarification of next steps. Setting the state attribute to a value of translated,
signed-off, or final before import will avoid uncertainty.
• Do not change the content of source elements in XLIFF files. Arbortext
Styler will not be able to match the translation in the XLIFF file with the
translation unit in the stylesheet.
• You must only enter a translation in the target element for the relevant
translation unit. Do not use any other part of the XLIFF file for translation
information.
• Do not delete or change the parameter markers for the target element. They
must remain the same as shown in the source element to allow Arbortext
Styler to match the translations with their source in the stylesheet. You are
permitted to change the order of the markers in the target element.
• Parameter markers that originate from tag pairs must also have both start and
end markers in the translation.
For example, {1} Inside {1} cannot be translated as {1} --inside--.
It must be translated as {1} --inside--{1} to enable correct matching
with its stylesheet source.
• Parameter markers that originate from tag pairs must be nested properly.
For example, {1} start {2} middle {2} end {1} cannot be translated
as {1} xstart {2} xmiddle {1} xend {2}. Tag pairs are not permitted
to overlap in this manner.

Importing Translations of Generated Text

Once you have received a translated XLIFF file from your translator, you must
import it into the stylesheet. The purpose of this action is to match the translations
in the XLIFF file with their source translation units in the stylesheet. When the
source and target have matched, and import of a new translation has succeeded,
Arbortext Styler will mark the translation in the stylesheet as current.
The expected result of an import of translated generated text is a stylesheet where
all the translation units that were marked as needing translation receive their
translations and are marked as current. When this has been done, the correct
language version of generated text will be output when you publish a language
version of your document.

Adding Generated Text 541

Before beginning the import, note that changes to generated text may or may not
have caused a change in the status of its translation:
• If you have created a new translation unit in the stylesheet, or modified the
content of an existing translation unit, its translation will be marked as not
current. It will need a first or new translation to be imported for it to be
marked as current.
• If you have only modified the markup in a translation unit, Arbortext Styler
will not change the status of the translation. These changes can be propagated
to the translation.
You may want to check the status of translations in your stylesheet. Choose the
Tools ▶ View Translation Status menu option to view information on the status of
all the translation units in the stylesheet, as well as the dates the XLIFF files were
last exported and imported. Refer to Translation Statistics on page 544 for a
summary of the information this report contains.
To import translations of generated text:
1. In Arbortext Styler , select the Tools ▶ Import Generated Text menu option to
open the Import Generated Text Translation dialog box on page 983.
The menu option is not available if you have not specified any target
languages for generated text.
2. In the dialog box, select the XLIFF file(s) that you wish to import and click
Import to begin the process.
3. Arbortext Styler will import translations from the XLIFF files into your
stylesheet, according to the following rules:
• If the target value of the trans-unit in an XLIFF file has not
changed since the last import and the translation in the stylesheet is
marked as current - the target is not imported.
• If the target value of the trans-unit in an XLIFF file has not
changed and the translation in the stylesheet is not current, you will
receive a prompt to confirm whether you want the existing translation in
the stylesheet to be marked as current.
○ If you want to mark the existing translation as current, answer Yes.
For example, you may have changed the generated text in the
stylesheet but do not want to change the translation.
○ If you don’t want to change the status of the translation in the
stylesheet, answer No.
For example, you may have changed the generated text in the
stylesheet and intend to change the translation, but have not yet done
so.

542 User's Guide

 • If the target value of the trans-unit in an XLIFF file remains the
same as the source value, and the status attribute still has a value of new,
and the translation in the stylesheet is not current, you will receive a
prompt to confirm whether you want the existing translation in the
stylesheet to be marked as current.
○ If you want to mark the existing translation as current, answer Yes.
For example, it is feasible that the translation is the same as the source.
○ If you don’t want to change the status of the translation in the
stylesheet, answer No.
For example, you may not have translated this generated text yet, but
intend to do so.
• If the target value of the trans-unit in an XLIFF file is different
from the translation in the stylesheet, and the translation in the stylesheet is
marked as not current, the translation will be imported. This is the usual
case - a translation has been requested and is available for import.
• If the target value of the trans-unit in an XLIFF file is different
from the translation in the stylesheet, but the translation in the stylesheet is
already marked as current, you will receive a prompt to confirm that you
want to continue with the import.
○ If you want to overwrite the current existing translation, answer Yes.
For example, you may have refined the translation and wish to apply it.
○ If you wish to maintain the current existing translation, answer No.
• If the source value of the trans-unit in an XLIFF file does not
match the source in the stylesheet, the translation will not be imported. If
you have changed generated text in the stylesheet after exporting the
XLIFF file, you must re-export the XLIFF file.
Note that if you have only changed markup in the generated text, you do
not need to re-export the stylesheet.
4. If you receive an error that reports a tag pair mismatch, correct the target to
ensure it includes balanced and properly nested markers for parameter markers
representing tag pairs. Refer to Guidelines for working with XLIFF files in
XLIFF Files on page 538 for further information.
5. The Arbortext Styler log will display the results of your import. See Import
Generated Text Translation Results Information on page 544 below.
You can import an XLIFF programmatically via API. Please refer to Using ACL
to Import XLIFF Files on page 545 for information.

Adding Generated Text 543

Import Generated Text Translation Results Information
Arbortext Styler provides information about the status of a generated text import,
and how each individual translation unit has been processed, when an import has
finished. This information is written in the Arbortext Styler log window.
The following columns of information are available in the report:
• File Name - The name of the XLIFF file(s) imported during the import process.
• Language - The language(s) imported from the translation file(s).
• Total in Translation File - The number of translation units in each translation
file.
• Total in Stylesheet - The number of translation units in the stylesheet that are
set to be translated for each language. If the stylesheet has not been modified
since the translation file was exported, this column should equal the number in
the Total in Translation File column.
• Updated - The number of translation units in the stylesheet that have been
updated or marked as current for each language, as a result of this import. The
total number of current translation units in the stylesheet may be higher.
• Not Present in Translation File - The number of translation units in the
stylesheet that did not have a corresponding translation unit in the translation
file. This could happen if you edited the stylesheet after the translation file was
created.
• Not Accepted - The number of translation units in the translation file you did
not accept during the import process, by making either of two statements in
dialogs presented during the import process:
○ Do not import
○ Do not mark as current in the stylesheet for this import

Translation Statistics
You may need to check the status of translations of generated text. You can find
this information in several places.

Status of Translations for Current Stylesheet

Select the Tools ▶ View Translation Status menu option to generate a report that
will give you information on the overall status of translations of generated text in
the current stylesheet.
A sample report is shown below:
Stylesheet "mydoctype.style" contains 30 translatable items.
The source language is "en (English)".

Language Translated Not Translated Last Import Date Export Date

544 User's Guide

 Current Not Current
fr(French) 20 5 5 20-Sep-2009 1-Aug-2009
de(German) 25 3 2 25-Sep-2009 1-Aug-2009
Note that Export Date is the date that the file that was last imported was exported.
If you have exported a file, but never imported its translations, this report will
contain no value for Export Date. Dates are localized.
Refer to Importing Translations of Generated Text on page 541 for the process of
marking translations as current or not current.
If the current stylesheet contains no target language definitions, the report will
explain this:
Stylesheet "mydoctype.style" contains 30 translatable items.
The source language is "en (English)".
No target languages have been designated for translation.

Locating Missing or Out of Date Translations

To locate translations that are listed in the translation status report as missing or
not current, choose the Tools ▶ List Translation Defects. This will open the
Translation Defects window. Refer to Translation Defects Window on page 1054
for a summary of information this report contains.

Validating the Stylesheet for Translations

During a Validate Stylesheet action invoked via the Tools ▶ Validate Stylesheet
menu option, Arbortext Styler will provide information about the translation
settings in the stylesheet. The report will list:
• Any target languages for which translations are missing:
Warning: Generated text translations are not current for these languages:
fr (French), de (German)
Choose Tools->View Translation Status or Tools->List Translation Defec
for more details.
• Any differences in the generated text source language of the modules in the
stylesheet
See Ensuring Source Language is Consistent Across Modules in Managing
Translated Generated Text in Stylesheet Modules on page 547 for further
information.
• Any translation units that display duplicate IDs
See Ensuring Translation Units have Unique IDs in Managing Translation
Units on page 532 for further information.

Using ACL to Import XLIFF Files

Arbortext Styler includes an API to automatically import XLIFF files that contain
translations of generated text. The API includes the following functions:

Adding Generated Text 545

• stylesheet_import_xlf - imports the XLIFF file and provides some
statistics about the import. Specify the XLIFF file to import, the stylesheet it
should be associated with, and how questionable translations should be
handled during the import.
• stylesheet_gentext_lang_stats - provides statistical information
about the translation status of the stylesheet. Define the target translation
language from the stylesheet for which to provide statistics.
You can use the functions in either of the following ways — note that it is not
essential that a user document is opened:
• Open a user document that uses the stylesheet and then perform these
operations by passing in the user document
• Open the stylesheet directly and pass it in

Sample ACL Code Calling stylesheet_import_xlf and

stylesheet_gentext_lang_stats
function test(doc_id, xlf_file)
{

local stats[]

local ret = stylesheet_gentext_lang_stats('de', stats, doc);

local total = stats['total'];

local current = stats['current'];
local ecurrent = stats['effectivecurrent'];
local notcurrent = stats['notcurrent'];
local enotcurrent = stats['effectivenotcurrent'];
local untranslated = stats['untranslated'];
local euntranslated = stats['effectiveuntranslated'];

if (ret == 0)
{
response("Call to stylesheet_gentext_lang_stats failed");
}
else
{
response("Stats: total=$total, current=$current($ecurrent), not current=$notcurr
}

# Flags are set to 0, will reject for the 3 documented circumstances.

local stats[]
ret = stylesheet_import_xlf('c:\test.xlf', 0, stats, doc);

local xlfTotal = stats['xlftotal'];

local ssTotal = stats['sstotal'];
local rejected = stats['rejected'];

546 User's Guide

 local updated = stats['updated'];
local found = stats['found'];
local missing = stats['missing'];

if (ret == 0)
{
response("Call to stylesheet_import_xlf failed");
}
else
{
response("Import results: xliff total=$xlfTotal, stylesheet total=$ssTotal
}
}

Managing Translated Generated Text in Stylesheet

Modules
Arbortext Styler requires that all modules of a stylesheet have the same generated
text source language. It monitors the stylesheet in the following stages of
development:
• When you create a new stylesheet module, its generated text source language
will match that of the stylesheet.
• When you add a module to the stylesheet, Arbortext Styler assesses whether
the added module has the same generated text source language as the
stylesheet. If it has a different source language, you will see a warning
message explaining the differences. The module will not be added.
[A23948] The generated text source language ("fr (French)") for the module
"translated_gentext-module.style" does not match the source language of the
stylesheet ("en (English)". The Source language must match before the
module can be added.
• A validate stylesheet action invoked via the Tools ▶ Validate Stylesheet menu
option will report any differences in the generated text source language of
modules.

Adding Generated Text 547

 20
Cross References and Other Links
Cross Reference and Linking Overview..................................................................... 550
Creating a Cross Reference Format Object ............................................................... 551
Creating Cross References and Cross Reference Formatting ..................................... 551
Modifying Default Cross Reference Formatting .......................................................... 563
SFEs to Support Linking .......................................................................................... 565

This section describes how to manage cross references, links, and dynamic link
information via your stylesheet.

549
Cross Reference and Linking Overview
Arbortext Styler lets you configure cross references and links for your document,
whereby you can create links between elements in the document, or between
elements in multiple documents. There are three principal ways in which this can
be achieved:
• Cross reference - Configuring elements to automatically generate the text upon
which the user will click. Allocate the Cross Reference style to the element
that should generate the reference. Note that the target element of a cross
reference of this nature must fall under one of the following two categories:
○ An element styled as Division or Formal Block that has an ID and a title.
The target ID you are cross referencing can either appear on the division or
formal block element itself or on its title element.
It is possible to cross reference an element that does not have a title, but
this must be achieved via a non-standard process. See Creating Cross
References and Cross Reference Formatting on page 551 for further
information.

Note
You must ensure that you create and/or maintain a context for the use
of the title element in the element being cross referenced. For example,
if you are cross referencing a chapter, you must maintain the context
title in chapter in Arbortext Styler, and ensure that the
occurrence of chapter in your document includes an ID.

○ An element that has an ID and that is numbered

You can create pseudo-numbering for a non-numbered element, to allow
cross reference linking. Refer to Configuring Pseudo Numbering for Non-
Numbered Elements to Permit Links on page 563 for further information.
• Simple internal link - Manually authoring the text that the user will click on.
Allocate the Link style to the element that should generate the reference
Creating a Cross Reference Format Object on page 551 and Creating Cross
References and Cross Reference Formatting on page 551 deal mainly with the first
method of creating a cross reference, i.e. via the Cross Reference style, but Styling
an element as a cross reference does contain an example of how to create a simple
internal link.
Documents with cross references are easier to maintain than those with links, but
cross references do only work within a single document.

550 User's Guide

When you configure an element that generates the cross reference, you have the
opportunity to select a format in which the cross reference should be displayed. To
support this, the Cross References list contains a list of all cross reference
formats currently available in the stylesheet, and permits you to create formats of
your own. Note that, if you choose a cross reference format that includes a request
to display the target element's number in the reference text, you must be linking to
an element that is set to display its number, such as a division or a formal block.
Otherwise you can cross reference to any object that has an ID associated with it.

Creating a Cross Reference Format

Object
To create a new cross reference format object, select the Insert ▶ Cross Reference
menu option. The Cross References list will open, if it is not already active,
and the new cross reference object will be added to the list with the name
ReferenceFormat. Once you have renamed the object you can invoke the
Generated Text Editor, by clicking the Edit button in the Cross References
window, via which you can format the cross reference and add text, numbering,
fills, graphics and any other content you wish your cross reference to display,
either static or dynamic.
Once you have created the cross reference format object you can reference it from
whichever element in the stylesheet you select to generate the cross reference. See
Creating Cross References and Cross Reference Formatting on page 551 for
details.

Creating Cross References and Cross

Reference Formatting
You can configure an element in your stylesheet to generate a cross reference to
another element by applying a cross reference format to an element styled as a
cross reference.
Some examples are included below:
• Creating a basic internal document link on page 554
• Defining output-specific cross reference formatting on page 555
• Specifying cross reference formatting based on attribute values on page 556
• Specifying cross reference formatting for references to a particular element on
page 556
• Cross referencing to an alternative title element on page 557
• Cross referencing to an element that does not have a title on page 559

Cross References and Other Links 551

• Cross referencing to an element whose title is hidden on page 562
• Configuring pseudo numbering for non-numbered elements to permit links on
page 563

Example: Creating a Basic Cross Reference

This example describes how to create a cross reference from a paragraph to a
chapter division. Note that you could, if required, also link to the title of the
chapter if your chapter titles are the elements that include an ID.
1. In Arbortext Editor, open the transport.xml sample document located at
Arbortext-path/samples/styler.
2. Choose Styler ▶ New Stylesheet to create a new stylesheet. Click OK in the
Stylesheet Properties dialog box that appears, to accept the default settings for
the stylesheet.
3. In Arbortext Styler, deselect the View ▶ Only Elements In Document option to
list all elements in the stylesheet, rather than just those that have been used in
your document.
4. Select the xref element (or applicable context) in the Elements list, and
assign it the Cross Reference style via the Edit ▶ Style menu option, if this has
not already been done.
5. In the Cross References Details dialog box that appears, choose linkend as the
Reference attribute.

If the Cross Reference style had already been applied to the element when you
selected it in the previous step, you will need to use the Edit ▶ Edit Style Details
menu option for the element to access the Cross Reference Details dialog box.
6. Choose Label Number Text Page as the format, then click OK to exit the
dialog box. This will advise Arbortext Styler to output the label, the division
number, and the text content of the title, as well as the page number in which
the title appears, as the text of your cross reference. This is a default cross
reference format already configured for the axdocbook.style stylesheet -
there are others that define other content for the reference, or you may create
your own format. Refer to Creating a Cross Reference Format Object on page
551 for further information.
Refer to the Generated text category for the xref context - you will see that
details of the cross reference formatting applied to the element are shown in
the After-text field. Click the Edit button to open the Generated Text Editor and
elect to modify the attributes of the CrossReference object. You will see
that the settings you made in previous steps of this procedure are shown in the
Modify Cross Reference dialog box:

552 User's Guide

7. In Arbortext Editor, add a new para within abstract, and add the
following sentence: Refer to xref for more information, adding the
xref tag around the word xref:

The Modify Attributes dialog box for the xref element opens.
8. Type intro as the value of the linkend attribute, and then click OK, thus
specifying the target ID of the cross reference.
9. Click to the right of the first chapter element in the document, and then
choose Edit ▶ Modify Attributes.
10. Type intro as the value of the id field, and then click OK.
11. In Arbortext Styler, select the chapter element in the Elements list, choose
Division as its style, and then click OK in the Division Details dialog box.
12. Select the title in chapter context in the Elements list.
13. Select Print/PDF output from the Outputs to Edit list, then go to the
Generated text category for the context.
14. Check the Number option in the Numbers and bullets field if this has not
already been done, then click the Details button to open the Division Title
Number dialog box. In the next steps you will set the format of the title when it
appears in a chapter, which in turn will be shown as the text of your cross
reference.
15. In the Label field, type Chapter followed by a space.
16. If you want punctuation to appear after the number in the cross reference, but
not in the chapter title when it appears in the body of the document, enter it in
the Suffix (does not appear in references) field in the dialog box. For example,
if you want a chapter title to read 1. Chapter 1 but the reference mark to
simply show Refer to Chapter 1 Introduction, page 1 (i.e. with no period),
enter the period character in the Suffix (does not appear in references) field.

Cross References and Other Links 553

17. Click OK to save the numbering setting and exit the dialog box.
18. Choose Preview ▶ Print.
In the Print Preview window, note that the second paragraph in the document
now contains the following cross reference Refer to Chapter 1.
Introduction, page 1 for more information.
If you want to create a cross reference for which you author the clickable text,
rather that it being generated automatically, the process is similar but involves
styling an element with the Link style rather than the Cross Reference style.

Creating a Basic Internal Document Link

1. In Arbortext Editor, open the transport.xml sample document located at
Arbortext-path/samples/styler.
2. Choose Styler ▶ New Stylesheet to create a new stylesheet. Click OK in the
Stylesheet Properties dialog box that appears, to accept the default settings for
the stylesheet.
3. In Arbortext Styler, deselect the View ▶ Only Elements In Document option to
list all elements in the stylesheet, rather than just those that have been used in
your document.
4. Select the link element (or applicable context) in the Elements list, and
assign it the Link style via the Edit ▶ Style menu option, if this has not already
been done.
5. In the Link Details dialog box that appears, choose linkend as the Reference
attribute.

If the Link style had already been applied to the element when you selected it
in the previous step, you will need to use the Edit ▶ Edit Style Details menu
option for the element to access the Link Details dialog box.
6. In Arbortext Editor, add a new para within abstract, and add the
following sentence: Refer to the following section for more
information, adding the link tag around the words following
section:

The Modify Attributes dialog box for the link element opens.
7. Type intro as the value of the linkend attribute, and then click OK to
close the dialog box, thus specifying the target ID of the link.
8. Click to the right of the first chapter element in the document, and then
choose Edit ▶ Modify Attributes.
9. Type intro as the value of the id field, and then click OK.

554 User's Guide

10. In Arbortext Styler, select the chapter element in the Elements list, choose
Division as its style, and then click OK in the Division Details dialog box to
accept 1 as the level of the division.
11. Choose Preview ▶ Print.
In the Print Preview window, note that the second paragraph in the document
now contains the following cross reference Refer to the following
section for more information.
You can also create different formats for cross references based on the type of
output, or on the type of element that is the target of the cross reference. For
example, if you have a cross reference element that can refer to two types of
element, for example elements with titles and numbered elements that are not
titles, you may require the cross reference to include the content of the title in the
first case, but leave out the title in the second. The ways in which formatting of
this nature can be applied is described in the examples shown below:

Defining Output-Specific Cross Reference

Formatting
To advise that a cross reference should be formatted in a particular way when the
original document is output in HTML format:
1. In Arbortext Styler, select HTML File from the Outputs to edit list.
2. Select the xref element in the Elements list, and then go to the Generated
text category.
3. Click Edit next to After-text.
4. Click to the right of the Cross Reference element, and then choose Edit ▶
Modify Attributes.
5. Choose Label Number Text as the Reference format, and linkend as the
Reference attribute.
6. Click OK.
7. Choose File ▶ Apply and Close to exit the Generated Text Editor.
8. In Arbortext Editor, choose File ▶ Publish ▶ HTML File.
In the browser, note that the second paragraph in the document now has the
following cross reference: Refer to Chapter 1 Introduction for
more information.

Cross References and Other Links 555

Specifying Cross Reference Formatting Based on
Attribute Values
To specify the formatting that should be applied to a cross reference when the
author sets the value of the role attribute on the xref element:
1. In Arbortext Styler, select the xref element in the Elements list, then choose
Insert ▶ Condition.
2. Click New Attribute Test in the New Condition dialog box to open the Attribute
Test dialog box.
3. Select role as the Attribute Name, and then select the Comparison option.
4. Choose = as the Comparison operator, and type number in the Comparison
text box
5. Click OK, and then click OK to exit the Condition dialog box.
6. In the Elements list, select the condition you just created and navigate to the
Generated text category.
7. Click Edit to the right of the After-text field.
8. In the Generated Text Editor, click to the right of the Cross Reference
element, and then choose Edit ▶ Modify Attributes.
9. Choose Number as the Reference format, and linkend as the Reference
attribute.
10. Click OK.
11. Choose File ▶ Apply and Close to exit the Generated Text Editor.
12. In Arbortext Editor, choose File ▶ Print Preview.
In the Print Preview window, note that the xref with the role=”number”
attribute demonstrates the cross reference: Refer to 1 for more
information. because it's using generated text configured for the condition
if attribute “role”=“number”.

Specifying Cross Reference Formatting for

References to a Particular Element
To use an XPath expression to specify the formatting for cross references whose
linkend attribute defines a reference to a listitem element only:
1. In Arbortext Styler, select the xref element (or applicable context) in the
Elements list, and then choose Insert ▶ Condition to define a condition for this
element.
2. In the New Condition dialog box, click New XPath Test to open the New XPath
Test dialog box.

556 User's Guide

3. Enter the XPath expression name(id(@linkend))='listitem' to
advise Arbortext Styler that the formatting will apply to listitem elements
that are given as targets of the cross reference. Click OK to exit the XPath
dialog box.
4. In the New Condition dialog box, select the Condition Type as applicable and
click OK, to exit the dialog box.
Note that here you can test for multiple numbered element names. Two
methods apply:
• Include multiple tests in a single XPath expression
• Define a separate XPath expression for each element and select the Any
test is true option in the Condition dialog box
5. Select the condition you just created in the Elements list then navigate to the
Generated text category.
6. Click Edit to the right of the After-text field.
7. Click to the right of the Cross Reference element, and then choose Edit ▶
Modify Attributes.
8. Choose Number as the Cross reference format, and linkend as the Reference
attribute.
9. Click OK.
10. Choose File ▶ Apply and Close in the Generated Text Editor.
11. In Arbortext Editor, choose File ▶ Print Preview to confirm that the Number
formatting style has been applied to your cross reference.

Cross Referencing to an Alternative Title Element

The procedure detailed below describes how to cross reference to a chapter that
can include both a title and a subtitle element. The cross reference will be
configured so that it points to the subtitle element if one exists for the chapter,
or to the regular title element if a subtitle does not exist. The procedure uses
the existing cross reference format object Label Number Text as its basis.
1. In Arbortext Editor, open the transport.xml sample document located at
Arbortext-path/samples/styler.
2. Choose Styler ▶ Edit Stylesheet to open the associated stylesheet for edit. This
is a read only stylesheet so you will need to save a local copy if you want to
make amendments.
3. Back in Arbortext Editor, add a subtitle element directly after the title in
the second chapter, and add some alternative title text.
4. Give the id attribute of the second chapter element a value of chap2, and set
the value of the same attribute on the third chapter to chap3.

Cross References and Other Links 557

5. Add two xref elements into the text somewhere at the beginning of the
document - one with the attribute linkend=”chap2”, i.e. pointing to the second
chapter, and one with the attribute linkend=”chap3”, i.e. pointing to the third
chapter. Note that neither cross reference currently displays any link text.
6. In Arbortext Styler, give the subtitle element the Title style via the Edit ▶
Style menu option. If the element already has this style, you can skip this step.
7. Create a context for the subtitle in a chapter, and style it as required.
8. In the Cross References list , copy the Label Number Text cross
reference format object, and paste the copy into the same list with a new name,
for example Label Xref Title.
9. In the properties list for the object, click the Edit button to open the Generated
Text Editor. Place your cursor to the right of the existing ElementContent
element, and choose the Edit ▶ Modify Attributes menu option. The Modify
Element Content dialog box opens.
10. Select the By XPath and Insert only content options, and add the XPath
expression shown below to the field:
self::node()[not(following-sibling::subtitle)]|following-sibling::subtitle

Note that the expression assumes the context node for the expression is the
title element. The expression will select subtitle if it exists, or title
if a subtitle does not exist.
Click OK to save the content setting and exit the dialog box. Click File ▶ Apply
and Close to exit the Generated Text Editor.
11. In the Elements list, give the xref element the Cross Reference style if this
has not already been done, via the Edit ▶ Style menu option. If the element
already has this style, choose the Edit ▶ Edit Style Details for the element. In
either case, the Cross Reference Details dialog box opens. Configure the
settings for the cross reference object as shown below, then click OK to exit
the dialog box.
• Reference attribute - linkend
• Select a cross reference format - Label Number Text

Here you have styled any cross references that point to elements other than
chapter such that they will use the Label Number Text format to output
the chapter number and title text as the link text.
12. Still in the Elements list, create a condition for the xref element, via the
Insert ▶ Condition menu option. The Condition dialog box opens.
13. Choose the New XPath Test button to open the XPath test dialog box. In the
expression field, enter the XPath expression shown below:
name(id(@linkend))='chapter'

558 User's Guide

 Click OK twice to save the condition and exit the two dialog boxes. The
condition If XPath expression (name(id(@linkend))=
’chapter’) is true now appears in the Elements list.
14. Navigate to the Generated text category for the condition and click the Edit
button next to the After-text field. In the Generated Text Editor, modify the
attributes of the existing CrossReference element and change the value of
the Cross reference format field to Label Xref Title. Click OK to save the
change and exit the dialog box. Click File ▶ Apply and Close to save the
generated text setting and exit the editor.
Here you have styled cross references that point to chapter elements such that
they will use the Label Xref Title format to output the chapter subtitle if
it exists, or the chapter title if a subtitle does not exist, as the link text.
15. Choose Preview ▶ Print. In the print preview window, note that the cross
reference to the second chapter outputs the chapter's subtitle as its link text,
while the cross reference to the third chapter has the chapter's title as its link
text.
Note also that the subtitle for the second chapter is included in the table of
contents (TOC) for the document. This is because it is styled as a title context
and given the same TOC settings as the title in chapter context. To
remove the subtitle from the TOC, invoke the Customize Table of Contents
dialog box for the relevant table of contents format object and make the
necessary changes. See Customize Table of Contents Dialog Box on page 937
for information.

Cross Referencing to an Element That Does Not

Have a Title
The steps detailed below describe how to generate a cross reference to a
caution element, which does not have a title element, and output the text
caution, page and the page number upon which the caution appears as the
text for the cross reference. To mimic usual cross reference linking procedure you
must create a pseudo title, represented by a User Formatting Element (UFE), for
the caution element. The UFE does not need to contain any content, so
including it will not affect the appearance of the caution element.
1. In Arbortext Editor, open the transport.xml sample document located at
Arbortext-path/samples/styler.
2. Choose Styler ▶ Edit Stylesheet to open the associated stylesheet for edit. This
is a read only stylesheet so you will need to save a local copy if you want to
make amendments.

Cross References and Other Links 559

3. Choose InsertCross Reference to create a new cross reference format object in
the Cross References list . Rename the object caution.
4. Click the Edit button to open the Generated Text Editor for the object.
5. Type the text caution, page followed by a space. Choose Insert ▶ Page
Number to insert a PageNumberReference gentext object. You have now
set the clickable text that will be output for the cross reference.
6. Click File ▶ Apply and Close to save the gentext setting and exit the editor. The
window in the property area shows the setting you have made:

7. In the Elements list, select the xref element. This element has the Cross
Reference style in the default stylesheet for the sample file - if this is not the
case, use the Edit ▶ Style menu option to assign that style to the element.
8. Navigate to the Generated text category and click the Edit button next to the
After-text field to open the Generated Text Editor.
9. Place your cursor to the right of the CrossReference element and click
Edit ▶ Modify Attributes to open the Modify Cross Reference dialog box.
10. In the Cross reference format field, select caution. Click OK to exit the
dialog box.
11. Click FileApply and Close to save the change and exit the editor. The After-text
field shows the change you have made to the format of the cross reference:

12. In the Elements list, choose Insert ▶ Element to create a new element. Here you
are creating a User Formatting Element (UFE), so name the element
accordingly, for example _ufe:caution-title.
13. Assign the Title style to the UFE, via the Edit ▶ Style menu option.
14. Choose Insert ▶ Context to create a new context for _ufe:caution-
title. The New Context dialog box opens.
15. Click the New Ancestor button and select caution from the ancestor drop
down menu. Note that field at the top of the dialog box now reads
_ufe:caution-title anywhere in caution.

560 User's Guide

16. Click OK to save the new context and exit the dialog box. The new context
now appears in the Elements list, described as _ufe:caution-title
anywhere in caution.
17. In the Elements list, select the caution element. This element has the
Formal Block style in the default stylesheet for the sample file - if this is not
the case, use the Edit ▶ Style menu option to assign that style to the element.
18. Note the Description of the caution element - you can see that the element
has a separate generated text setting for Print/PDF output. The final step of
this procedure is to preview the sample document for PDF output so you must
make sure that you edit the Print/PDF option, rather than the overall Base
(All Outputs) option.
19. In the Outputs to Edit field, select the Print/PDF option.
20. Navigate to the Generated text category and click the Edit button for the
Before-text field. The Generated Text Editor opens.
21. Place your cursor before the markup in the field, then choose Insert ▶ User
Formatting Element. Select _ufe:caution-title from the list of UFEs
that appears.
22. Choose File ▶ Apply and Close to save the changes and exit the editor. The
Before-text field shows the change you have made to the generated text for the
caution element in Print/PDF output.

Cross References and Other Links 561

23. In Arbortext Editor, navigate to Chapter 2 of the sample document and add a
caution element after the first para element and give it some random text.
Set the id attribute of the element to caution.
24. Navigate back to the abstract element at the start of the document. Insert a
new para element into the element.
25. In the para element, add the text Refer to for further
information.
26. Place your cursor between the words to and for and insert an xref element.
The Modify Attributes dialog box appears for the xref element.
27. Set the value of the linkend attribute to caution. Click OK to exit the dialog
box. The text is updated to reflect the addition of the cross reference.

28. In Arbortext Styler, choose PreviewPrint. In the print preview window that
appears, note that the cross reference in the abstract element is updated to
read Refer to caution, page 3 for further information. Click on the cross
reference to be taken to the caution element.

Creating Cross References to Elements with Hidden

Titles
Cross references to a division or formal block whose title is hidden will only be
included in output if one of the following conditions is true:
• The title’s content is inserted in its own generated text
• The title’s content is inserted inside a User Formatting Element (UFE) that:
○ is styled as a title and
○ appears within the formal block / division and
○ is configured as shown in the Creating a numbered caption or title for a
figure on page 496 example
If neither of the above is true, and a cross reference to a hidden title is required,
use a property set to hide the title (instead of setting the Hidden property explicitly
for the context or condition).

Note
If you are using a UFE to output the title, as described in the bullet point
above, the title must be hidden explicitly, not by property set reference.

562 User's Guide

Configuring Pseudo Numbering for Non-Numbered
Elements to Permit Links
If you wish to cross reference to an element that is not numbered, you will need to
configure pseudo numbering for the element to allow the generation of cross
references. Use the following steps:
1. Create a dummy condition for the element/content to be numbered.
For example, create a condition that will match an XPath test of 0, i.e. If
XPath expression (0) is true.
This expression will never actually output numbers for the element/context, as
it will never match.
2. Navigate to the Gentext tab for the condition.
3. Select the Number option to set the condition to be numbered.
You should now be able to generate valid cross references to occurrences of the
element/context.

Modifying Default Cross Reference

Formatting
There are two Styler Formatting Elements for formatting cross references,
_sfe:CrossReference and _sfe:CrossReferenceTitle. The
_sfe:CrossReference element wraps the entire cross reference, while the
_sfe:CrossReferenceTitle element wraps text extracted from the target's
title when text is included in the cross reference format (for example, the Label
Number Text format).
You can change the properties of the _sfe:CrossReference element to
change the formatting of the entire cross reference. Change the properties of the
_sfe:CrossReferenceTitle element if you only want to change the title
text formatting.

Example: Changing the Formatting of Arbortext Styler Cross

Reference Elements
1. In Arbortext Styler, deselect the View ▶ Only Elements In Document option to
list all elements in the stylesheet, rather than just those that have been used in
your document.
2. Select the xref element in the Elements list, and style it as a Cross Reference
via the Edit ▶ Style menu option.
3. In the Cross Reference Details dialog box, choose linkend as the Reference
attribute.
4. Choose Label Number Text Page as the format, then click OK.

Cross References and Other Links 563

5. In Arbortext Editor, add a new para within abstract, and add the content
Refer to <xref> for further information

6. Select the xref tag, and choose Edit ▶ Modify Attributes.

7. Type intro in the linkend field, then click OK.
8. Click to the right of the first chapter element in the document, then choose
Edit ▶ Modify Attributes.
9. Type intro in the id field, and then click OK.
10. In Arbortext Styler, select the chapter element in the Elements list, choose
Division as its style, then click OK in the Division Details dialog box.
11. Select the title in chapter context for the title element in the
Elements list, then go to the Generated text category.
12. Click Details in the Bullets and Numbers field.
13. Type Chapter followed by a space in the Label field, and then click OK.
14. Choose Preview ▶ Print.
In the Print Preview window, note that the second paragraph in the document
now has the following cross reference: Refer to Chapter 1 Introduction, page 2
for more information.
15. In Arbortext Styler, check the View ▶ Styler Formatting Elements menu option
to ensure that all Styler Formatting Elements (SFEs) defined for the stylesheet
are displayed in the Elements list.
16. Select the _sfe:CrossReferenceTitle element, and go to the Text
category.
17. Change Italic to No.
18. Specify Red as the Text color and set Bold to Yes.
19. Choose File ▶ Print Preview.
In the Print Preview window, note that the title text, Introduction, in the cross
reference in the second paragraph is now bold and red. To have the whole of
the cross reference text displayed in bold red font, carry out steps 16–18 but
choose the SFE _sfe:CrossReference in step 16.

Cross Referencing a Title that Contains Footnotes

If you elect to create a cross reference to a title that contains footnotes, you may
encounter error messages of the form shown below when composing your
document:
[A12531] ERROR: Styldesc counter variable "cnt__footnote_default_footnotes.cnt"
is modified in the pagedesc.

564 User's Guide

You will also see the footnote reference with the title in the cross reference text,
and a footnote will appear on the page.
To avoid this situation, create the context footnote anywhere in
_sfe:xxxx for the relevant generated text element, and set the value of the
Hidden field in the Text category to Yes for that context. For example, if you
create the context footnote anywhere in _sfe:CrossReference, it will
be matched for footnotes in cross references and neither the footnote reference nor
the footnote will appear when the title appears in the cross reference text. As
another example, you could create the context footnote anywhere in
_sfe:Gentext. In this case you will ensure that footnote references will be
hidden when the title appears in headers, footers, tables of contents, and cross
references.

SFEs to Support Linking

Two Styler Formatting Elements (SFE) support the creation and maintenance of
dynamic links. One of the many benefits of a dynamic link is that it is possible to
author it from an element in the document type that is not defined as a link
element. Arbortext Styler inserts Styler Formatting Elements styled as Link during
the link creation process, which act as pseudo link elements and means that a
specific link element in the document type is not required.

_sfe:InternalLink
This generated text tag represents an internal link. It is listed with other SFEs in
the Elements list. It is styled as a Link and contains the document target attribute
targetId. Whilst you are not permitted change the style or the style details for the
element, you can change its formatting properties. When inserted into generated
text via the generated text editor to create a link, the element contains two
children, each of which may have content. The markup shown below is inserted
by Arbortext Styler:
<_sfe:InternalLink>
<_gte:LinkTarget>xxx</_gte:LinkTarget>
<_gte:LinkContent>yyy</_gte:LinkContent>
</_sfe:InternalLink>
Where:
_gte:LinkTarget should define the target of the link. xxx can be any
combination of attribute content, element content, an XPath expression or
authored text. This tag is expected to have content - you will not be permitted to
exit the Generated Text Editor if you attempt to save this tag without content, or
with just whitespace.

Cross References and Other Links 565

_gte:LinkContent should define the clickable text that will appear in the
final document. yyy can be any content. The content defined for this element will
be styled in the final document according to the style properties of
_sfe:InternalLink.

_sfe:ExternalLink
This generated text tag represents an external link. It is listed with other SFEs in
the Elements list. It is styled as a Link and contains the web target attribute href.
Whilst you are not permitted change the style or the style details for the element,
you can change its formatting properties if you wish. When inserted into
generated text via the generated text editor to create a link, the element contains
two children, each of which may have content. The markup shown below is
inserted by Arbortext Styler:
<_sfe:ExternalLink>
<_gte:LinkTarget>xxx</_gte:LinkTarget>
<_gte:LinkContent>yyy</_gte:LinkContent>
</_sfe:ExternalLink>
Where:
_gte:LinkTarget should define the target of the link. xxx can be any
combination of attribute content, element content, an XPath expression or
authored text. This tag is expected to have content - you will not be permitted to
exit the Generated Text Editor if you attempt to save this tag without content, or
with just whitespace.
_gte:LinkContent should define the clickable text that will appear in the
final document. yyy can be any content. The content defined for this element will
be styled in the final document according to the style properties of
_sfe:ExternalLink

566 User's Guide

 21
Graphic Support
Supporting Intelligent Graphics Sets ......................................................................... 568
PDF Graphics ......................................................................................................... 570
Publishing PDF with 3D Graphics ............................................................................. 571

This section describes options for using graphics in your output.

567
Supporting Intelligent Graphics Sets
Arbortext Editor enables you to develop a set of related intelligent graphics that
can be displayed in the same Arbortext IsoView control in published HTML
output. When the graphics set is initially displayed in an HTML document, the
first graphic in the set is displayed in the control. You can develop links that will
change the graphic displayed in the control based on which graphic in the set is
the target of the link.
Support for graphics sets must be added to the stylesheet associated with a
document type. This support is already added to the default .style files for the
Arbortext XML DocBook and the DITA document types. If you use a different
stylesheet for these document types or if you have your own custom document
type with its own stylesheet, then you must explicitly add support for intelligent
graphics sets to your .style file.
To support intelligent graphics sets, you must have a tag in your document type
that can contain multiple graphic tags. Also, this container tag must have an
attribute to which you can assign an attribute value that flags the tag as containing
an intelligent graphics set. The suggested attribute value is viewer.
For example, in the DITA document types, the fig tag can contain multiple
image tags that reference the actual graphics. The fig tag also has an
outputclass attribute to which the value viewer can be assigned.
In the Arbortext XML DocBook document type, the mediaobject tag can
contain multiple imageobject tags. Each imageobject tag contains an
imagedata tag that references the actual graphic. The mediaobject tag also
has a role attribute to which the value viewer can be assigned. Your document
type must have a similar set of tags to support intelligent graphics sets.
Follow these steps to add support for intelligent graphics sets to the .style file
for your document type:
1. Use Arbortext Styler to style the tags you will be using for intelligent graphics
sets.
Be sure to assign the Graphic style to the tag that references the actual graphic.
Also, be sure to use the Graphic Details dialog box to assign the relevant
attribute values to this graphics tag.
2. Use Arbortext Editor to edit your .style file.
3. Select Find ▶ Find Tag/Attribute to open the Find Tag/Attribute dialog box.
4. Enter GraphicDetails in the Tag Name field and click the Find Next
button.
Search through the file until you find the GraphicDetails tag associated
with the graphics tag you are using for intelligent graphics sets. For example,
in the Arbortext XML DocBook document type the imagedata tag

568 User's Guide

 references the actual graphic in a graphics set. In the DITA document types,
the image tag references the actual graphic in a graphics set.
5. Place your cursor inside of the GraphicDetails tag and select Insert ▶
Markup to open the Insert Markup dialog box.
6. Select the AtgraGraphicInfo tag in the Insert Markup dialog box and click the
Insert button to insert that tag inside of the GraphicDetails tag associated
with your graphics tag.
If you have the Force Required Attributes Edit preference selected, the Modify
Attributes dialog box opens. Otherwise, you must select the
AtgraGraphicInfo tag and select Edit ▶ Modify Attributes to open the
dialog box.
7. In the Modify Attributes dialog box, enter values for the following
AtgraGraphicInfo tag attributes:
• atgraGraphicSetAttrName — The name of the attribute on the tag that
contains the graphic set tags to which the value that flags the tag as
containing a graphics set can be assigned.
For example, in the Arbortext XML DocBook document type the role
attribute on the mediaobject tag is the attribute used for this purpose.
• atgraGraphicSetAttrValue — The attribute value that is assigned to the
atgraGraphicSetAttrName attribute that defines the tag as a container for
graphics sets.
It is suggested that you use viewer for this value.
• atgraGraphicSetWrapper — The name of the tag that contains the graphics
set.
For example, in the Arbortext XML DocBook document type the
mediaobject tag is the container tag for graphics sets.
8. Close the dialog boxes.
9. Save and close your .style file.
Your .style file now supports intelligent graphics sets.

Example
Here is how the tagging for the imagedata tag in the .style file for the
Arbortext XML DocBook document type appears in Arbortext Editor:

Graphic Support 569

PDF Graphics
Arbortext Styler supports the inclusion of PDF graphics in documents published
to PDF output. It provides options that specify the pages of the PDF graphic to be
included in the document output.
There are two options for specifying the pages of a PDF graphic to use:
• Single page (default)
Set the value of an XML attribute with the View role
Here it is assumed that an XML document includes an image element that
references a PDF graphic.
1. In the stylesheet, style image as a Graphic and then edit the style
2. In the Graphic Details dialog box, specify which attribute of image should
have the View role, for example rev
For more information, see Graphic Details Dialog Box on page 978.
3. Set the value of the rev attribute for the image element in XML source to
the number of the page in the PDF graphic that should be included in PDF
output
The specified page is output by Arbortext Styler when generating PDF with
the PTC APP engine.
• Multiple pages or a range
Use the Graphic category for a context, condition or property set to provide
more specific control over the pages in a PDF graphic to be output
1. Select the required context or condition (for an element styled as Graphic)
or property set in the stylesheet and navigate to the Graphic property
category
2. Use the Page selection field, select the method of determining which pages
of a PDF graphic to output:
○ <Derive>
○ Show all pages from PDF — include all pages
○ Use a custom page range — specify the range of pages to be included

570 User's Guide

 You can specify the range in the Page range field in a number of ways:
◆ Simple range, for example 1–3
◆ Range with open start, for example -3 (all pages up to and
including 3)
With this option you do not need to know the page number of the
initial page of the PDF
◆ Range with open end, for example 3– (all pages from page 3 to last
page)
With this option you do not need to know the page number of the
final page of the PDF
◆ Range with open start and end, i.e. - (all pages)
With this option you do not need to know the page number of the
initial or final page of the PDF
You can also use a combination of page range and single pages,
separated by a comma, for example:
1–3, 5
1–3, 10–15
○ Use Graphic 'view' role attribute — use the value of the attribute of the
element styled as Graphic that has the View role as the page number to
include (see above)
The specified pages are output by Arbortext Styler when generating PDF with
the PTC APP engine.
For information on inserting PDF graphics into XML content, see Vector Graphics
in Arbortext Editor help.

Publishing PDF with 3D Graphics

We have been able to embed 3D graphics in web-based output. We also supported
using U3D in PDF when using Layout Developer. Now you can publish to PDF
with U3D graphics when using Styler stylesheets.
There is nothing special to do from a stylesheet point of view. An element styled
as a Graphic can link to a U3D graphic file and this will be included in the PDF
when publishing. Arbortext Layout Developer provides tools for interacting with
the embedded U3D graphic, so if this is required consider using a native template
as the volume of source code necessary to do this will be challenging to achieve in
the Styler interface.

Graphic Support 571

If the XML content links to a PVZ file in Windchill, a U3D secondary content
item should be created (and this can be done automatically on check-in) for the
Arbortext Print Publishing engine to use to generate the PDF. The fall-back to the
U3D secondary content item will occur naturally in order to be embedded in the
PDF.

572 User's Guide

 22
Multimedia Support
Introduction............................................................................................................. 574
Styling and Publishing Video and Audio Content ........................................................ 574

This section describes options for using multimedia files.

573
Introduction
Arbortext Styler provides the ability to style certain elements as ‘multimedia’.
This is different from ‘graphic’ as multimedia requires different settings. To
support this, a new style type has been added to Styler, Multimedia, and a new
formatting category available for items styled with that type. This document will
provide information on how to use these settings and options.
Arbortext Styler publishing supports MP4 for video and MP3 for audio.
Also supported is the ability to use U3D graphics when publishing to PDF. U3D is
one of the 3D graphic formats supported by PDF and is also an export type
supported by Creo Illustrate.

Note
InArbortext Styler 8.2.0.0, the Flash multimedia containers which allowed
controllers for audio and video content when publishing to PDF have been
removed. This is necessary as Adobe Acrobat no longer supports Flash in this
way.

Styling and Publishing Video and Audio

Content
Introduction
Styler now provides a new style in support of publishing multimedia to PDF and
HTML. This topic describes how to make that work in your Styler stylesheet.

Styling Elements for Multimedia

The Styler list of applicable styles now contains an option to style an element as
‘Multimedia’. The graphic below shows where to find that option in the list.

574 User's Guide

When this style is applied to an element, the user is requested to provide some
information about how to assign the roles of that element’s attributes.

Multimedia Support 575

Attribute roles are:
• File name — the attribute which will provide the URI of the multimedia object
to use
• Entity name — if a file name isn’t used, an entity might point to the
multimedia object and this attribute will specify that entity
• Height — the display height of the media object in the output
• Width — the display width of the media object in the output
• Other — should other roles be required, this option can be used
As with the Graphic style, these roles can be changed later, if required. The
element can also carry other styling available in the other categories.
When the Multimedia style is set, the Multimedia category becomes available for
elements, contexts and conditions. This category carries specific properties for
handling the multimedia object.
The first thing to set it the type of media, and the choice is Video or Audio. This
value can also be derived in the same way as other Styler properties.

576 User's Guide

Next, specify whether the media should autoplay when it becomes visible in the
HTML or PDF.

Finally, set whether the media should loop, or not.

Multimedia Support 577

Editing with Multimedia
When a multimedia element is inserted, and a file linked to the content, the
‘missing graphic’ icon is shown. This is because currently Editor cannot show the
multimedia in place. However, double clicking on the icon will open the media in
a pop-up window.

Updating Stylesheet Properties

To ensure that multimedia output is properly displayed in HTML and web output,
you must enable HTML5 output in the stylesheet properties. In the Stylesheet
Properties, an option to Generate HTML5 is available for both outputs – HTML File
(a single HTML file on page 1033 output) and HTML Chunk (chunked HTML on
page 1037 or web output). Make sure that the Generate HTML5 checkbox is
selected under the appropriate tab.

Updating DCFs
To support multimedia, DCFs will need to be updated if using old ones or custom
ones.
Firstly, a new category is provided for multimedia which can be used when using
the dialog to insert mark-up by category:
<Category title="&Multimedia;">
<ElementListItem element="audiodata"/>
<ElementListItem element="videodata"/>
</Category>
This section shows the update to the DocBook DCF where the audiodata and
videodata elements are declared to be in the Multimedia category.
Next, in the ‘Specials’ section, there is a new Multimedia type, upon which the
default attribute roles are specified:
<Multimedia element="audiodata"

578 User's Guide

 entity="entityref" filename="fileref"/>
<Multimedia element="videodata"
entity="entityref" filename="fileref"
height="depth" width="width"/>

Multimedia Support 579

 23
Working with Modules
Modules Overview................................................................................................... 582
Creating a Module from an Existing Stylesheet .......................................................... 584
Developing a New Stylesheet Using Existing Modules................................................ 585
Overriding Stylesheet Definitions .............................................................................. 588
Modifying Definitions in a Module.............................................................................. 591
Adding New Definitions to a Module.......................................................................... 593

This section describes how to manage modularized stylesheets and the individual
modules that make up those stylesheets.

581
Modules Overview
Arbortext Styler supports modularized stylesheets, which enables you to develop a
stylesheet from modular components. Multiple stylesheets can share common
modules, which adds flexibility to stylesheet design and reduces development
time. You can also reference a fully developed stylesheet as a module and
selectively override some of the formatting characteristics. Using modules makes
it easier to maintain multiple stylesheets with common styling. If having the best
possible performance when publishing is one of your requirements, you can use
File ▶ Save as Merged Stylesheet to save a modular stylesheet as a merged,
flattened stylesheet. It is recommended that you edit the individual stylesheet
modules themselves, and then use the merged stylesheet for production work to
ensure the best performance when publishing.
A stylesheet can reference any other stylesheet as a module. You can also
reference read-only modules, though you cannot modify the contents of those
modules. You can use the Arbortext-path\custom\stylermodules
directory to store modules.
Modularized stylesheets are arranged in a module hierarchy. The hierarchy starts
with a single root module that can reference any number of other modules.
Modules in the hierarchy can reference other modules down to the leaf module
level. Modules higher in the hierarchy have precedence over modules lower in the
hierarchy. Any mergeable definitions in modules lower in the hierarchy are
overridden by identically named definitions higher in the hierarchy.
The following stylesheet components are considered definitions:
• Element
• Property set
• Page set
• Page type
• Page region
• Generated content
• Table of contents
• Cross reference
• Custom table
• Size
• Combined font
A module can contain and share any or all of these types of definitions. For
example, if you have defined header and footer objects for the stylesheet
axdocbook1.style and you wish to make these available for a second
stylesheet axdocbook2.style without having to recreate the same objects in

582 User's Guide

the second stylesheet, create a module headers-footers.style and move
all the header and footer objects into it. You can then make both stylesheets
modular and include the headers-footers.style module in both.

Note
When working with a modularized stylesheet, it is possible that two modules
in a single stylesheet use different prefixes for the same namespace. This will
have an effect on the order in which elements are listed in the Elements list.
Since elements are displayed with the prefix for the namespace that applies in
the module in which the element definition occurs, definitions for the same
element may not be displayed adjacent to each other in the list. Their
precedence relationship will be maintained, however.

Arbortext Styler overrides an entire definition. For example, for elements with the
same name the entire element is overridden, not just included contexts or
conditions.
The names of modules below the root module are displayed for individual
elements and property sets in the Elements and Property Sets lists. The Arbortext
Styler interface also contains precedence information for the elements and
property sets. The name of the root module is displayed in the Arbortext Styler
title bar. The Modules dialog box, available through File ▶ Modules, enables you to
control the module hierarchy. Other user interface components enable you to
move or copy selected definitions to modules.

Validating Modularized Stylesheets

When working with modularized stylesheets, you should remember that if you are
adding or deleting or modules this may invalidate every stylesheet that shares that
module. It is good practice to validate any stylesheets that use those modules
before production to confirm that any changes you have made have not had a
negative effect. There are two ways in which you can validate a stylesheet:
1. Choose the Tools ▶ Validate Stylesheet menu option in Arbortext Styler.
2. Carry out a preview action with the stylesheet, via the Preview menu.
Arbortext Styler carries out an automatic stylesheet validation process
whenever a preview action is selected.
If the publishing log displays errors such as that shown below, it may because the
stylesheet has errors caused by missing modules or incorrect module references:
Fatal error encountered while running composition piepline

Working with Modules 583

Creating a Module from an Existing
Stylesheet
Arbortext Styler allows you to create stylesheet modules from definitions in an
existing stylesheet. The first procedure shown below demonstrates how to move
all of the inline elements from an existing stylesheet into a module.
You can use the same process to move other element styles, User Formatting
Elements, Styler Formatting Elements, or any other definitions in your stylesheet
into sharable modules.

Note
You may need to select the View ▶ User Formatting Elements and View ▶ Styler
Formatting Elements menu options to ensure these elements are displayed in
the Elements list. In addition, the list views each contain a list of user interface
components, enabling you to move or copy those definitions to modules.

Example: Creating a Module Containing Inline Elements from an

Existing Stylesheet
The procedure given below describes how to create a new module and add to the
module all elements in the stylesheet that currently have a particular style.
1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/styler.
2. Choose the menu option Styler ▶ Edit Stylesheet to open the associated
stylesheet for edit. This is a read only stylesheet so you will need to save a
local copy if you want to make amendments.
3. In Arbortext Styler, select File ▶ Modules.
The Modules dialog box opens.
4. Select the New button.
The New Module dialog box opens.
5. Browse to the Arbortext-path/custom/stylermodules directory
and enter inlines.style in the File name directory. Enter a Title and
Description, if desired, and select Create to create the new module.

The new module appears in the module hierarchy in the Modules dialog box.
6. Click Close to exit the Modules dialog box.
7. In Arbortext Styler, select the Style heading in the Elements list. The list is
sorted by style.

584 User's Guide

8. Select all the elements that have the Inline style, using CTRL+left click or
SHIFT+left click to select multiple elements if necessary.
9. Select File ▶ Move to Module.
The Move to Module dialog box opens. You can also copy selected definitions
to a module via the File ▶ Copy to Module menu option.
10. Select inlines in the Move selected Elements to hierarchy and click OK.
The Inline elements are moved to the inlines.style module. The entry
for each inline element in the Elements list is updated to indicate that it is part
of a module in the stylesheet:

11. If, once you have allocated your objects to the module, you wish to protect the
module with a read-only restriction, you can do this by navigating to the
module in your desktop explorer, right clicking and selecting Properties, then
checking the Read-only option in the General tab. Your module will then be
displayed in the Modules box with a lock icon over its regular icon and the
title text grayed out.
You cannot subsequently add objects to a read only module.

Developing a New Stylesheet Using

Existing Modules
Arbortext Styler enables you to create a new stylesheet using existing modules.
This procedure assumes that you have modules available to use as building blocks
for the new stylesheet. In particular, you need to have the Styler Formatting
Elements (SFE) required for the stylesheet available in a module. You can move
those to a module by opening an existing stylesheet in Arbortext Styler that

Working with Modules 585

contains the necessary SFEs, selecting the SFEs in the Elements list, and using
File ▶ Move to Module to move the elements to a module. If the SFEs are not
available in a module, you could also copy and paste them from another stylesheet
or create them.

Note
SFEs associated with a Table of Contents definition must remain in the same
module as the associated table of contents and cannot be copied or moved to
another module. These elements begin with _sfe:Toc. If any of these SFEs
are selected, the Move.. and Copy to Module menu items are disabled. If the
Table of Contents definition is moved to a module, the associated SFEs move
with it.

Example: Developing a New Stylesheet Using Modules

1. In Arbortext Editor, open your document and select Styler ▶ New Empty
Stylesheet menu to open an empty stylesheet.
2. In Arbortext Styler, select File ▶ Modules.
The Modules dialog box opens.
3. Select the Add button.
The Add Module dialog box opens.
4. Browse to the directory containing your stylesheet modules, select from the
list of modules a module you would like to add to your stylesheet, and click
the Add button.
The new module appears in the Modules dialog box's module hierarchy as a
child of whatever module was highlighted in the dialog box when you clicked
the Add button. Keep the top level module selected in the dialog box to create
a set of sibling children.
5. Repeat steps 3 and 4 until you have added all relevant modules to your
stylesheet.

586 User's Guide

6. Click Close to exit the Modules dialog box.
7. Select Insert ▶ Add Elements from Document or Doctype
The Add New Elements dialog box opens.
8. Make sure that the document type listed in the Document Type field is correct
and that the Include declared elements from this document type option is
selected:

Working with Modules 587

9. Click OK to close the dialog box. All elements from the document type that
have not been added to the stylesheet via the module hierarchy are added to
the root module in the Elements list.
10. Apply styling to any unstyled elements that have been added to the stylesheet,
via the Edit ▶ Style menu option.
11. If you did not add a module containing other necessary definitions, use the
appropriate user interface elements to develop those definitions.
For example, use the Insert ▶ Table of Contents menu option to create a new
table of contents definition.

Overriding Stylesheet Definitions

Arbortext Styler enables you to override the formatting of definitions by creating
additional versions of the definition higher in the module hierarchy than the
default one. Any definition in the hierarchy is automatically overridden by a
definition with the same name that is higher in the hierarchy. This enables you to
do things such as referencing an existing stylesheet as a module but customizing it
by overriding selected definitions.
The processes listed in this section apply to all the available definitions within
Arbortext Styler; use the relevant definition list to carry out the creation of
overrides:
• Elements, contexts, and conditions
• Property sets

• Page sets
• Page types
• Page regions
• Generated Content objects
• Tables of contents
• Custom tables
• Cross references
• Sizes
• Combined fonts
There are three ways in which you can create an override for an existing
definition:

588 User's Guide

• Create a new definition in the root module
• Copy and paste the definition into the root module
• Copy the definition to the root module

Create a New Definition in the Root Module

1. Open your modularized stylesheet in Arbortext Styler.
2. Use the Insert menu to add a new definition to the relevant list.
3. Enter the name of the child module definition you want to override in the root
module.
Arbortext Styler warns you that adding this definition to the root module will
override the definition in the child module, asking you if you wish to rename
the definition to avoid the override. For example, the error message shown
below appears when you create a new author element for the purpose of
overriding the existing author element in the Blocks module:

4. Click OK to continue with creating the definition as an override of the existing

definition. The display of the definition's description in the relevant list will
change to advise that the definition in the module has been overridden by
the new version of the definition, which now takes precedence :
The graphic below shows how two versions of the author element are
displayed in the Elements list:

5. Style the definition as desired. This formatting will now be applied whenever
the definition is encountered in this particular document.

Copy and Paste the Definition into the Root Module

1. Open your modularized stylesheet in Arbortext Styler.
2. Select the child module definition you want to override in the relevant list.

Working with Modules 589

3. Select Edit ▶ Copy and Edit ▶ Paste to add a copy of the definition to the root
module.
Arbortext Styler warns you that pasting this definition to the root module will
override the definition in the child module, asking you if you wish to continue
with the paste. For example, the error message shown below appears when
you paste a copy of the author element for the purpose of overriding the
existing author element in the Blocks module:

4. Click OK to continue with the paste process. As shown above, the definition
description in the relevant list will change to advise that the element in the
module has been overridden by the new version of the definition, which
now takes precedence :
5. Modify the copied definition's properties as desired.
Note that this copy process is not permitted for a Size object - use the process
detailed in Create a new definition in the root module above to create an
override for a Size object.

Copy the Definition to the Root Module

1. Open your modularized stylesheet in Arbortext Styler.
2. Select the child module definition you want to override in the relevant list.
3. Select File ▶ Copy to Module to open the Copy to Module dialog box.
4. Select the root module in the Copy to Module dialog box and select OK to close
the dialog box and add the copied definition to the root module.

590 User's Guide

 You will see no error message asking if you wish to continue with this action,
but once complete the definition's description in the relevant list will change to
advise that the definition in the module has been overridden by the new
version of the definition, which now takes precedence .

Note
If you want to create overrides for User Formatting Elements (UFE) and Styler
Formatting Elements (SFE), you may need to select the View ▶ User
Formatting Elements and View ▶ Styler Formatting Elements menu options to
ensure these elements are displayed in the Elements list.

Modifying Definitions in a Module

One of the maintenance tasks associated with modularized stylesheets is
modifying a definition contained in one of the modules in the module hierarchy.
Arbortext Styler enables you to accomplish this in two ways - in the module itself
or from within the modularized stylesheet.
The processes listed in here apply to all the available definitions within Arbortext
Styler; use the relevant definition list to carry out the modifications:
• Elements, contexts and conditions
• Property sets

• Page sets

Working with Modules 591

• Page types
• Page regions
• Generated Content objects
• Tables of contents
• Custom tables
• Cross references
• Sizes
• Combined fonts

Modify the Definition in the Module

1. Open your document in Arbortext Editor.
2. Select Styler ▶ Open Stylesheet to open the Open Stylesheet dialog box.
3. In the Available Stylesheets list, select the module you want to modify - use
the Add button to browse your filesystem for the module if it does not
currently appear in the list.
4. Click OK to close the dialog box and open the module in Arbortext Styler.
Note that the module opens on the Elements list by default - if the module
does not contain any elements navigate to the relevant list to find the
definitions you wish to modify.

Note
When electing to open a standalone module you may see an error advising
that the module references missing definitions. It may be the case that
definitions in the module you are opening reference objects in another
module and, since the module is being opened independently of the
modular stylesheet or module that contains those definitions, the
connections cannot be made. For example, if the objects in your module
contain references to property sets in their definition, the link to the
property sets will not be resolved and the error will appear. Use the Tools ▶
Validate Stylesheet menu option to confirm that this is the case if you
encounter the error.

5. Modify the definitions in the module as usual and save the module.

592 User's Guide

The advantage of this approach is that the module opens faster in Arbortext Styler
than the complete modularized stylesheet. The disadvantage is that you cannot
preview your changes, as the complete stylesheet is not available.

Modify the Definition in the Modularized Stylesheet

1. In Arbortext Editor, open a document with an associated stylesheet that
references the module you want to modify.
2. Select Styler ▶ Edit Stylesheet to open the modularized stylesheet in Arbortext
Styler.
3. Modify the definitions as usual and save the stylesheet.
When you save the stylesheet, all modified modules in the hierarchy are also
saved. Note, however, that you cannot save a read-only module. You can save
a module that is referenced by a read-only module, as long as the included
module is not read-only.
The advantage of this approach is that you can meaningfully preview your
changes. The disadvantage is that it takes longer to open the modularized
stylesheet in Arbortext Styler.

Adding New Definitions to a Module

One of the maintenance tasks associated with modularized stylesheets is adding
new definitions to one of the modules in the module hierarchy. Arbortext Styler
enables you to accomplish this in two ways - adding the definition either to the
module itself or to the modularized stylesheet.
The processes listed here apply to all the available definitions within Arbortext
Styler; use the relevant definition list to carry out the modifications:
• Elements, contexts and conditions
• Property sets

• Page sets
• Page types
• Page regions
• Generated Content objects
• Tables of contents
• Custom tables
• Cross references

Working with Modules 593

• Sizes
• Combined fonts
Note that these examples will create a new element definition.

Add the Definition to the Module

The advantage of this approach is that the individual module opens faster in
Arbortext Styler than the complete modularized stylesheet. The disadvantage is
that you cannot preview your changes, as the complete stylesheet is not available.
1. In Arbortext Editor, open a document.
2. Select Styler ▶ Open Stylesheet to open the Open Stylesheet dialog box.
3. In the Available Stylesheets list, select the module you want to modify - use
the Add button to browse your filesystem for the module if it does not
currently appear in the list.
4. Click OK to close the dialog box and open the module in Arbortext Styler.
Note that the module opens on the Elements list by default - if the module
does not contain any elements navigate to the relevant list to find the
definitions you wish to modify.

Note
When electing to open a standalone module you may see an error advising
that the module references missing definitions. It may be the case that
definitions in the module you are opening reference objects in another
module and, since the module is being opened independently of the
modular stylesheet or module that contains those definitions, the
connections cannot be made. For example, if the objects in your module
contain references to property sets in their definition, the link to the
property sets will not be resolved and the error will appear. Use the Tools ▶
Validate Stylesheet menu option to confirm that this is the case if you
encounter the error.

5. In Arbortext Styler, use the Insert ▶ Element to add a new element to the
Elements list.
6. Name and style the new element as desired and save the module.

594 User's Guide

Add the Definition in the Modularized Stylesheet
The advantage of this approach is that you can meaningfully preview your
changes. The disadvantage is that it takes longer to open the modularized
stylesheet in Arbortext Styler.
1. In Arbortext Editor, open a document with an associated stylesheet that
references the module you want to modify.
2. Select Styler ▶ Edit Stylesheet to open the modularized stylesheet in Arbortext
Styler.
3. In Arbortext Styler, select Insert ▶ Element to add a new element to the
Elements list.
4. Name and style the element as desired.
5. Highlight the new element in the Elements list and select File ▶ Move to
Module. The Move to Module dialog box opens.
6. Select the module to which you want to move the element in the Move
selected Elements to hierarchy and click OK. The new element is moved to the
module.
7. Save the stylesheet.
When you save the stylesheet, all modified modules in the hierarchy are also
saved. Note, however, that you cannot save a read-only module. You can save
a module that is referenced by a read-only module, as long as the included
module is not read-only.

Note
If you want to add User Formatting Elements (UFE) and Styler Formatting
Elements (SFE), you may need to select the View ▶ User Formatting Elements
and View ▶ Styler Formatting Elements menu options to ensure these elements
are displayed in the Elements list before performing one of these options.

Working with Modules 595

 24
Advanced Formatting Techniques
Formatting Landscape Tables and Figures ................................................................ 598
Generating Barcodes and QR Codes ........................................................................ 599

This section describes some advanced formatting techniques.

597
Formatting Landscape Tables and
Figures
You can format elements such as tables and figures so they are displayed in
landscape orientation, even if the rest of the document uses the portrait format.
You can configure this formatting to apply to all occurrences of a context of an
element or you can make it conditional, so that the formatting is only applied
when a certain condition is true.

Example: Formatting a Landscape Table Using Contexts

1. In Arbortext Styler, click the Styler ▶ Open Stylesheet menu option to open
your stylesheet for edit.
2. In the Elements list, select the table context that should be displayed in
landscape format and click on the Breaks category.
3. Choose Page from the Start new drop down menu, then choose Yes from the
Landscape page body for duration of element: menu.
4. Select the Preview ▶ Print (XSL-FO) menu option.
5. In the Print Preview window, note any tables in the relevant document context
now display in landscape mode.

Note
If headers and footers are configured for the table, they will display in
portrait orientation.

Example: Formatting a Landscape Table Using Conditions

1. In Arbortext Editor, locate the relevant table element and elect to modify its
attributes via the Edit ▶ Modify Attributes menu option.
2. Type landscape in the role field, then click OK. Note that the table
element now has a role=“landscape” attribute.
3. In Arbortext Styler, select the table everywhere context in the Elements
list, then choose the Insert ▶ Condition menu option.
4. In the Condition dialog box, click New Attribute Test to open the Attribute Test
dialog box. Ensure that table is shown in the Current Element field.
5. Select role from the Attribute Name drop down menu, then select the
Comparison option in the Attribute Value: field.
6. Choose = as the Comparison operator, and type landscape in the
Comparison text box.

598 User's Guide

7. Click OK, and click OK to save the change and exit the Condition dialog box.
Note that the table everywhere context now has the condition: If
attribute “role” = “landscape”.
8. Select the condition you just created in the Elements list, and click on the
Breaks category.
9. Choose Page in the Start new: field, then choose Yes from the Landscape
page body for duration of element drop down menu.
10. Choose Preview ▶ Print (XSL-FO).
11. In the Print Preview window, note that the selected table starts a new page, and
displays in landscape mode.

Note
If headers and footers are configured for the table, they will display in
portrait orientation.

Generating Barcodes and QR Codes

PTC Advanced Print Publisher supports barcodes and other scannable objects, for
example QR codes. You can use PTC APP edited source in your Arbortext Styler
stylesheet to configure a graphic object to display a code of the required type, with
the requisite value. The code can then be included in PDF output generated by the
PTC APP engine.
PTC APP includes a full library of code types that conform to recognized
standards, for example:.
• Barcodes — CODE 128, EAN-8, EAN-13, EAN-2, EAN-5, DUN-14, Code
25, Code 39, Code 93, GS1-128, ITF-14, Pharmacode, and JAN standards
• QR codes — ISO/IEC 18004 standard
Sample code to create a new barcode is given below:
//Create the barcode object. This is just a normal barcode
var b = new fBarcode;
b.type = fBarcode.BARCODE_EANX;

//Create a variable for the value to use when creating the barcode
var value = "981858705125";
//Create a variable for the tag to create based on the value to
ensure the graphic is unique to the value
var tagName = "barcode_" + application.calculateHash(value);

//Create the barcode graphic, unless it already exists

var barcodeGraphic = template.content.getGraphic(tagName);

Advanced Formatting Techniques 599

if (!barcodeGraphic) {
barcodeGraphic = template.content.createBarcode(tagName,"80mm",
"30mm","black","none",b,value);
}

//Output the barcode graphic inline

formatting.addImage(barcodeGraphic);
The first section of code includes the line b.type = fBarcode.BARCODE_
EANX;, which specifies that a barcode of type EAN will be generated. See
Barcode Types and Options below for a list of supported barcode types. Note that
the value declared in the second section of code, 981858705125, is 12 digits
long. The code will generate an EAN-13 barcode.
Refer to the description of the fBarcode object in the Formatting Object Model
Reference for further information.
The second section of the code defines the value that will be displayed in the
barcode, i.e. 981858705125. It also includes barcode_" +
application.calculateHash(value) to generate the name of the
graphic tag that will be created to display the barcode. Here the tag name will be
barcode_981858705125 — the text barcode_ followed by the current
value of the variable value.
The third section of code uses the fContent.createBarcode() method to
output the barcode (a graphic) with certain properties:
• tagName — the name of the graphic tag
In this example, the current value of the variable tagName will be queried for
the tag name
• “80mm” — width
• “30mm” — height
• “black” — foreground color of barcode (for bars and numbers etc.)
• “none” — background color of barcode
• b — barcode type
In this example, the current value of the variable b will be queried for the
barcode information
• value — value (numbers)
In this example, the current value of the variable value will be queried for
the value
The method will fail if the tag already exists.
Refer to the description of the fContent.generateBarcode() method in
the Formatting Object Model Reference for further information.

600 User's Guide

A sample file that demonstrates PTC APP’s barcode capability and options is
provided at Arbortext-path\samples\APP\Barcode. You can refer to
these files:
• barcodeSampler.xml — sample XML file with elements configured to
output each one of PTC APP’s available barcode types. The sample also
describes the property sets provided in the accompanying stylesheet.
• barcodeSample.style — stylesheet with property sets that provide the
PTC APP source edits required to generate the barcodes.

Barcode Types and Options

Supported barcode types are listed below. When declaring for an fBarcode
object, you can specify the type with either the constant name or the number.

One-dimensional Barcodes

Barcode Type Constant Name Number

Code 11 fBarcode.BARCODE_CODE11 1
Value can take a string of digits of any length and an
optional hyphen
Codabar fBarcode.BARCODE_CODABAR 18
Value can be any length and can consist of one letter (A-
D), followed by a combination of numbers, dash, colon,
slash, full-stops or plus signs, followed by another letter
(A-D)
Pharmacode One- fBarcode.BARCODE_PHARMA 51
Track Value must be a number between 3 and 131070
Korea Post fBarcode.BARCODE_KOREAPOST 77
Value is a 6 digit numeric string
Channel Code fBarcode.BARCODE_CHANNEL 140
Value is a numeric string up to 7 digits long.
This barcode type can accept an fBarcode.option2
property to specify the number of digits the library should
expect (the channels):
• fBarcode.option2=3 — a two digit value
between 00 and 26
• fBarcode.option2=4 — a three digit value
between 000 and 292
• fBarcode.option2=5 — a four digit value
between 0000 and 3493
• fBarcode.option2=6 — a five digit value

Advanced Formatting Techniques 601

One-dimensional Barcodes (continued)
Barcode Type Constant Name Number
between 00000 and 44072
• fBarcode.option2=7 — a six digit value between
000000 and 576688
• fBarcode.option2=8 — a seven digit value
between 0000000 and 7742862
If fewer digits are supplied, leading 0s will be added. If too
many digits are provided, or the value is out of the
specified range, no barcode will be generated and an error
will be raised.
Code 2 of 5 Variants
Standard Code 2 of fBarcode.BARCODE_C25MATRIX 2
5 Value takes a string of numbers of any length
Interleaved 2 of 5 fBarcode.BARCODE_C25INTER 3
Value can take a string of numbers of any length, ideally
an even number of numbers
If an odd number is provided, a leading 0 will be added.
Code 2 of 5 IATA fBarcode.BARCODE_C25IATA 4
Value can take a numeric string of any length
Code 2 of 5 Data fBarcode.BARCODE_C25LOGIC 6
Logic Value can take a string of numbers of any length
Code 2 of 5 fBarcode.BARCODE_C25IND 7
Industrial Value can take a string of numbers of any length
ITF-14 fBarcode.BARCODE_ITF14 89
Value takes a 13 digit numeric string
Deutsche Post fBarcode.BARCODE_DPLEIT 21
Leitcode Value takes a 13 digit numeric string
Deutsche Post fBarcode.BARCODE_DPIDENT 22
Identcode Value takes an 11 digit numeric string
UPC Variants
UPC A fBarcode.BARCODE_UPCA 34
Value takes an 11 digit numeric string
EAN-2 and EAN-5 add-ons can be added by following the
value with a + and the appropriate number of digits.
UPC E fBarcode.BARCODE_UPCE 37
Value takes a 6 digit numeric string.

602 User's Guide

One-dimensional Barcodes (continued)
Barcode Type Constant Name Number
EAN2 and EAN5 add-ons can be added by following the
value with a + and the appropriate number of digits.
EAN Variants
EAN fBarcode.BARCODE_EANX 13
This barcode type will create the appropriate barcode
depending on the number of digits provided:
EAN-2 is generated from 2 digits
EAN-5 is generated from 5 digits
EAN-8 is generated from 7 digits
EAN-13 is generated from 12 digits
Add-on barcodes can be created by providing a value with
two sets of digits separated by a + symbol.
ISBN (EAN-13 with fBarcode.BARCODE_ISBNX 69
verification stage) Value can be 9, 10, or 13 digits long
If the code is invalid an error will be raised.
Plessey Variants
Plessey Code fBarcode.BARCODE_PLESSEY 86
Value can be any length and can include digits and the
letters A-E
MSI Plessey fBarcode.BARCODE_MSI_ 47
PLESSEY
Value can take a numeric string of any length
This type can accept an fBarcode.option2 property
to control the check digits generated by the library:
• fBarcode.option2 = 0 — no check digit
• fBarcode.option2 = 1 — a modulo 10 check
digit
• fBarcode.option2 = 2 — two modulo 10 check
digits
• fBarcode.option2 = 3 — a modulo 11 check
digit
• fBarcode.option2 = 4 — a modulo 11 check
digit and a modulo 10 check digit
Telepen Variants
Telepen Alpha fBarcode.BARCODE_TELEPEN 32

Advanced Formatting Techniques 603

One-dimensional Barcodes (continued)
Barcode Type Constant Name Number
Value can take an ASCII string of any length
Telepen Numeric fBarcode.BARCODE_TELEPEN_ 87
NUM
Value takes a numeric string of an even number length
Code 39 Variants
Code 3 of 9 (Code fBarcode.BARCODE_CODE39 8
39) Value can take a string of numbers, letters, dash, full stop,
space, dollar, slash and percent symbols of any length
Adding an optional fBarcode.option2=1 generates
the check digit.
Extended Code 3 of fBarcode.BARCODE_EXCODE39 9
9 (Code 39+) Value can be a string of ASCII characters of any length.
Adding an optional fBarcode.option2=1 generates
the check digit.
Code 93 fBarcode.BARCODE_CODE93 25
Value can take a string of ASCII characters of any length
PZN fBarcode.BARCODE_PZN 52
Value takes a 6 digit numeric string
LOGMARS fBarcode.BARCODE_LOGMARS 50
Value takes the same type of string as the standard code 39
Code 32 fBarcode.BARCODE_CODE32 129
Value takes a numeric string up to 8 characters long
HIBC Code 39 fBarcode.BARCODE_HIBC_39 99
Value takes the same type of string as code 39
Code 128 Variants
Code 128 fBarcode.BARCODE_CODE128 20
(automatic subset
switching)
Code 128 (Subset fBarcode.BARCODE_CODE128B 60
B) As above, but without automatic switching to Code C
GS1-128 fBarcode.BARCODE_EAN128 16
Value takes a string starting with an Application Identifier
in square brackets
Errors will be raised if the Application Identifier is missing
or if an incorrect string length for the Application
Identifier is provided.

604 User's Guide

One-dimensional Barcodes (continued)
Barcode Type Constant Name Number
EAN-14 fBarcode.BARCODE_EAN14 72
Value takes a 13 digit numeric string
If fewer than 13 digits are provided, leading 0s will be
added.
NVE-18 fBarcode.BARCODE_NVE18 75
Value takes a 17 digit numeric string
If fewer than 17 digits are provided, leading 0s will be
added.
HIBC Code 128 fBarcode.BARCODE_HIBC_128 98
Takes the same input for value as the standard Code 128
The leading + and trailing check digit are generated.
GS1 DataBar Variants
GS1 DataBar-14 fBarcode.BARCODE_RSS14 29
Value can be a numeric string up to 13 digits long
If fewer than 13 digits are provided, leading 0s will be
added.
GS1 DataBar fBarcode.BARCODE_RSS_LTD 30
Limited Value can be a numeric string up to 13 digits long, which
must start with a 1 or a 0
GS1 DataBar fBarcode.BARCODE_RSS_EXP 31
Expanded Value takes a numeric string with Application Identifiers in
square brackets
No barcode will be generated if the number of digits in the
string is not appropriate for the Application Identifier.

Stacked Symbols

Barcode Type Constant Name Number

Code 16K fBarcode.BARCODE_CODE16K 23
Value is one or more groups of ASCII characters,
separated by a comma
PDF417 fBarcode.BARCODE_PDF417 55
Value can be an ASCII string up to 1850 text characters or
2710 digits long
The value can accept options:

Advanced Formatting Techniques 605

Stacked Symbols (continued)
Barcode Type Constant Name Number
• fBarcode.option1 — specifies the checksum
codewords
Enter a value between 0 and 8.
• fBarcode.option2 — specifies the number of
column width of the generated symbol
Enter a value between 1 and 30.
HIBC PDF417 fBarcode.BARCODE_HIBC_PDF 106
As above
PDF417 Truncated fBarcode.BARCODE_ 56
PDF417TRUNC
Options are the same as for PDF417
MicroPDF417 fBarcode.BARCODE_ 84
MICROPDF417
Value is similar to PDF417, but the value is limited to 250
characters (or 366 digits)
Use the fBarcode.option2 property to specify the
number of columns (1–4).
HIBC fBarcode.BARCODE_HIBC_ 108
MicroPDF417 MICPDF
As above.
GS1 DataBar-14 fBarcode.BARCODE_RSS14STACK 79
Stacked Value can be a numeric string up to 12 digits long
If fewer than 12 digits are provided, leading 0s will be
added.
GS1 DataBar-14 fBarcode.BARCODE_ 80
Stacked RSS14STACK_OMNI
Omnidirectional Value can be a numeric string up to 12 digits long
If fewer than 12 digits are provided, leading 0s will be
added.
GS1 DataBar fBarcode.BARCODE_RSS_ 81
Expanded Stacked EXPSTACK
Value takes a numeric string
fBarcode.option2 can provide the width (number of
columns) for the generated symbol.
This type will generate a stacked symbol if multiple codes
are provided with their Application Identifiers (e.g. value
= [01]12345678901234[01]12345678901234).

606 User's Guide

Stacked Symbols (continued)
Barcode Type Constant Name Number
Code 49 fBarcode.BARCODE_CODE49 24

Two-track Symbols

Barcode Type Constant Name Number

Pharmacode Two- fBarcode.BARCODE_PHARMA_TWO 53
Track Value can be a numeric string with a value between 4 and
64570080
PostNet fBarcode.BARCODE_POSTNET 40
Value can be a numeric string of any length
PLANET fBarcode.BARCODE_PLANET 82
Value can be a numeric string of any length

4–State Postal Codes

Barcode Type Constant Name Number

AUSTRALIAN
Australia Post fBarcode.BARCODE_AUSPOST 63
Standard Customer Value should follow one of the following patterns:
• 12345678 — will output a 37 bar symbol, where the
value is an 8 digit numeric string
• 12345678ABCDE — will output a 52 bar symbol,
where the value is a 13 character string of 8 digits
followed by 5 alphabetical characters
• 1234567812345678 — will also output a 52 bar
symbol, where the value is a 16 digit numeric string
• 12345678ABCDEFGHIJ — will output a 67 bar
symbol, where the value is an 8 digit numeric string
followed by a 10 character alphabetical string
•
12345678901234567890123 — will output a 67 bar
symbol, where the value is a 23 digit numeric string
Australia Post Reply fBarcode.BARCODE_AUSREPLY 66
Paid Value takes an 8 digit numeric string
Australia Post fBarcode.BARCODE_AUSROUTE 67
Routing Value takes an 8 digit numeric string
Australia Post fBarcode.BARCODE_ 68

Advanced Formatting Techniques 607

4–State Postal Codes (continued)
Barcode Type Constant Name Number
Redirection AUSREDIRECT
Value takes an 8 digit numeric string
DUTCH
Dutch Post KIX fBarcode.BARCODE_KIX 90
Code The value can have numbers and alphabetical characters
(A-Z)
ROYAL MAIL
Royal Mail 4 State fBarcode.BARCODE_RM4SCC 70
(RM4SCC) Value can be a string of letters and numbers
USPS
USPS OneCode fBarcode.BARCODE_ONECODE 85
Value must be at least 20 digits long
After 20 digits, the value takes a dash followed by either 0,
5, 9, or 11 further digits.
Errors will be raised if this pattern is not followed.
JAPANESE
Japanese Postal fBarcode.BARCODE_JAPANPOST 76
Code Value can accept numbers, alphabetical characters (A-Z),
and dashes

Two-dimensional Symbols

Barcode Type Constant Name Number

Data Matrix fBarcode.BARCODE_DATAMATRIX 71
Value can be any ASCII + Latin–1 text
The value can accept a fBarcode.option2 property to
determine the size of the symbol generated:
• fBarcode.option2 = 1 — a 10x10 symbol
• fBarcode.option2 = 2 — a 12x12 symbol
• fBarcode.option2 = 3 — a 14x14 symbol
• fBarcode.option2 = 4 — a 16x16 symbol
• fBarcode.option2 = 5 — a 18x18 symbol
• fBarcode.option2 = 6 — a 20x20 symbol
• fBarcode.option2 = 7 — a 22x22 symbol
• fBarcode.option2 = 8 — a 24x24 symbol

608 User's Guide

Two-dimensional Symbols (continued)
Barcode Type Constant Name Number
• fBarcode.option2 = 9 — a 26x26 symbol
• fBarcode.option2 = 10 — a 32x32 symbol
• fBarcode.option2 = 11 — a 36x36 symbol
• fBarcode.option2 = 12 — a 40x40 symbol
• fBarcode.option2 = 13 — a 44x44 symbol
• fBarcode.option2 = 14 — a 48x48 symbol
• fBarcode.option2 = 15 — a 52x52 symbol
• fBarcode.option2 = 16 — a 64x64 symbol
• fBarcode.option2 = 17 — a 72x72 symbol
• fBarcode.option2 = 18 — a 80x80 symbol
• fBarcode.option2 = 19 — a 88x88 symbol
• fBarcode.option2 = 20 — a 96x96 symbol
• fBarcode.option2 = 21 — a 104x104 symbol
• fBarcode.option2 = 22 — a 120x120 symbol
• fBarcode.option2 = 23 — a 132x132 symbol
• fBarcode.option2 = 24 — a 144x144 symbol
• fBarcode.option2 = 25 — a 8x18 symbol
• fBarcode.option2 = 26 — a 8x32 symbol
• fBarcode.option2 = 27 — a 12x26 symbol
• fBarcode.option2 = 28 — a 12x36 symbol
• fBarcode.option2 = 29 — a 16x36 symbol
• fBarcode.option2 = 30 — a 16x48 symbol
HIBC Data Matrix fBarcode.BARCODE_HIBC_DM 102
As above
QR Code fBarcode.BARCODE_QRCODE 58
Value can be up to 7089 digits or 4296 alphanumeric
characters from ASCII plus Latin-1 and kanji characters
QR codes can take two options:

Advanced Formatting Techniques 609

Two-dimensional Symbols (continued)
Barcode Type Constant Name Number
• fBarcode.option1 specifies the level or error
correction encoded in the symbols:
○ fBarcode.option1 = 1 — ECC level L
○ fBarcode.option1 = 2 — ECC level M
○ fBarcode.option1 = 3 — ECC level Q
○ fBarcode.option1 = 4 — ECC level H

610 User's Guide

Two-dimensional Symbols (continued)
Barcode Type Constant Name Number
• fBarcode.option2 determines the size of the
symbol generated:
○ fBarcode.option2 = 1 — a 21 x 21 QR code
○ fBarcode.option2 = 2 — a 25 x 25 QR code
○ fBarcode.option2 = 3 — a 29 x 29 QR code
○ fBarcode.option2 = 4 — a 33 x 33 QR code
○ fBarcode.option2 = 5 — a 37 x 37 QR code
○ fBarcode.option2 = 6 — a 41 x 41 QR code
○ fBarcode.option2 = 7 — a 45 x 45 QR code
○ fBarcode.option2 = 8 — a 49 x 49 QR code
○ fBarcode.option2 = 9 — a 53 x 53 QR code
○ fBarcode.option2 = 10 — a 57 x 57 QR
code
○ fBarcode.option2 = 11 — a 61 x 61 QR
code
○ fBarcode.option2 = 12 — a 65 x 65 QR
code
○ fBarcode.option2 = 13 — a 69 x 69 QR
code
○ fBarcode.option2 = 14 — a 73 x 73 QR
code
○ fBarcode.option2 = 15 — a 77 x 77 QR
code
○ fBarcode.option2 = 16 — a 81 x 81 QR
code
○ fBarcode.option2 = 17 — a 85 x 85 QR
code
○ fBarcode.option2 = 18 — a 89 x 89 QR
code
○ fBarcode.option2 = 19 — a 93 x 93 QR
code
○ fBarcode.option2 = 20 — a 97 x 97 QR
code
○ fBarcode.option2 = 21 — a 101 x 101 QR

Advanced Formatting Techniques 611

Two-dimensional Symbols (continued)
Barcode Type Constant Name Number
code
○ fBarcode.option2 = 22 — a 105 x 105 QR
code
○ fBarcode.option2 = 23 — a 109 x 109 QR
code
○ fBarcode.option2 = 24 — 113 x 113 QR
code
○ fBarcode.option2 = 25 — a 117 x 117 QR
code
○ fBarcode.option2 = 26 — a 121 x 121 QR
code
○ fBarcode.option2 = 27 — a 125 x 125 QR
code
○ fBarcode.option2 = 28 — a 129 x 129 QR
code
○ fBarcode.option2 = 29 — a 133 x 133 QR
code
○ fBarcode.option2 = 30 — a 137 x 137 QR
code
○ fBarcode.option2 = 31 — a 141 x 141 QR
code
○ fBarcode.option2 = 32 — a 145 x 145 QR
code
○ fBarcode.option2 = 33 — a 149 x 149 QR
code
○ fBarcode.option2 = 34 — a 153 x 153 QR
code
○ fBarcode.option2 = 35 — a 157 x 157 QR
code
○ fBarcode.option2 = 36 — a 161 x 161 QR
code
○ fBarcode.option2 = 37 — a 165 x 165 QR
code
○ fBarcode.option2 = 38 — a 169 x 169 QR
code

612 User's Guide

Two-dimensional Symbols (continued)
Barcode Type Constant Name Number
○ fBarcode.option2 = 39 — a 173 x 173 QR
code
○ fBarcode.option2 = 40 — a 177 x 177 QR
code
HIBC QR Code fBarcode.BARCODE_HIBC_QR 104
As above
Micro QR Code fBarcode.BARCODE_MICROQR 97
Value can be Latin-1 and kanji characters
The value can accept a fBarcode.option2 property to
specify the version of the code to be used:
• fBarcode.option2 = 1 — uses version M1 of the
code, which generates an 11x11 symbol
• fBarcode.option2 = 2 — uses version M2 of the
code, which generates a 13x13 symbol
• fBarcode.option2 = 3 — uses version M3 of the
code, which generates a 15x15 symbol
• fBarcode.option2 = 4 — uses version M4 of the
code, which generates a 17x17 symbol
Aztec Code fBarcode.BARCODE_AZTEC 92
Value can be any ASCII string up to 3067 alphanumeric
characters or 3823 digits long
This type can accept two options:
• fBarcode.option1 sets the error correction
capacity:
○ fBarcode.option1 = 1 — >10% + 3
codewords
○ fBarcode.option1 = 2 — >23% + 3
codewords
○ fBarcode.option1 = 3 — >36% + 3
codewords
○ fBarcode.option1 = 4 — >50% + 3
codewords
• fBarcode.option2 sets the size of the symbol
produced:
○ fBarcode.option2 = 1 — 15 x 15 symbol

Advanced Formatting Techniques 613

Two-dimensional Symbols (continued)
Barcode Type Constant Name Number
○ fBarcode.option2 = 2 — 19 x 19 symbol
○ fBarcode.option2 = 3 — 23 x 23 symbol
○ fBarcode.option2 = 4 — 27 x 27 symbol
○ fBarcode.option2 = 5 — 19 x 19 symbol
○ fBarcode.option2 = 6 — 23 x 23 symbol
○ fBarcode.option2 = 7 — 27 x 27 symbol
○ fBarcode.option2 = 8 — 31 x 31 symbol
○ fBarcode.option2 = 9 — 37 x 37 symbol
○ fBarcode.option2 = 10 — 41 x 41 symbol
○ fBarcode.option2 = 11 — 45 x 45 symbol
○ fBarcode.option2 = 12 — 49 x 49 symbol
○ fBarcode.option2 = 13 — 53 x 53 symbol
○ fBarcode.option2 = 14 — 57 x 57 symbol
○ fBarcode.option2 = 15 — 61 x 61 symbol
○ fBarcode.option2 = 16 — 67 x 67 symbol
○ fBarcode.option2 = 17 — 71 x 71 symbol
○ fBarcode.option2 = 18 — 75 x 75 symbol
○ fBarcode.option2 = 19 — 79 x 79 symbol
○ fBarcode.option2 = 20 — 83 x 83 symbol
○ fBarcode.option2 = 21 — 87 x 87 symbol
○ fBarcode.option2 = 22 — 91 x 91 symbol
○ fBarcode.option2 = 23 — 95 x 95 symbol
○ fBarcode.option2 = 24 — 101 x 101 symbol
○ fBarcode.option2 = 25 — 105 x 105 symbol
○ fBarcode.option2 = 26 — 109 x 109 symbol
○ fBarcode.option2 = 27 — 113 x 113 symbol
○ fBarcode.option2 = 28 — 117 x 117 symbol
○ fBarcode.option2 = 29 — 121 x 121 symbol
○ fBarcode.option2 = 30 — 125 x 125 symbol
○ fBarcode.option2 = 31 — 131 x 131 symbol
○ fBarcode.option2 = 32 — 135 x 135 symbol

614 User's Guide

Two-dimensional Symbols (continued)
Barcode Type Constant Name Number
○ fBarcode.option2 = 33 — 139 x 139 symbol
○ fBarcode.option2 = 34 — 143 x 143 symbol
○ fBarcode.option2 = 35 — 147 x 147 symbol
○ fBarcode.option2 = 36 — 151 x 151 symbol
If both options are set, option1 will be ignored.
HIBC Aztec Code fBarcode.BARCODE_HIBC_AZTEC 112
As above
Aztec Runes fBarcode.BARCODE_AZRUNE 128
Value can be any integer between 0 and 255
Code One fBarcode.BARCODE_CODEONE 141
Value can be Latin-1 or ASCII characters
The amount of content provided by the value is specified
by the type, which is controlled by the value of the
fBarcode.option2 property:
Value of Version Size Numeric Alphanu-
property of Code string meric
One size string size
1 A 16 x 18 22 13
2 B 22 x 22 44 27
3 C 28 x 32 104 64
4 D 40 x 42 217 135
5 E 52 x 54 435 271
6 F 70 x 76 886 553
7 G 104 x 98 1755 1096
8 H 148 x 3550 2218
132
9 S 8x 18 (not
height allowed)
10 T 16x 90 55
height
Grid matrix fBarcode.BARCODE_GRIDMATRIX 142

Advanced Formatting Techniques 615

Two-dimensional Symbols (continued)
Barcode Type Constant Name Number
Value can contain Latin-1 and Chinese characters
This type can accept two options:
• fBarcode.option1 specifies the error correction:
○ fBarcode.option1 = 1 — ECC ~10%
○ fBarcode.option1 = 2 — ECC ~20%
○ fBarcode.option1 = 3 — ECC ~30%
○ fBarcode.option1 = 4 — ECC ~40%
○ fBarcode.option1 = 5 — ECC ~50%
• fBarcode.option2 specifies the size:
○ fBarcode.option2 = 1 – 18x18 symbol
○ fBarcode.option2 = 2 – 30x30 symbol
○ fBarcode.option2 = 3 – 42x42 symbol
○ fBarcode.option2 = 4 – 54x54 symbol
○ fBarcode.option2 = 5 – 66x66 symbol
○ fBarcode.option2 = 6 – 78x78 symbol
○ fBarcode.option2 = 7 – 90x90 symbol
○ fBarcode.option2 = 8 – 102x102 symbol
○ fBarcode.option2 = 9 – 114x114 symbol
○ fBarcode.option2 = 10 – 126x126 symbol
○ fBarcode.option2 = 11 – 138x138 symbol
○ fBarcode.option2 = 12 – 150x150 symbol
○ fBarcode.option2 = 13 – 162x162 symbol

Other Types

Barcode Type Constant Name Number

FIM fBarcode.BARCODE_FIM 49
Value can be A, B, C, or D
Flattermarken fBarcode.BARCODE_FLAT 28
Value takes a numeric string
DAFT Code fBarcode.BARCODE_DAFT 93

616 User's Guide

Other Types (continued)
Barcode Type Constant Name Number
Value can be a string containing only D, A, F, and T
characters
If the string contains other characters, an error will be
raised and no symbol will be generated.

Advanced Formatting Techniques 617

 25
Styling DITA Documents
DITA Styling Overview ............................................................................................. 620
Working with the Resolved Document for Styling ....................................................... 623
Working with Specialized Elements........................................................................... 630

This section describes the options in Arbortext Styler that support working with
documents based on DITA document types.

619
DITA Styling Overview
The DITA (Darwin Information Typing Architecture) standard was pioneered at
IBM and is sponsored by OASIS (Organization for the Advancement of
Structured Information Standards), a not-for-profit, international consortium that
drives the development, convergence, and adoption of e-business standards.
OASIS defines DITA as “an architecture for creating topic-oriented, information-
typed content that can be reused and single-sourced in a variety of ways. It is also
an architecture for creating new information types and describing new information
domains based on existing types and domains.”
To obtain more information on OASIS and DITA, refer to the OASIS web site at
www.oasis-open.org/. Refer to the DITA Architectural Specification for an
overview of the DITA standard. Refer to the DITA Language Reference for
specific information about DITA elements and attributes. These documents are
available on the OASIS web site and in the Arbortext Help Center.
Arbortext Editor supports the DITA standard and provides a sophisticated, flexible
environment for authoring and publishing DITA documents. Arbortext Editor has
customized configurations for editing both DITA topics and DITA maps. Refer to
the Arbortext Editor online help for more information about authoring DITA
documents withArbortext Editor.
There are two distinct types of DITA document:
• DITA topic — a modular document that provides discrete information about a
single subject. DITA topics are XML documents and styling DITA topics is
similar to styling other types of XML document.
• DITA map — DITA maps are XML documents, but they contain very little
text or other content. Instead, DITA maps specify the DITA topics and other
types of documents that are to be collected and organized into a deliverable.
Using a DITA map allows you to create a hierarchy of DITA topics and other
information resources that serve as an outline, table of contents, or build
manifest. During publishing, titles, short descriptions, and other metadata from
a map may override titles, short descriptions, and other metadata in a topic.
Since a DITA map does not contain the actual content of your deliverable, during
publishing Arbortext Editor automatically generates an intermediate document
called the Resolved Document for Styling (RDS) from a DITA map and the maps
and topics that the map references. This document contains all of the content
referenced from the map. It is the RDS that is acted upon by your stylesheet
during publishing.
You do not normally need to work with or see the RDS, but it is often helpful to
generate and use it when using Arbortext Styler to develop stylesheets for use
with DITA documents. You may generate a resolved document with the Arbortext
Editor menu choice Edit ▶ Edit Resolved Document ▶ For Styling. When you select
this menu choice, Arbortext Editor assembles all of the content in your map into a

620 User's Guide

resolved document and opens that document in a new Arbortext Editor window.
You can then use the resolved document to style the content of your DITA map.
Refer to Working with the Resolved Document for Styling on page 623 for more
information on styling with the resolved document.
Arbortext Styler provides additional support for styling DITA documents in the
following areas:
• Fallback generalization
Arbortext Styler supports the DITA standard class attribute that enables an
element to be labeled as a specialization of another element. When a
specialized element is left Unstyled, Arbortext Styler and the publishing
process treat occurrences of the specialized element as if they were the base
element used for the specialization. This process is called generalization or
fallback processing.
See Working with Specialized Elements on page 630 for information.
• The DITA index model
Note that the DITA index-see, index-see-also, and index-sort-
as indexing tags are mainly supported in the default stylesheet. The elements
are supported for the following output types:
DITA index Print / Web HTML RTF
element PDF Help

index-see Full Full Full support Full support

support support
index-see-also Full Full Full support Partial
support support support
index-sort-as Full No support No support No support
support

○ Support for index-see-also in RTF output is restricted by a

Microsoft Word limitation. Microsoft Word can only approximate a See
Also reference if the source document contains the required See Also
text in its primary index term. This prevents an index entry without a
see-also reference and one with a see also reference from merging
when the primary index terms are equal.
○ Support for index-sort-as option in RTF output is not available due
to a Microsoft Word limitation.
○ There is no indexing capability in HTML File output.

Styling DITA Documents 621

 See Creating a Index with Nesting Element Model Index Terms on page 382
for information.
• The DITA footnote model - see Creating and Modifying a Hybrid Model
Footnote on page 434 for information.

Note
If you add a new context to a DITA document, you cannot click inside that
context in Arbortext Editor and have the new context highlighted in Arbortext
Styler until you perform a Preview ▶ Arbortext Editor operation.

Default DITA Stylesheets

Arbortext Editor provides a default stylesheet for all of the distributed DITA
document types. The Technical Information Application also provides a single
stylesheet for all its DITA document types. The location of the relevant .style
file is specified in the .dcf file for each document type. The default stylesheets
are provided in both modular and merged formats:
• The modularized version of the stylesheets are located in the following
directory locations:
○ DITA document types:
◆ For DITA 1.2 and 1.3 —<Arbortext-path>\doctypes\dita\
ditabase
◆ For DITA 2.0—<Arbortext-path>\doctypes\dita\2.0\ditabase
Its file name is ditabase.style
○ Technical Information Application:
◆ For DITA 1.2 and 1.3 —<Arbortext-path>\application\
com.ptc.arbortext.techinfo\doctypes\techinfo
◆ For DITA 2.0 —<Arbortext-path>\application\
com.ptc.arbortext.techinfo\doctypes\2.0\
techinfo
Its filename is techinfo.style
• The stylesheet modules that were used to develop the merged stylesheets are
in the following location:
○ DITA document types:
<Arbortext-path>\stylermodules

622 User's Guide

 The top level module of the stylesheet is dita.style
○ Technical Information Application:
<Arbortext-path>\application\com.ptc.arbortext.techinfo\
stylermodules

The top level module of the stylesheet is techinfo.style

You can use the default stylesheet to publish your DITA documents or use it as the
basis for developing your own enhanced or custom stylesheets. It is recommended
that you use the individual DITA stylesheet modules when doing your own
stylesheet development, as that provides the greatest flexibility. Use the File ▶
Modules menu option in Arbortext Styler to manage modules in your stylesheet.
Once you have completed your stylesheet development, use the File ▶ Save as
Merged Stylesheet feature to save your stylesheet as a merged stylesheet. Using a
merged stylesheet improves performance.
Some of the elements in the default stylesheet contain source edits, so cannot be
modified through the Arbortext Styler user interface. Please refer to Identifying
Items that have Edited Source on page 700 for details of how to ascertain if an
element includes source edits.

DITA Support in Distributed Stylesheets

Arbortext Editor supports all of the DITA elements and attributes for the purposes
of editing. The most commonly used DITA elements and attributes are styled in
the default Arbortext Styler stylesheets that are distributed with the default DITA
and Technical Information document types. Some elements and attributes are not
styled or not styled completely in the distributed Arbortext Styler stylesheets.
Some of the specialized elements that are not styled will inherit styling from the
base element from which the specialization was created. You may add styling for
unstyled elements or customize the styling for elements and attributes that are
already styled by creating new Arbortext Styler stylesheets from scratch or by
modifying a copy of the distributed stylesheets. In addition, there are a few
elements and attributes for which it is difficult to add styling using Arbortext
Styler stylesheets without enhancements to the PTC Arbortext DITA support.

Working with the Resolved Document for

Styling
To assist you with styling DITA maps, Arbortext Editor enables you to generate
an assembled version of your topic or map. This is called the Resolved Document
for Styling (RDS). The RDS contains all of the content referenced in the source
document, so you can use it to style your DITA deliverable documents.

Styling DITA Documents 623

You generate the RDS with the Arbortext Editor menu choice Edit ▶ Edit Resolved
Document ▶ For Styling. When you select this menu choice, Arbortext Editor
assembles all of the content in your topic or map into a resolved document and
opens that resolved document in a new Arbortext Editor window. The version of
the RDS displayed is ungeneralized, but any unstyled elements will be generalized
to a styled base element, if possible, before it is processed by the Arbortext Styler
stylesheet (.style file). For this fallback generalization to take place an
Arbortext Styler stylesheet must be used.
In much the same way that you can publish just a portion of a DITA map, you can
create an RDS from a subset of a map by selecting just the topic references that
you wish to have included before you generate the RDS.
By default, Arbortext Styler only displays the RDS elements in the topic or the
topics referenced in your DITA map. If you are using fallback generalization, the
base element that you are using to provide the styling for an unstyled, specialized
element may not be available in the Arbortext Styler Elements list. In this case,
uncheck the View ▶ Only Elements in Document menu option in Arbortext Styler to
pull the base element into the Elements list.
By default, the RDS is read-only and cannot be saved. Because of this, the
Arbortext Editor window containing the RDS has a limited feature set. While
developing your stylesheet, you might find it useful to save and edit the RDS to
test the styling of element and attribute combinations that are not present in the
DITA map and topics from which you produced the RDS. If you want to edit or
save the RDS, select the File ▶ Enable Editing menu choice and the full Arbortext
Editor feature set is enabled. Once you have access to the full Arbortext Editor
feature set, you can edit the document and use the File ▶ Save As menu choice to
save it. Any changes you make to the RDS are not saved in the source documents
from which the RDS was produced.

Note
Context rules are always off for the RDS. You must make any structural
changes to the resolved document with care to avoid making it an invalid
document.

Contents of the Resolved Document for Styling

The Resolved Document for Styling (RDS) contains the content that is referenced
from the map or topic being published. The original markup from maps and topics
is assembled, normalized, and augmented in various ways to facilitate publishing
and styling.

624 User's Guide

The content of the RDS is described below. However, the best way to gain an
understanding of the format and contents of the RDS is to use the Edit ▶ Edit
Resolved Document ▶ For Styling menu item to create an RDS from a DITA map
and to examine it in an Arbortext Editor window.
The RDStyle element is the “first tag” element in the RDS. It contains the three
major structural elements of the RDS, as described in the following sections.

ResolvedMap Section of the RDS

ResolvedMap is the wrapper element for the assembled content from the DITA
maps. The contents of this element are styled to become the majority of the output
in the final deliverable.
The content in the ResolvedMap section of the RDS consists of a map element
that contains the map title, optionally followed by map metadata, and then the
topics referenced from the map. These topics are nested in the RDS as called for
by the nesting of the topic references within the map.

ReferredTopics Section of the RDS

ReferredTopics is a wrapper element for topics referred to from other topics,
but not referred to from a map. When there are no such topics, this element will be
empty. This element is not usually styled. In the default DITA and Techinfo
stylesheets that are distributed with Arbortext Editor the content of this element is
hidden and so does not appear in any outputs.
The content in the ReferredTopics section of the RDS is similar to that of the
ResolvedMap section. It consists of topics but no map, map title, or map metadata
elements. The topics are all peers of one another rather than being nested.
This section does not appear in the new format RDS introduced in 6.1 M030.

FlattenedMap Section of the RDS

FlattenedMap is a wrapper for the elements from the original DITA maps.
This element and its contents are not used in the final output and are not usually
styled.
The content in the FlattenedMap section of the RDS consists of map markup.
Topic references that reference DITA maps are removed and replaced by the
markup from the referenced map.

Topics, Dummy Topics, Pseudo Topics, and Dummy Pseudo Topics in

the RDS
The topics that are contained in the ResolvedMap section are either regular DITA
topics or “dummy” topics. Dummy topics are created as placeholders in the RDS
when a topic reference in a DITA map references one of the following:

Styling DITA Documents 625

1. a non-DITA topic (where the value of its @format attribute is not equal to
dita)
2. a non-local topic (where the value of its @scope attribute is not equal to local)
3. a local DITA topic (with the attribute values @format="dita" and @scope=
"local") that does not exist or cannot be read.
The type of a dummy topic is determined by the value of the type attribute on the
topic reference in the map. Dummy topics contain a title and possibly metadata
taken from the referencing map, but they do not contain additional content other
than possibly other nested topics as determined by the nesting of topic references
in the map.
When a topic is included in the RDS as the result of a topic reference by a
topicref, topichead, or topicgroup element, the topic tag is included in
the RDS unchanged. When a topic is included in the RDS as the result of a topic
reference speculation such as part, chapter, or appendix, the topic tag in the RDS
is changed into a pseudo topic that uses the element name of the specialization as
the name for the topic tag. Pseudo topics make it easy to style a part differently
from a chapter from an appendix from a concept or other topic. The class attribute
for a pseudo topic contains information that allows the pseudo topic to be
generalized back to its original base elements if the pseudo element is unstyled.
A pseudo topic may or may not have content when it appears in the RDS. Note
that if the pseudo topic has content but the topicref specialization used to
name it is declared to have an EMPTY content model, the element name will be
placed in the atirds namespace. Examples of such elements include:
abbrevlist, amendments, bibliolist, bookabstract, booklist,
colophon, dedication, figurelist, indexlist, tablelist, toc,
and trademarklist all from the bookmap specialization. When such elements
are unstyled, they are generalized as any other unstyled element would be. It may
be necessary to add explicit styling for some of the atirds: elements if you
don’t want the fallback styling associated with the base element. You may also
add your own EMPTY topicref specializations.
A dummy topic that is included in the RDS as a result of a specialized topic
reference will be included as a dummy pseudo topic.
During publishing, unstyled topics, dummy topics, pseudo topics, and pseudo
dummy topics will all be generalized to a styled base element, if one exists, before
Arbortext Styler stylesheet processing occurs.
Only references to pseudo topics appear in the new format RDS introduced in 6.1
M030.

Attributes and Metadata in the RDS

Titles, navigation titles, search titles, short descriptions, and other metadata
elements cascade from maps to other maps and to topics in the RDS.

626 User's Guide

Attribute values cascade from ancestor to descendent elements within documents
and from referencing to referenced documents in the RDS. Default attribute values
are made explicit in the RDS by using either default values from the DTD or
schema or processor-supplied default values as called for in the DITA
specification. In some cases cascading attributes values replace or override values
in topics, but where multiple values are allowed, the values are combined.
See the OASIS DITA Specification for details about default values, cascading
values, processor supplied default values, and which values override or are
combined.
Five categories of attribute appear in the RDS:
• Attributes and values from the original maps and topics.
• Attributes with default values from the DTD or schema.
• Attributes with values that cascade from ancestors to descendents within
maps, from maps to other maps, from maps to topics, and from ancestors to
descendents within topics. Most of these attributes appear without a
namespace prefix, but a few attributes that are legal in maps but not in topics
use the atirds namespace prefix when they cascade from maps to topics.
• Attributes with processor-supplied default values.
• Attributes and values added to the RDS to facilitate publishing and styling.
These attributes will be in one of two XML namespaces and will use one of
the following namespace prefixes: atirds (general) or ch (chunking)

Namespaced and Other Attributes in the RDS

The following table lists the attributes that augment, or occur in, the RDS in a
normalized form:

Attribute Description
chunk
The DITA chunk attribute. Arbortext
Editor only uses the value of this
attribute from the topmost map element
and only recognizes the two token
values by-topic and by-document. by-
topic is the default value. For DITA
documents chunking is controlled by
Arbortext Styler using hints that are
added to the RDS during the publishing
process in the form of ch:xxx attributes.
href This attribute displays its information
in one of three ways, depending on the
type of reference it belongs to:

Styling DITA Documents 627

Attribute Description
• For references to local DITA topics
(i.e. with the attribute values
scope=”local” and format=”dita”)
this is the original href value
converted into an id reference to a
normalized ID value elsewhere in
the RDS
• For references to non-local scope
topics (i.e. where the value of the
@scope attribute is not equal to
local) or for references to non-
DITA topics (where the value of the
@format attribute is not equal to
dita) this is the original unchanged
URI href value.
• For local scope, non-DITA format
references, this is the original URI
href value converted from a relative
path to an absolute path, if
necessary.
id, xml:id The original ID value normalized for
use within the RDS. Some DITA id
attributes are true XML IDs, while
others are not. To provide a value for
use by processing that requires true
XML IDs, the normalized ID value is
duplicated as the value on the xml:id
attribute.
xtrc, xtrf Two DITA attributes that are not
currently used by Arbortext Editor.
These attributes are not applicable in
case of DITA 2.0 documents.
atirds:appid The original ID attribute value from
DITA elements before the ID value is
normalized for use within the RDS
atirds:comptype
This attribute with the value
topicAsMap will appear on the map
element in the ResolvedMap section of
the RDS when a topic rather than a map
is being published.

628 User's Guide

Attribute Description
atirds:ehref Contains a URI reference value. It is
used for all non-local and non-DITA
references. The value is a copy of the
href attribute’s value as described
above.
atirds:ihref Contains an ID reference value. It is
used for all local DITA references. The
value is a copy of the href attribute’s
value as described above.
atirds:mapelement The name of the ungeneralized element
in the map that caused this element to
be included in the RDS.
atirds:mapsourceref
An ID reference to the element in the
FlattenedMap section that caused this
element to be included in the RDS.
atirds:parentTopicId The ID value from the topic element
that contains the element.
This attribute does not appear in the
new format RDS introduced in 6.1
M030.

Styling DITA Documents 629

Attribute Description
atirds:toc One of a list of attributes that are used
in DITA maps, but not in DITA topics.
When such an attribute is used on a
topic tag in the RDS it appears as
atirds:toc.
Other attributes used in this way are:
• collection-type
• format
• linking
• locktitle (locktitle attribute is not
applicable in case of DITA 2.0
documents.)
• print
• scope
• search
• type
ch:xxxx An example of a chunker namespace
attribute that is added to the RDS as a
hint or a directive to control the
creation of HTML output chunks.

Working with Specialized Elements

Arbortext Styler provides fallback generalization support for specialized DITA
elements. Arbortext Styler supports the DITA standard class attribute that
enables an element to be labeled as a specialization of another element. When a
specialized element is left Unstyled, Arbortext Styler and the publishing process
treat occurrences of the specialized element as if they were the base element used
for the specialization. This process is called generalization or fallback processing.
Note that for fallback generalization to work, you must have no references to the
unstyled, specialized element in your stylesheet besides the definition that makes
the element unstyled. For example, if you want fallback generalization to treat the
concept element as an unstyled specialization of the topic element, you must
not perform any of the following operation in Arbortext Styler:
• Create a context for title in concept or any similar context.
• Use concept as the scoping element for a table of contents.

630 User's Guide

• Use concept as the element for which an attribute is tested in a condition.
• Use concept in any XPath expressions.
This is only a partial list. In general, you should never use an unstyled, specialized
element in any Arbortext Styler control where you can specify an element name.
Arbortext Styler detects and reports most occurrences of these invalid references
when you execute Tools ▶ Validate Stylesheet, File ▶ Export operations, or a
preview operation. However, Arbortext Styler does not detect invalid references in
XPath expressions.
Arbortext Styler supports fallback generalization in the following areas:
• Arbortext Editor display - When you use an Arbortext Styler stylesheet to
control display in Arbortext Editor, Arbortext Editor uses the styling
developed for a base element when a specialized element is unstyled.
The specialized element and base element must both be in the stylesheet for
fallback generalization to work in this case. Also, when you select a
specialized element in Arbortext Editor that is unstyled, Arbortext Styler does
not highlight that element in the Elements list. Instead, Arbortext Styler
highlights the base element from which the specialized element is getting its
style.
• Arbortext Styler user interface - Arbortext Styler recognizes when an unstyled
specialized element has an associated base element that has been styled and
provides that information in the Elements list.
For example, the DITA step element is a specialization of the li element. If
you have styled li but not step, Arbortext Styler applies the styling for the
li element and displays the following message in the Elements list for the
step element:
Unstyled (List Item by specialization)

If you hover the cursor over this message, the following additional information
is provided in a small popup (tooltip):
(Specialization of li, using List Item style)
• Publishing - When publishing with an Arbortext Styler stylesheet, the
publishing process replaces unstyled, specialized elements with the associated
base element.
• Arbortext Styler preview - Arbortext Styler replaces unstyled, specialized
elements with the associated base element in preview operations.
Note that once you style a specialization of an element that is styled as a division,
it is no longer associated with the base element for division numbering. This is
because Arbortext Styler counts an unstyled, specialized element along with its

Styling DITA Documents 631

base element, but counts a styled, specialization separately from its base element.
For this and similar reasons, it is often a good practice to leave specialized
elements unstyled and allow the fallback processing to apply styling.

632 User's Guide

 26
Non-Latin Language Support
Overview of Support for Non-Latin Text in Arbortext Styler .......................................... 634
Combined Fonts...................................................................................................... 635
List and Page Numbering......................................................................................... 638
Hanging Punctuation ............................................................................................... 644
Text Underlining and Strikethrough ........................................................................... 646
Right-to-Left Layout Direction ................................................................................... 652

This section describes the options in Arbortext Styler that support documents that
include text in non-Latin languages.

633
Overview of Support for Non-Latin Text in
Arbortext Styler
Arbortext Styler includes support for Chinese, Japanese, Korean, Hebrew, Arabic,
and Thai languages, both in terms of the characters that can be used in text and the
formatting properties that can be applied to that text. The features that support
content in these languages are summarized below, with each being dealt with in
more detail in subsequent sections of this chapter:
• Combined fonts (see Combined Fonts on page 635): the Arbortext Styler UI
provides an interface whereby a user can create a user defined font that
specifies which system font(s) should be used to display the different
characters or character blocks in a piece of text
• List and page numbering (see List and Page Numbering on page 638): non-
Latin numbering styles are included in the list of available numbering schemes
for page sets, divisions, formal blocks, tables of content, list items, footnotes,
and indexes.
• Hanging punctuation (see Hanging Punctuation on page 644): certain
characters are permitted to hang outside the margins of the text area
• Underlining and strikethrough of text (see Text Underlining and Strikethrough
on page 646): a number of underline and strikethrough styles beyond the
simple straight rule
• Right-to-left text direction (see Right-to-Left Layout Direction on page 652):
layout text from the right margin to the left margin, instead of the default left-
to-right text direction.
It is recommended that you elect to preview and publish your documents via the
PTC APP print engine to ensure that non-Latin text, punctuation, or formatting
properties in your document are treated correctly. Right to left writing direction,
hanging punctuation, and word boundaries for Thai content are only enabled if
PTC APP is the effective print engine for your environment.
PTC APP includes support for Hebrew, Arabic, and Thai languages in print and
PDF outputs:
• Right to left writing direction
• Hebrew, Arabic, and Thai list and page numbering styles
• Word boundaries for Thai content
Please refer to Working with Non-Latin Language Content in Arbortext Editor
help for further information.
You must elect to compose via the PTC APP print engine to enable these features.

634 User's Guide

Combined Fonts
A combined font allows you to specify that different system fonts should be used
to display certain characters (or character blocks or script groups) from the
Unicode specification in the document's text.
For example, you might want to define the default font Arial for the majority of
the characters in a paragraph, but specify that any characters from the East Asian
Scripts script group that appear in the paragraph's text should be displayed with
the SimSum font. This preference can be defined by creating a combined font, and
assigning this font to the relevant paragraph element in your document.
The character and character range options presented in the properties area for a
combined font object are based on the Unicode specification. Refer to http://www.
unicode.org/charts/ for information.
For print and PDF, you must publish documents that use combined fonts with the
PTC APP print engine.

Note
When you export an Arbortext Styler stylesheet that uses combined font
definitions to XSL-HTML, XSL-HTML Help, or XSL-Web formats, the
exported stylesheet contains the processing instruction (PI) <?APT
combined-font-defn...?>. One PI for each combined font appears at
the start of each output file. Each PI specifies the details of the combined fonts
used in the original stylesheet, by confirming the combined font's name and
the list of Unicode point ranges it defines, along with the fonts assigned to
each range.
If you subsequently use the exported stylesheet outside of Arbortext Styler to
generate HTML output, the PI is included in the generated HTML. The PI is
removed when publishing to HTML in Arbortext Styler.

Example: Creating a Combined Font

In this example you will create a combined font that supports the following font
use in the same paragraph:
• Default font for paragraph - Arial
• Default font for characters from the East Asian Scripts script group - MS
Mincho
• Font for characters from the Japanese Katakana character block (a subset of
the East Asian Scripts script group) - SimSun

Non-Latin Language Support 635

This procedure advises how to create the combined font and assign it to the
relevant paragraph context.
1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/styler
2. Choose Styler ▶ Edit Stylesheet to open the stylesheet currently associated with
the document for edit. This is a read only stylesheet so you will need to save a
local copy if you want to make amendments.
3. Configure your Arbortext Editor with Styler environment to use PTC APP as
the effective print engine.
4. Choose the Insert ▶ Combined Font menu option. The Combined Fonts list
opens, if it is not already active, with a new combined font object New
Combined Font highlighted in the list. Rename the combined font object as
required.
Certain restrictions apply for the name of a combined font. As a general rule,
you cannot use the same name as an PTC Arbortext system font:
• Reserved font family names, for example serif, sanserif — do not
use in any case
• Built in fonts, for example arbortext — do not use in any case
• Installed system fonts, for example Arial —
○ In the same case as the installed font (Arial) — may be used as a
combined font name
In this instance the combined font overrides the installed font.
○ With a case variation (arial, ARIAL) — do not use as a combined
font name
5. In the properties area of the Combined Fonts list, select Arial from the
Default font list.

Here you have selected the font to be used to display the majority of characters
in a paragraph. In the next steps you will create exceptions to this default,
where you specify the fonts to display particular characters in the text.
6. Click New. A new exception line is created in the font list.
7. In the Character Set field, select the character block or type for which you are
defining the font, in this case East Asian Scripts. Script groups are
displayed in bold text, while character blocks are shown in normal text.
8. In the Font field, select MS Mincho
Here you have specified that any characters from the East Asian Scripts script
group will be displayed using the MS Mincho font.

636 User's Guide

9. Click New again to create a second exception to the default font setting. This
time, select Katakana from the Character Set list, and SimSun from the
Font list.

Here you have specified that Katakana characters, although they also belong to
the East Asian Scripts script group, should be displayed in SimSun font rather
than the default MS Mincho font defined for the script group.
The creation of the combined font is now complete:

10. The next step is to assign the font setting to the relevant paragraph context in
your stylesheet. In the Elements list , select the para everywhere
else context.
11. In the Text category for the context, select your combined font from the list of
available fonts in the Font family field. You will see that the combined font is

Non-Latin Language Support 637

 distinguished from the list of installed system fonts with a combined font icon
(see CombinedFont, below)

12. Choose Preview ▶ Print. In the PTC APP preview that appears, note that any
East Asian Scripts characters, and any Katakana characters, are displayed
correctly.

List and Page Numbering

To provide support for numbering schemes required in documents produced in
non-Latin languages, CJK and Hebrew, Arabic, and Thai number formats are
included in the list of available numbering styles from which you can pick when
setting numbering for page sets, divisions, formal blocks, tables of content, list
items, footnotes and indices.
Lists of Asian numbering styles are available in the following locations in the
Arbortext Styler UI:
• The Page numbers category for the Page Sets list
• The Division Title Number dialog box
• The Footnotes dialog box
• The Formal Block Title Number dialog box

638 User's Guide

• The List Item Number dialog box
• The Number Details dialog box
The CJK and Hebrew, Arabic, and Thai numbering styles included in these lists
are detailed below. Refer to Supported Range for Each Numbering Scheme on
page 641 and Limitations of Non-Latin Numbering Styles in Output on page 643
for additional information.
• ①, ②, ③... (circled decimal numbering scheme, implemented to support the
Zenkaku numeric numbering scheme)
• ァ,ィ,ゥ... (Japanese - katakana numbering scheme)
• イ, ロ, ハ... (Japanese - katakana-iroha numbering scheme)
• あ, い, う... (Japanese - hiragana numbering scheme)
• い, ろ, は... (Japanese - hiragana-iroha numbering scheme)
• 一, 二, 三... (Chinese - simp-chinese-informal numbering scheme,
implemented to support the Kanji numeric 1 numbering scheme)
• 子, 丑, 寅... (CJK earthly-branch numbering scheme)
• 甲, 乙, 丙... (CJK heavenly-stem numbering scheme)
• 가, 나, 다 ... (Korean - hangul numbering scheme)
• ㄱ, ㄴ, ㄷ... (Korean - hangul-consonant numbering scheme)
• ๑ , ๒ , ๓... (Thai)
• ۱, ۲, ۳... (Arabic-indic numbering scheme)
• ۱, ۲, ۳... (Urdu)

Note
Where numbering schemes are listed in a category or dialog box as described
above, the display of the characters in the number selection drop down menus
and associated Preview window is limited by the fonts installed on your
system. If your system is unable to display a character because the required
font is missing, you may see a hollow square or a question mark in the menu
or preview window instead of the number character. For this reason the names
of the numbering styles are displayed in the drop down menu, as well as their
first three characters. If the characters cannot be displayed it will still be clear
which numbering scheme has been selected.

This capability can be applied differently in different circumstances, for which

suggestions are made below as to the best way to configure the stylesheet to make
use of the option:

Non-Latin Language Support 639

• Non-Latin numbered lists in entire single document: enable the numbering on
the element that the stylesheet uses for all ordered list items.
• Non-Latin numbered lists in some of a set of different language documents
styled from a single stylesheet: create a condition for the list item element in
the ordered list, based on a test for the value of the xml:lang attribute for the
document's top level element. Enable the numbering based on that condition.
• Non-Latin numbering in selected lists in a single document in multiple
languages: enable the numbering for the specific ordered list or list item
elements, contexts or conditions in the document.
You may also elect to start numbering at 0, if required. Please refer to the example
Start list numbering at 0 in Advanced Formatting of Titles and Numbering on
page 495 for information.

Example: Numbering the Items in a List According to the Katakana

Numbering Scheme
1. In Arbortext Editor, open the transport.xml document located at
Arbortext-path/samples/styler.
2. Choose Styler ▶ Edit Stylesheet to open the stylesheet currently associated with
the document for edit. This is a read only stylesheet so you will need to save a
local copy if you want to make amendments.
3. In Arbortext Styler, select the listitem in itemizedlist context in the
Elements list.
4. In the Generated text category, select the Number option.
5. Click the Details button to open the List Item Number dialog box.
6. The Number format field reflects the style selected in the Number style field.
Select ァ,ィ,ゥ ,...(katakana) from the Number style drop down list.
Note that the ァ character displays in the Number format field and the Preview
window displays the first three characters of the Katakana numbering scheme.

Note
The display of the Preview window is limited by the fonts that are actually
installed on your system. If your system does not contain the necessary
font you may see a hollow square or a question mark where the number
characters should be in the preview.

7. Click OK to save the numbering settings and exit the dialog box.
8. Choose Preview ▶ Print.

640 User's Guide

 In the Print Preview window, note that list items are now preceded by numbers
in the Katakana style. Refer to the list contained in the first chapter of the
transport.xml sample document:

Example: Numbering the Pages of a Document According to the

Circled-Decimal Numbering Scheme
1. In Arbortext Editor, open the file transport.xml located at
Arbortext-path/samples/styler.
2. Choose Styler ▶ Edit Stylesheet to open the stylesheet currently associated with
the document for edit. This is a read only stylesheet so you will need to save a
local copy if you want to make amendments.
3. In the Elements list in Arbortext Styler, select the chapter everywhere
else context.
4. In the Breaks category for the element, note that the pages in a chapter are set
to be formatted by the mainbody-page page set.

5. Navigate to the Page Sets list and select the mainbody-page page set
in the list.
6. In the Page numbers category for the page set, open the Page number style
drop down menu and select ①, ②, ③... (circled-decimal) from
the list of possible numbering styles.
7. Preview your document via the Preview ▶ Print menu option. In the Print
Preview window, note that the page number displays at the bottom of the page
in each chapter as usual, but that the number is enclosed in a circle according
to the selected numbering style.

Supported Range for Each Numbering Scheme

The table below describes the ranges supported by Arbortext Styler for each style
of numbering:
Numbering Scheme Number of Symbols Range
Circled decimal 21 0 - 20 (reverts to decimal
numbering after 20)
Katakana 48 32000 values (as alphabet
scheme)

Non-Latin Language Support 641

Numbering Scheme Number of Symbols Range
Katakana-iroha 47 32000 values (as alphabet
scheme)
Hiragana 48 32000 values (as alphabet
scheme)
Hiragana-iroha 47 32000 values (as alphabet
scheme)
Simplified-chinese- 0 - 100
informal
Earthly-branch 12 1 - 12 (reverts to decimal
numbering after 12)
Heavenly-stem 10 1 - 10 (reverts to decimal
numbering after 10)
Hangul 14 32000 values (as alphabet
scheme)
Hangul-consonant 14 32000 values (as alphabet
scheme)
Thai 0 - 32000
Arabic-indic 0 - 32000
Urdu 0 - 32000
Upper / lower roman 1 - 32000
Upper / lower alphabet 32000 values
(A...Z, AA, AB, AC...ZZ)

642 User's Guide

Limitations of Non-Latin Numbering Styles in Output
Output format Limitation
HTML • If the stylesheet property Format list items as tables is
not selected, numbering is implemented in the HTML
list by setting the list style in an attribute of the
generated HTML. Support for this method of declaring
the list style varies by browser.
Refer to Numbering List Items on page 474 for a
summary of differences.
• The following styles of list and title numbering are not
supported in HTML output - numbering assigned these
styles will be displayed in the decimal style:
○ circled decimal
○ cjk-earthly-branch
○ cjk-heavenly-stem
○ hangul
○ hangul-consonant
• For certain Asian numbering styles, browsers that do
not support the word-break: keep-all CSS
property (such as Firefox) allow line breaks to occur
within the number or between the number and its
following punctuation.
• 0 is not supported for simplified-chinese-informal
RTF • The following numbering styles are not supported in
RTF output for the numbered elements in the body of
the document, such as divisions and list items -
numbering assigned these styles will be displayed in the
decimal style in those contexts:
○ circled decimal
○ cjk-earthly-branch
○ cjk-heavenly-stem
○ hangul
○ hangul-consonant
A stylesheet developer who wishes to use Word’s built-
in capabilities for numbering schemes can assign list-
paragraph and division-title contexts to user-defined
Word styles which make use of different numbering
schemes supported directly by Word.
• Page numbers and footnote numbers in RTF only

Non-Latin Language Support 643

Output format Limitation
support the simplified-chinese-informal,
cjk-earthly-branch, cjk-heavenly-stem,
circled decimal, hangul, and hangul-
consonant numbering styles. Any of the other non-
Latin styles in these contexts will be displayed in the
decimal style in RTF output.
Note that alphabetic and roman numeral page and
footnote numbers are permitted
• 0 is not supported for simplified-chinese-informal
Print/PDF via XSL- • The circled decimal, earthly-branch,
FO heavenly-stem, hangul, and hangul
consonant numbering schemes are not supported for
list numbering. Numbers from these schemes will be
displayed in the decimal style.
• 0 is not supported for simplified-chinese-informal

Hanging Punctuation
Arbortext Styler provides the option to permit punctuation characters to hang
outside the margin of any text area formatted as a block. With the hanging
punctuation option set for the element that contains the text, certain punctuation
characters will be placed outside the text margin if they appear at the end of a line:
• Ideographic comma x3001
• Ideographic full stop x3002
• Latin comma x002c
• Latin full stop x002e
The hanging punctuation option is activated (or deactivated) in the Hanging
punctuation (Print/PDF only) property field, located in the Indent category for
elements, contexts, conditions, and property sets.

Note
This formatting is only effective when publishing the document for print or
PDF with an Arbortext Styler stylesheet and the PTC APP print engine. The
Hanging punctuation (Print/PDF only) option not available in the Indent
category if either FOSI or XSL-FO is set as the active print engine.

This capability can be applied to a number of different cases. Suggestions are

made below:

644 User's Guide

• Hanging punctuation active throughout entire single document — enable the
setting on the document's top level element and it will be inherited through all
children elements in the document.
• Hanging punctuation active in some of a set of different language documents
styled from a single stylesheet — create a condition based on a test for the
value of the xml:lang attribute for the document's top level element and enable
the setting for that condition.
• Hanging punctuation active in some parts of a single document in multiple
languages — enable the setting for the elements, contexts or conditions within
the document that should display hanging punctuation, for example the
division elements where language transitions will occur.

Note
The use of hanging punctuation is not exclusive to non Latin languages. Using
the same UI functionality documents in other languages such as French may
display this type of alignment.

Example: Activating Hanging Punctuation for an Element

The example shown below describes how to specify that hanging punctuation
should apply for the context first para in a chapter in an XML document
based on the DocBook document type.
1. In Arbortext Editor, open the file transport.xml located at
Arbortext-path/samples/styler.
2. Choose Styler ▶ Edit Stylesheet to open the stylesheet currently associated with
the document for edit. This is a read only stylesheet so you will need to save a
local copy if you want to make amendments.
3. Configure your Arbortext Editor with Styler environment to use PTC APP as
the effective print engine.
4. In the Elements list, create the context first para in chapter.
5. In the Indent category for the context, set the Hanging punctuation (Print/PDF
only) field to Yes.

This field is only available if your environment is set to use PTC APP as the
effective print engine.
6. In Arbortext Editor, navigate to the first paragraph in the sample document,
which begins “Welcome to the world of....”. Place one of the four defined
punctuation characters at the end of a line in the paragraph.

Non-Latin Language Support 645

7. Choose the Preview ▶ Print menu option. In the PTC APP preview that
appears, note that the punctuation characters you placed in the first chapter are
displayed outside the main text margin.
8. Go back to the Indent category for the first para in chapter context.
Set the Hanging punctuation (Print/PDF only) field to No.
9. Run a second PTC APP print preview action and note the difference in the
display of the output of the same chapter. The punctuation characters are now
included in the main text block.

Text Underlining and Strikethrough

Arbortext Styler provides an extensive list of configured underlining styles, and
permits the user to customize the color of a selected underline. The Text category
for elements, contexts, conditions, and property sets contains Underline style and
Underline color menus for underlining.
The Text category for elements, contexts, conditions and property sets also
contains the options Strikethrough style and Strikethrough color, with which you
can customize the type and color of text strikethrough. In these menus you may
select the extent to which text strikethrough should apply in a text block, i.e. to
words and spaces or to words only, and elect a color for the strike bar.

Note
Customized settings for underline and strikethrough styles will only be visible
in print or Arbortext Editor output when the document is published via an
Arbortext Styler stylesheet. Customized underline and strikethrough styles are
not supported in HTML output and will be treated as standard scoring in
output of these types.

Example: Underlining Text in a Context Identified with a Particular

Attribute Value
In this example the text to be deleted is identified by applying the attribute role=
”delete” to the para everywhere else context. In print output the text will
be underlined with a red wavy underline style.
1. In Arbortext Editor, open the file transport.xml located at
Arbortext-path/samples/styler.
2. Choose Styler ▶ Edit Stylesheet to open the stylesheet currently associated with
the document for edit. This is a read only stylesheet so you will need to save a
local copy if you want to make amendments.

646 User's Guide

3. Select the para element in the first formalpara element in the first
chapter of the document. Apply the attribute role=”delete”.
4. In Arbortext Styler, navigate to the Elements list and select the para
everywhere else context.
5. Create a new condition for the element via the Insert ▶ Condition menu option.
The New Condition dialog box opens.
6. Click New Attribute Test to open the New Attribute Test dialog box.
7. Create the attribute test for the condition by setting the following values:
• Test attribute of Current element (para)
• Attribute name role
• Attribute value: Comparison =delete
8. Click OK to exit the New Attribute Test dialog box, then click OK again to exit
the New Condition dialog box. The condition If attribute “role=
”delete” appears in the Elements list for the para everywhere else
element.
9. With the condition highlighted, navigate to the Text category.
10. Set the Underline style field to Jagged Heavy and the Underline color field
to Red.
11. Choose Preview ▶ Print. In the Print Preview window, note that the first
paragraph in the sample document is underlined with a red wavy line.
12. Choose Preview ▶ HTML File. In the Print Preview window, note that the first
paragraph is underlined with a black standard underline.

Example: Striking Through Text in an Element Identified with a

Particular Attribute Value
In this example the text to be deleted is identified by applying the attribute role=
”strikethrough” to the emphasis element. In print output the text will be
crossed out with a blue strikethrough bar.
1. In Arbortext Editor, open the file transport.xml located at
Arbortext-path/samples/styler.
2. Choose Styler ▶ Edit Stylesheet to open the stylesheet currently associated with
the document for edit. This is a read only stylesheet so you will need to save a
local copy if you want to make amendments.
3. Locate the para element in the first formalpara element in the first
chapter of the document. Surround the text Welcome to the world of
modern transportation with an emphasis element, and give the
element the attribute role=”strikethrough”.

Non-Latin Language Support 647

4. In Arbortext Styler, navigate to the Elements list and select the If
attribute “role”=”strikethrough” condition of the emphasis
everywhere context.
5. With the condition highlighted, navigate to the Text category.
6. Set the Strikethrough style field to Words only and the Strikethrough color
field to Blue.
7. Choose Preview ▶ Print. In the Print Preview window, note that the words in
the text “Welcome to the world of modern transportation” are struck through
with a blue bar, whilst the spaces between the words are not.
8. Choose Preview ▶ HTML File. In the Print Preview window, note that all the
text “Welcome to the world of modern transportation” is struck through,
including the spaces, and that the strike bar is of the standard black color.

648 User's Guide

Limitations of Output Support for Underlining and Strikethrough
Output format Limitation
All outputs • Strikethrough and overlining (defined via the
overline property set) cannot be displayed
concurrently for the same element/context, although
they can both be set.
The overline property set is predefined in the
stylesheets that exist in the Arbortext Styler distribution
and, as the name suggests, defines a line drawn above
text. It uses the same underlying publishing capabilities
as the strikethrough property. As such an overline
cannot display with a strikethrough set via the Text
category.

Non-Latin Language Support 649

Output format Limitation
• Color and height settings for strikethrough and
overlining are shared and may produce unexpected
results when both are set for an element/context.
The overline property set and the strikethrough
property share the same underlying publishing
capabilities, where the specification of both is contained
in the same set of height and color attributes. The
height attribute has different values depending on the
text property being activated - for strikethrough, the
value of the height attribute sets the line to run through
the middle of the letters; for overline, the same attribute
is given the correct value to draw the line over the top
of the letters. The color attribute is independent of the
height attribute, and the color of any scoring defaults to
the color of the text to which it is to be applied, unless a
specific color setting is specified. You may therefore
find an attribute setting you make for one of the
overline/strikethrough properties will carry through to
the other when they are both defined for a context, even
though they cannot both be displayed.
Compare the property combinations defined below, and
the results they will produce:
○ Strikethrough set:
◆ Strikethrough style: Words and spaces
◆ Strikethrough color: Red
◆ Net result on publishing: red strikethrough
○ Strikethrough and overline set:
◆ Strikethrough style: Words and spaces
◆ Strikethrough color: Red
◆ Overline property set activated
◆ Net result on publishing: red overline (note: no
strikethrough as cannot be displayed
concurrently)
○ Strikethrough explicitly deactivated and overline set
◆ Strikethrough style: none
◆ Strikethrough color: <Derive>

650 User's Guide

Output format Limitation
◆ Overline property set activated
◆ Net result on publishing: no overline or
strikethrough (since the properties share the
same height attribute, the explicit value of none
applies to both)
All XSL outputs • Since both underlining and strikethrough are specified
(including RTF) in XSL outputs using the single text-decoration
property, you can only get both effects for the same
context if both underlining and strikethrough are
specified at the same time, i.e. in the same property set,
and on the same condition if conditions are being used.
If you set one of underlining or strikethrough in one
condition or property set and the other in another
condition or property set, the last setting may override
all or part of any previous setting.
Similarly, because the overline property set that is
predefined in most Arbortext Styler stylesheets uses the
same underlying publishing capabilities as the
strikethrough property, you may not get both effects
when the overline property set is used in conjunction
with underlining.
Print/PDF via PTC • The Words Only setting for underlining is not
APP supported
RTF • Because of limitations in MS Word, the curvy underline
styles will be mapped to the jagged style in RTF output.
• Strikethrough color settings are not supported -
strikethrough will be displayed in the current font color.
• The Words only setting for strikethrough is not
supported - strikethrough will apply to words and
spaces

Non-Latin Language Support 651

Output format Limitation
HTML • HTML outputs only support scoring with a single rule -
all scoring types are mapped to a single underline.
• HTML outputs do not support scoring or strikethrough
color - the color will always match the font color. This
is a HTML, CSS, and browser limitation.
• HTML outputs do not support the application of scoring
to words only - scoring will always run over spaces
between words.
• The Words Only setting for strikethrough is not
supported
• Custom underline styles will be supported when applied
using the Words and Spaces option. A single
underline will only appear if the Words Only position
option is used.
Arbortext Editor Arbortext Editor ignores the height value specified for
view scoring (used to apply strikethrough and overline effects),
assuming that any scoring set should appear midway
through the text. For this reason, an overline setting will
appear as strikethrough.

Right-to-Left Layout Direction

Arbortext Styler provides the option to set a right-to-left layout direction for an
element. The element’s content and margins, indents, columns, etc. are drawn in
relation to the right of the page. Hebrew and Arabic language documents can
therefore be formatted correctly in print.
The right-to-left layout direction option is activated by setting the Layout direction
(PTC APP) property field, located in the Indent category for elements, contexts,
conditions, and property sets, to a value of Right to left.

Note
This formatting is only effective when publishing the document for print or
PDF with an Arbortext Styler stylesheet and the PTC APP print engine. The
Layout direction (print/PDF only) option is not available in the Indent category
if either FOSI or XSL-FO is set as the active print engine.

This capability can be applied to a number of different cases. Suggestions are

made below:

652 User's Guide

• Right-to-left text direction active throughout entire single document — enable
the setting on the document's top level element and it will be inherited through
all children elements in the document
• Right-to-left text direction active in some of a set of different language
documents styled from a single stylesheet — create a condition based on a test
for the value of the xml:lang attribute for the document's top level element and
enable the setting for that condition.
• Right-to-left text direction active in some parts of a single document in
multiple languages — enable the setting for the elements, contexts or
conditions within the document that should display right-to-left text direction,
for example the division elements where language transitions will occur.

Example: Activating Right-to-Left Text Direction for an Element

The example shown below describes how to specify that right-to-left layout
direction should apply for the context first para in a chapter in an XML
document based on the DocBook document type.
1. In Arbortext Editor, open the file transport.xml located at
Arbortext-path/samples/styler.
2. Choose Styler ▶ Edit Stylesheet to open the stylesheet currently associated with
the document for edit. This is a read only stylesheet so you will need to save a
local copy if you want to make amendments.
3. Configure your Arbortext Editor with Styler environment to use PTC APP as
the effective print engine.
4. In the Elements list, create the context first para in chapter.
5. In the Indent category for the context, set the Layout direction (print/PDF only)
field to Right to left.
This field is only available if your environment is set to use PTC APP as the
effective print engine.
6. Choose the Preview ▶ Print menu option. In the PTC APP preview that
appears, note that the first paragraph in each chapter is set in relation to the
right of the page.

Non-Latin Language Support 653

 27
Publishing XML Documents as
RTF Files
Overview of Publishing to RTF ................................................................................. 656
Publishing RTF Files ............................................................................................... 656
Creating Export Stylesheets ..................................................................................... 657
Publishing RTF With and Without Using Word Style Names........................................ 658
Publishing Word Fields, Instructions, and Switches .................................................... 663
Publishing XML Attributes to Unique Word Paragraph or Character Styles................... 667
Publishing Figures in RTF Files ................................................................................ 670
Publishing Tables in RTF Files.................................................................................. 672
Publishing Table and Figure Captions in RTF Files..................................................... 673
Publishing Lists in RTF Files .................................................................................... 687
Publishing Headers and Footers in RTF Files ............................................................ 689
Publishing Footnotes and Endnotes in RTF Files ....................................................... 692
Publishing Scoped Tables of Contents in RTF Files.................................................... 692
Using Batch Processing to Publish RTF Files ............................................................ 694
Troubleshooting Import and Export Issues................................................................. 695
Limitations when Publishing to RTF .......................................................................... 696

This section describes how to publish XML documents as RTF files for use in any
application supporting RTF files.

655
Overview of Publishing to RTF
The export capabilities of Arbortext let you use Arbortext Styler to create Export
stylesheets, preview RTF versions of XML documents and publish XML
documents as RTF files. The published RTF documents can be opened in any
application supporting RTF files, such as FrameMaker, Interleaf, or Word. The
Export stylesheet is typically not unique to RTF output. It can be an existing
stylesheet currently used for other outputs that is updated to include RTF-specific
information.
It should be noted that you may notice differences if you compare published print
or PDF outputs with published RTF outputs of the same document.PTC Arbortext
does not, and cannot, guarantee page fidelity between PDF, print, and RTF output.
There are too many variables between publishing formats, applications that
display those formats, and versions of the applications which are used as the
viewers to be able to ensure identical output in all formats.

System requirements
Arbortext Styler must be installed and licensed to create Export stylesheets and to
preview RTF documents being exported with Published documents are formatted
in RTF meeting the Microsoft 1.7 specification.
This guide describes how to use Arbortext Styler to create Export stylesheets and
export XML documents to RTF.

Publishing RTF Files

Once one or more stylesheets have been created to support publishing to RTF, the
process is similar to that for publishing a document to any other format. Use the
following procedure to publish a document as an RTF file:
1. Open the XML document in Arbortext Editor.
2. Choose File ▶ Publish ▶ RTF File. The Publish to RTF dialog box is displayed.
3. In the Save As field, specify the path and file name of the published document.
4. In the Stylesheet field, select the stylesheet to use to style the RTF in the
published document. The stylesheet defines all of the aspects of the output
RTF file, based on the RTF export settings in the stylesheet. Typically, Export
stylesheets have been placed on the Arbortext Publishing Engine server.
5. Optionally, check the View Exported RTF Document option to automatically
view the published document. An application must be associated with the
.rtf file extension, as described in the Windows online help.
6. Choose OK. The document is published to RTF.
Refer to Using Batch Processing to Publish RTF Files on page 694 for information
on automating the publishing of documents.

656 User's Guide

Creating Export Stylesheets
Similar to that used to create styles for other publishing outputs, the process of
creating Export stylesheets involves using Arbortext Styler to set RTF stylesheet
properties for each context in your XML documents.
The general process described below applies:
1. In Arbortext Styler, open or create a stylesheet for the document type your
documents use.
2. Choose to edit the RTF stylesheet properties by selecting RTF in the Outputs
to edit field.
3. For each context and condition you expect to export, specify the font
properties, indent properties, spacing properties and so on via the tabs in the
Properties area of the Elements list.
4. In the RTF category, specify whether to use style names in the published
document, and, if using style names, where to define them. Refer to Publishing
RTF With and Without Using Word Style Names on page 658 for more details.

Note
The settings defined in the RTF category do not have to be specific only to
RTF output. Any settings defined in the category, such as RTF style names
and fields, will simply be ignored by all other outputs. In these cases, the
RTF category setting Base (All Outputs) has no effect.

5. At regular intervals throughout the stylesheet development, publish or preview

a test document to ensure the results are as you expect.
6. When your stylesheet is complete, copy it to the Arbortext Publishing Engine
server, making it available to your users. Refer to the Customizer's Guide for
details on working with the Arbortext Publishing Engine.
If you are developing Export stylesheets for publish to RTF, the following provide
further assistance on specific areas of focus:
• Publishing Figures in RTF Files on page 670
• Publishing Tables in RTF Files on page 672
• Publishing Table and Figure Captions in RTF Files on page 673
• Publishing Lists in RTF Files on page 687
• Publishing Word Fields, Instructions, and Switches on page 663
• Publishing XML Attributes to Unique Word Paragraph or Character Styles on
page 667

Publishing XML Documents as RTF Files 657

RTF Guidelines
Certain restrictions apply when you are creating an Export stylesheet. These are
described in the list below:

Note
If you encounter an unexpected error when publishing, refer to
Troubleshooting Import and Export Issues on page 695, which contains some
information that may help you diagnose the problem.

• The following characters are not permitted in RTF style names:

○ { – left brace (0x7B)
○ } – right brace (0x7D)
○ \ – backslash (0x5C)
○ ; – semicolon (0x3B)
• Arbortext Styler’s generic family names are mapped to specific Windows font
names as follows:
○ serif - Times New Roman
○ sanserif - Arial
○ monospace - Courier New
• XML id attributes must be exported as Word bookmark names. Only alpha
characters are permitted as the first character of Word bookmark names. The
only characters allowed as “not-first” characters in Word bookmark names are
alpha characters, numerals (0-9) and the underscore (_) character. IDs
destined for Word bookmarks are not case sensitive.
• Bookmark names cannot exceed 40 characters.
• Paragraph border information cannot be exported from Arbortext Styler-based
formatting.

Publishing RTF With and Without Using

Word Style Names
When publishing documents to RTF, you can choose to publish them either with
or without Word style names applied to paragraphs and inline characters.
You may wish to exclude style names for purposes of expedience and cost-
effectiveness. When you choose not to assign style names, it is assumed that your
primary concern is simply that the output RTF is well-formatted and appears

658 User's Guide

similar to other outputs. You are not concerned with the structure of the RTF file
(in terms of style names) and as such you wish to limit the time spent developing
Export stylesheets.
However, there are several circumstances in which you will need to use style
names:
• You want to leverage existing Word templates
• You will need to re-import published documents at a later date
• You want an identifiable structure in your exported documents (paragraphs in
documents published without style names are all assigned the Normal style).
When creating stylesheets that export XML to Word or RTF, you have the
following choices regarding style names:
• Publish using all of the style stylesheet properties defined in a stylesheet
without regard to Word style names
• Publish using Word style names automatically generated by Arbortext Styler
using the XPath version of the context selector string as the style name
• Publish using Word style names as defined in a user-specified Word template
• Publish using Word style names as defined in the stylesheet
• Publish list items using Word's built-in list paragraph styles (in conjunction
with any of the previous options)
These options are described individually in the sections below.

Publish Using the Style Properties Defined in a Stylesheet Without

Regard to Word Style Names
When publishing documents without style names, the formatting in the published
file will reflect most values defined in Arbortext Styler and all paragraphs (except
possibly listitem paragraphs, see below) will be assigned the Normal style.
Some Arbortext Styler stylesheet properties such as keeps, odd-even page sets,
and hyphenation may not be fully supported by Word or by Arbortext Import/
Export. Refer to Limitations when Publishing to RTF on page 696 for further
details.
Any context whose element is designated as a list item in Arbortext Styler may
use the Word built-in styles for list-related paragraph styles, depending on the
setting of the Use Built-in List Paragraph Styles option. This is the only exception
to output without style names. To set the required option:
1. With Arbortext Styler and your stylesheet open, choose the File ▶ Stylesheet
Properties menu option. The Stylesheet Properties dialog box is displayed.
2. Navigate to the RTF tab.
3. Ensure that the Generate RTF-style names automatically option is not checked
and choose OK.

Publishing XML Documents as RTF Files 659

Publish Using Word Style Names Automatically Generated by
Arbortext Styler Based on the Context Selector String
When publishing documents using automatically generated style names, the
formatting in the published file will reflect any values defined in Arbortext Styler.
Style names will be generated as follows:
• Any context whose structure type is Block will generate a Word paragraph
style with the same name as the element context name, as defined by the
XPath syntax (displayed when the Arbortext Styler menu option Options ▶
Show Contexts as XSL is checked). A Word style definition will be created as a
new style definition in the published RTF file, if it does not already exist,
which reflects the formatting stylesheet properties of the context.
• Any context whose Structure Type is Inline will generate a Word character
style with the same name as the context name. A Word style definition will be
created as a new style definition in the exported RTF file, if it does not already
exist, which reflects the formatting stylesheet properties of the context.
• Any context whose element is designated as a list item in Arbortext Styler
may use the Word built-in styles for list-related paragraph styles depending on
the setting of the Use built-in list paragraph styles option.
Word-builtin-styles.rtf can be used to support those publishing
processes that do not need final output to include custom styles, or Word styles. A
process using this template will use the word built-in styles defined in
normal.dot. For more specificity in output styles, specific style name
definitions must be included in the template associated with the publishing
process in the RTF tab of the Stylesheet Properties dialog box.
If Arbortext Styler is set to autogenerate style names in your publishing process it
will provide most of the work towards creating a Word template that is “Word
smart”. You should note, however, that Arbortext Styler does not provide support
for all Word constructs. For example, Word's document map depends on what
Word calls Headings. In an out of the box, English Word installation, these
Headings are called Heading 1, Heading 2, Heading 3, etc. Arbortext Styler does
not set this RTF-specific property, but allows the stylesheet developer to take
advantage of Word's unique formatting capabilities by allowing one to use a style
name to reference and link to a style which has been named and fully formatted in
Word (sometimes in very Word-centric ways that Arbortext Styler does not
support).
Documents that contain divisions do not lend themselves easily to a publishing
process that works on autogenerated style names. While you can define divisions
with associated levels in Arbortext Styler, they cannot be matched in Word
because Word does not use division elements, only titles with an associated
division level. Arbortext Styler does not attempt to derive the division level of
titles, because the style names used may be user-defined, automatically defined, or
not defined at all. It is intended that anything Arbortext Styler does not support

660 User's Guide

can be defined in a Word template to accompany the publishing process, then this
Word-specific information will be passed through verbatim to the resultant RTF
file.
To include style names that match Arbortext Styler contexts, e.g. chapter/
title, section/title, etc. the user-defined RTF template that is associated
with the publishing process in the RTF tab of the Stylesheet Properties dialog box
must contain Word's definition of those style names, which in turn must include
level settings. The easiest way to do this is to define the properties of these new
styles in Word, as based on Heading 1, Heading 2, etc. as appropriate. The based
on setting is a Word one, and as such further information can be found by
examining the style formatting dialog boxes in Word, and investigating Word's
online help.
Use the following steps to specify that Word style names be automatically
generated by Arbortext Styler based on the context selector string:
1. With Arbortext Styler and your stylesheet open, choose File ▶ Stylesheet
Properties. The Stylesheet Properties dialog box is displayed.
2. Navigate to the RTF tab.
3. Ensure that the Generate RTF style names automatically option is checked then
choose OK.
You should note that setting Arbortext Styler to autogenerate style names may
cause your publishing process to run about 10 times slower than usual.

Publish Using Word Style Names as Defined in Your Stylesheet

When defining style names in your stylesheet, Word style definitions will be
created and stored in the published Word document as named paragraphs or
character styles. The style definitions will reside in the \stylesheet section of
the RTF file. Optionally, you can open the published document in Word and copy
any of these Arbortext Styler-created Word style definitions to existing Word
templates.
Use the following procedure to designate style names for any stylesheet context:
1. For each context you wish to style, choose User-defined in the RTF style name
generation field on the RTF category. You may need to deselect the Default
(None) option before you can select the User-defined option.
2. In the RTF style name field, enter the name of the style to be assigned to the
content of the published context. The style name will be displayed in the RTF
Style/Field column in the Elements list.

Publishing XML Documents as RTF Files 661

 Note
If you intend to publish your document with user defined style names, it is
important that you disable the Keep track of formatting option in
Word when observing or defining the target style names for the final Word
document. When the option is enabled, the actual style name might not be
displayed as planned in Word's Style UI. Instead Word may display a
dynamically-created “phantom” style name which is a concatenation of local
formatting overrides to established styles, such as “Normal” + bold, when in
reality no such explicit style name exists. This may cause confusion (or
obscure the real task) in formatting when the Word styles are being applied in
Arbortext Styler.
To disable the option, uncheck the Keep track of formatting option in
Word's Editing Options (see Word online help).

Publish Using Word Built-In Styles for List Items

1. Consider the following items when publishing list items using Word's built-in
list paragraph styles.
• If you want list items to be auto-numbered in Word, ensure the Use built-in
list paragraph styles option is checked in the RTF tab of the Stylesheet
Properties dialog box, accessed by choosing the File ▶ Stylesheet
Properties menu option. In this case, list items will be published using the
built-in Word style names that exist in Normal.dot, Word's template
style template.
The advantage of this option depends on the intended recipient of the
document. If the RTF document is to be modified by the Word user, the
built-in list paragraph styles will ensure flexibility and dynamic auto-
numbering or auto-bulleting when list items are added to or deleted from
existing lists.
○ Bulleted list items, as defined by the Arbortext Styler style List -
Bulleted, will be published using the following Word style names:
◆ List Bullet - Represents a first-level bulleted list.
◆ List Bullet n - A nested list, where n is a digit from 2 to 5
representing the nesting level.
○ Numbered list items as defined by the Arbortext Styler style List -
Numbered, will be published using the following Word style names:
◆ List Number - Represents a first-level numbered, or ordered,
list.

662 User's Guide

 ◆ List Number n - A nested numbered list, where n is a digit from
2 to 5 representing the nesting level.
• If you do not want list items to be auto-numbered in Word, ensure Use
built-in list paragraph styles is not checked in the RTF tab of the Stylesheet
Properties dialog box. In this case list items will be published using bullet
characters, numerals, and punctuation as defined by Arbortext Styler.
This is the least flexible way to publish, from the perspective of a Word
author. The number and bullet characters, as well as punctuation and white
space, will be hard-coded as normal text. Auto-numbering will not take
place. Use this feature if you are delivering RTF documents for preview
only and you do not expect to re-import them. The advantage is that the
formatting of the numbers and bullet will match the Arbortext Styler-
defined stylesheet properties used for other outputs.
• If a given list item context, as defined by Arbortext Styler's List Item style,
is explicitly assigned a user-defined RTF style name, the Use built-in list
paragraph styles option is ignored.

Publishing Word Fields, Instructions, and

Switches
Word fields in Word documents are used as placeholders for data that might
change in a document (called the field result). Arbortext Styler contexts can be
mapped to Word field codes. For example, the contents of a document's author
element could be mapped to a Word field { AUTHOR [ "NewName" ] }. Content
that is all or partially generated can be mapped to an appropriate Word field.
Fields are typically composed of instructions and switches that combine to
produce a dynamically-generated field result. Instructions are single string values,
written in double quotes if enclosing ASCII spaces. Simple switches are boolean
arguments that are either on or off based on their presence. Value switches are
arguments with a string value.
Arbortext Styler automatically creates fields for certain element types when
publishing to RTF, and these are listed below. Note that the elements nominated to
represent these types in the document must be configured in the document type
and given the relevant style in the Arbortext Styler stylesheet for these mappings
to function correctly - for example an xref element must be configured and
styled as Cross Reference:

Fields Created for Element Types During an RTF Export Process

Element / attribute Word field created

Element with Arbortext Styler-generated ID bookmark
Element with user-defined ID attribute bookmark

Publishing XML Documents as RTF Files 663

Fields Created for Element Types During an RTF Export Process
(continued)
Element / attribute Word field created
link HYPERLINK
cross reference REF
graphic (linked) INCLUDEPICTURE
table of contents TOC
division title TC
index term XE
Mapping of Word fields does not depend on the use of a Word template during the
publishing process.
For further details on Word fields, and each field's instructions and switches, refer
to the online help accompanying Microsoft Word. The location of this information
in the help in different releases of Word varies, but finding Field Types and
Switches in the help Table of Contents should display a reference to fields.

Publishing Fields
When specifying fields, consider the different structure types involved with Word
fields. Some fields are simple text fields much like generated text in XML, where
the field wraps some dynamically created text. In these fields, such as AUTHOR,
the source for the generated text might be a Word document property. If you
publish text as the content of the field (such as Jane Doe), the text will display in
Word. But when fields are updated, for example via a CTRL+A+F9 refresh, the
text might be dynamically changed to use a different name depending on the
author currently editing the Word document.
Likewise, a field such as EDITTIME, which displays the amount of time spent
editing the document, can be published with a value such as 20.0 which
represents 20 minutes of editing. However, the value published by Arbortext
Import/Export will not be valid for very long, because the editing time is
constantly changing. Bear in mind, Word does not automatically update fields in
the same way as Arbortext Editor when automatically updating generated text.
You must manually update fields in Word via a CTRL+A+F9 refresh, or via a
macro function saved as part of your Word editing environment.

664 User's Guide

 Note
Certain Word fields depend upon real-time information created by Word when
a document is saved. For example, EDITTIME, LASTSAVEDBY, TIME,
NUMCHARS, NUMWORDS, and other fields depend on Word-based information
and cannot be supplied by Arbortext Import/Export in any meaningful way. If
dynamic fields such as these are published, be aware their result strings may
changes every time the document is saved by Word.

Mapping a Context to a Field

1. In the Elements list, highlight the context you wish to map to a field.
2. In the RTF category, choose Edit in the RTF field area. The Field dialog box is
displayed.
3. From the Field name list, choose the field to be published for the context. A
description of the field is displayed in the Field description field and the Field
instructions and switches table is filled with the instructions and switches
pertinent to the selected field.
Specify the characteristics of one or more Word fields to be exported with the
selected context
4. Enable boolean switches by clicking in the Use column for the switch.
5. Enable value switches by highlighting the switch:
a. Press F2 or double-click on the highlighted switch to edit simple text
strings.
b. Choose the Edit Value button to launch the Generated Text Editor, which
allows you to enter sophisticated expressions for computing, extracting, or
locating the value of the switch using the array of tools available. Refer to
Generated Text Overview on page 464 for details on using the Generated
Text Editor.
6. After entering a value, ensure that the box in the Use column for that switch is
checked.
7. Required instructions or switches are denoted using gray check boxes which
cannot be unchecked. You must enter a value for instructions or value switches
where marked as required, otherwise the field may display an error in Word or
exhibit other unexpected behavior.

Publishing XML Documents as RTF Files 665

Contexts can be mapped to output styles, fields, or both. For example, an author
context in a document can be mapped to a Word paragraph style called Author.
That same context can also be mapped to an author field. The resulting
document would contain a formatted paragraph with the style name Author
containing the author field result.

Preventing PCDATA From Being Published as a Field Result

If a #PCDATA element is published as a field, the default behavior in Arbortext
Import/Export is to publish the #PCDATA as the field result string, even though at
some later date the result string may change when fields are updated.
Use this procedure to suppress the #PCDATA and prevent its output as the field
result:
1. In Arbortext Styler select the context for which you wish to suppress the
#PCDATA.
2. In the Text category for the Elements list, set the Hidden option to Yes.
3. Create a User Formatting Element (UFE), with a name of your choice, to serve
as a placeholder in generated text. The UFE will be responsible for publishing
the desired field.
4. In the Generated text category, insert the newly-created UFE. Use RTF
Stylesheet Properties.
5. Select the UFE's default context and specify the desired field.
6. The #PCDATA of the main context will be suppressed because the Hidden
property is enabled, but the field will be published because generated text is
always published, regardless of the setting of the Hidden property.

Limitations when Publishing Fields

The following limitations apply in Arbortext Import/Export when publishing
fields:
• The following fields are not supported:
○ ADDRESSBLOCK
○ ASK
○ AUTOTEXT
○ AUTOTEXTLIST
○ BIDIOUTLINE
○ DATABASE
○ DDE
○ EMBED
○ GREETINGLINE

666 User's Guide

 ○ MERGEFIELD
○ MERGEREC
○ MERGESEQ
○ NEXT
○ NEXTIF
○ PRINT
○ SKIPIF
• Nested fields are not supported.
• When referencing XML id attributes in Word fields, the XML ID values may
not contain characters which are illegal in Word bookmark names. Arbortext
Import/Export automatically filters illegal characters before publishing as
Word bookmark names. The only characters allowed as the first character of a
Word bookmark names are alpha characters. The only characters allowed as
non-first characters in Word bookmark names are alpha characters, numerals
(0 - 9) and the underscore (_) character. Illegal characters are escaped using
the underscore character (_), followed by the two-digit hexidecimal value of
the character. This means that underscores are themselves escaped as _5F, as
well as any other punctuation characters. Unicode characters are allowed in
bookmark names, as well as 8-bit characters between 128 and 255.
• Not all Word fields are automatically updated when a document is first
opened. Consequently, field results may not be immediately visible in
published documents. To update the fields in an RTF (or Word) document,
open the document, press CTRL+A to highlight the entire document, and press
F9 to refresh. This process can be automated with a post-publishing hook,
which can load the RTF document into Word, update the fields, and save the
changes to RTF or to a binary (.doc) format.

Publishing XML Attributes to Unique

Word Paragraph or Character Styles
With Arbortext Import/Export, you can publish a document as an RTF file,
mapping a context and its attributes to multiple paragraph or character styles. This
will create generated text that presents attribute values as well-formatted visible
text such as #PCDATA. This technique can be beneficial when a top-level element
contains metadata attributes that must be included in the content of the published
document.
Consider the following markup:
<topic audience="marketing"
importance="urgent"
otherprops="company-confidential"

Publishing XML Documents as RTF Files 667

 platform="windows"
product="Widget 1.0" xml:lang="en-us">

You may want the resulting RTF document to contain content similar to the
following:
Product: Widget 1.0
Department: Marketing
Platform: Windows
Priority: Urgent
For Internal Use Only

You may want each newly-created paragraph to use a Word style name that
reflects its role, such as Product, Department, Platform, Priority, and Status. The
values could also be accurately re-imported as attributes on the topic element.
To map a context and its attributes to multiple paragraphs in Arbortext Styler,
create a User Formatting Element (UFE) for each attribute on the context you
wish to publish. The default context of each newly-created UFE makes it simple
to assign a Word style name and sophisticated generated text to highlight and
display attribute data which is very important, yet has no corresponding structural
counterpoint in RTF. Word has no concept of attributes except at the level of
document stylesheet properties. The technique described here serves the purpose
well at any structure level, not just the document level.
Use the following steps to create the published output described in the earlier
example:
1. In Arbortext Styler, create UFEs for each attribute to be published. Refer to
Adding User Formatting Elements to Generated Text on page 517 for steps on
adding UFEs.
For this example, create the following UFEs:
ufe:product
ufe:audience
ufe:importance
ufe:platform
ufe:otherprops

2. In the Generated text category for the topic element, click Edit to add
generated text before the element. Use the Insert ▶ User Formatting Element
menu option to insert your UFEs in the required order, then add leading text to
the first 4 UFEs as shown below:

668 User's Guide

3. In the case of _ufe:otherprops, the attribute value is not published as
document content. Instead, unique generated text is created based on the value
of the attribute.
Create a condition on _ufe:otherprops that will output the generated text
For Internal Use Only when the otherprops attribute has the value
company-confidential:

Refer to Adding User Formatting Elements to Generated Text on page 517 for
information on working with conditions.
4. Assign direct styling to each of the newly-created UFE elements, or reference
a Word style name, to format the output.
5. The granularity of the output in terms of paragraph styles and character styles
is at the discretion of the stylesheet developer. If the published document
might be later re-imported, consider creating UFE elements with an Inline
style to denote the generated text and UFE elements styled as Block to wrap
the #PCDATA. This makes it is easier to filter out and remove the character
styles which were the result of generated text, and simplifies the mapping of
the text back into the appropriate XML attributes.

Publishing XML Documents as RTF Files 669

Publishing Figures in RTF Files
By default, figures are published as linked graphics using the INCLUDEPICTURE
field. You can, however choose to publish documents with embedded graphics by
carrying out the following steps:
1. In Arbortext Styler, select the File ▶ Stylesheet Properties menu option. The
Stylesheet Properties dialog box is displayed.
2. Navigate to the RTF tab and check the Embed graphics option.
Be aware of the following restrictions when publishing graphics:
• Some graphic types have been assessed by Microsoft as posing a security risk
and are not permitted in RTF output by default. You may need to enable a
particular graphic type with a graphic filter setting.
For more information, see Microsoft support bulletin 2479871 — Security
settings for graphic filters for Microsoft Office 2013, Microsoft Office 2010,
the 2007 Microsoft Office system, Microsoft Office 2003, and Microsoft Office
XP.
• Positioning of graphics in published documents is not supported.
• RTF does not preserve the scaling of linked graphics images. Word binary files
(.doc) do preserve the scaling of linked graphics. If the graphic type can be
embedded, and you choose to embed graphics images rather than link graphics
images, scaling will be preserved in the RTF file.
This is true both for graphics originating in your document and graphics in
generated text.
• If you publish embedded graphics, the images will not display when the RTF
file is viewed using MS Word 97. This restriction does not apply to linked
graphics published using the INCLUDEPICTURE field, or when loading the
document containing embedded graphics in a later release of Word. If Word 97
compatibility is important, you should ensure that you work with linked
graphics, rather than embedding them. This is a limitation of Word 97.
• Only the following graphics formats may be embedded in an RTF file:
○ .jpeg
○ .gif (automatically embedded as .png)
○ .png
○ .wmf
○ .emf
All other graphics formats are published as linked graphics regardless of the
setting of the Embed graphics option.

670 User's Guide

All graphics are included in the accompanying output_filename_files
directory generated when publishing to RTF format. Both graphics files that are
referenced by link and those that are embedded in the host document will appear
in this directory.
If you have published with the Embed graphics option selected so that the
resulting RTF document’s graphics are embedded, you may be able to delete the
generated output_filename_files directory containing the graphics files
as it is no longer needed. Be sure to check that all your graphics have been
successfully embedded before deleting the directory. Rename (or move) the
output_filename_files directory then open the RTF document in Word.
Check that all the embedded graphics you expect to see are visible. If they are,
you can delete the graphics directory.
Note that some graphics cannot be embedded, either under the RTF specification
or due to limitations of Word. Even if you have set the Embed graphics option,
some of your graphics may still have been published as linked graphics. This is
one reason for checking before deleting the graphics file.

Publishing XML Documents as RTF Files 671

 Note
If generated, the output_filename_files directory has the same name
for both HTML File and RTF output. If you produce both HTML and RTF
output for the same document, and publish them to the same output directory,
both outputs will reference the same output_filename_files directory.
This could cause issues in certain circumstances:
• If, after generating both HTML File and RTF output, you delete/move the
.htm file, Windows will also delete/move the output_filename_files
directory. If the equivalent RTF output contains linked graphics, these will be
lost when the output_filename_files directory is deleted. To avoid
this issue, take care to output HTML File and RTF to separate directories, or
set your RTF file to use embedded graphics.
• Your stylesheet may be set up to treat a graphic in different ways, depending
on whether it appears in HTML File or RTF output. In this case it is not
acceptable to reference the same output_filename_files directory for
both outputs, since this will result in only one version of the graphic being
available.
Note also that publishing to HTML File may change the file extension of a
graphic, as the process converts graphics to web friendly format. Take care
that this will not overwrite a graphic of the same name that is intended to be
referenced in RTF output only. For example, a graphic named styler.cgm
will be converted to styler.jpg when the document is composed to
HTML File. If the graphic styler.jpg already exists in the output_
filename_files directory, but for RTF output only, this distinction will be
lost when the file is overwritten.
It is a good idea to publish HTML File and RTF outputs of the same document
to separate directories to avoid these issues.

Refer to Publishing Table and Figure Captions in RTF Files on page 673 for
information on publishing figure captions.

Publishing Tables in RTF Files

Tables are published with the layout defined when they were created in Arbortext
Editor.
Be aware of the following restrictions when publishing tables:

672 User's Guide

• Table Styles, introduced in Word XP, are not supported.
• Nested tables are not supported.
• Tables inside a footnote body are not supported.
• If auto-generation of RTF style names is enabled, or if a user-defined RTF
style is attached to a table-cell element (such as entry in the axdocbook
document type), table spanning is ignored. Spanning is not affected by child
elements of a table-cell element.
• Word does not apply prespace to tables, only to paragraphs. You may find that
a table that has a prespace setting still runs into preceding content or tables
when a RTF document is opened in Word. Refer to Prespace in tables in RTF
output in Applying Prespace and Postspace to Elements on page 239 for a
method by which prespace can be applied to a table.
Refer to Publishing Table and Figure Captions in RTF Files on page 673 for
information on publishing table captions.

Publishing Table and Figure Captions in

RTF Files
When publishing RTF documents containing tables or figures, you may want to
create captions that use autonumbering (generated text). This task can become
quite complex, with at least three solutions, each depending on whether you want
captions before or after the table or figure in the published document. Details of
each of the possible solutions are described later in this section.
The possible solutions are summarized below:
• Map a context to a single paragraph style - This approach is the simplest. The
caption is published as a single RTF paragraph style. Formatting, generated
text, and autonumbering are specified for the style with Arbortext Styler.
• Use generated text for labeling and a SEQ field for numbering - This approach
uses the SEQ field to perform the autonumbering of captions in Word, but
otherwise relies on Arbortext Styler to define the generated text for the pretext
label and the formatting surrounding the autonumbering. As in the first
approach, the caption is published as a single RTF paragraph style.
• Mix paragraph and character styles with a SEQ field - This approach publishes
the caption with a paragraph style that includes a character style for the
generated text and a SEQ field for autonumbering.

Publishing XML Documents as RTF Files 673

Mapping a Context to a Single Paragraph Style
With this approach, the context title in table publishes to a unique RTF
paragraph style designed exclusively for the presentation of a table title. This style
must be created or modified using Word to attach autonumbering stylesheet
properties to it.

Publishing the Title Before the Table

The element to be published is marked up as shown below:
<table><title>My user-defined Table Title</title>...</table>

Use the following steps to publish the title before the table itself:
1. In Arbortext Styler, create the context title in table.
2. Highlight the title in table context in the Elements list.
3. To avoid affecting non-RTF outputs, select RTF from the Outputs to edit drop
down list. This will ensure that any generated text and numbering used for
titles will not appear in other outputs.
4. Assign a user-defined RTF paragraph style, such as TableTitle, to the
title in table context, using the following steps:
a. In the RTF category, select the User-defined option in the RTF style name
generation field. You may need to deselect the Default (None) option to be
able to make this selection.
b. In the RTF style type field, check the Paragraph option.
c. Enter the name, for example TableTitle, of your user defined
paragraph style in the RTF style name field.
d. Click elsewhere in the Arbortext Styler window to update your setting.
You will see the style name you entered in the RTF Style/Field column in
the Elements list.
Note that this column may not be visible in your window - use the View ▶
Configure Columns menu option to activate it in your display.
The following RTF content will be published:
Paragraph Style: TableTitle
"Table n: " (RTF gentext, where n is autonumbering)
My user-defined Table Title (PCDATA)
[the Word table]

The title will use the paragraph style TableTitle. Table is a generated text
label and n is autonumbering. Both are assumed to be part of the RTF style
definition, not Arbortext Styler generated text.

Publishing the Title After the Table

The element to be published is marked up as shown below:
<table><title>My user-defined Table Title</title>...</table>

674 User's Guide

Use the following steps to publish the title after the table:
1. Create a User Formatting Element (UFE) with a name of your choice, for
example _ufe:tabletitle, to represent the context title in table.
Doing so will let you map this context to an RTF style and permit you to use
generated text to move the resulting RTF style to an arbitrary location which
does not depend on document order.
a. In Arbortext Styler, create the UFE _ufe:tabletitle. Check the View
▶ User Formatting Elements menu option to ensure your new UFE is
shown in the Elements list.
b. Select the context _ufe:tabletitle everywhere.
c. Assign the user defined RTF paragraph style TableTitle to the UFE
context by using the following steps:
i. In the RTF category, select the User-defined option in the RTF style
name generation field. You may need to deselect the Default (None)
option to be able to make this selection.
ii. In the RTF style type field, check the Paragraph option
iii. Enter the name, for example TableTitle, of your user defined
paragraph style in the RTF style name field.
iv. Click elsewhere in the Arbortext Styler window to update your setting.
You will see the style name you entered in the RTF Style/Field column
in the Elements list.
Note that this column may not be visible in your window - use the View
▶ Configure Columns menu option to activate it in your display.
d. To avoid affecting non-RTF outputs, select RTF from the Outputs to edit
drop down list. This will ensure that any generated text and numbering
used for titles will not appear in other outputs.
e. In the Generated text category, click Edit to add generated text after
element content. The Generated Text Editor opens. Follow the steps listed
below to insert the element content of the first title of table:
i. In the Generated Text Editor, choose the Insert ▶ Element Content
menu option. The Insert Element Content dialog box opens.
ii. In the Of: field, select title from the drop down menu. Ensure that
Element content is selected in the Insert field.
iii. In the Element selection field, check the Specific occurrence option.
iv. In the Occurrence: field, select 1st from the drop down list.
v. In the Within: field, select table from the drop down list.

Publishing XML Documents as RTF Files 675

 vi. Click OK to exit the Insert Element Content dialog box, then File ▶
Apply and Close to apply the change and exit the Generated Text
Editor.
2. Create generated text to publish _ufe:tabletitle after the table, using
the steps below. Generated text provides the means to place the table title text
outside the table construct.
a. In the Elements list, select the default context for table.
b. In the Generated text category, click Edit to add generated text after
element content. The Generated Text Editor opens. Follow the steps listed
below to insert the UFE _ufe:tabletitle:
i. In the Generated Text Editor, choose the Insert ▶ User Formatting
Element menu option, then select _ufe:tabletitle from the
pullright menu.
ii. Click File ▶ Apply and Close to apply the change and exit the Generated
Text Editor.
3. Make this context hidden in RTF-specific output, by using the following steps.
RTF output requires the flexibility to place a table title or a figure title after the
respective table or graphic image. Making it hidden for RTF output prevents

676 User's Guide

 RTF-driven side-effects on other outputs and prevents default Arbortext Styler
handling of the title.
a. In the Elements list, select the title in table context.
b. Select RTF in the Outputs to Edit list.
c. In the Text category, set Hidden to Yes.
The following RTF content will be published:
[the Word table]
Paragraph Style: TableTitle
"Table n: " (RTF gentext, where n is autonumbering)
My user-defined Table Title (PCDATA)

The title will use the paragraph style TableTitle and will be the element
content of the first title in table. Table is a generated text label and n
represents autonumbering. Both are assumed to be part of the RTF style definition,
not Arbortext Styler generated text.

Using Generated Text for Labeling a SEQ Field for

Numbering
This approach uses the SEQ field to perform the autonumbering of captions in
Word, but otherwise relies on Arbortext Styler to define the generated text for the
pretext label and the formatting surrounding the autonumbering.

Publishing the Title Before the Table

The element to be published is marked up as shown below:
<table><title>My user-defined Table Title</title>...</table>

Use the following steps to publish the table title before the table, using generated
text for labeling and a SEQ field for numbering:
1. Create the User Formatting Element _ufe:tabletitlenumber, using the
steps described below. Doing so lets you map the default context of this UFE
to a Word field, define structure at a level of granularity lower than the
paragraph text, and autonumber all tables that are given the common
numbering reference Table.
a. In Arbortext Styler, create the UFE _ufe:tabletitlenumber. Check
the View ▶ User Formatting Elements menu option to ensure your new UFE
is shown in the Elements list.
b. Assign the Inline style to _ufe:tabletitlenumber, via the Edit ▶
Style menu option.
c. Assign the RTF field SEQ to _ufe:tabletitlenumber by following
the steps described below:
i. Select the default context of _ufe:tabletitlenumber in the
Elements list.

Publishing XML Documents as RTF Files 677

 ii. In the RTF category, click the Edit button in the RTF Field field. The
Field dialog box opens.
iii. In the Field Name field, select SEQ from the drop down list.
d. Set the field values for SEQ as follows: .
• Set the field instruction VARIABLE NAME to Table. Ensure the Use
box is checked.
• (Optional) Set the \* switch to Arabic. Ensure the Use box is
checked.

2. Create generated text before the table, using the steps below. Generated text
provides the means to insert a user-defined SEQ field to perform
autonumbering. In this manner, the table numbering will be dynamic for the
Word author.
a. In the Elements list, create the context title in table if it doesn't
already exist.
b. Select the default title in table context for table.
c. In the Generated text category, click Edit to add generated text before
element content. The Generated Text Editor opens. Enter the following in
text format:
"Table " + <ufe:tabletitlenumber> + ":"

d. Click File ▶ Apply and Close to apply the change and exit the Generated
Text Editor.
The following RTF content will be published:

678 User's Guide

Paragraph Style: TableTitle
"Table: " (Styler gentext)
SEQ field (RTF gentext)
": " (Styler gentext)
My user-defined Table Title (PCDATA)
[the Word table]

Publishing the Title After the Table

The element to be published is marked up as shown below:
<table><title>My user-defined Table Title</title>...</table>

Use the following steps to publish the table title after the table using generated
text for labeling and a SEQ field for numbering:
1. Create the User Formatting Element _ufe:tabletitlenumber, using the
steps described below. Doing so lets you map the default context of this UFE
to a Word field, define structure at a level of granularity lower than the
paragraph text, and autonumber all tables that are given the common
numbering reference Table.
a. In Arbortext Styler, create the UFE _ufe:tabletitlenumber. Check
the View ▶ User Formatting Elements menu option to ensure your new UFE
is shown in the Elements list.
b. Assign the Inline style to _ufe:tabletitlenumber, via the Edit ▶
Style menu option.
c. Assign the RTF field SEQ to _ufe:tabletitlenumber by following
the steps described below:
i. Select the default context of _ufe:tabletitlenumber in the
Elements list.
ii. In the RTF category, click the Edit button in the RTF field field. The
Field dialog box opens.
iii. In the Field name field, select SEQ from the drop down list.
d. Set the field values for SEQ as follows: .
• Set the field instruction VARIABLE NAME to Table. Ensure the Use
box is checked.
• (Optional) Set the \* switch to Arabic. Ensure the Use box is
checked.

Publishing XML Documents as RTF Files 679

2. Create the UFE _ufe:tabletitle. The Arbortext Styler generated text for
the default context of title in table is responsible for defining the
destination RTF style TableTitle and publishing all title-related data to
RTF.
a. In Arbortext Styler, create the UFE _ufe:tabletitle. Check the View
▶ User Formatting Elements menu option to ensure your new UFE is
shown in the Elements list.
b. Assign the user defined RTF paragraph style TableTitle to the UFE
context by using the following steps:
i. In the RTF category, select the User-defined option in the RTF style
name generation field. You may need to deselect the Default (None)
option to be able to make this selection.
ii. In the RTF style type field, check the Paragraph option
iii. Enter the name, for example TableTitle, of your user defined
paragraph style in the RTF style name field.
iv. Click elsewhere in the Arbortext Styler window to update your setting.
You will see the style name you entered in the RTF Style/Field column
in the Elements list.
Note that this column may not be visible in your window - use the View
▶ Configure Columns menu option to activate it in your display.

680 User's Guide

 c. In the Generated text category, click Edit to add generated text after
element content. The Generated Text Editor opens. Enter the following in
text format:
"Table " + <ufe:tabletitlenumber> + ":"

Click File ▶ Apply and Close to apply the change and exit the Generated
Text Editor.
3. Create generated text to publish _ufe:tabletitle after the table, using
the steps below. Generated text provides the means to place the table title text
outside the table construct.
a. In the Elements list, select the default context for the table element.
b. In the Generated text category, click Edit to add generated text after
element content. The Generated Text Editor opens.
c. In the Generated Text Editor, choose the Insert ▶ User Formatting Element
menu option, then select _ufe:tabletitle from the pullright menu.
d. Click File ▶ Apply and Close to apply the change and exit the Generated
Text Editor.
4. Make this context hidden in RTF-specific output, by using the following steps.
RTF output requires the flexibility to place a table title or a figure title after the
respective table or graphic image. Making it hidden for RTF output prevents
RTF-driven side-effects on other outputs and prevents default Arbortext Styler
handling of the title.
a. In the Elements view, select the title in table context.
b. Select RTF in the Outputs to Edit list.
c. In the Text category, set Hidden to Yes.
The following RTF content will be published:
[the Word table]
Paragraph Style: TableTitle
"Table: " (Styler gentext)
SEQ field (RTF gentext)
": " (Styler gentext)
My user-defined Table Title (PCDATA)

Mixing Paragraph and Character Styles with a SEQ

Field
This approach publishes the caption with a paragraph style that includes a
character style for the generated text and a SEQ field for autonumbering. This
approach is appropriate when re-importing the document is a priority. This
approach is more difficult to set up, but it makes the import mapping simpler and
more efficient because the import mapping process does not have to parse the
details of generated text and numbering for the table title.

Publishing XML Documents as RTF Files 681

Publishing the Title Before the Table
The element to be published is marked up as shown below:
<table><title>My user-defined Table Title</title>...</table>

Use the following steps to publish the table title before the table, mixing
paragraph and character styles with a SEQ field:
1. Create the User Formatting Element _ufe:tabletitlenumber, using the
steps described below. Doing so lets you map the default context of this UFE
to a Word field, define structure at a level of granularity lower than the
paragraph text, and autonumber all tables that are given the common
numbering reference Table.
a. In Arbortext Styler, create the UFE _ufe:tabletitlenumber. Check
the View ▶ User Formatting Elements menu option to ensure your new UFE
is shown in the Elements list.
b. Assign the Inline style to _ufe:tabletitlenumber, via the Edit ▶
Style menu option.
c. Assign the RTF field SEQ to _ufe:tabletitlenumber by following
the steps described below:
i. Select the default context of _ufe:tabletitlenumber in the
Elements list.
ii. In the RTF category, click the Edit button in the RTF Field field. The
Field dialog box opens.
iii. In the Field name field, select SEQ from the drop down list.
d. Set the field values for SEQ as follows: .
• Set the field instruction VARIABLE NAME to Table. Ensure the Use
box is checked.
• (Optional) Set the \* switch to Arabic. Ensure the Use box is
checked.

682 User's Guide

2. Create the UFE ufe:tabletitlelabel. Creating a unique UFE for the
generated text associated with this title lets you provide a character style
which wraps the generated text within the table title. This character style
wrapper can then be ignored easily if you later import the document. Without
it, Arbortext Import must parse the entire table title to remove the non-
PCDATA. For example, in the title Table 1: My user-defined Table Title, the
only data to be imported to XML is the actual title My user-defined Table Title.
a. In Arbortext Styler, create the UFE _ufe:tabletitlelabel. Check
the View ▶ User Formatting Elements menu option to ensure your new UFE
is shown in the Elements list.
b. Assign the Inline style to _ufe:tabletitlelabel, via the Edit ▶
Style menu option.
c. Assign the RTF Character style TableTitleLabel to
_ufe:tabletitlelabel by using the following steps:
i. In the RTF category, select the User-defined option in the RTF style
name generation field. You may need to deselect the Default (None)
option to be able to make this selection.
ii. In the RTF style type field, check the Character option.
iii. Enter the name, for example TableTitleLabel, of your user
defined character style in the RTF style name field.
iv. Click elsewhere in the Arbortext Styler window to update your setting.
You will see the style name you entered in the RTF Style/Field column
in the Elements list.

Publishing XML Documents as RTF Files 683

 Note that this column may not be visible in your window - use the View
▶ Configure Columns menu option to activate it in your display.
d. In the Generated text category, click Edit to add generated text before
element content. The Generated Text Editor opens. Enter the following in
text format:
"Table "+ <ufe:tabletitlenumber> + ":"

Click File ▶ Apply and Close to apply the change and exit the Generated
Text Editor.
3. Assign the paragraph style TableTitle to the title in table context
and create Add Before generated text. By inserting
_ufe:tabletitlelabel in Add Before generated text, this context will
publish the TableTile paragraph start. Then, it will publish the character
style TableTitleLabel which will encapsulate the pretext and generated
text autonumbering. Finally, this context will publish the title PCDATA (by
default), which will reside in the parent paragraph style TableTitle.
a. Select the default context of title in table in the Elements list.
b. Assign the user defined RTF paragraph style TableTitle to the element
context by using the following steps:
i. In the RTF category, select the User-defined option in the RTF name
generation field. You may need to deselect the Default (None) option to
be able to make this selection.
ii. In the RTF style type field, check the Paragraph option.
iii. Enter the name, for example TableTitle, of your user defined
paragraph style in the RTF style name field.
iv. Click elsewhere in the Arbortext Styler window to update your setting.
You will see the style name you entered in the RTF Style/Field column
in the Elements list.
Note that this column may not be visible in your window - use the View
▶ Configure Columns menu option to activate it in your display.
c. In the Generated text category, click Edit to add generated text before
element content. The Generated Text Editor opens. Enter the following in
text format:
<ufe:tabletitlelabel>

Click File ▶ Apply and Close to apply the change and exit the Generated
Text Editor.
The following RTF content will be published:
Paragraph Style: TableTitle
Character Style:
"Table: " (Styler gentext) (ufe:tabletitlelable: PCDATA in the Character Style)
SEQ field (RTF gentext) (SEQ in the Character Style)
": " (Styler gentext) (ufe:tablelable: PCDATA in the Character Style)

684 User's Guide

 My user-defined Table Title (PCDATA in the Paragraph style)
[the Word table]

Publishing the Title After the Table

The element to be published is marked up as shown below:
<table><title>My user-defined Table Title</title>...</table>

Use the following steps to publish the table title after the table, using generated
text for labeling and a SEQ field for numbering:
1. Create the User Formatting Element _ufe:tabletitlenumber, using the
steps described below. Doing so lets you map the default context of this UFE
to a Word field, define structure at a level of granularity lower than the
paragraph text, and autonumber all tables that are given a common numbering
referenceTable.
a. In Arbortext Styler, create the UFE _ufe:tabletitlenumber. Check
the View ▶ User Formatting Elements menu option to ensure your new UFE
is shown in the Elements list.
b. Assign the Inline style to _ufe:tabletitlenumber, via the Edit ▶
Style menu option.
c. Assign the RTF field SEQ to _ufe:tabletitlenumber by following
the steps described below:
i. Select the default context of _ufe:tabletitlenumber in the
Elements list.
ii. In the RTF category, click the Edit button in the RTF field field. The
Field dialog box opens.
iii. In the Field name field, select SEQ from the drop down list.
d. Set the field values for SEQ as follows: .
• Set the field instruction VARIABLE NAME to Table. Ensure the Use
box is checked.
• (Optional) Set the \* switch to Arabic. Ensure the Use box is
checked.

Publishing XML Documents as RTF Files 685

2. Create the UFE ufe:tabletitlelabel. Creating a unique UFE element
for the generated text associated with this title lets you provide a character
style which wraps the generated text within the table title. This character style
wrapper can then be ignored easily if you later import the document. Without
it, Arbortext Import must parse the entire table title to remove the non-
PCDATA. For example, in the title Table 1: My user-defined Table Title, the
only data to be imported to XML is the actual title My user-defined Table Title.
a. In Arbortext Styler, create the UFE _ufe:tabletitlelabel. Check
the View ▶ User Formatting Elements menu option to ensure your new UFE
is shown in the Elements list.
b. Assign the Inline style to _ufe:tabletitlelabel, via the Edit ▶
Style menu option.
c. Assign the RTF Character style TableTitleLabel to
ufe:tabletitlelabel by using the following steps:
i. In the RTF category, select the User-defined option in the RTF name
generation field. You may need to deselect the Default (None) option to
be able to make this selection.
ii. In the RTF style type field, check the Character option.
iii. Enter the name, for example TableTitleLabel, of your user
defined character style in the RTF style name field.
iv. Click elsewhere in the Arbortext Styler window to update your setting.
You will see the style name you entered in the RTF Style/Field column
in the Elements list.

686 User's Guide

 Note that this column may not be visible in your window - use the View
▶ Configure Columns menu option to activate it in your display.
d. In the Generated text category, click Edit to add generated text before
element content. The Generated Text Editor opens. Enter the following in
text format:
"Table "+ <ufe:tabletitlenumber> + ":"

Click File ▶ Apply and Close to apply the change and exit the Generated
Text Editor.
3. Create generated text to publish _ufe:tabletitle after the table, using
the steps below. Generated text provides the means to place the table title text
outside the table construct.
a. In the Elements list, select the default context for table.
b. In the Generated text category, click Edit to add generated text after
element content. The Generated Text Editor opens.
c. In the Generated Text Editor, choose the Insert ▶ User Formatting Element
menu option, then select _ufe:tabletitle from the pullright menu.
d. Click File ▶ Apply and Close to apply the change and exit the Generated
Text Editor.
4. Make this context hidden in RTF-specific output, by using the following steps.
RTF output requires the flexibility to place a table title or a figure title after the
respective table or graphic image. Making it hidden for RTF output prevents
RTF-driven side-effects on other outputs and prevents default Arbortext Styler
handling of the title.
a. In the Elements view, select the title in table context.
b. Select RTF in the Outputs to Edit list.
c. In the Text category, set Hidden to Yes.
The following RTF content will be published:
[the Word table]
Paragraph Style: TableTitle
Character Style:
"Table: " (Styler gentext) (ufe:tabletitlelable: PCDATA in Character Style)
SEQ field (RTF gentext) (SEQ in Character Style)
": " (Styler gentext) (ufe:tablelable: PCDATA in Character Style)
My user-defined Table Title (PCDATA in the Paragraph style)

Publishing Lists in RTF Files

Word supports three ways to designate lists:

Publishing XML Documents as RTF Files 687

• List-related paragraph styles - A Word paragraph designated as a list item by
means of a paragraph style which includes auto-numbering stylesheet
properties.
• List objects - A Word paragraph designated as a list item using Word's
Numbering or Bullets toolbar buttons, or Format/Bullets and
Numbering menu selection.
• List styles - Introduced with Word XP, a list style combines the features of
Word's Bullets and Numbering dialog box, adding the ability to name a
given list organization and hierarchy.
Arbortext Import/Export publishes list-related paragraph styles only. Be aware of
the following restrictions when publishing lists:
• If you specify a Word style name which is a list-related paragraph style name,
either in the built-in style template or the user-defined Word template, the
paragraph will be formatted according to the style definition in Word, not the
formatting defined by Arbortext Styler.
• If you specify a style name in Arbortext Styler, the paragraph will use the
named style, regardless of whether it renders as a list item or not.
• If you do not specify a style name for an element that is defined in Arbortext
Styler as a list item style, one of the built-in Word styles typically used for list-
related paragraphs (listed later in this section) will automatically be assigned if
the Use built-in list paragraph styles option is checked in the RTF tab of the
Stylesheet Properties dialog box. Lists and nested lists will be limited to
simple numbering patterns, with no compound numbering, for numbered lists
and simple bullet characters for bullet lists.
• If you specify a named Word style that does not exist in the destination Word
template, the published document will designate the style name as defined by
Arbortext Styler, and the formatting will be defined by the Arbortext Styler
stylesheet properties for the given context. The style will be based on the
template's Normal style, meaning the base style for the newly-created Word
style will be the Normal style, but the appearance of the new style will be
defined by Arbortext Styler.
• Only Arbortext Styler context objects can be published to Word list
paragraphs. Arbortext Styler, in general, has the ability to change the list type
and list numbering scheme at the condition level, but this is not supported by
the publishing process. If you want to publish Listitem styles to Word list
paragraph styles based on the value of an attribute in the document, you must
create unique XPath-based contexts to make the distinction. If Word list
paragraph styles are used for published lists and conditions are used to
override the bullet or numbering scheme, you have to remove the number-
related generated text from the RTF output.

688 User's Guide

Word Built-In Paragraph Styles for Lists
The built-in paragraph styles for bullet lists include:
• List Bullet
• List Bullet 2
• List Bullet 3
• List Bullet 4
• List Bullet 5
The built-in paragraph styles for numbered lists include:
• List Number
• List Number 2
• List Number 3
• List Number 4
• List Number 5
The built-in paragraph styles for simple lists include:
• List
• List 2
• List 3
• List 4
• List 5
The built-in paragraph styles for “not-first” list paragraphs include:
• List Continue
• List Continue 2
• List Continue 3
• List Continue 4
• List Continue 5

Publishing Headers and Footers in RTF

Files
Publishing headers requires knowledge of how headers and page sets are created
and used in Arbortext Styler. Fortunately almost all of the stylesheet development
for page headers and footers in other outputs such as PDF serves equally well for,

Publishing XML Documents as RTF Files 689

or at least does not interfere with, RTF output. The main difference is some
additional work that defines how to create dynamically active headers for a Word
document in cases where the Word document may be edited by the end user.
Consider the concept that output to RTF is different from most other outputs
because the published document may be destined for an editing system such as
Word. Most other outputs are documents destined for read-only viewers of various
types, such PDF files, HTML files, print publishing, and HTML Help. Because
the RTF document might be edited significantly with extensive addition or
reduction of pages, it is not sufficient to simply publish hard-coded page numbers
and header content.
Page numbering is automatically supported by virtue of Word PAGEREF fields, so
simple page footers require no extra effort. Headers with dynamic title
information requires some minor additions.
The easiest way to implement dynamic header information is by using the
STYLEREF field in conjunction with RTF style names associated with division
titles. For example, with the axdocbook doctype, if you wish to insert the current
chapter title into the RTF header, use the following steps:

Inserting a Chapter Title into the RTF Header

1. In Arbortext Styler, select the title in chapter context in the Elements
list.
2. Assign an RTF style name to the context, for example the default auto-
generated name chapter/title, using the steps described below. This will
ensure all chapter titles are published to RTF with this designated paragraph
style name.
a. In the RTF category, check the User-defined option in the RTF style name
generation field. You may need to deselect the Default (None) option to
enable you to make the selection.
b. In the RTF style type field, select the Paragraph option.
c. In the RTF style name field, leave the default style chapter/title that
is added by Arbortext Styler.
3. Create the UFE _ufe:RTFHeader. Check the View ▶ User Formatting
Elements menu option to ensure your new UFE is shown in the Elements list.
4. Assign the Inline style to ufe:RTFHeader, via the Edit ▶ Style menu option.
5. Assign the RTF field STYLEREF to _ufe:RTFHeader by following the
steps described below:
a. Select the default context of _ufe:RTFHeader in the Elements list.
b. In the RTF category, click the Edit button in the RTF field field. The Field
dialog box opens.

690 User's Guide

 c. In the Field name field, select STYLEREF from the drop down list.
6. Set the field values for STYLEREF as follows: .
• Set the field instruction STRING to chapter/title. Ensure the Use box
is checked.

7. Modify the odd-page and even-page header blocks for the mainbody-page
Page Set by inserting the newly-created _ufe:RTFHeader into the
generated text that defines each header. In the case of the distributed
axdocbook stylesheet, the new header markup would be:
<_ufe:header-font><DivisionReference><_ufe:RTFHeader></_ufe:RTFHeader>
</_ufe:header-font>

Because _ufe:RTFHeader only publishes a Word field, and because RTF-

related features are ignored by all other outputs, the RTF-specific markup has
no affect on non-RTF outputs. In turn, the DivisionReference markup
has no effect on RTF output, meaning the two different types of markup can
coexist if desired.

Note
In the previous example, the content and level of granularity is easily managed
with Arbortext Styler through UFEs. _ufe:RTFHeader could, for example,
include its own generated text, such as the prefix Chapter, or the header could
also include lower-level information such as sect1 titles instead of just
chapter titles by creating additional UFE elements as needed.

Publishing XML Documents as RTF Files 691

Publishing Footnotes and Endnotes in
RTF Files
Arbortext Import/Export supports the publishing of footnotes. However, be aware
the publishing of tables and lists inside a footnote body are not supported.
The published footnotes are dynamic in Word as auto-numbered footnotes, but
endnotes are not fully supported. Publishing footnotes requires no extra work
when compared to other outputs, such as PDF, but, if desired, the footnote body
can be mapped to a paragraph style, such as the Word built-in style Footnote
Text. The Word built-in style Footnote reference is not supported on the
footnote superscript numerals, but their formatting and functionality is the same as
one would expect in Word.
The user can create endnotes, as described in Endnotes Overview on page 448, but
the insertion, deletion, or autonumbering of endnotes will not use the Word
endnote object model as is typically created using the Word user interface. The
result is hard-coded numbering which is not conducive to round-tripping or
editing in Word.

Publishing Scoped Tables of Contents in

RTF Files
The process below describes how to configure a scoped table of contents (TOC),
for example a TOC for each chapter of a document, that will be generated when
your document is published to RTF output. In general, you will need to create two
sets of UFEs:
• Two UFEs that mark the beginning and end of the scope of the TOC (Word
calls such markers "bookmarks", though these are unrelated to PDF
bookmarks). These UFEs contain RTF edited source
• A UFE that makes use of Word field codes to generate the scoped TOC
The RTF-specific tasks required to set up the TOC using these UFEs are given
below (note that the process uses chapter as the scope of the TOC):
1. Assign a unique ID to the chapter element for which you wish to create the
TOC.
2. In Arbortext Styler, set the Outputs to edit field to RTF, if required.
3. Create a context for the occurrence of the chapter element for which you
are creating the TOC, if necessary.
4. Create the UFE that marks the beginning bookmark for the chapter. This UFE
must be named _ufe:bookmark_begin to ensure the publishing process
identifies it as the marker for the start of the scope. Give the UFE the Hidden
style.

692 User's Guide

5. Create the necessary source edits for XSL-FO RTF output for
_ufe:bookmark_begin, so that it will emit a tag for defining the
beginning of a Word bookmark range. This range defines the boundary of a
TOC's scope.
Refer to the XSL-FO RTF source edits in the distributed sample stylesheet
axdocbook.style for an example of the required source edit.
6. Reference the UFE in the generated text of the required chapter context,
using the Before-text option. Insert an XPath string such as
concat(ancestor-or-self::chapter/@id,'_toc') as a child of
the UFE to create a unique bookmark from each chapter ID attribute.
7. Create the UFE that marks the end of the bookmark range for the chapter. This
UFE must be named _ufe:bookmark_end to ensure the publishing
process identifies it as the marker for the end of the scope. Give the UFE the
Hidden style.
8. Create the necessary source edits for XSL-FO RTF output for
_ufe:bookmark_end, so that it will emit a tag for defining the end of a
Word bookmark range. This range defines the boundary of a TOC's scope.
Refer to the XSL-FO RTF source edits in the distributed sample stylesheet
axdocbook.style for an example of the required source edit.
9. Reference the UFE in the generated text of the required chapter context,
using the After-text option. Insert an XPath string such as
concat(ancestor-or-self::chapter/@id,'_toc') as a child of
the UFE to create a unique bookmark from each chapter ID attribute.
10. Create the UFE that will override the default behavior of Arbortext Styler
when creating TOCs, by using bookmark-specific options on the Word TOC
field (see Word's online help for the TOC field). This UFE can have any name,
for example _ufe:rtf_chapter_toc. Give the UFE the Block style.
11. Define the TOC field for this UFE so that it emits a Word TOC field of the
following form:
{ TOC \f X \b bookmark_name_toc }
Where X is a Word TOC identifier (see Word online help), and bookmark_
name_toc is built from the ID value of the chapter tag plus a _toc suffix.
12. Reference the UFE in the generated text of the required TOC context, for
example toc in chapter, using the Before-text option. This will emit the
Word TOC field, automatically matching the bookmark_name_toc
described above
In all cases the Word TOC identifier coincides with Word TC fields emitted on the
appropriate division titles.

Publishing XML Documents as RTF Files 693

The identifiers are automatically generated in upper case alpha order based on the
list of tables of contents in Arbortext Styler. For example, the first TOC in the
Arbortext Styler list matches the "A" identifier in the Word TOC and TC fields.
The second TOC in Arbortext Styler matches the "B" identifier. There is therefore
a practical limit of 26 unique tables of contents per stylesheet.
Because these Word identifiers are automatically created and generated in the TC
fields (which are the TOC entries) during the publishing process, but the
stylesheet developer must enter a hard-coded value, "A", "B", "C", "D", etc., in
the TOC field, changes to the list of tables of contents which affect the order of
TOCs may mean you need to adjust the values in affected TOCs’ contexts.

Note
If Word Heading styles are used for division titles (see Word online help), the
TC fields may be ignored.

You must update fields to see these TOCs. Select all content in the document by
pressing CTRL+A, then update the fields by pressing F9.

Using Batch Processing to Publish RTF

Files
You can use Arbortext Import/Export to publish documents in an unattended, or
batch, fashion. Use the following ACL function when publishing documents in
batch mode.
document_export([InFile[, outFile[, styleFile[, logFile[, nFlags]]]]])
The document_export command can be run from the Arbortext Editor
command line, or placed in a .bat or script file and scheduled to run at some
other time. Use the following syntax for publishing documents (where the
parameters are replaceable values, as described in document_export in Arbortext
Command Language Reference):

Note
The syntax examples specify when quotes are required.

<Arbortext-path>\bin\epic -c "document_export('inFile',
'outFile','styleFile','logFile',1)"

694 User's Guide

Troubleshooting Import and Export
Issues
Extended processing times when publishing documents to RTF
Microsoft Word's document model is one with a flat structure consisting primarily
of paragraphs, tables, and images. In Word documents there is no such thing as a
structural division tag; there are only paragraphs which are formatted to look like
divisions. If your XML document is based on a complex DTD with a hierarchy
nested to many levels, some flattening has to occur at some point in the process of
producing RTF. This is a limitation of MS Word. If your document is extremely
complex, for example with blocks nested to many levels, or if your document is
large (more than 100 pages), the publishing process requires a lot of processing
time to flatten this out to a Word-friendly structure. Please take note of this in the
first instance when troubleshooting an Export process.

Log Files, Error Return Codes, and Event Log Errors

The Arbortext ACL functions and general import, publish, and mapping
functionality uses the PTC Arbortext event log mechanism. Error return codes for
these operations are defined in the following table.

Import and Export Return Codes

Return Description
code
-1 Platform is not MS Windows.
0 No error.
1 No HOME directory defined.
2 No file selected.
3 Arbortext Import/Export feature not installed.
4 Specified Repository directory is in the install tree.
5 Specified Repository directory not found.
6 Specified Repository directory is missing required
subdirectories.
7 Cannot open \importexport\config\XYZ_
SysPrefs.xml.
8 Cannot create specified Arbortext Import Workbench path.
9 Cannot create specified Arbortext Import configuration path.
10 Cannot copy default configuration from install tree.
11 Cannot create Repository directory.
12 Attempt to create project in the install tree.

Publishing XML Documents as RTF Files 695

Import and Export Return Codes (continued)
Return Description
code
13 Arbortext Import project fatal exception.
14 Invalid Import options.
15 File copy operation failed.
16 Directory copy operation failed.
17 Repository copy operation failed.
18 Project copy operation failed.
19 Operation cancelled by user.
20 Project .exlst not found.
21 Project .exlst is invalid.
22 No Arbortext Import Workbench license found.
23 No Arbortext Import/Export license found.
24 Cannot create backup copy.
25 Undefined error.
26 Path too long.
27 Cannot open driver factory.
28 Configuration directory does not exist.
29 sysprefs path not found.
30 Configuration directory is network path.
31 Configuration directory copied.
32 Cannot load conversion bridge DLL.
If you receive the error message Failed to load
conversion bridge DLL with return code 30 and a path
starting with \\, this indicates that the executable is on a
network drive. This configuration is not supported due to .Net
library restrictions.
33 Migration no longer supported.

Limitations when Publishing to RTF

Be aware of the following limitations and usage notes when using Arbortext to
publish documents as RTF files:

696 User's Guide

• To preview published RTF documents from Arbortext Styler, a Windows
application must be associated with the .rtf file extension. Typically, Word
is associated with .rtf , but WordPad will also display .rtf documents.
• RTF does not support VBA macros. However, templates that contain macros
can be actively associated with an RTF file. RTF does not support toolbars,
because document-specific toolbars employ VBA. In the same way, RTF does
not support autotext lists since these also employ VBA.
• User-defined style names cannot exceed 64 characters when manually entered
on the Arbortext Editor RTF tab. Selecting style names from a user-defined
drop down list allows for style names up to 253 characters long.
• Links can only contain text data.
• Hyphenation is supported at the paragraph level, but is not apparent unless the
global hyphenation option is enabled in MS Word. Automatic hyphenation
must be manually enabled in Word to view the hyphenation.
• Hyphenation does not address localization differences.
• Word character styles do not include a background color (or highlight)
property. Therefore, an inline element which is mapped to a character style
cannot simultaneously apply the background color. This limitation does not
prevent you from formatting the background color of an inline element when
that element is not mapped to an RTF character style.
• Arbortext Styler inline elements cannot be published as RTF paragraph styles
in a reliable manner. If the Arbortext Styler structure type is Inline, and the
desired output is an RTF paragraph style, create an Arbortext Styler UFE of
structure type Block and associate the desired RTF paragraph style with that
UFE. With Arbortext Styler generated text, you can publish the original
element and its content within the context of the UFE.
• When auto-generating style names when publishing to RTF, it is assumed that
certain Arbortext Styler style categories do not contain text data or have no
style information at all. Therefore, because they do not correspond to a Word
paragraph style or character style, no Word style will be created for the
following Arbortext Styler styles or roles:
○ Custom Table
○ Definition List
○ Division
○ Document
○ Formal Block
○ Graphic
○ Index

Publishing XML Documents as RTF Files 697

 ○ Table Style
○ Index
○ Index Term (both models)
○ List Bulleted
○ List Numbered
○ No Style
○ Table of Contents
○ Unstyled
○ Table
○ Table roles such as header row and row
• Refer to Creating Export Stylesheets on page 657 for a list of usage notes
related to creating styles.
• Refer to Publishing Word Fields, Instructions, and Switches on page 663 for a
list of usage notes related to publishing fields.
• Refer to Publishing Lists in RTF Files on page 687 for a list of usage notes
related to publishing list items.
• Refer to Publishing Tables in RTF Files on page 672 for a list of usage notes
related to publishing tables.
• Refer to Publishing Figures in RTF Files on page 670 for a list of usage notes
related to publishing figures.

698 User's Guide

 28
Extending Stylesheets
Identifying Items that have Edited Source.................................................................. 700
Viewing Stylesheet Source....................................................................................... 701
Editing Stylesheet Source Overview ......................................................................... 703
Editing Element Source ........................................................................................... 706
Editing Property Set Source ..................................................................................... 709
Editing Page Set Source .......................................................................................... 709
Editing FOSI Resource Description Source ............................................................... 710
Editing Common XSL Source ................................................................................... 711
Editing XSL Root Template Source ........................................................................... 712
Editing PTC APP Root Template Source ................................................................... 712
Overview of Autogenerated PTC APP Source ........................................................... 714
Tips for Editing Stylesheet Source ............................................................................ 722
Editing Stylesheet Source Examples......................................................................... 723
Editing FOSI Source that Contains a Reference to an Object ...................................... 725
Editing FOSI Source of Elements with Numbered Contexts or Conditions .................... 726
Extending the Edited Source Function by Adding More Complex Code........................ 727
Deleting Source Edits .............................................................................................. 731
Comparing Edited Source and XPath for Stylesheet Extension ................................... 731

This section describes how you can extend your stylesheet by editing its source
code for individual output formats. This gives you the option to provide
formatting that cannot be achieved via settings in the Arbortext Styler UI.

699
Identifying Items that have Edited Source
If an object includes edited source, visual and textual indicators are visible in three
principal locations:
• Arbortext Styler window
○ The Description field of the Arbortext Styler window will contain a
confirmation in orange text that source edits have been defined.

If you have selected an element in the Elements list, the text will advise
whether the edited source applies to elements, contexts or both.
The Arbortext Editor preference stylerhassourceeditsfontcolor
determines the color of the Description tab label and the text confirming that
an object has source edits. See set stylerhassourceeditsfontcolor in Arbortext
Command Language Reference for further information. This is set to the
default color of orange, which matches the color of the icon overlay and the
checkmark in the Source Edits column, but you can change the color if you
require. Note, though, that if you set this preference to a different color, this
will not affect the color of the icon and the checkmark.
• List View
○ The icon for the object will be overlaid with an orange icon.
○ The Source Edits column will contain an orange tick icon. Note that this
column is not visible by default: use the View ▶ Configure Columns menu
option to open the Configure Columns dialog box and change your view.

700 User's Guide

 Sorting the column based on the Source Edits column will place all
definitions with source edits together.

• Find Where Used Results dialog box

○ The icon for the object in the Name field will be overlaid with an orange
square
○ The Source Edits column will contain an orange tick icon. Note that this
column is not visible by default: use the View ▶ Configure Columns menu
option to open the Configure Columns dialog box and change your view.
Sorting the column based on the Source Edits column will place all
definitions with source edits together.

Viewing Stylesheet Source

Arbortext Styler uses the style settings you make to generate different types of
stylesheet source code for different outputs and editors.
Arbortext Styler provides the ability to view the generated source code as you are
editing the stylesheet. Choosing View ▶ Source, and then choosing a format
launches an Arbortext Editor window with a subset of menus, with the specified
source code displayed in the window as a read-only file.
You can view edited source in the following formats:
• PTC APP (or FOSI or XSL-FO)
The print/PDF output type presented depends on the Print Engine setting for
the stylesheet..
• XSL-EPUB
• XSL-HTML File
• XSL-HTML Help

Extending Stylesheets 701

• XSL-Web
• XSL-FO RTF

View Source Menus

This section describes the menus in the View Source window.
• File menu:

○ Page Setup - Specifies print output settings for the source file.
○ Print - Prints an Editor View of the source document.
○ Close - Closes the window.
• Edit menu:

○ Copy - Copies the selected region to the clipboard.

○ Select Element - Selects the element containing the cursor. This option is
disabled in the Plain Text view (see View menu).
○ Select All - Selects the entire source file.
• Find menu:

○ Find - Finds specific text in the source file.

○ Find Next - Finds the next occurrence of the text specified in the Find/
Replace dialog box.
○ Find Tag/Attribute - Finds any combination of tag name, attribute name,
and attribute value. This option is disabled when editing as plain text, that
is, when the View ▶ Plain Text menu option is checked.
• View menu:

○ Collapse Element Content - Allows you to collapse the content of a

selected element
○ Refresh - Updates the window with any changes you have made in
Arbortext Styler since opening the source window.
○ Plain Text - Displays the stylesheet source using color coded, ASCII text.
○ Structured - Displays the stylesheet source as a structured document. This
view includes a document map and tags.
○ Edit View - Displays the stylesheet source as a tagged document when
Structured view is selected
○ Document Map - Displays the stylesheet source as a document map when
Structured view is selected
○ Synchronize views - Manually synchronizes the Document Map and the
Edit pane when Left-Right Split or Top-Bottom Split is selected on the
Window menu.

702 User's Guide

 ○ Expand Attributes - Displays all attributes associated with each element in
the Document Map.
○ Font Size - Sets font size for Plain Text or Structured views:
◆ Increase - Increases the size of the font in the pane with the focus. Font
size in percent is shown in the status bar. The limit is 500 percent of
the default size.
◆ Decrease - Decreases the size of the font in the pane with the focus.
Font size in percent is shown in the status bar. The limit is 40 percent
of the default size.

Editing Stylesheet Source Overview

Arbortext Styler uses the style settings you make to generate different types of
stylesheet source code for different outputs and editors. Arbortext Styler allows
you to directly edit the different types of generated stylesheet source to
accomplish effects that are not possible through the Arbortext Styler user
interface.
You can use source edits to reference custom JavaScript functions, if you are
working with the PTC APP engine. Arbortext Styler provides the option to create,
edit, and manage Function objects that hold JavaScript function code. You can call
these objects from a stylesheet extension with PTC APP code. Fore more
information, see Custom JavaScript Functions on page 749.
Be aware that if you edit the source of an object you cannot subsequently use the
Arbortext Styler UI to make further changes to the object. You should make all
changes to your element that are possible through the UI and then edit source to
apply the more complex effects.
There are many ways to identify if an object includes edited source - if you see
any of these indicators for an object, any changes to that object in the UI will have
no effect.
See Identifying Items that have Edited Source on page 700 for a list of the visual
indicators that an object includes edited source.

Extending Stylesheets 703

 Caution
Significant code changes between releases of Arbortext Styler mean that you
should always check that stylesheets that contain edited source still provide
the desired effect when they have been updated to a new release.
It can be difficult to maintain edited source changes as the stylesheet
progresses through later releases. Some suggestions to make the maintenance
task easier are given below:
• Try to isolate edited source as much as possible — edit only a context rather
than an entire element or, if possible, edit the source of a property set.
• If applicable, insert a UFE via generated text and edit the source of that UFE.
• Comment your edited source effectively so that, if you need to regenerate it
for a new release, you'll recognize the edit and know what it was meant to
achieve.
See the note in Comment Tab on page 785 for information on how to add
comments to source code.

You can edit stylesheet source for the following object types:
• Element
• Element context
• Property set
• Page set (print outputs only)
• Page type (PTC APP only)
• Page region (PTC APP only)
• Generated content object (FOSI and XSL-FO output only)
• XSL root template (XSL outputs only)
• FOSI resource description (FOSI output only)
• Common XSL source (XSL outputs only)
• PTC APP root template (PTC APP only)
The tables below describes the types of source that can be edited for each type of
output.

704 User's Guide

Supported Types of Source Editing

Source Uses Element Context Proper- Page Page

type ty set set type
APP Print/PDF • • • •
output
FOSI Editor view, • • • •
Print / PDF
output
XSL-FO Print / PDF • • • •
output
XSL-FO Text output • • •
RTF
XSL- HTML File • • •
HTML File output
XSL- HTML • • •
HTML Help output
Help
XSL-Web Web output • • •

Supported Types of Source Editing

Source Uses Page Gener- XSL FOSI Com-

type region ated root re- mon
content tem- source XSL
plate descrip- source
tion
APP Print/PDF •
output
FOSI Editor view, • •
Print / PDF
output
XSL-FO Print / PDF • • •
output
XSL-FO Text output • •
RTF
XSL- HTML File • •
HTML File output

Extending Stylesheets 705

Supported Types of Source Editing (continued)
Source Uses Page Gener- XSL FOSI Com-
type region ated root re- mon
content tem- source XSL
plate descrip- source
tion
XSL- HTML • •
HTML Help output
Help
XSL-Web Web output • •

Supported Types of Source Editing

Source type Uses PTC APP root

template
APP Print/PDF output •
FOSI Editor view, Print / PDF
output
XSL-FO Print / PDF output
XSL-FO RTF Text output
XSL-HTML File HTML File output
XSL-HTML Help HTML Help output
XSL-Web Web output

Editing Element Source

Arbortext Styler enables you to edit the source of an element, which will apply to
all contexts for the element and their conditions. The changes will affect the use of
the element in any output or editor.

706 User's Guide

 Note
Any edited source created for an element applies to the entire element
definition, i.e. all contexts of that element. The entire element definition then
becomes uneditable in the Arbortext Styler interface. If you subsequently
attempt to make changes to the element with the Arbortext Styler user
interface, those changes will not be reflected in any output or editor that uses
that type of source. Be sure you edit the source as the last step, after doing as
much configuring as possible for that object through the user interface.
For example, if you edit the FOSI source of an element in order to make it be
boxed in print output, and then later you change the font through the Arbortext
Styler user interface, the font change will not affect either Arbortext Editor or
print/PDF outputs. You must also make the font change to the edited source.
To handle the type of change:
1. Make a copy of the element.
2. In the original element, delete the edited source and make the font change.
3. In the copied element, edit the element source and copy the added boxing
formatting.
4. In the original element, edit the element source and paste the added boxing
formatting.
5. Delete the copied element.
For many types of changes to element edited source, the best way to prevent
maintenance problems is to isolate the edited source in a property set that is
referenced by the element. That will enable changes made through the
Arbortext Styler user interface to still affect the element.
You are permitted to create and manage edited source for individual contexts
of an element definition. It is possible to apply more advanced formatting to
the contexts of the element that need it, and continue to use the Arbortext
Styler UI to specify more common formatting for the element definition and
other contexts.
If you elect to edit the source of an element, you will be presented with a
message asking you to confirm that you wish to edit the source of the element,
rather than its individual contexts. Since any change you make to the element's
source will affect all contexts it is always preferable to edit the individual
contexts where possible.

Extending Stylesheets 707

Edit the source of an element
1. Select an element in the Elements list.
2. Choose Edit ▶ Edit Element Source, and then choose the type of output to
which the changes should apply.
You can choose FOSI (or XSL-FO), XSL-EPUB, XSL-HTML File, XSL-
HTML Help, XSL-Web, or XSL-FO RTF, or but you must make changes to
the element source for each output individually.
The print/PDF option presented depends on the print/PDF engine setting in
your stylesheet.
You cannot edit the source of an element for PTC APP.
3. Click Yes in the warning dialog box that appears to confirm that you wish to
proceed with editing the element's source.
4. In the Source Editor, you can make changes to the element's source that will
produce the desired formatting effect.

Editing the source of an element context

You may also edit the source of particular context of an element. The changes will
affect the use of the context in any output or editor. It should be noted here,
though, that although it is possible to edit the source of a single context of an
element, any changes made to source in this way will apply to all conditions in
that context.
1. Select a particular element context in the Elements list, choose Edit ▶ Edit
Context Source, and then choose the type of output to which the changes
should apply.
You can choose PTC APP (or FOSI or XSL-FO), XSL-EPUB, XSL-HTML
File, XSL-HTML Help, XSL-Web, or XSL-FO RTF but you must make
changes to the element source for each output individually.
The print/PDF option presented depends on the print/PDF engine setting in
your stylesheet.
2. In the Source Editor, you can make changes to the element's source that will
produce the desired formatting effect.
The ability to edit source of an element context was introduced in release 5.4 of
Arbortext Styler. If you introduce a pre-5.4 stylesheet that contains edited source
for an element, that edited source will apply for all contexts of the element
individually when you update the stylesheet for use in a later release.

708 User's Guide

Editing Property Set Source
Arbortext Styler enables you to edit the source for a property set. The changes will
affect the use of the property set in any output.
To edit a property set's source:
1. Select a property set in the Property Sets list.
2. Choose Edit ▶ Edit Property Set Source, and then choose the type of output to
which the changes should be applied. You can choose PTC APP (or FOSI or
XSL-FO), XSL-EPUB, XSL-HTML File, XSL-HTML Help, XSL-Web, or
XSL-FO RTF. You must make changes to the property set source for each
output individually.
The print/PDF option presented depends on the print/PDF engine setting in
your stylesheet.
3. In the Source Editor, you can make changes to the property set's source that
will produce the desired formatting effect.

Editing Page Set Source

Arbortext Styler enables you to edit the source for a page set. The changes will
affect the use of the page set in print and PDF outputs only.
To edit a page set's source:
1. Select a page set in the Page Sets list.
2. Choose Edit ▶ Edit Page Set Source, then choose the type of output to which
the changes should be applied. You can choose PTC APP, XSL-FO or FOSI,
depending on the Print Engine setting for your stylesheet. You must makes
changes to the page set source for each output individually.
3. In the Source Editor, you can make changes to the page set's source that will
produce the desired formatting effect.
You may also edit the source of the elements that make up a page set. This
depends on the Print Engine setting for your stylesheet:
• PTC APP — you can edit the source of page sets, page types, and page
regions
• FOSI or XSL-FO — you can edit the source of page sets and generated
content objects

Extending Stylesheets 709

Editing FOSI Resource Description
Source
Arbortext Styler enables you to edit the FOSI resource description to affect
display in Arbortext Editor and Print and PDF outputs (if your stylesheet uses
FOSI for print and PDF).
There are two types of edits you can make:
• Add a new charfill, counter, floatloc, hyphrule, or
stringdecl element.
• Modify one of the above elements that is generated by Arbortext Styler.

To add a new element to the FOSI resource description

1. Choose View ▶ Source ▶ FOSI, and review the contents of the generated
rsrcdesc element so you can avoid a name conflict with Arbortext Styler
generated elements. The following table shows the attributes that serve as keys
for each rsrcdesc element.
Element Key Attribute
charfill cfid
counter enumid
floatloc floatid
hyphrule language
stringdecl textid

You can leave the FOSI Source window open during the following steps.
2. Choose Tools ▶ Advanced Edited Source ▶ Edit FOSI Resource Description.
3. In the Source Editor, insert the elements you need, using values for the key
attributes that do not conflict with Arbortext Styler generated keys.
4. Choose File ▶ Apply and Close.
5. In Arbortext Styler, choose View ▶ Source ▶ FOSI to verify that your edits were
correctly merged with Arbortext Styler's generated resource description.

Note
The order among each of the types of elements is random.

To modify an element in the FOSI resource description

1. Choose View ▶ Source ▶ FOSI, and review the contents of the generated
rsrcdesc elements to find the keys of the elements you wish to modify. The

710 User's Guide

 table in To add a new element to the FOSI resource description above shows
the attributes that serve as keys for each rsrcdesc element.
You can leave the FOSI Source window open during the following steps.
2. Choose Tools ▶ Advanced Edited Source ▶ Edit FOSI Resource Description.
3. In the Source Editor, insert the elements you need to modify, using values for
the key attributes that match the Arbortext Styler generated keys.
4. Choose File ▶ Apply and Close.
5. In Arbortext Styler, choose View ▶ Source ▶ FOSI to verify that your edits were
correctly merged with Arbortext Styler's generated resource description.

Note
The order among each of the types of elements is random.

Editing Common XSL Source

Arbortext Styler enables you to provide common XSL source in your stylesheet,
where you write edits to the XSL code in a single location in the .style file.
The source edits will then apply to all XSL outputs (XSL-FO, RTF, HTML File,
Web, HTML Help, EPUB). Code that is common to XSL outputs is often of the
“utility template” kind that isn’t necessarily related to any particular element or
contexts. Such code would not be accessed unless referenced by some output-
specific edited source for some context.
For example, if you need to call a certain named template from the XSL-HTML
and XSL-Web sources, you can declare the template in the common XSL source,
then call that template from the required sources.
To provide common XSL source:
1. Choose the Tools ▶ Advanced Edited Source ▶ Edit Common XSL Source.
2. In the Source Editor, make the changes required then apply those changes.
For example, you could add a declaration for a particular named template that
all XSL source types may need to reference.
Common XSL code is included in the styler2xsl-exported XSL for all XSL
outputs.
You can include most top level XSLT elements in common XSL source. It is
expected that the most common construct will be a named template which could
then be called from other edited source for any XSL output type. However, it may
also be useful to include elements such as the following:

Extending Stylesheets 711

• match templates
• xsl:variable assignments
• xsl:attribute-set definitions

Note
You must ensure that neither of the situations listed below occurs when
providing common XSL source:
• No named template, variable, or attribute-set is given a name that is already
used by the Arbortext Styler-generated XSLT.
• No added match template can have the identical match attribute, mode, and
priority as one generated by Arbortext Styler.
If such a conflict exists, you will see a warning and your publishing process
will contain errors.

Editing XSL Root Template Source

Arbortext Styler enables you to edit the XSL root template of a stylesheet. This
can be useful for all types of XSL output.
To edit XSL root template source:
1. Select an element, choose Tools ▶ Advanced Edited Source ▶ Edit XSL Root
Template, and then choose the type of output to which the changes should be
applied. You can choose XSL-FO, XSL-HTML Help, XSL-HTML File, XSL-
FO RTF, and XSL-Web. You must make changes to the XSL root template for
each output individually.
2. In the Source Editor, you can make changes to the XSL root template source
that will produce the desired effect.
For example, you could add a meta tag to the root template for XSL-HTML
output.

Editing PTC APP Root Template Source

Arbortext Styler allows you to view and edit the root PTC APP template source of
a stylesheet. You can configure custom settings for the tags in the PTC APP root
template, which will be used when the stylesheet is used to publish PDF output.
For example, you could modify the default behavior of tables, or change the
default footnote control stream, by editing the tags that support these definitions.

712 User's Guide

For more information about the PTC APP root template, see PTC APP Source
Code Edit Locations in PTC Arbortext Layout Developer in Arbortext Styler.
Custom edits for the tags in the PTC APP root template are saved with the
stylesheet. They override the default configuration for the tag that is generated by
PTC APP. The custom settings are used as default when the stylesheet is used to
publish PDF with the PTC APP engine. They do not affect other stylesheets, as
you have not modified the system PTC APP namespace files.

Viewing PTC APP Root Template Code

To access the tags in the PTC APP root template:
1. Set the stylerviewapproottags preference to on in Arbortext Editor,
to enable the display of the PTC APP root template tags
You can specify the option with a set command, or set it as an Advanced
Preference.
You can also use the Tools ▶ Advanced Edited Source ▶ Edit APP Root
Template menu option in Arbortext Styler to toggle the display of the tags.

2. Navigate to the Functions list in Arbortext Styler.

The root template tags are displayed in the Functions list , grouped in namespaces.
When you select a tag in the list, a preview of its code is shown in the properties
area of the list.

Editing PTC APP Root Template Source

To edit root PTC APP template source:
1. Enable the display of PTC APP root template tags in the Functions list, using
the process defined in Viewing APP Root Template Source.
2. Navigate to the Functions list and select the tag in the root template that you
want to edit.
3. Click the Edit button in the properties area of the list.
The PTC APP Source Editor window opens.
For more information, see PTC APP Source Editor on page 897.
4. Make the required changes to the code in the tag
If you are working with JavaScript code (in a Jf tag), syntax highlighting and
autocomplete features are available.
5. Click File ▶ Apply or File ▶ Apply and Close to save your changes to the tag.
The tag you edited is marked as having a source edit.

Extending Stylesheets 713

 For more information, see Identifying Items that have Edited Source on page
700.
If you are working with JavaScript code (in a Jf tag), a syntax validation
feature is available when you apply your changes.
6. Save the stylesheet. The custom settings you made for the tag are saved in the
stylesheet.

Removing Edits to PTC APP Root Template Source

To remove all custom edits made to a tag in PTC APP root template source:
1. Enable the display of PTC APP root template tags in the Functions list, using
the process defined in Viewing APP Root Template Source.
2. Navigate to the Functions list and select the tag in the root template from
which you want to remove source edits.
3. Choose the menu option Edit ▶ Delete Function Source Edits ▶ APP.
4. A message asks you to confirm that you want to delete PTC APP source edits.
Click Yes.
Source edits are deleted from the selected tag, and the source edit indicator is
removed.

Overview of Autogenerated PTC APP

Source
When you choose to edit the source of an object for PTC APP, PTC APP will
generate a prescribed set of source based on the object you are editing, and its
current settings for certain properties. The source is written in JavaScript and
based on objects defined in PTC Advanced Print Publisher’s Formatting Object
Model (FOM). You will then add your own edits to that generated source. This
topic takes a context from a sample stylesheet and describes the default source
generated for a context by Arbortext Styler.

Note
You are not permitted to edit the source of a whole element for PTC APP; you
can only edit it at context level.

The stylesheet referenced in this section is axdocbook.style, accessed by

electing to create a sample Arbortext XML DocBook 4.0 (axdocbook) file and
choosing to edit its stylesheet. Once you have opened the stylesheet, select the

714 User's Guide

context title in sect1 then elect to edit its source for PTC APP with the
menu option Edit ▶ Edit Context Source ▶ PTC APP. The source will open in the
Source Editor window.
The menu option is only available if your stylesheet to use PTC APP as its print/
PDF engine.
Each section below provides a snippet of autogenerated code from the sample
stylesheet and briefly describes its purpose.

OnEnter command
<OnEnter type="application/x-javascript" xml:space="preserve">
// onEnter processing for context: sect1/title

The OnEnter command is marks the start of the context. It contains the
instructions for processing the context, as described in the next sections (with the
exception of the OnExit command).

Context preamble
formatting.fishSave( template.stylerFish );
var block = new fBlock();
var paragraph = block.defaultParagraph;
var style = block.defaultStyle;
var graphic = {};
var useGraphic = false;
var isBlock = -1;
formatting.fish[ template.stylerFish ]['isBlock'] = 0;
formatting.fish[ template.stylerFish ]['isHidden'] = 0;
formatting.fish[ template.stylerFish ]['startNew' ] = 0;
formatting.fish[ template.stylerFish ]['pageSet'] = '';
formatting.fish[ template.stylerFish ]['pageType'] = 0;
formatting.fish[ template.stylerFish ]['pageNumber'] = 0;
formatting.fish[ template.stylerFish ]['wantColumnTopMargin'] = 0;
formatting.fish[ template.stylerFish ]['customTable'] = 0;
formatting.fish[ template.stylerFish ][ 'markerType' ] = '';

// context preamble complete.

This section provides two sets of information that may be used later in the code. It
sets up the object and defines variables to hold settings made in certain areas of
the Arbortext Styler UI. Note that there is a default set of variables for each object
type you are permitted to edit, and the same set will be created in source for every
object of a certain type. In this example, these are the variables that are set up for
an element context.
• Object :
var block = new fBlock();

The code sets up a new block and provides the variable that will hold the
block information.
• Variables:
var paragraph = block.defaultParagraph;
var style = block.defaultStyle;
var graphic = {};
var useGraphic = false;
var isBlock = -1;
formatting.fish[ template.stylerFish ]['isBlock'] = 0;
formatting.fish[ template.stylerFish ]['isHidden'] = 0;
formatting.fish[ template.stylerFish ]['startNew' ] = 0;
formatting.fish[ template.stylerFish ]['pageSet'] = '';
formatting.fish[ template.stylerFish ]['pageType'] = 0;
formatting.fish[ template.stylerFish ]['pageNumber'] = 0;
formatting.fish[ template.stylerFish ]['wantColumnTopMargin'] = 0;
formatting.fish[ template.stylerFish ]['customTable'] = 0;
formatting.fish[ template.stylerFish ][ 'markerType' ] = '';

Extending Stylesheets 715

 The code defines the variables that will hold default style and paragraph
properties, and values set in certain areas of the Arbortext Styler UI. Each of
these corresponds to a set of conditions by which properties are applied in
later sections of the code.
Note the presence of var isBlock – this variable will hold a value that
reflects the setting in the Structure type field of the Breaks category for the
context. If this value receives a value of -1, this means that the Structure type
field has not been set for the context and, as such, properties set for the context
via property set(s) will take precedence over others. If the context has a
defined structure type of Block or Inline, where this variable will receive a
value of 0 or 1, property sets cannot override other settings. See the entry for
Properties defined via UI below for the way in which this setting will appear
when the context has a structure of Block.

Property set information — all outputs

template.content.functions[ template.stylerNamespace ].PropertySet['title']( block );
template.content.functions[ template.stylerNamespace ].PropertySet['Title_3']( block );

This section describes property sets that has been assigned to the context for all
outputs.
Referring to the sample axdocbook.style, for Base (All Outputs), you will
see that the title in sect1 context has two property sets assigned:
1. title
2. Title 3

Properties defined via UI – all outputs

block.indent = '-0.00pt';
block.indentStart = '0.00pt';
block.absoluteStart = 0;
formatting.fish[ template.stylerFish ]['isBlock'] = isBlock = 1;
var markerArgs = { followWith : "&#x20;", format : "(PREVIOUS) '.' (CURRENT)", labelPlacement : "beforeNumber",
numberStyle : "1", countAs : "title0BA755AB" };
formatting.fish[ template.stylerFish ]['markerType'] = 'Numbering';
if ( !formatting.evaluateXPath( 'x3b2:get-userdata( "_temp_hasbefore_" )' ) != 0 )
{
if ( template.content.getStream('axdocbook_sample:Element:title:title_in_sect1:addBefore') == null )
{
var stream = template.content.createStream( 'axdocbook_sample:Element:title:title_in_sect1:addBefore',
fTag.TYPE_EDITOR_TREE );
stream.write( "<?xml version=\"1.0\"?><Gentext xmlns:_dtd=\"\" xmlns:_gte=\"http://www.arbortext.com/
namespace/Styler/GeneratedTextElements\"
xmlns:_sfe=\"http://www.arbortext.com/namespace/Styler/StylerFormattingElements\"
xmlns:_ufe=\"http://www.arbortext.com/namespace/Styler/UserFormattingElements\"
xmlns:atidlm=\"http://www.arbortext.com/namespace/atidlm\"
xmlns:ch=\"http://www.arbortext.com/namespace/chunker\"
xmlns:rtf=\"http://www.cambridgedocs.com/namespace/fo/rtf\"
xmlns:saxon=\"http://saxon.sf.net/\"
xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"><_sfe:BeforeOrAfterText>
<_gte:LabelAndNumberMarker><_gte:Font><_gte:ElementNumber display=\"#.1\"/></_gte:Font>
</_gte:LabelAndNumberMarker></_sfe:BeforeOrAfterText></Gentext>" );
}
formatting.evaluateXPath( 'x3b2:clear-before( self::node())' );
formatting.evaluateXPath( 'x3b2:add-before( "axdocbook_sample:Element:title:title_in_sect1:addBefore",
1, self::node())' );
formatting.evaluateXPath( 'x3b2:set-userdata( "_temp_hasbefore_", "1" )' );
var hasTOCEntry = formatting.evaluateXPath( 'x3b2:get-userdata( "app_tocEntry" )' );
if ( hasTOCEntry == 1 ) template.needTOCRebuild = 1;
}

716 User's Guide

This section of code describes the individual properties that have been assigned to
the context via the Arbortext Styler UI, for all outputs.
Referring to the sample axdocbook.style, for Base (All Outputs), you will
see the following settings in the properties area of the Elements list:
• Indent category:

○ Indentation left: 0.00pt

○ Indentation first line: -0.00pt
The corresponding code fragment is shown below:
block.indent = '-0.00pt';
block.indentStart = '0.00pt';
block.absoluteStart = 0;

• Breaks category:

○ Structure type: Block

The corresponding code fragment is shown below:
formatting.fish[ template.stylerFish ]['isBlock'] = isBlock = 1;

• Generated text category:

○ Numbered element
○ Added before element content: compound number defined in Division Title
Number dialog box

The corresponding code fragment is shown below:

var markerArgs = { followWith : "&#x20;", format : "(PREVIOUS) '.' (CURRENT)", labelPlacement :
"beforeNumber", numberStyle : "1", countAs : "title0BA755AB" };
formatting.fish[ template.stylerFish ]['markerType'] = 'Numbering';
if ( !formatting.evaluateXPath( 'x3b2:get-userdata( "_temp_hasbefore_" )' ) != 0 )
{
if ( template.content.getStream('axdocbook_sample:Element:title:title_in_sect1:addBefore') == null )
{
var stream = template.content.createStream( 'axdocbook_sample:Element:title:title_in_sect1:addBefore',
fTag.TYPE_EDITOR_TREE );
stream.write( "<?xml version=\"1.0\"?><Gentext xmlns:_dtd=\"\" xmlns:_gte=\"http://www.arbortext.com
/namespace/Styler/GeneratedTextElements\"
xmlns:_sfe=\"http://www.arbortext.com/namespace/Styler/StylerFormattingElements\"
xmlns:_ufe=\"http://www.arbortext.com/namespace/Styler/UserFormattingElements\"
xmlns:atidlm=\"http://www.arbortext.com/namespace/atidlm\"
xmlns:ch=\"http://www.arbortext.com/namespace/chunker\"
xmlns:rtf=\"http://www.cambridgedocs.com/namespace/fo/rtf\"
xmlns:saxon=\"http://saxon.sf.net/\"
xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"><_sfe:BeforeOrAfterText>
<_gte:LabelAndNumberMarker><_gte:Font><_gte:ElementNumber display=\"#.1\"/></_gte:Font>
</_gte:LabelAndNumberMarker></_sfe:BeforeOrAfterText>
</Gentext>" );
}
formatting.evaluateXPath( 'x3b2:clear-before( self::node())' );
formatting.evaluateXPath( 'x3b2:add-before( "axdocbook_sample:Element:title:title_in_sect1:addBefore", 1,
self::node())' );
formatting.evaluateXPath( 'x3b2:set-userdata( "_temp_hasbefore_", "1" )' );
var hasTOCEntry = formatting.evaluateXPath( 'x3b2:get-userdata( "app_tocEntry" )' );
if ( hasTOCEntry == 1 ) template.needTOCRebuild = 1;
}

Note that this context is also set to appear in the table of contents for the book
(see the table of contents object Book Table of Contents). The last lines
in the code reflect this.

Extending Stylesheets 717

Property set information – specific outputs
// processing print/pdf output properties.

template.content.functions[ template.stylerNamespace ].PropertySet['Title_color_for_print']( block );

// processing print/pdf output properties complete.

This section describes a property set that has been assigned to the context for
print/PDF outputs only.
Referring to the sample axdocbook.style, for Print/PDF outputs, you will
see that the title in sect1 context has the Title color for print
property set assigned.

Properties defined via UI – specific outputs

In the sample file, this context has no individual output-specific properties defined
for it in the Arbortext Styler UI. There is no information of this type shown in this
piece of code. However, if output-specific properties had been defined for the
context, these would be listed at this point in the code.

Method for setting column top margin

if ( formatting.fish[ template.stylerFish ]['wantColumnTopMargin'] == 1 )
{
block.marginColumnTop = block.marginTop;
block.marginColumnTopPriority = block.marginTopPriority;
block.vjMarginColumnTop = block.vjMarginTop;
}
else
{
block.marginColumnTop = '0pt';
block.vjMarginColumnTop = '0pt';
}

In this section, a set of if/else conditions describes how the context should be
processed based on the settings for it in the Keep space at top of column or page
field of the Spacing category in the Arbortext Styler UI. In that field, a setting of
Keep equates to a value of 1 in source code, and a setting of Discard will pass
a value of 0 in the code. This code fragment specifically describes the formatting
that should be applied when the field is set to Keep, and provides an alternative
when it is not, i.e. when the Keep space at top of column or page field is set to
Discard.
Note that the wantColumnTopMargin variable, as defined at the beginning of the
code, is set to hold the Keep space at top of column or page information for the
context.

Method for hiding the context in output

var markerType = formatting.fish[ template.stylerFish ]['markerType'];
if ( formatting.fish[ template.stylerFish ]['isHidden'] == 1 )
{
formatting.evaluateXPath( 'x3b2:set-reference( "_app:hidden", 1 )');
useGraphic = false;
if ( markerType != '' )
{
formatting.fish[ template.stylerFish ]['referenceMode'] = '';
if ( markerType == 'Footnote' )
template.content.functions._app[ markerType ]( { attributes: markerArgs } );
else
template.content.functions._app.fom[ markerType ]( markerArgs );
}
return;
}

718 User's Guide

In this section, a set of if/else conditions describes how to process the context
based on the value of the Hidden field of the Text category in the Arbortext Styler
UI, including how to deal with markers (bullets, numbering, footnotes) set for the
context. In the Hidden field, a setting of Yes equates to a value of 1 in source
code, and a setting of No will pass a value of 0 in the code. This code fragment
only describes the formatting that should be applied when its value is 1, as
otherwise no special action is needed.
Note that the isHidden variable, as defined at the beginning of the code, is set to
hold the Hidden information for the context.

Method for starting new pages

var startNew = formatting.fish[ template.stylerFish ]['startNew'];
if ( startNew == '2' )
{
var pageSet = formatting.fish[ template.stylerFish ]['pageSet'];
var pageType = formatting.fish[ template.stylerFish ]['pageType'];
if ( pageSet != '' )
{
template.content.functions[template.stylerNamespace].PageSets[ pageSet ].PageSetup();
if ( block.numColumns == 0 )
{
block.spanColumns = 1;
block.numColumns = formatting.fish[ template.stylerFish ][ 'page_InitialColumns' ];
}

var pageseq = new fDocumentSequenceItem;

pageseq.sequence = template.content.getControl( template.stylerNamespace + ':PageSets:' + pageSet +
':PageSequence' );
pageseq.start = pageType;
pageseq.initial = formatting.fish[ template.stylerFish ]['pageNumber'];
formatting.pageSequenceStart( pageseq, true );
}
else
{
formatting.pageSequenceBreak( Number( pageType ));
}
}
else if ( startNew == '1' )
{
formatting.recordEnd( fFormatting.END_PARAGRAPH, fFormatting.ALIGN_DEFAULT, 1 );
formatting.breakTop( fFormatting.BREAK_COLUMN, 1 );
}

if ( isBlock != -1 ) formatting.fish[ template.stylerFish ]['isBlock'] = isBlock;

if ( formatting.fish[ template.stylerFish ]['isBlock'] == 1 )
{
if ( block.numColumns > 1 )
{
var widths = formatting.fish[ template.stylerFish ][ 'page_'+ block.numColumns + 'Column_Widths' ]
.split( ',' );
var gutters = formatting.fish[ template.stylerFish ][ 'page_'+ block.numColumns + 'Column_Gutters' ]
.split( ',' );
for( var i = 0; i < block.numColumns; ++i )
{
block.columns[i].width = widths[i];
block.columns[i].gutter = gutters[i];
}
block.balanceColumns = formatting.fish[ template.stylerFish ][ 'page_BalanceColumns' ] != 0;
}
formatting.blockStart( block );
}
else
{
formatting.styleSave();
formatting.styleChange( style );
formatting.currentParagraph.preserveProperties = 2;
}

In this section, a set of if/else conditions describes how the context should be
processed based on the settings made for context in the Start new field on the
Breaks category in the Arbortext Styler UI. In the field, a setting of Page equates
to a value of 2 in source code, and a setting of Column will pass a value of 1 in

Extending Stylesheets 719

the code. This code fragment describes the formatting that should be applied in
each of those cases, and provides an alternative if neither of these settings is made.
Notice that the code lays out instructions for the start of new page sets, document
sequences and number of columns when a new page is started.
Note that the startNew, pageSet, and pageType variables, as defined at the
beginning of the code, are set to hold the page start information for the context.

Method for creating a new block

if ( isBlock != -1 ) formatting.fish[ template.stylerFish ]['isBlock'] = isBlock;
if ( formatting.fish[ template.stylerFish ]['isBlock'] == 1 )
{
if ( block.numColumns > 1 )
{
var widths = formatting.fish[ template.stylerFish ][ 'page_'+ block.numColumns + 'Column_Widths' ]
.split( ',' );
var gutters = formatting.fish[ template.stylerFish ][ 'page_'+ block.numColumns + 'Column_Gutters' ]
.split( ',' );
for( var i = 0; i < block.numColumns; ++i )
{
block.columns[i].width = widths[i];
block.columns[i].gutter = gutters[i];
}
block.balanceColumns = formatting.fish[ template.stylerFish ][ 'page_BalanceColumns' ] != 0;
}
formatting.blockStart( block );
}
else
{
formatting.styleSave();
formatting.styleChange( style );
formatting.currentParagraph.preserveProperties = 2;
}

In this section, a set of if/else conditions describes how the context should be
processed based on the settings made for context in the Structure type field on the
Breaks category in the Arbortext Styler UI. In the field, a setting of Block
equates to a value of 1 in source code. This code fragment specifically describes
the formatting that should be applied when the structure is set to Block, and
provide an alternative when it is not, i.e. when the Structure type field is set to
Inline. Notice that the code lays out instructions for creation of individual
columns and gutters when the context is of Block structure. This aligns with the
column information provided in the page set for the context – you can therefore
chose to edit the column information in either the code or the page set.
Note that the isBlock variable, as defined at the beginning of the code, is set to
hold the Structure type information for the context.

Method for including context in table of contents

formatting.formatStream( template.content.streams._app.Reference );
template.content.functions._app.MakeLink( { attributes : { forTOC : "true", inPDF : "true", level : 2,
formatStream : template.stylerNamespace + ":TOCs:Book_Table_of_Contents:title_in_sect1" }} );

This section reflects the settings made in the stylesheet for the context, for its
appearance in a table of contents. Here you can see that the title in sect1
context is selected for inclusion at level 2 of a table of contents generated by the
Book Table of Contents table of contents object. For confirmation of these
settings, please refer to Book Table of Contents object in the Table of
Contents list in the Arbortext Styler UI.

720 User's Guide

Method for setting markers
if ( markerType != '' )
{
formatting.fish[ template.stylerFish ]['referenceMode'] = '';
if ( markerType == 'Footnote' )
template.content.functions._app[ markerType ]( { attributes: markerArgs } );
else
template.content.functions._app.fom[ markerType ]( markerArgs );
}

In this section, a set of if/else conditions describes how to process any markers
(bullets, numbers, footnotes) set for the context.
Note that the markerType variable, as defined at the beginning of the code, is set
to hold the marker information for the context.

Method for outputting graphics

if ( useGraphic ) template.content.functions._app.Graphic( { attributes: graphic } );

This section states that if a context contains a graphic, one will be output.
Note that the useGraphic variable, as defined at the beginning of the code, is set
hold the graphic information for the context.

Context contents
This section describes objects that are contained within the boundary of the
selected context, for example a table or a definition list within a block. There is no
information of this type shown in this piece of code so the entry is empty.

OnExit command
<OnExit type=”application/x-javascript” xml:space=”preserve”>

<![CDATA[ // onExit processing for context: sect1/title

if ( formatting.fish[ template.stylerFish ]['markerType'] != '' && formatting.fish[ template.stylerFish ]

['markerType'] != 'Footnote' )
{
template.content.functions._app.fom[ 'end'+formatting.fish[ template.stylerFish ]['markerType']]();
}

switch ( formatting.fish[ template.stylerFish ]['isBlock'] )

{
case '1': formatting.endBlock( 2 ); break;
case '-1': break;
case '0':
default:
formatting.styleRestore(); break;
break;
}

if ( formatting.fish[ template.stylerFish ]['startNew'] != 0 && formatting.fish[ template.stylerFish ]

['pageSet'] != '' )
{
formatting.pageSequenceEnd( true );
formatting.output( '<?breakt 2,2>' );
}

formatting.fishRestore( template.stylerFish );
]]></OnExit>

The OnExit command marks the end of the context. It contains instructions to
undo everything set by the OnEnter command – ends the object that was
created, terminates any page sequencing, resets variables, etc.

Extending Stylesheets 721

Tips for Editing Stylesheet Source
Tips when Editing FOSI Source
• If you plan to add e-i-cs to the FOSI source of an element, which is permitted,
bear in mind that the order of the e-i-cs in the source is critical: the order in the
FOSI determines the order of priority. The output engine will run through the
e-i-c entries in the FOSI source and simply use the first context it matches in
the source. This could have some unexpected effects if you maintain multiple
contexts of the same element.
• Any nested or if, else or else/if conditions in your stylesheet will be flattened
to a single layer of top level conditions when the stylesheet is exported to
FOSI. See Nested and If, Else/If, and Else Conditions in Exported Stylesheets
on page 317 for details on how to identify the new conditions and translate
them to FOSI attribute tests.

Tips when Editing XSL Source

• Arbortext Styler uses XSL to generate the following outputs: Print and PDF
(via the XSL-FO engine), HTML File, Web, HTML Help, and RTF. If you edit
any of these XSL-based sources, via the Edit ▶ Edit Element Source menu
option, you will be presented with a window containing XSLT data. To be
more specific, you will make use of the following stylesheet fragments when
electing XSL-based source for a particular output format:
○ XSL-FO (for Print and PDF) and XSL-FO RTF - XSL-FO stylesheet
○ XSL-HTML File, XSL-HTML Help, and XSL-Web - XSL-HTML
stylesheet
A good general knowledge of XSLT (including XPath), and either XSL-FO or
XSL-HTML, will therefore be required when making source edits of this
nature.
• The XSLT generated by Arbortext Styler is generally XSLT 1.0 and XPath 1.0
compliant. You may also use XPath 2.0 and XSLT 2.0 code in XSL edited
source, since this is supported by the XSL transformation engine.
• Arbortext Styler generates a minimum of two XSL templates for each context
of an element, depending on the formatting that has been applied. The type of
template is identified in the XSL source by the presence of the mode attribute.
The two default templates are:
○ Template used to style the final output of the element - no value for mode
attribute
○ Template used to add necessary generated text to the context - mode=
expand-gentext

722 User's Guide

 Further templates may also be created, depending on the formatting requests
that have been made for the element - for example a template with a mode=
toc-mode definition will be generated for each table of contents that references
the selected context. Arbortext Styler numbering is defined in templates with
the definitions mode=styler-numbering or mode=styler-
LabelAndNumberMarker.
When electing to edit an element's source, all the templates that have been
generated for an element in this way are listed in the selected XSL source file -
you may edit any of the templates but you must not delete them.
• Any nested or if, else or else/if conditions in your stylesheet will be flattened
to a single layer of top level conditions when the stylesheet is exported to
XSL. See Nested and If, Else/If, and Else Conditions in Exported Stylesheets
on page 317 for details on how to identify the new conditions.

Editing Stylesheet Source Examples

If you need to control the formatting of an element in a way that is not currently
supported in the user interface, Arbortext Styler enables you to select that element
and directly edit the source for any supported output style language. You are also
permitted to edit the source of a particular context of the element.

Editing Source for PTC APP

Arbortext Styler provides a set of sample files that contain edited source for PTC
APP. These stylesheet files contain code that will achieve the following:
• Applying boxing to a block
• Rotating a block
• Setting text, line, and background color
• Using counters and variables
• Testing the values of attributes or text properties
• Testing page number or position on page
• Setting text properties
Please refer to Arbortext-path/samples/APP for sample files for each
example.
You may use these files in three ways:

Extending Stylesheets 723

• Incorporate the required stylesheet module into an existing modularized
stylesheet
• Copy the required code from the supplied stylesheet module into your own
stylesheet, then modify the code as required
• Refer to the stylesheet module and the readme.txt file to ascertain how to
create your own source edits
See the Stylesheet Developer’s Guide to APP Code in the PTC Arbortext Help
Center for full information about the samples.

Editing Source for FOSI

Example: Editing the FOSI Source of an Element
In the following example, an offset is applied to the para element beyond that
allowed by the Arbortext Styler properties. The General Purpose document type
provided with Arbortext Editor is used to demonstrate how to add that offset.
Note that, although you can set the offset of the element in the Arbortext Styler
interface, we are using offset as an example of how to edit the element's source.
You can, if required, edit the offset of an element via the Offset field in the Text
category.
Follow these steps to change the offset for the para element in the associated
FOSI source:
1. In Arbortext Editor, select File ▶ New.
The New Document dialog box opens.
2. Select DocBook in the Category list and Arbortext XML DocBook V4.0
in the Type list, then select the Sample option.
3. Click OK. The sample XML DocBook document opens in Arbortext Editor.
4. Select Styler ▶ Edit Stylesheet.
Arbortext Styler opens the stylesheet associated with the XML DocBook
document. This is a read only stylesheet so you will need to make a local copy
if you wish to make changes.
5. Select FOSI as the Print Engine in the Print/PDF tab of the Stylesheet
Properties dialog box.
6. In the Elements list, select the para element.
7. Change the properties in the Text category to be as close to the desired final
output as possible, for example, set the Text size field to 12pt and set the
Italic field to Yes.
8. In Arbortext Styler, select Edit ▶ Edit Element Source ▶ FOSI. You will see a
Styler Warning dialog box asking you to confirm that you wish to proceed with

724 User's Guide

 editing the source of the element, rather than one of its contexts. Click Yes to
continue.
The Source Editor opens with the FOSI source for the para element. The
source is based on the current Arbortext Styler properties.
9. In the Source Editor, place your cursor after the font element in the first
para in step context and select Edit ▶ Modify Attributes.
The Modify Attributes dialog box opens.
10. Enter a value in the offset field, for example 0.4em.
11. Click OK to confirm the change and exit the dialog box.
12. Select File ▶ Apply and Close to save the change and exit the editor. The edited
source now applies for all contexts of the para element in the document.
When you select one of the para contexts in the Elements list, the
Description field now confirms that the element has source edits for the FOSI.

Note
You may also choose to edit the source of a single context of the para
element only. Use the same steps as detailed above, but select the relevant
element context in the Elements list before choosing the Edit ▶ Edit Context
Source ▶ FOSI menu option. When you have completed the edit, only the
selected context will display the visual indicators that it contains edited
source, rather than the element and all its contexts. The change will apply
only to the selected context.

Editing FOSI Source that Contains a

Reference to an Object
If you edit source that contains a reference to a property set, page set, header or
footer object, TOC object or cross reference object for FOSI, and then
subsequently delete or rename that referenced object in Arbortext Styler, you must
return to the edited source and make the necessary changes to update the
references. The rename and delete functions do not extend into edited source to
search for references to the renamed/deleted object. The stylesheet will generate
errors when the document is opened or previewed until the edited source has been
fixed:
[A28138] Stylesheet has references to missing definitions.
These references will be ignored, use Styler's Validate
Stylesheet menu item to locate these errors.

Extending Stylesheets 725

However, the Tools ▶ Validate Stylesheet option also does not extend into edited
source and hence you will need to use a different method of error detection to find
out the cause of the problem:
1. Export the stylesheet in FOSI format to an external file, via the File ▶ Export ▶
FOSI menu option.

Note
Your stylesheet must be set to use FOSI as the print/PDF engine to access
this menu option.

2. In Arbortext Editor, select the exported FOSI as the stylesheet for the
document.
3. View the completeness errors that are reported by Arbortext Editor/Arbortext
Styler when the stylesheet change is made.
4. Locate and edit the erroneous references directly in the FOSI source: open the
exported FOSI in Arbortext Editor, then use the Tools ▶ IDs and ID References
tool to locate the particular reference causing the error.

Note
The name of a charsubset in FOSI differs slightly from that of the
corresponding property set in the Arbortext Styler stylesheet: spaces are
replaced by underscores, and single underscores are replaced by double
underscores. For example, the property set Title font in Arbortext
Styler is listed as the charsubset Title_font in the FOSI source.
The same convention applies for page set names and the names of
variables in TOCs and cross references.

Editing FOSI Source of Elements with

Numbered Contexts or Conditions
If you edit source of an element that includes contain numbering definitions for
any of its contexts or conditions, and then subsequently remove the numbering
from that context or condition, you must return to the edited source and make the
necessary changes to update the numbering. The generated text function does not
extend into edited source to search for and remove deleted numbering definitions
so the stylesheet will generate errors on document open or preview until the edited
source has been fixed:

726 User's Guide

[A28138] Stylesheet has references to missing definitions.
These references will be ignored, use Styler's Validate
Stylesheet menu item to locate these errors.
However, the Tools ▶ Validate Stylesheet option also does not extend into edited
source and hence you will need to use a different method of error detection to find
out the cause of the problem:
1. Export the stylesheet in FOSI format to an external file, via the File ▶ Export ▶
FOSI menu option.

Note
Your stylesheet must be set to use FOSI as the print/PDF engine to access
this menu option.

2. In Arbortext Editor, select the exported FOSI as the stylesheet for the
document.
3. View the completeness errors that are reported by Arbortext Editor/Arbortext
Styler when the stylesheet change is made.
4. Locate and edit the erroneous numbering definitions directly in the FOSI
source: open the exported FOSI in Arbortext Editor, then use the Tools ▶ IDs
and ID References tool to locate the particular definition causing the error.

Extending the Edited Source Function by

Adding More Complex Code
While the edited source function in Arbortext Styler is useful for carrying out
minor edits, occasionally you may find it necessary to develop or introduce some
much more substantial code to accomplish some formatting that simply is not
possible in the Arbortext Styler UI. In this instance it is easier to work with the
code outside of Arbortext Styler and then introduce that code into Arbortext Styler
once it has been completed and debugged. Depending on how extensive your
requirements are, there are two main ways in which complex code may be
introduced - note that here the functions use XSL-based code:
• Creating more complex edited source
• Adding custom XSL code
The steps you can take to enable you to work on your code outside of Arbortext
Styler, then introduce the changes to your stylesheet, are detailed in each section
below.

Extending Stylesheets 727

Creating More Complex Edited Source
1. Export your stylesheet via the File ▶ Export menu option, selecting the desired
output format from the list. Save the exported XSL file to your preferred
directory location - for the purpose of completeness, save it to the same
directory as the original document.
2. In Arbortext Editor associate the newly exported XSL stylesheet with your
document via the Format ▶ Select Stylesheets menu option, defining it as the
desired stylesheet for your required output type.
3. You can now edit the exported XSL to make any changes you require - update
templates, add new templates, and so on. Save the changes to the exported
XSL then publish the original document to the desired output type to verify
the changes have the desired effect. In this way you can test all changes you
make.
4. To complete the process, you must merge the edited source for the elements
you changed back into the original .style file. Carry out the following steps
for each element you edited:
a. In Arbortext Styler, select the element and elect to edit its source by
selecting Edit ▶ Edit Element Source and choosing the same output type
from the list as you selected in step 1 above.
b. Delete all markup and content from the edited source window that appears.
Leave the window open.
c. Copy all the templates for the element you updated from your exported
and updated XSL file.
d. Paste the copied templates from the edited XSL file into the Arbortext
Styler edited source window for the element.
e. Select File ▶ Apply and Close in the edited source window. You have now
updated the element as it appears in the .style with the changes you
made in your exported XSL file.

Note
It is important to note that edited source that is embedded in a .style file
has its markup characters “escaped”; for example < characters are changed to
&lt; references. For this reason it is not possible to simply copy the updated
elements from the exported XSL file to the original .style file. By copying
the new code to the original file via the edited source window, Arbortext
Editor will update the new code correctly, escaping the characters as required.

728 User's Guide

Adding Custom XSL Code
At times you may need to further extend the functionality of the edited source
feature by introducing XSL templates containing a complete set of formatting
requests, none of which can be fulfilled by existing Arbortext Styler window
functionality. In this instance you must introduce the code to the Arbortext Styler
window in such a way that Arbortext Styler window recognizes the code as edited
source, even if the code bears no relation to any existing element in the document.
To accomplish this, create a random User Formatting Element (UFE) that will
hold the templates - the templates can then be referenced by other elements when
their formatting is required.
The general process to create the new UFE is defined below, although a specific
example is included at the end of the section for reference, including instructions
on how to associate your new template with an existing element:
1. In Arbortext Styler, create a new element via the Insert ▶ Element menu
option. Give it a _ufe prefix and a self explanatory name - for example
_ufe:custom-xsl-code. This prefix will ensure that Arbortext Styler
creates the element as a User Formatting Element.
2. Highlight the _ufe:custom-xsl-code element in the Elements list and
elect to edit its source by selecting Edit ▶ Edit Element Source and choosing
the desired XSL output.
3. Delete the contents of the edited source window.
4. Paste your custom XSL code into the empty edited source window. Save the
changes to the edited source by clicking File ▶ Apply and Close
5. Your new template now exists in your stylesheet and can be referenced by any
other elements to which its formatting properties should be applied.
For example: your current doctype includes an empty fill-in-the-blank
element, which contains an optional blanksize attribute whose value is an
unsigned and limitless number. The presence of the blanksize attribute will output
a baseline rule whose length in inches is either the value of the attribute, or 1 if the
attribute does not have a value. It is not possible to format the baseline in this way
in the Arbortext Styler window, although XSL-FO provides this formatting
capability. In this instance, you must create a separate XSLT template named, for
example, blanksize-to-leader-length, which will perform the baseline
length computation. The steps are defined below:
1. In Arbortext Styler, style the fill-in-the-blank element as required, in
this case it is given the Inline style
2. Using the Generated Text Editor to place generated text before the element,
add a rule as a leader by selecting the Insert ▶ Leaders, Rule or Space menu
option and selecting Rule from the Type menu.

Extending Stylesheets 729

3. In the Elements list, elect to edit the source of the fill-in-the-blank
element for XSL-FO via the Edit ▶ Edit Element Source menu option.
4. In the edited source window, locate the element fo:leader. Change its
content from:
<fo:leader leader-pattern="rule" rule-thickness="1.00pt"
leader-length="12.00pt" leader-pattern-width
="use-font-metrics" baseline-shift="0.00pt"/>

to:
<fo:leader leader-pattern="rule" rule-thickness="1.00pt"
leader-length="12.00pt" leader-pattern-width
="use-font-metrics" baseline-shift="0.00pt">
<xsl:attribute name="leader-length">
<xsl:call-template name="blanksize-to-leader-length">
<xsl:with-param name="blanksize" select="@blanksize"/>
</xsl:call-template>
</xsl:attribute>
</fo:leader>

Ensuring that the code is entered in tag form, not text.

Click File ▶ Apply and Close to save the changes to the element and ensure that
the custom blanksize-to-leader-length template will be called
every time the length to which to set the fo:leader element's leader-length
property needs to be calculated.
5. Now you must introduce the custom blanksize-to-leader-length
template into the .style stylesheet. Follow the steps detailed in the outline
procedure at the beginning of this section:
a. In Arbortext Styler, create a new element via the Insert ▶ Element menu
option. Give it a _ufe prefix and a self explanatory name - for example
_ufe:custom-xsl-code. This prefix will ensure that Arbortext Styler
creates the element as a User Formatting Element.
b. Highlight the _ufe:custom-xsl-code element in the Elements list
and elect to edit its source for XSL-FO by selecting Edit ▶ Edit Element
Source and choosing XSL-FO from the list.
c. Delete the contents of the edited source window.
d. Add the following code in the edited source window, to declare the custom
blanksize-to-leader-length template as the formatting option
for the _ufe:custom-xsl-code element, and set up its rule length
calculation mechanism:
<xsl:template name="blanksize-to-leader-length">
<xsl:param name="blanksize" select="''"/>
<xsl:choose>
<xsl:when test="$blanksize!=''">
<xsl:value-of select="$blanksize"/>
<xsl:text>in</xsl:text>

730 User's Guide

 </xsl:when>
<xsl:otherwise>
<xsl:text>1in</xsl:text>
</xsl:otherwise>
</xsl:choose>
</xsl:template>
e. Click File ▶ Apply and Close to save the changes and ensure that the
fill-in-the-blank element has the desired effect when publishing
for XSL-FO, i.e. producing a rule of a specified length when the blanksize
attribute value is defined, or a rule of 1 inch in length when the attribute
does not have a value.

Deleting Source Edits

Each type of source edit can be deleted individually. For example, to delete
changes made to the element source for PTC APP, choose Edit ▶ Delete Element
Source Edits ▶ APP.
If deleting source edits for a print/PDF output type, your stylesheet must be set to
use the relevant print engine to access the required menu option.
To delete all types of source edits created for an object, use Tools ▶ Advanced
Edited Source ▶ Delete All Source Edits.

Comparing Edited Source and XPath for

Stylesheet Extension
The choice between using edited source or XPath expressions to extend basic
stylesheet capability is an individual one, although there are some points to
consider when making the choice:
• Solutions involving XPath expressions will work with all outputs - a separate
configuration for each output is not required. With XPath you can therefore
produce an overall formatting that will apply to all output.
• With edited source, a separate source edit is required for each output type
(with the exception of FOSI source, which applies for both print/PDF and
Arbortext Editor outputs). For this reason, the use of edited source is
recommended if you wish to maintain different formatting capabilities for
different outputs.
• The use of edited source is also recommended if you need to include an XPath
expression for an element, but that expression occurs inside generated text.

Extending Stylesheets 731

 29
Working with Custom CSS Styles
Associating External CSS with Styler Stylesheets ...................................................... 734
Custom CSS Style Definitions .................................................................................. 736

You can create and use custom CSS to replace the CSS generated by Arbortext
Styler when creating HTML-based outputs. This means that both HTML file and
chunked HTML output can now include:
• External CSS stylesheets as well as Styler-generated CSS stylesheets
• Custom CSS definitions that are directly associated with the HTML elements
generated during publishing

733
Associating External CSS with Styler
Stylesheets
There are two methods in which Arbortext Editor stylesheets can be configured to
provide the CSS styling for HTML-based outputs. The CSS can either be
embedded in the HTML or be provided as a separate file linked to the HTML.
However, there may be few scenarios when a user would want to include further
CSS styling for the HTML generated by Arbortext Styler stylesheets. Following
are examples of different scenarios:
• Arbortext Styler does not create ‘responsive’ styling, but a separate stylesheet
can be created to apply the @media tests and subsequent styling changes to
provide the desired look and feel for different viewport sizes.
• To provide styling options which are not available through the Arbortext
Styler interface.
To associate external CSS stylesheets with HTML output, follow these steps:
1. In Arbortext Styler, open the Stylesheet Properties dialog box.
2. Click theHTML File or the HTML Chunk tab.

734 User's Guide

3. To associate an external CSS file, click Add and enter the location of the file in
the Associated CSS Files area at the bottom of the dialog box.

Note
A file picker is not provided as he location is usually a web URL. Local files can
also be linked, but if using relative location paths, they must be relative to where
the HTML file is deployed.

You can edit the path to the selected CSS file by clicking Edit You can remove the
linked file by clicking Delete.

Working with Custom CSS Styles 735

The published HTML output will now include a <link> inside the <head>
element, which specifies the path to each of the external files as shown in the
following image:

The associated stylesheets are listed after those created from Styler (in this case
external stylesheets have been selected) to allow the external CSS to override any
declarations that Arbortext Styler generates.

Custom CSS Style Definitions

Custom CSS Style Definitions Overview
The usual method to override the default CSS is to perform source edits on the
element, context, condition, or property set. However, this method has certain
limitations – it requires knowledge of XSLT to make changes in multiple places
and it locks the element for edits in Arbortext Styler.
To replace the CSS generated for an element, context, condition, or property set,
Arbortext Styler allows you to create a custom CSS style and directly associate it
with the HTML element generated.

Creating Custom CSS Styles

Custom CSS style definitions are a stylesheet component and are available on CSS
Styles tab.
To create a custom CSS style definition, you can either:
• Click Insert ▶ CSS Style in Arbortext Styler; or
• Click on the CSS Styles tab

in Arbortext Styler and then click Insert CSS Style.

736 User's Guide

Working with Custom CSS Styles 737
Inserting a new CSS Style adds a new definition called NewCSSStyle. To
rename the definition, right-click and select Rename.
To edit the CSS style definition, you can either:
• Click Edit ▶ Edit CSS Style; or
• Select the CSS style definition and press Enter; or
• Right-click the CSS style definition and select Edit CSS Style.
The HTML CSS Editor opens. New definitions include a CSS comment, /*
CSS declaration block */. This can be removed or left as is. You can then add
your own CSS code as though it would appear in a CSS stylesheet between
braces following a selector.

738 User's Guide

You must save the definition before closing the HTML CSS Editor.
The edited CSS style definitions are highlighted in the list for quick reference.

Using Custom CSS Styles

After the CSS style definition has been created, you can associate it with the
HTML tag which is generated during publishing.
To do this,
1. For the element, context or condition, select the HTML Tag styling category.

Working with Custom CSS Styles 739

2. Click Add to add an HTML attribute. The Add HTML Attribute dialog box
opens
3. In the HTML attribute box, select class.

Under Value, CSS Style is now available.

4. Select the CSS style definition in the box.

740 User's Guide

To apply more than one definition, click Text and type the names of the CSS style
definitions required.

Working with Custom CSS Styles 741

After the attribute values have been set, click OK to apply the changes. The HTML
Tag category Attributes are updated:

Creating Output With Custom CSS Styles

HTML output does not require any changes to apply the new CSS style
definitions. The CSS style definitions are included in the HTML output as
follows:

742 User's Guide

• When you publish with external CSS files, the custom CSS style definitions
appear at the bottom of the CSS styles generated by Arbortext Styler.

• When you publish with internal CSS, the custom CSS style definitions appear
in a separate <style> block within the <head> section of the HTML file after
the generated style block.

The element to which CSS style is applied has the class attribute set to the value
specified in the HTML Tag category.

Working with Custom CSS Styles 743

 30
Scripting and Interactivity
Accessing Scripts from Arbortext Styler..................................................................... 746
Associating a JavaScript Library with a Stylesheet ..................................................... 749
Custom JavaScript Functions ................................................................................... 749
Including PDF Forms in PDF Output ......................................................................... 752

Arbortext Styler provides multiple options for you to extend a stylesheet with
ACL or JavaScript code, to add dynamic processing, content, layout, and
interactivity:
• Access ACL or JavaScript scripts via XPath
• Associate JavaScript libraries with a stylesheet and include them in HTML
output
• Manage custom JavaScript functions in a stylesheet and include them in print/
PDF and HTML outputs

745
Accessing Scripts from Arbortext Styler
The ability to access scripts from Arbortext Styler is an advanced feature that
permits you to use ACL and Javascript as part of your stylesheet processing. For
example, you might want to examine application configuration information to
make a style decision, or insert a string from a configuration file in generated text.
Script access is available wherever Arbortext Styler allows you to use XPath, via
the supplied XPath extension functions _js:eval() and _acl:eval().
Scripting must be done with care. Please refer to Guidelines for Accessing Scripts
below.
The examples below show how to utilize scripts to perform some common tasks
in Arbortext Styler.

Example: Embedding the Output of a Script in Generated Text via

XPath
You can embed any string that can be generated from a JavaScript or ACL
function. This example uses XPath to embed the composition year in a generated
text section in output.
1. Select an element context and choose the Generated text category.
2. Choose the Edit button associated with the Before-text or After-text field,
depending on the intended placement of your generated text.
3. In the Generated Text Editor, choose Insert ▶ XPath String.
4. Enter the expression _js:eval("new Date().getFullYear()")
5. Save the generated text setting and exit the editor.
6. When you preview or publish your document, you will see that the selected
element displays the current year in its generated text.

Note
The PTC Arbortext print engines and HTML processing use different
JavaScript processors. This may result in differences in output. Please ensure
that you test your script in all outputs, and with the print engine you will be
using to ensure you are happy with the results.

Example: Using XPath to Create Conditions Based on the Result of a

Script
You can create a condition that is matched based on the result of an ACL or a
JavaScript script.

746 User's Guide

Using this example, you will base the location of figure headers on the value of
the application variable com.arbortext.sma.FigureHeaderLocation.
This variable can have values of above and below, and can be accessed via the
ACL function figure_header_loc(). The function figure_header_
loc() could be code like this:
function figure_header_loc()
{
local figureHeaderLoc = \
get_user_property("com.arbortext.sma.FigureHeaderLocation", \
get_custom_property("com.arbortext.sma.FigureHeaderLo
return tolower(figureHeaderLoc)
}
This example assumes the use of a fig element in your document type.
1. In your Arbortext Styler stylesheet, add a condition for the fig
everywhere context.
2. Add an XPath test for the condition, and enter the following test:
_acl:eval("figure_header_loc()") = "above"
3. Assign the required properties to that condition to place the figure headers in
their correct location.
4. Repeat the previous steps to create a second condition for the fig
everywhere context, this time based on a test for the value of below:
_acl:eval("figure_header_loc()") = "below"

Set the properties to place the headers in the correct position.

Guidelines for Accessing Scripts

Please note the following when using scripts in Arbortext Styler:
• Functions that access or manipulate the current document, for example oid_
caret() or current_doc(), or that modify any document, should not be
used.
• XPath expressions are evaluated frequently. Calling functions that require
significant processing time can have a significant impact on screen display
response and composition time, and is not recommended
• Script functions used within XPath expressions should be loaded and available
before the document that uses them is opened.
One way to do this is to place the scripts in a file alongside the doctype, with
an appropriate extension. For example, ACL scripts used with
mydoctype.dtd could be placed beside it in mydoctype.acl.

Scripting and Interactivity 747

 Note
When the document will be published through a PE server, only scripts
contained in the custom/init directory when the server is started will
be loaded. Contact your PE server administrator if you need to install
scripts on a PE server.

• When using XPath to call script functions that return boolean (true/false)
values, note that the boolean values are returned from the scripts as strings —
1 (true) or 0 (false). Consequently, XPath expressions testing these functions
should be written in the form shown below:
_acl:eval('myfunc()' = '0')
Otherwise, XPath will interpret the returned 0 as true, because XPath
interprets any non-empty string as true.

Using Arbortext Editor to Test an XPath Expression

It might take multiple attempts to define script use in an XPath expression to
obtain the results you desire. It is much quicker to develop and test expressions in
Arbortext Editor than in Arbortext Styler - the steps below explain how:
1. Open your document in Arbortext Editor.
2. Declare the _js or _acl prefix as an XML prefix in the current document,
using the following steps:
a. Select the document element of the current document.
b. From the command line, modify the current document by adding the
namespace declaration to the document tag. Use one of the following:
mt
xmlns:_js="java:com.arbortext.epic.internal.js.JavaScript"

or
mt xmlns:_acl="java:com.arbortext.epic.Acl"
3. Place the cursor inside the element whose context will contain the required
condition. In the Arbortext Editor command line, enter the command eval
oid_xpath_boolean(oid_caret(), "self::node()[...]") -
replacing ... with the expression you wish to use for the XPath test.
oid_xpath_boolean is useful for trying out scripts for conditions
Use oid_xpath_string if you want to test scripts for use in XPath string
in generated text.
4. Look at the resulting value in the Eval Output window - if the value is 1, the
test is true. If a value of 0 returned, the test is false.

748 User's Guide

Associating a JavaScript Library with a
Stylesheet
Web pages can contain dynamic content, layout, and interactivity provided
through JavaScript. Arbortext Styler allows you to add JavaScript to HTML
output, including the option to reference JavaScript libraries as part of a
stylesheet’s properties. You can reference common libraries, such as jQuery or
AngularJS, or custom libraries.
When a library is associated with a stylesheet it can be included in HTML output
generated with the stylesheet.
To associate a JavaScript library with a stylesheet:
1. Open the Stylesheet Properties dialog box for your stylesheet, using File ▶
Stylesheet Properties
2. Navigate to the HTML File or HTML Chunk tab, depending on the type of output
that will include the JavaScript library.
3. In the Associated JavaScript Libraries field, click Add.
The Add JavaScript library dialog box on page 918 opens.
4. In the Library field, enter the path to the required JavaScript library in one of
these formats:
• HTTP URL
• file reference

Note
Arbortext Styler does not validate the path provided here.

5. Click OK to close the dialog box and return to Stylesheet Properties.

The path to the library appears in the Associated JavaScript Libraries field.
A reference to each library listed here is included in the <head> section of
HTML files generated using the stylesheet, in this format:
<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.
Libraries are added to output in the order they are declared in this field.

Custom JavaScript Functions

You can create, edit, and manage custom JavaScript functions in Arbortext Styler.
There are two types:

Scripting and Interactivity 749

• ALD Functions — custom JavaScript functions that can be included in ALD
(print/PDF) output
You can reference the ALD function in a stylesheet source extension for an
element context. This feature applies to stylesheets set up to use PTC APP as
the effective print engine.
Custom ALD functions are stored in PTC APP templates and documents
created from the stylesheet. They are grouped in their own namespace.
• HTML Functions — custom JavaScript functions that can be included in
HTML File or chunked HTML output
You can reference an HTML function as the value of an attribute of an event-
based HTML tag (such as onclick or onmouseover) defined for an element or
context. The function is then output and called by the HTML tag in HTML
output.

ALD Functions
To create a custom ALD function in a stylesheet (or in a stylesheet module, if you
want to group functions and share them with other stylesheets):
1. Make sure that your environment is set to use PTC APP as the effective print
engine.
2. Custom JavaScript functions for ALD output are held in ALD Function
objects. Navigate to the ALD Functions list and click Insert ▶ ALD Function
.
3. Name the ALD Function object, for example jscript. Note the name
appears in the Description tab for the object, for example
_user.jscript()

Note
If you rename an ALD Function object, the new name will not pass to
references to the object. You must update the references manually.

4. Edit the function by clicking the Edit button in the lower window. You can also
select an ALD Function object in the list and choose Edit ALD Function from
the context menu. The ALD Source Editor window opens with some default
code provided.
5. Enter your JavaScript code into the empty lines in the window. Auto-
completion with a list of suggested function names is provided as you type.
6. Click File ▶ Apply to save the code change.

750 User's Guide

 You can also choose File ▶ Apply and Close to save the change and close the
Source Editor. The code from the Source Editor window appears in the lower
window.
7. Add your own information about the object/function in the Comment tab, if
required.
To reference the ALD function in a stylesheet extension with PTC APP code:
1. Navigate to the Elements list and choose the context that will reference the
function.
2. Choose Edit ▶ Edit Context Source ▶ ALD (or Edit Context Source ▶ ALD from
the context menu). The ALD Source Editor windows opens.
3. To reference the function, you can use the shortcut
user.functionObject(), for example user.jscript().
You can copy this shortcut from the Description tab for the ALD Function
object.

HTML Functions
To create a custom HTML function in a stylesheet (or in a stylesheet module, if
you want to group functions and share them with other stylesheets):
1. Custom JavaScript functions for HTML output are held in HTML Function
objects. Navigate to the HTML Functions list and click Insert ▶ HTML
Function .
2. Name the HTML Function object, for example jscript. Note the name
appears in the Description tab for the object, for example jscript().

Note
If you rename an HTML Function object, the new name will not pass to
references to the object. You must update the references manually.

3. Edit the function by clicking the Edit button in the lower window. You can also
select an HTML Function object in the list and choose Edit HTML Function
from the context menu. The HTML JavaScript Editor window opens with some
default code provided.
4. Enter your custom JavaScript code into the empty lines in the window. Auto-
completion with a list of suggested function names is provided as you type.

Scripting and Interactivity 751

 Tip
If the selected function needs the current node to do work, edit the function
call to pass the this object to the function as an argument. In this context,
this is the node which executes the command. For example:
var thisNode = arguments[0];

5. Click File ▶ Apply to save the code change.

You can also choose File ▶ Apply and Close to save the change and close the
HTML JavaScript Editor. The code from the HTML JavaScript Editor window
appears in the lower window.
6. Add your own information about the object/function in the Comment tab, if
required.
To reference the HTML function as the value of an attribute for an HTML tag:
1. Navigate to the Elements list and choose the element or context that will
reference the function.
2. Navigate to the HTML tag category for the element or context.
3. Choose the HTML tag that will represent the element or context in HTML
output from the HTML tag field.
4. In the Attributes field, click Add to open the Add HTML Attribute dialog box.
Here you can set attributes and their values for the HTML tag.
5. Add the name of the attribute in the HTML attribute field. You can also select
the attribute from the drop down list.
6. Select Function in the Value area and choose the required HTML function
from the drop down list. The list displays the HTML Function objects
available in the stylesheet.
7. Click OK to close the dialog box. The attribute and its value (the HTML
function name, in quotes) are shown in the Attributes field.

Including PDF Forms in PDF Output

PDF Forms allow a user to interact with a PDF document. These types of PDF
form field are supported by Arbortext Styler:
• Text boxes
• Buttons
• Radio buttons

752 User's Guide

• Check boxes
• List boxes
• Combo boxes
• Signatures

Note
Your Arbortext Styler environment must be setup to use PTC APP as the print
engine for PDF output.

Stylesheet modules that provide sample code for defining and embedding PDF
Forms are provided in Arbortext-path/samples/APP/
pdfFormFields. Advanced users of Arbortext Styler can use the modules in
their stylesheet or customize them.
The sample stylesheets provide User Formatting Elements (UFE), Property Sets
and custom PTC APP Functions to insert and use the PDF Form fields.

Sample Stylesheet Module

The stylesheet module pdfFormFields_MODULE.style includes sample
code to support all supported types of PDF Form. Associate the module with
another stylesheet to load its provided components.
The module provides three types of defined component:
• UFEs – a set of UFEs that are referenced by the generated text of elements in
the base stylesheet
For more information about UFEs, see Adding User Formatting Elements to
Generated Text on page 517
• Property sets – a set of property sets (prefixed pdfForms_) which all contain
PTC APP edited source to call PTC APP user functions
• PTC APP user functions – a set of custom PTC APP JavaScript functions that
contain the code that creates and applies the different PDF Form fields. The
functions are called by the pdfForms_ property sets.
For more information about PTC APP functions, see Custom JavaScript
Functions on page 749

Description of Components in Stylesheet Module

The sample provides components for each type of PDF Form supported by
Arbortext Styler (with PTC APP engine). The components for each type are
defined and used in the same pattern:

Scripting and Interactivity 753

• The base stylesheet includes an element that represents the PDF Form type
The element is styled as Hidden
• The element applies some Before-text generated text that inserts a UFE
that represents the PDF Form field in output.
The UFE (defined in the stylesheet module) has two jobs:
○ Wrap the content to apply to the field (either explicitly or added using
XPath)
○ Carry attributes that set properties of the field
The UFE is also styled as Hidden
• The UFE applies a property set that references a custom APP function
The property set (defined in the stylesheet module) uses the attribute values set
on the UFE, plus some default values, to call a custom PTC APP function to
add the field
The property set only contains only edited PTC APP source
• The custom PTC APP function (defined in the stylesheet module) creates the
form field object with values passed from the property set, using a create
function. It then uses the general-purpose insert function to output the form
field.

Further Information
For more information about PDF Form Fields, see the PTC Advanced Print
Publisher (PTC APP) Help Center. It contains information about the JavaScript
objects that support PDF Forms, for example fPDFFormItem, and the objects
which inherit it, such as fPDFFormListBox.
The Help Center also contains information about the types of PDF Action
supported by PTC APP.

PDF Form — Text Field

A Text Field is an area in which a user can write text.
The stylesheet samples in Arbortext-path/samples/APP/
pdfFormFields provide these components to support definition and output of
a PDF Text Field:

754 User's Guide

Component Description
Element Name — textField
Contents define the initial text provided
in the Text Field
Styled as Hidden
UFE Name — addTextField
Added by Before-text generated text
defined for textField element
Attributes:
• height
• width
• display (inline or block)
property set Name — pdfForms_
addTextField
Applied by the addTextField UFE

PDF Form — Button

In PDF, buttons are used to invoke an action. The sample provides a dumb button,
which does nothing, and a button that invokes an alert action.
The stylesheet samples in Arbortext-path/samples/APP/
pdfFormFields provide these components to support definition and output of
a PDF Button:
Component Description
Element Name — button
Wraps text that is used as the label on
the button
UFE (button) Name — addButton
Added by Before-text generated text
defined for button element
Attributes:
• height
• width
• display (inline or block)
• tooltip (text to display when the
user hovers over the button)
UFE (alert button) Name — add AlertButton

Scripting and Interactivity 755

Component Description
Added by Before-text generated text
defined for button element
Attributes:
• height
• width
• display (inline or block)
• tooltip (text to display when the
user hovers over the button)
property set (button) Name — pdfForms_addButton
Applied by the addButton UFE
property set (alert button) Name — pdfForms_
addAlertButton
Applied by the addAlertButton
UFE
APP function (button) Name — addPDFButton
Called by the property set pdfForms_
addPDFButton
APP function (alert button) Name — addPDFAlertButton
Called by the property set pdfForms_
addPDFAlertButton
For information on how to extend the use of buttons by adding PDF Actions, see
the PTC Advanced Print Publisher(PTC APP) Help Center.

PDF Form — Radio Button

Radio Buttons are selectable boxes which, when in a group, are mutually
exclusive. In PDF, the button name includes the parent group name.
The stylesheet samples in Arbortext-path/samples/APP/
pdfFormFields provide these components to support definition and output of
a PDF Radio Button:
Component Description
Element Name — radioButton
UFE (button) Name — addRadioButton
Added by Before-text generated text
defined for radioButton element
Generates the button and wraps another
UFE, radioButtonGroup

756 User's Guide

Component Description
Attributes:
• height
• width
• display (inline or block)
• style — defines the character added
when the radio button is selected
The value can be circle, check,
cross, diamond, star, or square
UFE (group) Name — radioButtonGroup
Contains generated text for the radio
button group name
property set Name — pdfForms_
addRadioButton
Applied by the addRadioButton
UFE
APP function Name — addPDFRadioButton
Called by the property set pdfForms_
addRadioButton

PDF Form — Check Box

PDF Check Boxes are small boxes which, when selected, display a check mark (or
another symbol). There are six different symbols as illustrated in the sample.

Note
In PDF, only the cross symbol fits squarely in the box. The other symbols
appear to the right.

The stylesheet samples in Arbortext-path/samples/APP/

pdfFormFields provide these components to support definition and output of
a PDF Check Box:

Scripting and Interactivity 757

Component Description
Element Name — checkBox
Attributes:
• style — defines the character added
when the check box is selected: can
be circle, check, cross, diamond,
star, or square
Empty element
UFE Name — addCheckBox
Added by Before-text generated text
defined for checkBox element
Attributes:
• height
• width
• display (inline or block)
• state — activate or deactivate the
check box (on or off)
property set Name — pdfForms_addCheckBox
Applied by the addCheckBox UFE
APP function Name — addPDFCheckBox
Called by the property set pdfForms_
addCheckBox

PDF Form — List Box

A PDF List Box provides a vertical list of clickable lines of text in a scrollable
box.
The stylesheet samples in Arbortext-path/samples/APP/
pdfFormFields provide these components to support definition and output of
a PDF List Box:

758 User's Guide

Component Description
Element Name — listBox
Attributes:
• type — how to generate the list of
items provided by the List Box
The value can be content or
attribute
content — the item children of
listBox contain the List Box
items
attribute — the items attribute of
listBox provides a comma-
delimited list of items to add to the
List Box
The stylesheet provides the UFE
with the list using XPath.
UFE Name — addListBox
Wraps the list items
Added by Before-text generated text
defined for listBox element
Attributes:
• height
• width
• display (inline or block)
• sort — whether the list items are
sorted (true or false)
property set Name — pdfForms_addListBox
Applied by the addListBox UFE
APP function Name — addPDFListBox
Called by the property set pdfForms_
addListBox
Concatenates the values of the item
elements for a List Box of type content.

Scripting and Interactivity 759

PDF form — Combo Box
Combo Boxes are very similar to List Boxes, but the list of items is provided in a
drop-down list rather than a flat vertical list. This means a Combo Box takes up
less space.
The stylesheet samples in Arbortext-path/samples/APP/
pdfFormFields provide these components to support definition and output of
a PDF Combo Box:
Component Description
Element Name — comboBox
Attributes:
• type — how to generate the list of
items provided by the Combo Box
The value can be content or
attribute
content — the item children of
comboBox contain the List Box
items
attribute — the items attribute of
comboBox provides a comma-
delimited list of items to add to the
List Box
The stylesheet provides the UFE
with the list using XPath.
UFE Name — addComboBox
Added by Before-text generated text
defined for comboBox element
Attributes:
• height
• width
• display (inline or block)
• sort — whether the list items are
sorted (true or false)
property set Name — pdfForms_addComboBox
Applied by the addComboBox UFE
APP function Name — addPDFComboBox
Called by the property set pdfForms_
addComboBox

760 User's Guide

PDF Form — Signature
In PDF, Signatures allow readers to electronically sign PDF documents. They are
displayed as a small box that the user clicks to start the signature process.
The stylesheet samples in Arbortext-path/samples/APP/
pdfFormFields provide these components to support definition and output of
a PDF Signature:
Component Description
Element Name — signature
UFE Name — addSignature
Added by Before-text generated text
defined for signature element
Attributes:
• height
• width
• display (inline or block)
property set Name — pdfForms_
addSignature
Applied by the addSignature UFE
APP function Name — addPDFSignature
Called by the property set pdfForms_
addSignature

Scripting and Interactivity 761

 31
Arbortext Styler Window and
Editors
Arbortext Styler’s Windows, Lists, and Editors ........................................................... 765
Arbortext Styler Window........................................................................................... 766
Elements List .......................................................................................................... 769
Property Sets List .................................................................................................... 771
Page Sets List......................................................................................................... 772
Page Types List....................................................................................................... 772
Page Regions List ................................................................................................... 774
Generated Contents List .......................................................................................... 774
Tables of Contents List............................................................................................. 774
Indexes List ............................................................................................................ 777
Custom Tables List .................................................................................................. 777
Cross References List ............................................................................................. 778
Sizes List ................................................................................................................ 778
Combined Fonts List................................................................................................ 780
PTC ALD Functions List........................................................................................... 781
HTML Functions List................................................................................................ 781
Columns in List Views.............................................................................................. 781
Description Tab ....................................................................................................... 784
Comment Tab ......................................................................................................... 785
Outputs to edit Field................................................................................................. 787
Text Category.......................................................................................................... 787
Indent Category ...................................................................................................... 795
Spacing Category.................................................................................................... 800
Breaks Category ..................................................................................................... 804
Generated Text Category ......................................................................................... 818
Property Sets Category............................................................................................ 820
Footnote Category................................................................................................... 821
Block border Category ............................................................................................. 823
Side by Side Category ............................................................................................. 825

763
PDF tags Category .................................................................................................. 831
HTML tag Category ................................................................................................. 834
RTF Category ......................................................................................................... 838
Graphic Category .................................................................................................... 843
Page Sets - Page Size Category............................................................................... 844
Page Sets - Page Types Category ............................................................................ 847
Page Sets - Columns Category ................................................................................ 848
Page Sets - Page Numbers Category........................................................................ 851
Page Sets - Other Category ..................................................................................... 852
Page Regions - Position Category ............................................................................ 853
Page Regions - Text Category .................................................................................. 855
Page Regions - Graphic Category ............................................................................ 856
Page Regions - Borders Category ............................................................................ 858
Page Regions - Other Category................................................................................ 859
Indexes - General Category ..................................................................................... 861
Indexes - Format Category....................................................................................... 861
Custom Tables - Elements Category ......................................................................... 862
Custom Tables - Cells Category................................................................................ 863
Custom Tables - Header Cells Category.................................................................... 864
Custom Tables - Format Category ............................................................................ 866
Custom Tables - Background Color Category ............................................................ 869
Menus .................................................................................................................... 870
Toolbars ................................................................................................................. 894
PTC APP Source Editor ........................................................................................... 897
Source Editor .......................................................................................................... 899
Generated Text Editor.............................................................................................. 903

This section provides a full description of the Arbortext Styler UI and its object
lists, fields, property tabs, menus, toolbars, and editors.

764 User's Guide

Arbortext Styler’s Windows, Lists, and
Editors
Arbortext Styler offers a set of windows, lists, and editors in which you can set the
styling for all the objects in your stylesheet.
• Arbortext Styler Window on page 766
• Elements List on page 769
• Property Sets List on page 771
• Page Sets List on page 772
• Page Types List on page 772
• Page Regions List on page 774
• Generated Contents List on page 774
• Tables of Contents List on page 774
• Indexes List on page 777
• Custom Tables List on page 777
• Cross References List on page 778
• Sizes List on page 778
• Combined Fonts List on page 780
• PTC ALD Functions List on page 781
• HTML Functions List on page 781
• Columns in List Views on page 781
• Description Tab on page 784
• Comment Tab on page 785
• Outputs to edit Field on page 787
• Menus on page 870
• Toolbars on page 894
• Source Editor on page 899
• Generated Text Editor on page 903

Arbortext Styler Window and Editors 765

Arbortext Styler Window

The Arbortext Styler window contains the following controls.

• List Views: contains information on the objects defined within your stylesheet,
and controls and menus from which you can create or edit those objects. Each
list is marked by a separate tab:
○ Elements list for elements, contexts, and conditions - see Elements List
on page 769
○ Property Sets list - see Property Sets List on page 771

766 User's Guide

 ○ Page Sets list - see Page Sets List on page 772
○ Page Types list - see Page Types List on page 772
○ Page Regions list - see Page Regions List on page 774
○ Generated Contents list - Generated Contents List on page 774
○ Tables of Contents list - see Tables of Contents List on page 774
○ Indexes list - see Indexes List on page 777.
○ Custom Tables list - see Custom Tables List on page 777
○ Cross References list - see Cross References List on page 778
○ Sizes list - see Sizes List on page 778
○ Combined Fonts list - see Combined Fonts List on page 780
○ APP Functions list - see PTC ALD Functions List on page 781
○ HTML Functions list - see HTML Functions List on page 781
The Find Where Used feature allows you to list the individual uses of a
particular object of any of these types in your stylesheet, and navigate to the
relevant list view that contains the use. Use the Find Where Used dialog box,
accessed via the Edit ▶ Find Where Used menu option, to perform a search of
this nature and locate the selected use in its list view from within the Find
Where Used Results dialog box.

For example, suppose you have a property set allcaps defined in your
stylesheet, which t is referenced to format titles in sections and chapters. To
list the current uses of the property set, select the allcaps property set in the
Property Sets list, then click the Edit ▶ Find Where Used menu option to access
the Find Where Used dialog box. Once you have confirmed the selection you
will see two results for the property set, advising you that it is referenced from
the title in section and title in chapter contexts. If you
subsequently change the title in section context to be styled with the
bold property set and then reopen the Find Where Used dialog box for the
allcaps property set (or refresh the results dialog box if it was left open
while you changed the properties for the context), you will see that only one
entry now exists for allcaps, i.e. the entry for the title in chapter
context.
As a second example, you may wish to replace a definition with a definition of
the same type. Suppose you have two property sets in your stylesheet, property
set A and property set B, which have exactly the same settings. You may wish
to remove property set B from the stylesheet altogether and only use property

Arbortext Styler Window and Editors 767

 set A throughout the stylesheet - to accomplish this correctly you will need to
change all references to property set B to point to property set A instead. To do
this, select property set B in the Property Sets list, then access the Find Where
Used dialog box to list all uses of property set B. From within the results
dialog box, double click the first entry in the results list to open it in its
relevant list view. From the list view you can then change its definition to
reference property set A instead of B. Repeat the action for all entries in the
Find Where Used results list for property set B. Once all definitions in the list
have been changed, use the Refresh button in the Find Where Used dialog box
and you will see that there are no longer any occurrences of a reference to
property set B in the stylesheet. You may now delete property set B.
The List Unused Definitions feature allows you to list those objects that are
defined but not ever referenced in the stylesheet (including from within
stylesheet modules). Use the Unused Definitions dialog box, accessed via the
Tools ▶ List Unused Definitions menu option, to locate each object in its list
view.
For example, you may want to clean up your stylesheet once you have
completed work on it, to remove any objects that you originally defined but
which did not end up being referenced from anywhere within the stylesheet.
Open the Unused Definitions dialog box for the stylesheet to see the list of
items that are not referenced. Highlight the first one in the list, then click the
Go To button to open it in its relevant list view. You may then delete the object
from the stylesheet. Repeat the actions for all entries in the Unused Definitions
results list. Click the Refresh button in the Unused Definitions dialog box after
you've deleted a definition to see it removed from the results list. When you
have deleted all the entries in the results list, click the Refresh button in the
Unused Definitions dialog box for the final time - you will see that there are no
longer any unused items in your stylesheet.
• List view columns (see Columns in List Views on page 781): contains
standard information about each of the objects in any one of the selected list
views.
• Description tab (see Description Tab on page 784): displays read only
information about the element or object selected in one of the list views at the
top of the window.
• Comment tab (see Comment Tab on page 785): a free text field for entering a
comment about the element or object selected in one of the list view at the top
of the window.
• Outputs to edit field (Outputs to edit Field on page 787): a drop down list of
available output formats.

768 User's Guide

• Property category areas in which you can set the formatting properties of
elements, contexts, conditions or property sets.
○ Text category on page 787
○ Indent category on page 795
○ Spacing category on page 800
○ Breaks category on page 804 (includes Keeps on page 812 and HTML
chunking on page 814 sub-categories)
○ Generated text category on page 818
○ Property sets category on page 820
○ Footnote category on page 821
○ Block border category on page 823
○ Side by side category on page 825
○ PDF tags category on page 831
○ HTML tag category on page 834
○ RTF category on page 838
○ Graphic category on page 843
Note that these property categories are only active when either the Elements
list or the Property Sets list is active. The other lists have their own controls
with which you can format their objects, and these are explained in more detail
in the relevant object sections.
• Menus (see Menus on page 870): Arbortext Styler menus
• Toolbars (see Toolbars on page 894): Arbortext Styler toolbars

Elements List
A list that can contain the following elements, and any contexts or conditions
applied to those elements:
• Stylesheet elements, with their associated contexts and conditions.
• Styler Formatting Elements (SFE): formatting elements configured by
Arbortext Styler that start with the _sfe: namespace prefix. These elements
appear in the list when the View ▶ Styler Formatting Elements option is
enabled.
• User Formatting Elements (UFE): user-configured formatting elements that
start with the _ufe: namespace prefix. These elements appear in the list
when the View ▶ User Formatting Elements option is enabled.

Arbortext Styler Window and Editors 769

This list appears when you choose View ▶ List View ▶ Elements or click on the
Elements tab. Move single contexts or conditions up or down, or increase or
decrease their nesting level, using the arrows in the Elements toolbar. Sort the
elements by clicking on any of the column headings.
When this list is active, the Insert Element button appears in the Standard
toolbar, allowing you to create a new element in the list. Insert Context and
Insert Condition buttons appear in the Elements toolbar.
To list the uses of an element, context, or condition in the stylesheet, use the Find
Where Used on page 964 option.
Use the categories in the Properties area of the view to set properties for the
elements, contexts or conditions in this list:
• Text properties: see Text Category on page 787
• Indent settings: see Indent Category on page 795
• Spacing properties: see Spacing Category on page 800
• Breaks: see Breaks Category on page 804 (includes Keeps on page 812 and
HTML chunking on page 814 sub-categories)
• Generated text: see Generated Text Category on page 818
• Property sets: see Property Sets Category on page 820
• Footnotes: see Footnote Category on page 821
• Side by Side properties: see Side by Side Category on page 825
• HTML/PDF tags: see PDF tags Category on page 831
• RTF properties: see RTF Category on page 838
• Graphic properties: see Graphic Category on page 843
To list the occurrences of a property that has been explicitly set, use the Find
Explicit Properties on page 962 option.
When selecting elements, contexts or conditions from this list, the following
general rules apply:
• You are permitted to select multiple elements.
• If you select an element, all the contexts of that element are automatically
selected too.
• Other than the instances described above, you are not permitted to select
objects that appear at different levels in the list:
○ You cannot select an element plus a context of another element
○ You cannot select a context and a condition

770 User's Guide

 ○ You cannot select a condition and a nested condition
• Some operations operate solely on the selected object, whilst other have an
effect on the selected object and its children. For example:
○ If you select a context, its conditions are not automatically highlighted.
But if you then elect to cut or copy the selected context the cut or copy
action will include the conditions.
○ If you select a parent condition in a group of nested conditions, its child
conditions are not automatically selected but a subsequent cut or copy
action will include the children.

Property Sets List

A list of property sets configured for the stylesheet. This list displays when you
choose View ▶ List View ▶ Property Sets
When this list is active, the Insert Property Set button appears in the Standard
toolbar, allowing you to create a new property set in the list.
To list the uses of a property set in the stylesheet, use the Find Where Used on
page 964 option.
Use the categories in the Properties area of the view to set the properties for the
property sets in this list:
• Text properties: see Text Category on page 787
• Indent settings: see Indent Category on page 795
• Spacing properties: see Spacing Category on page 800
• Breaks: see Breaks Category on page 804 (includes Keeps on page 812 and
HTML chunking on page 814 sub-categories)
• Generated text: see Generated Text Category on page 818
• Property sets: see Property Sets Category on page 820
• Footnotes: see Footnote Category on page 821
• Side by Side properties: see Side by Side Category on page 825
• HTML/PDF tags: see PDF tags Category on page 831
• RTF properties: see RTF Category on page 838
• Graphic properties: see Graphic Category on page 843
To list the occurrences of a property that has been explicitly set, use the Find
Explicit Properties on page 962 option.
Refer to Property Sets Overview on page 256, Working with Property Sets on
page 256, and Applying Property Sets on page 258 for further information.

Arbortext Styler Window and Editors 771

Page Sets List
A list of page sets configured for the stylesheet. This list displays when you
choose View ▶ List View ▶ Page Sets
When this list is active, the Insert Page Set button appears in the Standard
toolbar, allowing you to create a new page set in the list.
The Properties area of the Page Sets list contains the following property
categories, in which you can edit a selected page set by specifying settings for
page set features:
• Page size and margins: see Page size category on page 844
• Page types (layouts): see Page types category on page 847
• Columns and gutters: see Columns category on page 848 and x Columns
categories on page 850
• Page numbering: see Page numbers category on page 851
• Change bar placement: see Other category on page 852
The Add Region button will launch the Add Page Region helper. Use this option to
quickly create some common page region types for a selected page set.
Once you have created a page set, you can apply it to an element's context by
referencing it in the Breaks category for that element. In the Print/PDF only field,
set the Start new value to one of the page options, then specify the required page
set as the Name value in the Page Set field.
Any new Arbortext Styler stylesheet you create will contain a default Page Set
definition, named Default Page Set. The default page set provides suggested
settings for the options defined in a page set. It also uses the default Size
definitions that are available in a new stylesheet wherever a measurement is
requested. See Sizes List on page 778 for information.
Refer to Page Layout Overview on page 180, Creating a Page Set on page 182,
and Applying a Page Set to an Element on page 200 for further information.

Page Types List

A list of page types configured for the stylesheet. This list displays when you
choose View ▶ List View ▶ Page Types
When this list is active, the Insert Page Type button appears in the Standard
toolbar, allowing you to create a new page type in the list.

772 User's Guide

The Properties area of the Page Types list contains the following fields, in which
you can preview the appearance of page types in the context of a specified page
set:
• Page regions (front to back): an ordered list of page regions configured for a
page type.
Note the (front to back) suffix - the order of the page regions in the list relates
directly to the order in which the regions will be applied to a page. The last
entry in the list will be placed on the page first, followed by the preceding
regions in the order they appear in the list. If regions overlap on the page,
regions that appear earliest in the list will overlay those that appear later in the
list.
Use the up and down arrows to adjust the order of the list.
Select a region in the list to highlight it in the Preview window and view its
defined position. Use the CTRL button to make a multiple selection.
Use the Avoid (PTC APP only) field from the Other category for the Page
Regions list if you want the content in a region or regions to avoid another
region that overlays it.
• Add: click to open a list of page regions configured for the stylesheet. Select
one to add it to the list Page regions list.
• Remove: select a page region in the Page regions list and click Remove to
remove it from the page type definition.
• Go To: opens the selected page region in the Page Regions list and places
cursor focus on the object to allow you to edit it.
• Preview: a visual representation of how the configured page regions are
positioned in the page type
Various parts of the page layout are identified as follows:
○ Shadowed line: page edge
○ Dashed line: margin
○ Single line: page region
• Preview with page set: select a page set to preview the page type correctly with
the page size and margins defined for a page set
Use the Left and Right options to see how your page type would appear in left
and/or right pages.
Once you have created a page type, you can reference it from a page set to provide
the default page layout for first, right, left, or blank pages. Refer to the Page types
category for the Page Sets list.
Refer to Page Layout Overview on page 180, Creating a Page Set on page 182,
and Defining Page Regions on page 190 for further information.

Arbortext Styler Window and Editors 773

Page Regions List
A list of page regions configured for the stylesheet. This list displays when you
choose View ▶ List View ▶ Page Regions
When this list is active, the Insert Page Region button appears in the Standard
toolbar, allowing you to create a new page region in the list.
The Properties area of the Page Regions list contains the following categories, in
which you can edit a selected page region by specifying settings for its appearance
and content:
• Position on page: see Position category on page 853
• Text content: see Text category on page 855
• Graphical content: see Graphic category on page 856
• Borders: see Borders category on page 858
• Background color, clipping, and avoid settings: see Other category on page
859
Once you have created a page region, you can reference it from a Page Type
object to define a page layout scheme.
Refer to Page Layout Overview on page 180, Creating a Page Set on page 182,
and Defining Page Regions on page 190 for further information.

Generated Contents List

A list of Generated Content objects configured for the stylesheet. This list displays
when you choose View ▶ List View ▶ Generated Content
When this list is active, the Insert Generated Content button appears in the
Standard toolbar, allowing you to create a new generated content object in the list.
The Properties area of the Generated Contents list contains an Edit button. Click
this to access the Generated Text Editor, in which you can create or edit the
generated text that comprises the generated content format.
Once you have created a Generated Content object, you can reference it from a
Page Region object to define the text content of the region.
Refer to Page Layout Overview on page 180, Creating a Page Set on page 182,
and Defining Page Regions on page 190 for further information.

Tables of Contents List

A list of table of contents format objects configured for the stylesheet. This list
displays when you choose View ▶ List View ▶ Tables of Contents

774 User's Guide

When this list is active, the Insert Table of Contents button appears in the
Standard toolbar, allowing you to create a new table of contents format object in
the list.
The Properties area of the Tables of Contents list contains the following options
for you to edit table of contents format objects. You can also control whether the
elements in your tables of contents should be employed in certain output formats,
such as being used as bookmarks in PDF output or being included in any table of
contents created for chunked HTML output.
• Scope - Lists the elements for which you can specify a table of contents,
allowing you to generate a table of contents every time that element appears in
your document. You can also choose to create a table of contents for the whole
document. The list contains all elements in the stylesheet that are mapped to
Block, Division, Document or Unstyled styles, in alphabetical order. The
default scope is Whole Document.

Note
When you select a recursive division element for your table of contents
scope, only the outermost occurrences of that element are included in the
table of content.

• Use for PDF bookmarks - Indicates whether the entries in this table of contents
should also be output as bookmarks in your final PDF file. If you have
multiple tables of contents format objects for your document type, you can
enable this option for any or all of those objects. The resulting bookmark list
will be the union of all the tables of contents format objects defined for your
document type that have this option selected, with duplicate entries removed,
even if those have not been referenced from an element context. This option is
unchecked by default.
Use the Limit PDF bookmark levels opened initially (APP and FOSI only) option
in the Print/PDF tab of the Stylesheet Properties dialog box to control the
number of levels of bookmark that will be open in an output PDF.
If you have this option checked for FOSI output you may see the error
message shown below in the field at the bottom of the properties area:
Some titles will not appear in PDF bookmarks. Click Customize button
for details

This message means that some title contexts set to appear in the TOC do not
specify a direct parent. These contexts will not produce bookmarks in output
generated by FOSI. For example, the context title everywhere is not
acceptable, but title in book is permitted. Click the Customize button to

Arbortext Styler Window and Editors 775

 open the Customize Table of Contents dialog box, in which you can define the
contexts that should be included in a TOC.
If you have this option checked for PDF published via the XSL-FO engine,
PDF bookmarks generated will always consist of the number followed by the
title contents, irrespective of any other content that may be associated with the
title when it is displayed in a TOC. Only the fact that a given title context is
included in a TOC that is being used for PDF bookmarks is relevant to the
XSL-FO output - all formatting details associated with the context in the TOC
are ignored when using the XSL-FO engine. Neither generated text associated
with the title nor any label or punctuation associated with the title number will
be included in this title's entry in a bookmark. In addition, the title number
may be displayed in the bookmark even if it is set to be suppressed in a TOC.

Note
Index term, footnote, and other hidden elements that are included in a
division title will be output in the PDF bookmark for the division. You
should ensure that you place elements of this type in the first element
following the title to avoid them being displayed in the bookmark.

• Use for chunked HTML outputs (EPUB, HTML Help, and Web) - Indicates
whether the entries in this table of contents should be included in the online
TOC in EPUB, HTML Help, or Web output. If this option is checked the
resulting TOC will be displayed in a separate frame in the HTML file or web
page. If you have multiple tables of contents format objects for your document
type, you can enable this option for any or all of those objects. The resulting
online TOC will be the union of all the tables of contents format objects
defined for your document type that have this option selected, with duplicate
entries removed, even if those have not been referenced from an element
context. This option is unchecked by default.
When generating TOCs for EPUB output with this option, only titles at levels
1–3 in the document hierarchy will be included.
• Customize Title Contexts - Opens the Customize Table of Contents dialog box,
allowing you to select any title context currently configured in the stylesheet
for inclusion in the table of contents.
• Format - Opens the Table of Contents Format dialog box, in which you can
change the appearance of the table of contents.

776 User's Guide

Refer to Table of Contents Overview on page 352, Creating a Basic Table of
Contents Format Object on page 355, and Styling an Element to Generate a Table
of Contents on page 357 for further information to assist you in setting up and
using tables of contents.

Indexes List
A list of index definition objects configured for the stylesheet. This list displays
when you choose View ▶ List View ▶ Indexes, or if you assign the Index style to an
object via the Edit ▶ Style menu option.

When this list is active, the Insert Index button appears in the Standard
toolbar, allowing you to create a new index definition object in the list.
The Properties area of the Indexes list contains categories in which you can
configure the scope and styling provided by an index definition object:
• General category (see Indexes - General Category on page 861): define the
scope of the index
• Format category (see Indexes - Format Category on page 861): configure the
appearance of the index
Refer to Indexing Overview on page 378 for further information to assist you in
setting up an index.

Custom Tables List

A list of custom table objects configured for the stylesheet. This list displays when
you choose View ▶ List View ▶ Custom Tables, or if you assign the Custom Table
style to an object via the Edit ▶ Style menu option.
When this list is active, the Insert Custom Table button appears in the Standard
toolbar, allowing you to create a new custom table in the list.
The Properties area of the Custom Table list contains categories in which you can
configure the styling provided by a custom table object:
• Elements category (see Custom Tables - Elements Category on page 862):
define the elements that should form the basis of the custom table, and the role
each one should play in the table
• Cells category (see Custom Tables - Cells Category on page 863): generate
cells from XPath and reorder the columns in the body of the table
• Header cells category (see Custom Tables - Header Cells Category on page
864): generate header cells from XPath and reorder the columns in the header
of the table

Arbortext Styler Window and Editors 777

• Format category (see Custom Tables - Format Category on page 866): set
column width and rule preferences for the table
• Background color category (see Custom Tables - Background Color Category
on page 869): define background colors for the rows in the table
Refer to Custom Table Styling Overview on page 404 and Creating and Styling a
Custom Table on page 405 for further information to assist you in setting up a
custom table.

Cross References List

A list of cross references configured for the stylesheet. This list displays when you
choose View ▶ List View ▶ Cross References
When this list is active, the Insert Cross Reference button appears in the
Standard toolbar, allowing you to create a new cross reference object in the list.
The Properties area of the Cross References list contains an Edit button. Click the
button to access the Generated Text Editor, in which you can create or edit the
format of the generated text for the cross reference.
Once you have finished editing the cross reference in the editor, the cross
reference will be shown as an XML string in the read-only field.
Creating a Cross Reference Format Object on page 551 and Creating Cross
References and Cross Reference Formatting on page 551 contain further
information to assist you in using setting up and using cross references.

Sizes List
A list of Size definitions configured for the stylesheet. This list displays when you
choose View ▶ List View ▶ Sizes
When this list is active, the Insert Size button appears in the Standard toolbar,
allowing you to create a new Size definition in the list.
Note that, if you create a new Size object, its name must follow the conventions
listed below:
• Must start with a letter, and consist of letters, digits, periods, dashes,
underscores, or spaces - the normal rules for a definition name in Arbortext
Styler
• Cannot contain parentheses or mathematical operators (-, +, * or /) - the Size
definition may be used in expressions in the future
• Cannot be of the same name as the special font size names configured in
Arbortext Styler:
○ xx-small

778 User's Guide

 ○ x-small
○ small
○ medium
○ large
○ x-large
○ xx-large
○ larger
○ smaller
The Properties area of the Sizes list contains a field labelled Value: enter the
measurement that should be used whenever this Size object is selected from a
property menu. The following units of measurement are permitted:
• in
• cm
• mm
• em
• pc
• pt
• px
Defining measurements as Size objects in this way provides an easy method for
you to store common or default sizes in your stylesheet. Arbortext Styler provides
an option for you to select a Size object wherever a measurement can be specified,
for example the Size menu in the Text category for elements or contexts, or the
Margins category for page sets.
Any new Arbortext Styler stylesheet you create will contain the following Size
definitions. The default Sizes represent common measurements used when
creating pages or tables, and each provides a suggested value. You can use or
amend these sizes to suit your particular pagination requirements if you wish, or
create new ones as required.

Default Size Definitions Included in a New Stylesheet

Measurement Value
Bottom margin 1.5in
Column width in a 2 column table 18pc
Column width in a 3 column table 11.5pc
Column width in a 4 column table 8.5pc
Column width in a 5 column table 7pc

Arbortext Styler Window and Editors 779

Default Size Definitions Included in a New Stylesheet (continued)
Measurement Value
Column width in a 6 column table 6pc
Footer position from bottom of page 1in
Header position from bottom of page 1in
Inside mirror margin 1.25in
Left margin 1in
Outside mirror margin 0.75in
Page height 11in
Page width 8.5in
Right margin 1in
Top margin 1.5in

Combined Fonts List

A list of combined fonts configured for the stylesheet. This list displays when you
choose View ▶ List View ▶ Combined Fonts
When this list is active, the Insert Combined Font button appears in the
Standard toolbar, allowing you to create a new combined font in the list.
The Properties area of the Combined Fonts list contains options by which you can
specify the system fonts that should be automatically used to display certain
ranges of Unicode characters when the combined font is assigned to an element:
• Default font - specifies the system font that should be used to display the
majority of the characters in the text in the element to which the combined
font is applied.
• Exceptions list - defines exceptions to the default font setting for certain script
groups or character blocks from the Unicode specification:
○ Character Set - the script group or character block that will be displayed in
the exception font. Script groups are displayed in bold font, while
character blocks are shown in normal text.
○ Font - the system font that should be used to display the script group or
character block listed in the Character Set field.
• New - create a new exception font setting for the combined font object
definition
• Delete - delete an exception font setting from the combined font object
definition

780 User's Guide

Combined Fonts on page 635 contains further information on creating and using
combined fonts.

PTC ALD Functions List

A list of custom JavaScript functions in the stylesheet, which can be included in
print/PDF output generated by the PTC ALD engine. This list displays when you
choose View ▶ List View ▶ ALD Functions.
When this list is active, the Insert ALD Function button appears in the Standard
toolbar, allowing you to create a new PTC ALD Function object in the list.
The Properties area of the ALD Functions list contains an Edit button. Click the
button to access the PTC ALD Source Editor, where you can enter the custom
function code.
When you have finished editing the function in the editor, the code is shown in the
read-only field.
For more information, see Custom JavaScript Functions on page 749.

HTML Functions List

A list of custom JavaScript functions in the stylesheet, which can be included in
HTML output. This list displays when you choose View ▶ List View ▶ HTML
Functions.
When this list is active, the Insert HTML Function button appears in the
Standard toolbar, allowing you to create a new HTML Function object in the list.
The Properties area of the HTML Functions list contains an Edit button. Click the
button to access the HTML JavaScript Editor, where you can enter the custom
JavaScript function code.
When you have finished editing the function in the editor, the code is shown in the
read-only field.
For more information, see Custom JavaScript Functions on page 749.

Columns in List Views

The set of columns of columns available for viewing information about an object
differs according to the object list view selected.
Note that you can customize the display of these columns for your Arbortext
Styler window, via the View ▶ Configure Columns menu option.
The table below summarizes the columns available for each list type:

Arbortext Styler Window and Editors 781

Columns in UI for each List View

RTF Prece-
Style/ dence Source Com-
Style Field Category Module Edits ment
Elements • • • • • •
Property • • • •
Sets
Page Sets • • • •
Page • • • •
Types
Page • • • •
Regions
Generated • • • •
Contents
Tables of • • •
Contents
Indexes • • •
Custom • • •
Tables
Cross • • •
Referen-
ces
Sizes • • •
Combined • • •
Fonts
A description of each column is given below:
• Style - The style associated with the element or its context.

When you are styling a DITA document, Arbortext Styler detects when an
unstyled, specialized DITA element has an associated base element that has
been styled and provides that information in this column. For example, the
DITA step element is a specialization of the li element. If you have styled
li but not step, Arbortext Styler applies the styling for the li element and
displays the following message in the Elements list for the step element:
Unstyled (List Item by specialization)
If you hover the cursor over this message, the following additional information
is provided in a tooltip:
(Specialization of li, using List Item style)

782 User's Guide

 Since it is only possible to apply a style to an element, this column is only
available in the Elements list.
• RTF Style/Field - The RTF style or field (if one is defined) associated with the
element. RTF Styles and Fields are associated with elements using the features
on the RTF properties category in the Arbortext Styler window.
Since it is only possible to apply a style to an element or context, this column
is only available in the Elements list.
• Precedence Category - The state of the object with regard to other modules
included in the stylesheet. The state is indicated by one of the following icons:
○ - The definition only occurs is in one module.
○ - The definition overrides a definition in another module.
○ - The definition is overridden by a definition in another module.
• Module - The name of the stylesheet module in the module hierarchy that
contains the object. The name of the root module is displayed in the title bar. If
the definition is in a read-only module, text in the Elements, Style, and Module
columns is grayed out and a small lock icon appears over the element icon.

This column is blank if the selected element is in the root module.

• Source Edits ( ) - Whether the element or any of its contexts have edited
source. The presence of edited source is indicated by the presence of an orange
tick in the Source Edits column:

This is useful if you navigate your stylesheet with the elements collapsed. If an
element context has edited source but the element itself does not, the orange
square around the element icon does not appear in the UI but the presence of
the orange tick indicates that one of the element’s contexts has edited. The
orange square only indicates the presence of edited source at element level.
See Identifying Items that have Edited Source on page 700 for further
information.

• Comment - The first lines of text for any comments entered by the user for the
selected item or context. If the comment is longer than the size of the column,

Arbortext Styler Window and Editors 783

 ellipses will indicate that there is additional text to be read. A tooltip
containing the first 255 characters of the comment will be displayed if you
hover the cursor over the column. The full text of the comment is displayed in
the Comment tab of the middle section of the window.

The widths of the columns in the list view are saved as a preference when
Arbortext Styler closes, and will be opened to the saved widths when a new
Arbortext Styler session starts.

Description Tab
A read-only field that describes the formatting properties that have been specified
for the selected object. Output-specific settings are shown in this field, each on a
separate line. Referenced property sets are listed first, then any properties
explicitly set for the selected object. If multiple objects, or a top level element, are
selected in the list, this field is empty.

The Description field also contains a confirmation in orange text if source edits
have been defined for the selected object, and the label of the tab changes color to
orange.
If you have selected a Styler Formatting Element (SFE) in the Elements list, the
Description tab shows a comment explaining where the SFE is used, as well as the
usual summary of specific formatting properties that have been applied. An
example is shown below:

784 User's Guide

 Note
This tab is blank for the Headers, Footers, Cross References and Sizes lists
since these objects are based on either generated text or settings other than
basic formatting properties. The only exception to this is the indicator of the
presence of edited source for header and footer objects.

Comment Tab
A tab containing a field in which a user can enter a comment about the selected
object, for display in the Arbortext Styler interface. The tab appears in every list
view, permitting you to add a comment about any of the objects in your stylesheet,
including individual element contexts or conditions. The tab is greyed out if the
user is not permitted to edit the comment, for example if it is part of a read-only
module.
The comment is stored as an XML attribute and as such is subject to the following
restrictions:
• Only text characters are permitted
• No special formatting or markup can be applied
• Must not exceed 6,000 characters in length
You may create the comment either by typing or by pasting text into the field,
providing that text adheres to the conventions listed above.
Once you have completed your comment, the label of the Comment tab is
highlighted in bold blue (Arbortext Styler's default user customized color). When
you have clicked out of the Comment tab, the first characters of the comment will
appear in the Comment column for the object, if this has been activated for display
in the Arbortext Styler window via the Configure Columns dialog box.

Arbortext Styler Window and Editors 785

If you hover the cursor over the object’s entry in the Comment column you will
see the full version of the comment.

Note
You may also add a comment to an object in such a way that the comment will
be carried with the stylesheet when it is exported to another format. To achieve
this, elect to edit the source of the element in the desired language. In the
Edited Source window, choose the Insert ▶ Comment menu option and add text
as required. To review the comment once it has been saved, either choose the
View ▶ Source option in Arbortext Styler, or open the exported stylesheet in a
text editor, and locate the object in the code. The comment will be declared in
the object definition:

You can add comments in this way for any objects for which source edits are
permitted. See the table Supported types of source editing in Editing
Stylesheet Source Overview on page 703 for information.

786 User's Guide

Outputs to edit Field
This list is only visible when the Elements and Property Sets lists are active. It
provides a list of possible uses or outputs for your document, allowing you to
apply property settings for specific uses. By default, this field is set to Base (All
Outputs). When Base (All Outputs) is selected, any property settings you specify
are applied to all uses of the document. To apply property settings for a specific
use (or output), choose an output format from this list.
You can also combine uses or remove them from this list by selecting <Edit This
List> to open the Edit Uses List dialog box. Combined uses allow you to set
properties for more than one use. Combined uses are saved with your stylesheet.
Refer to Elements Overview on page 264, Adding New Elements to Your
Stylesheet on page 271, and Property Sets Overview on page 256 for further
information.

Text Category
The Text category provides options for specifying formatting characteristics for
text, such as bold, italic, underline, size, and color.
The following table describes the properties in the Text category:

Arbortext Styler Window and Editors 787

Property Description Default Value
Font family Specifies the name of the font to apply to Serif
the element content. Click on any name in
the list to choose a font (for example,
Times New Roman or Sanserif) or type the
name of a valid font in this field.
If you have defined combined fonts for
your stylesheet, these will be listed in the
list of available fonts accessed via this
drop down menu. An icon will identify a
font as a combined font (see
CombinedFont below):

Combined fonts are not supported in RTF

output.
Font size Specifies a font size to apply to the 12pt
element content. Choose a size from the
list or type the desired point size or a
percentage from 10% to 9999%.
This field also allows gives you the option
of choosing a defined size by selecting
from the list of Size objects configured for
your stylesheet. Click the Select Size
button next to the field and select the
name of the required Size object from the
resulting list. Once you have selected a
Size object, the measurement it defines
will be displayed wrapped in angle

788 User's Guide

Property Description Default Value
brackets (< > characters). For example, the
Size object InchSize defines a
measurement of 1.00in:

Note
The Size field has a default value if
you have set the value of the Super/
Subscript field:

• Normal: the value of Size is set to

1em
• Superscript: the value of Size is
set to 0.69em
• Subscript: the value of Size is set
to 0.69em

Arbortext Styler Window and Editors 789

Property Description Default Value
Hidden Suppresses element content in final output. No
To ensure content continues to be hidden
in the Arbortext Editor view, you must
deselect the Hidden Content option in the
Arbortext Editor Preferences dialog box,
under the View category.
Note
This Hidden setting cannot be changed
when the element's style is set to
Hidden.
Bold Applies a bold text style to the element No
content.
PTC APP will automatically apply a
pseudo bold effect if a Bold version of the
current font family is not available (print/
PDF).
Italic Applies an italic text style to the element No
content.
PTC APP will automatically apply a
pseudo italic effect if a Bold version of the
current font family is not available (print/
PDF).
This option can be configured in the Font
element of the .pdfcf PDF
configuration file for FOSI.
Text color Displays a color palette from which you Default
can select a color to apply to text content.
Click More Colors to select from wider
range of colors or create a custom color.
You may also use the option None, which
will output invisible text. This can be
useful for creating white space whose
width matches the length of a certain
string of text.
See color palette in Arbortext Editor help
for information.
Text shading Displays a shading palette from which you Default
can select a background color to apply to
the element content. Click More Colors to

790 User's Guide

Property Description Default Value
select from wider range of colors or create
a custom color.
You may also use the option None, which
will output transparent shading.
See shading palette in Arbortext Editor
help for information.
All caps Displays all alphabetical characters in No
element content as capital letters,
regardless of how they are typed.
Note
All caps is unavailable when Small
caps has been activated
Small caps Displays all alphabetical characters in a No
word or phrase as capital letters,
regardless of how they are typed. Small
caps differs from All caps in that lower
case letters are converted to uppercase, but
are reduced in size.
Note
Small caps is unavailable when All
caps has been activated
Super/Subscript Specifies if the element content will be Normal
displayed in superscript or subscript
format. The Size and Offset fields will be
assigned default values by the UI, based
on the value selected for the Super/
Subscript field here, defining the text size
and its offset from the horizontal baseline:
• Normal: text is drawn on the baseline
- Size field is set to 1em, and Offset
field is set to 0em.
• Superscript: text is made smaller
and drawn above the baseline - Size
field is set to .69em and Offset field
is set to .33em.
• Subscript: text is made smaller and
drawn below the baseline - Size field is
set to .69em and Offset field is set to
–.15em.

Arbortext Styler Window and Editors 791

Property Description Default Value
The Size and Offset fields can also be
adjusted as desired to produce the required
superscript or subscript effect.
Note
Setting the value of the Offset field
will have an effect on the value of the
Super/Subscript field, as follows:

• If Offset is given a value greater than

0, the value of Super/Subscript is
automatically set to Superscript.
• If Offset is given a value less than 0,
the value of Super/Subscript is
automatically set to Subscript.
• If Offset is given a value of 0, the
value of Super/Subscript is
automatically set to Normal.
• If Offset is given a value of
<Derive>, the value of Super/
Subscript is automatically set to
<Derive>.
Font offset Sets a distance from the horizontal 0em
baseline at which to display the element's
content.
When publishing with the FOSI engine,
this value will have no effect on content
consisting of an inline graphic.
This field also allows gives you the option
of choosing a defined measure by
selecting from the list of Size objects
configured for your stylesheet. Click the
Select Size button next to the field
and select the name of the required Size
object from the resulting list. Once you
have selected a Size object the
measurement it defines will be displayed
wrapped in angle brackets (< >
characters). For example, the Size object
InchSize defines a measurement of
1.00in:

792 User's Guide

Property Description Default Value

Note
The Offset field has a default value if
you have set the value of the Super/
Subscript field:

• <Derive>: the value of Offset is set

to <Derive>
• Normal: the value of Offset is set to
0em
• Superscript: the value of Offset is
set to .33em
• Subscript: the value of Offset is set
to -.15em
Underline style Specifies the type of underlining to be (none)
applied to the text content of the element,
and allows you to choose between
standard or customized styles (note that
customized styles will only be visible in
Editor or print output).
The available options are:
• <Derive>
• (none)
• Words only: apply a standard
straight underline to the words in a text
block. Spaces between words will not
be underlined.
• Custom: choose one of the configured
underline styles and it will be applied
to the words and spaces in the text
block.
Underline color Specifies the color of any underlining Current text color
configured for the element in the Underline
style field.
Select Text Color to use the same color as
the current text.

Arbortext Styler Window and Editors 793

Property Description Default Value
Note that underline colors will only be
visible in Arbortext Editor or print output.
Underlining will be shown in the current
font (text) color in other outputs.
Strikethrough Specifies the type of strikethrough to be (none)
style applied to the text content of the element
and allows you to choose between
standard or customized styles (note that
the customized style Words only will
only be visible in Editor or print output
published via FOSI or XSL-FO).
The available options are:
• <Derive>
• (none)
• Words only: apply a strike bar to the
words in a text block. Spaces between
words will not be struck through.
• Words and space: apply a strike
bar to the words and the spaces
between words in a text block. You
may subsequently choose a color in the
Color field, otherwise the strike bar
will be black.
Strikethrough Specifies the color of any strikethrough Current text color
color configured for the element in the
Strikethrough style field.
Select Text Color to use the same color as
the current text.
Note that strikethrough colors will only be
visible in Arbortext Editor or print output.
Underlining will be shown in the current
font (text) color in other outputs.
Use OpenType Turns on/off OpenType word shaping No
when using OPenType fonts.
• No: Do not use OpenType shaping.
This is the default for all outputs.
• Yes: Use OpenType shaping. This can
only be applied for Print/PDF output
using the PTC APP Engine.

794 User's Guide

Note that the default values are not automatically applied to the fields in the Text
category. These are simply the values applied to the element if no subsequent
settings are configured for the category. The defaults will apply regardless of the
style applied to the element if no options are set.

Indent Category
The Indent category provides options for specifying indent formatting
characteristics for elements with a Block structure.

Note
The options on the Indent category are not available if Structure type in the
Breaks category is set to Inline.

HTML File, HTML Help, and Web outputs have the following indent limitations:
• Left indent can only be displayed correctly if relative to parent's left indent
• First line indent can only be displayed correctly if relative to current left
indent.
• Right indent can only be displayed correctly if relative to parent's right indent.
• A hanging indent is where the first line of a block is not indented as far as the
rest of the block. You can get this effect simply by setting First line to a lesser
value than the value set for Left.
• Indent values can be negative. A negative value for Left or First line causes the
left edge of text to be moved to the left. A negative value for Right causes text
to extend further to the right.

Note
Negative indents relative to the left margin display correctly in Print and
PDF but not in other outputs or in the Arbortext Editor pane.

• You cannot format a negative indent for a numbered element.

The following table describes the properties on the Indent category.
Property Description Default Value
Horizontal placement
Alignment Positions text on a line, relative to Left
document margins. The available options

Arbortext Styler Window and Editors 795

Property Description Default Value
are:
• <Derive> - Specifies indent setting
based on system default, property set,
or ancestor settings.
• Left - Positions text so that all text
lines up evenly along the left side of
the page.
• Centered - Positions text so that all
text is centered on the page.
• Right - Positions text so that all text
lines up evenly along the right side of
the page.
Note
Right indent formatting does not
display in the Arbortext Editor
pane, but does display in other
outputs.
• Justified - Positions text so that
text lines up evenly on both the left
and right sides of the page. This results
in variable spacing between words.

796 User's Guide

Property Description Default Value
• Preformatted - Displays content
such that the spaces and line breaks are
preserved as authored and new spaces
and line breaks are not introduced by
the publishing process.
Note
If an element has been configured
with the xml:space=”preserve”
attribute set it will automatically
have a value of Preformatted
in this field and you will not be
able to change this setting. See the
description of the Preformatted
style in Applying Styles on page
37 for further details.
The Alignment, Left, and First line
controls, plus associated Relative to
options, are disabled for numbered and
bulleted elements if the Keep element at
beginning of line is selected in the
numbering dialog box for the element,
since alignment and indentation are
controlled in the numbering dialog box. If
this is the case, you will see the tooltip
message Specified for Number or
Bullet - click Details on
Gentext tab to change when you
hover over the controls. Refer to the
numbering dialog box to set the alignment/
indentation.

Arbortext Styler Window and Editors 797

Property Description Default Value
Hanging Specifies whether hanging punctuation is No
punctuation active for a block element.
(print/PDF only)
Note
This setting will only have an effect
for documents published for print with
an Arbortext Styler stylesheet and the
PTC APP print engine. The option will
be disabled in the category if either
FOSI or XSL-FO is set as the active
print engine.
Layout direction Defines the layout of the selected element, Left to right
(print/PDF only) i.e. whether content and margins, indents,
columns, etc. is set in relation to the left or
right of the page.
The options are:
• <Derive> - Specifies layout
direction setting based on system
default, property set, or ancestor
settings.
• Left to right - Element will be
drawn from left to right. This is the
default setting for this control.
• Right to left - Element will be
drawn from right to left.
Note
This setting will only have an effect
for documents published for print with
an Arbortext Styler stylesheet and the
PTC APP print engine. The option will
be disabled in the category if either
FOSI or XSL-FO is set as the active
print engine.
Indentation
Left Offsets text from the left. Choose whether 0pt relative to
the indent is positioned relative to the Parent left indent
Left margin or the Parent left
indent.

798 User's Guide

Property Description Default Value
This option is disabled when you are
working with an element that has bullets
applied. It is also disabled for an element
that has number applied when the Keep
number at beginning of line checkbox is
enabled on the associated numbering
dialog box.
For HTML File, HTML Help, and Web
outputs, the left indent can only be
displayed correctly if relative to parent's
left indent.
First line Offsets the text in the first line of the 0pt relative to
element content. Choose whether the Current left
indent is positioned relative to the Left indent
margin, Parent first line
indent, or Current left indent.
This option is disabled when you are
working with an element that has bullets
applied. It is also disabled for an element
that has number applied when the Keep
number at beginning of line checkbox is
enabled on the associated numbering
dialog box.
For HTML File, HTML Help, and Web
outputs, the first line indent can only be
displayed correctly if relative to current
left indent.
Note
A negative indent will not display in
the Arbortext Editor window.

Arbortext Styler Window and Editors 799

Property Description Default Value
Right Right - Offsets text from the right. Choose 0pt relative to
whether the indent is positioned relative to Parent right
the Right margin, Parent right indent
indent, or Current left indent.
For HTML File, HTML Help, and Web
outputs, the right indent can only be
displayed correctly if relative to parent's
right indent.
Note
Right indent settings are not displayed
in Arbortext Editor view.
Each field in the Indentation area allows
you to either type an arbitrary size in the
field or choose a defined size by selecting
from the list of Size objects configured for
your stylesheet. For the latter option, click
the Select Size button next to the
field for which you wish to set the
measurement and select the name of the
required Size object from the resulting list.
Once you have selected a Size object the
measurement it defines will be displayed
wrapped in angle brackets (< > characters)
in the relevant field. For example, the Size
object InchSize defines a measurement
of 1.00in:

Spacing Category
The Spacing category provides options for specifying line spacing for elements
with a block structure. The options on the Spacing category are not available when
Structure type in the Breaks category is set to Inline.

800 User's Guide

 Note
Refer to Units of measurement in Arbortext Editor help for information on
valid units.

The following table describes the properties on the Spacing category.

Property Description Default Value
Line spacing Controls spacing between the lines in an Single
element mapped to the Block style.
The choices are:
• <Derive> - Specifies line spacing
based on system default, property set,
or ancestor settings.
• Single - Sets lines to be single
spaced (1.1 em).
• 1.5 lines - Sets lines to be halfway
between single and double spaced
(1.65 em).
• Double - Sets lines to be double
spaced (2.2 em).
• Specified - Sets line spacing to the
value specified in the At field.
Note
Setting the value of the At field to
the em values associated with the
defined types of line spacing
resets line spacing to that type. For
example, if you set the value of
the At field to 1.65 em, the value
of Line spacing is automatically
set to 1.5 lines.
Arbortext Editor's display does not reflect
this property.
At Sets the specific amount of space to be
applied between lines when the
Specified option is selected in the
Line spacing field (see note after table for
input options).

Arbortext Styler Window and Editors 801

Property Description Default Value
Spacing before
Preferred Specifies the preferred amount of space 8pt
before the element (prespace). See the
note after the table for input options.
Precedence Specifies a priority for choosing one none
element's prespace value over that of
another element. Arbortext Editor uses the
value from the element with the highest
precedence. The choices are
• <Derive> - sets prespace value
based on system default, property set,
or ancestor settings.
• none
• low
• medium
• high
• force: this option ensures this value
is always used, regardless of the
precedence settings of other elements.
Allow space to Specifies the minimum amount of 6pt
vary (Print/PDF prespace that must be applied when
only)
spacing of this nature is required (see note
Minimum
after table for input options)
Allow space to Specifies the maximum amount of 10pt
vary (Print/PDF prespace that can be applied when spacing
only)
of this nature is used (see note after table
Maximum
for input options).
Note
If the maximum value is greater than
the preferred value, the maximum
value is treated as a guideline, not as
an absolute maximum.
Keep space at top When this option is set to Keep, Discard
of column or Arbortext Styler applies the values set in
page (Print/PDF
the Spacing before field when the element
only) starts a column or page. When this option
is set to Discard (the default), the
Desktop Composer ignores the values

802 User's Guide

Property Description Default Value
when the element starts a column or page.
Spacing After
Preferred Specifies the preferred amount of space 0pt
after the element (postspace). See the note
after the table for input options.
Precedence Specifies a priority for choosing one space before -
element's postspace value over that of medium
another element. Arbortext Editor uses the space after - high
value from the element with the highest
precedence. Choices are
• <Derive> - sets postspace value
based on system default, property set,
or ancestor settings.
• none
• low
• medium
• high
•
force: this option ensures this value
is always used, regardless of the
precedence settings of other elements.
Allow space to Specifies the minimum amount of Derive
vary (Print/PDF postspace that must be applied when
only)
spacing of this nature is required (see note
Minimum
after table for input options)
Allow space to Specifies the maximum amount of Derive
vary (Print/PDF postspace that can be applied when
only)
spacing of this nature is used (see note
Maximum (Print/
after table for input options).
PDF only)
Note
If the maximum value is greater than
the preferred value, the maximum
value is treated as a guideline, not as
an absolute maximum.
Spacing is fixed when the values of Minimum, Maximum, and Preferred are the
same. Spacing is variable when the values of Minimum, Maximum, and Preferred
are different. Variable spacing can be used to produce better looking pages, and is
required for vertical justification, which is specified on the Columns tab of the
Page Sets list. Vertical justification enables you to bottom-align columns.

Arbortext Styler Window and Editors 803

Variable spacing is set up as a default in Arbortext Styler - see property sets such
as Standard space in distributed stylesheets. To disable variable spacing, use one
of the following methods as applicable:
• Do not reference the property set that is providing the variable spacing setting
• Explicitly set the Minimum and Maximum fields to the same value
• Explicitly set the Minimum and Maximum fields to Derive

Note
The At, Preferred, Minimum, Maximum fields of this tab allow you to either
type an arbitrary size in the field or choose a defined size by selecting from the
list of Size objects configured for your stylesheet. For the latter option, click
the Select Size button next to the field for which you wish to set the
measurement and select the name of the required Size object from the
resulting list. Once you have selected a Size object the measurement it defines
will be displayed wrapped in angle brackets (< > characters) in the relevant
field. For example, the Size object InchSize defines a measurement of
1.00in:

Breaks Category
The Breaks category provides options for specifying, word, line, and page breaks
formatting properties.
The following table describes the properties on the Breaks category.

Note
When the Structure type field is set to Inline for an element, the Page set
fields are deactivated.

804 User's Guide

Property Description Default Value
Structure type This setting is automatically specified Inline
based on the element's style. However,
you can change the structure type for a
specific context or condition of an
element.
Note
When Structure type is set to
Inline, the options on the Indent
and Spacing tabs are not available.
You cannot change the value of Structure
type if the selected element is set to one
of the following styles:
• Definition List Item
• List - Bulleted
• List - Numbered
• List Item
• Division
• Formal Block
• Document
• Title
• Cross Reference
• Index
• Index Term (Attribute Model)
• Index Term (Element Model)
• Link Target
• Table of Contents
Run-in (print/PDF Select an option for run-in styling for Off
only) titles or other elements in PTC APP or
FOSI output. The list contains options for
the position of the element with which the
title (or other element) should appear on
the same line:
• <Derive>: inherit system default
(Off)
• Off: element is displayed in its own
line

Arbortext Styler Window and Editors 805

Property Description Default Value
• With preceding: an item’s content
will run into the content of the sibling
item that comes after it
• With following: an item’s content
will run into the content of the sibling
item that comes before it
• With both: an item’s content will
run into the content of the sibling
items that come before and after it
Refer to Run-in Styling
on page 215 for further information.
Note
For PTC APP output, a run-in
sequence must start with an element
styled with a With following or
With both setting. It will not start
with an element styled as Inline or
with a text node.
This option is not available for XSL-FO
output.
This feature is not supported for property
sets. The field is disabled in the Property
Sets list view.
Print/PDF and RTF only

806 User's Guide

Property Description Default Value
Word breaking Turn hyphenation on or off for print and <Derive>
PDF output, and configure how words
should break.
To activate hyphenation, set this field to
Hyphenate
To specify that words can break but
without displaying a hyphen, select
Break without hyphen.
Select Do not break if you do not want
words in the context to break.
Select <Derive> to use hyphenation
settings based on system default, property
set, or ancestor settings.
This field is unavailable if the stylesheet
is destined for non-print/PDF outputs, i.e.
if the Outputs to Edit field is set to a value
other than Base (All Outputs),
Print/PDF, or RTF.
Refer to Hyphenation
on page 216 for more information.
Language Set the hyphenation language to be used <Derive>
when hyphenating the element content.
The menu contains a list of supported
hyphenation languages for print and PDF
output, with their language codes.
Select <Derive> to use hyphenation
settings based on system default, property
set, or ancestor settings. If this setting
does not return a value the language will
be set to the default document language
specified in the language properties of the
stylesheet. See Stylesheet Properties —
Language on page 1040 for further
information.
Select (Use document language) to
use the document language resolved from
language settings configured in the
Language tab of the Stylesheet Properties
dialog box. If language settings do not
return a value the language will be set to

Arbortext Styler Window and Editors 807

Property Description Default Value
the default document language specified
in the language properties of the
stylesheet.
This field is unavailable if the stylesheet
is destined for non-print/PDF outputs, i.e.
if the Outputs to Edit field is set to a value
other than Base (All Outputs),
Print/PDF, or RTF.
Start new Indicate if you want the element to start a No change
new column, page, odd page, or even
page.
Select No change if you want the
element to follow the preceding element
on the same column or page (if it will fit).
If you select one of the page options, the
Page Set Name field will be activated,
allowing you to specify the page set
object that should be used to format the
pages for the element.
This field is unavailable if the stylesheet
is destined for non-print/PDF outputs, i.e.
if the Outputs to Edit field is set to a value
other than Base (All Outputs),
Print/PDF, or RTF.
Columns Specify the number of columns in which No change
Arbortext Editor will format the element.
When the element ends, the number of
columns reverts to its previous value. You
can specify from 1 to 8 columns or select
No change to continue with the current
layout when the element starts.
Select <Derive> to set column layout
based on system default, property set, or
ancestor settings.
This field is unavailable if the stylesheet
is destined for non-print/PDF outputs, i.e.
if the Outputs to Edit field is set to a value
other than Base (All Outputs),
Print/PDF, or RTF.
Page set

808 User's Guide

Property Description Default Value
Name This setting is available only when Start No change
new is set to Page, Odd Page, or Even
Page and the selected style allows page
sets.
Choose a page set to be used to format all
pages containing the content of the
selected element. The menu contains a list
of page sets configured for the stylesheet.
Choose No change to continue with the
page set currently in effect when the
element starts.
Select <Derive> to use the page set
defined in system default, property set, or
ancestor settings.
The page set you choose remains in effect
for the duration of the selected element.
This field is unavailable if the stylesheet
is destined for non-print/PDF outputs, i.e.
if the Outputs to Edit field is set to a value
other than Base (All Outputs),
Print/PDF, or RTF.
Page number This setting is available only when a page Continue
set is started, i.e. when Start new is set to
Page, Odd Page, or Even Page and
the Name field of the Page set group is
not No change.
Set the first number of the page set using
one of the following options:
• <Derive>: number the page set
based on system default, property set,
or ancestor settings.
• Continue: use the next number in
sequence after previous numbered
elements have had their numbers
applied
• Initial: restart numbering at 1
• Start at: specify that numbering
should start at a particular number.
You must also click the Start At button

Arbortext Styler Window and Editors 809

Property Description Default Value
to invoke the dialog box in which you
can define the start at number.
This field is unavailable if the stylesheet
is destined for non-print/PDF outputs, i.e.
if the Outputs to Edit field is set to a value
other than Base (All Outputs),
Print/PDF, or RTF.
Start At This button is only enabled when the
Page number field is set to Start at.
Invokes the Page Number Start At dialog
box, in which you can define the number
at which numbering should start.
This button is unavailable if the Outputs
to Edit field is set to a value other than
Base (All Outputs), Print/PDF,
or RTF.

810 User's Guide

Property Description Default Value
Landscape page This option is available only when Start No
body for duration new is set to Page, Odd Page, or Even
of element Page. Starting a landscape orientation
when not starting a new page is not
recommended as it can produce
unexpected results.
This option is not available for property
sets in a stylesheet set to generate print/
PDF output via the FOSI engine.
Setting this option to Yes for an element
has different effects depending on the
base orientation of the active page set:
• When the page set's page orientation
is portrait, selecting this option starts
a new page with the body of the page
printed in a landscape orientation
(rotated 90 degrees
counterclockwise). Headers and
footers remain in a portrait orientation
for the duration of this element
context or condition. This is
commonly used to produce landscape
tables in portrait documents.
• When the page set's page orientation
is landscape, selecting this option
rotates the body of each page 90
degrees counterclockwise, giving a
portrait page body and landscape
headers and footers.
If the elements that start Landscape page
body for duration of element are nested,
only the outermost setting has any effect.
This field is unavailable if the stylesheet
is destined for non-print/PDF outputs, i.e.
if the Outputs to Edit field is set to a value
other than Base (All Outputs) or
Print/PDF.

Arbortext Styler Window and Editors 811

Breaks Category - Keeps
The Keeps sub-category provides options for keeping elements together across
page, line, and column boundaries, and controlling widows and orphan lines in
print, PDF, and RTF outputs.
The following table describes the properties in the Keeps sub-category.

Note
When the Structure type field is set to Inline for an element, only the Keep
properties (print/PDF and RTF only) fields are available. All other properties
are deactivated.

Property Description Default Value

Widow and Limits or permits the appearance of
orphan control widows and orphans in a document,
(print/PDF and
which refers to a line of text left by itself
RTF only)
at the top (widow) or bottom (orphan) of
a column or page. Specify the number
(Any number, 2 or more, 3 or more)
of lines to keep at the top of a page or
column and the number of lines to keep at
the bottom of a page or column.
If a page or column break occurs in the
middle of a table, each table row is
considered as a line. When you make
settings in the Number of lines to keep at
top of page or column or Number of lines
to keep at bottom of page or column fields
in the context of table these define the
number of table rows to control. Widow
and orphan control will work correctly
within a table that breaks over pages.
Number of lines to Select Any number to permit a widow
keep at top of line in a page or column if needed, i.e. the
page or column
last line of a text block that has broken
over a page or column by itself. Select 2
or more or 3 or more to specify that, if
a text block has to run onto the next
column or page, it may only do so by at
least two or three lines, respectively.
Number of lines to Select Any number to permit an orphan

812 User's Guide

Property Description Default Value
keep at bottom of line in a page or column if needed, i.e. the
page or column first line of a text block that remains on
the previous page when the block breaks
over to the next column or page. Select 2
or more or 3 or more to specify that, if
a text block has to run onto the next
column or page, it must leave behind at
least two or three lines, respectively.
Keep properties Controls the breaking of elements over
(print/PDF and line, column, or page boundaries.
RTF only)
For every option defined, the priority
setting specifies the “strength” of the
keep, from 0 to 7: 0 always allows breaks
and 7 permits no breaks.
Keep scope Specifies the area in the document in
which the defined keeps should apply to
the element. The available options are:
Same line, Same column, or Same
page.
Note
Only Same line applies to elements
whose structure type is Inline.
Keep content Enter a value from 0–7 in this field to
together priority specify that element content should be
kept together. The value determines the
strictness of the keep.
Keep with Enter a value from 0–7 in this field to
previous priority specify that this element should be kept
with the previous element. The value
determines the strictness of the keep.
This is not available for elements whose
structure type is Inline.
Keep with next Enter a value from 0–7 in this field to
priority specify that this element should be kept
with the next element. The value
determines the strictness of the keep.
This is not available for elements whose
structure type is Inline.

Arbortext Styler Window and Editors 813

Property Description Default Value

Multiple Break Points and Keeps Settings

If two or more break points are found to fit, and each has a keeps setting,
composition will break at the location with the lowest keeps level while
attempting to place the maximum content on a page.
Note these two examples:
1. If two break points have a level of 3, the break point that fits the most content
is chosen.
2. If one break point with a level of 5 has more content than a second break
point, which has a level of 4, the second break point is chosen. It is chosen
because of its lower keeps value.

Breaks Category - HTML Chunking

The HTML chunking sub-category provides options for classing an element as a
chunk boundary, at which the document will break when publishing chunked
HTML output (EPUB, HTML Help, and Web formats). You can also set a
persistent filename for the chunk created from the element and its content.
The following table describes the properties on the HTML chunking sub-category.

Note
The properties in this category are unavailable if
• the stylesheet is destined for non-chunked HTML outputs, i.e. if the Outputs to
edit field is set to a value other than Base (All Outputs), HTML Help, Web, or
EPUB.
• the Element HTML chunking properties option in the HTML tab of the
Stylesheet Properties dialog box has not been checked.

814 User's Guide

Property Description Default Value
HTML chunking properties
Chunk boundary Specifies whether the element acts as a
chunk boundary. The available options
are Yes, No, and <Derive>. When the field
is set to <Derive>, and the value can be
resolved, a tool tip for the field describes
the origin of the chunk boundary setting
and the shortcut menu lists the locations
in the derivation chain. If you choose a
location from the derivation chain you
will be taken to the required location in
the Elements list, without having to exit
the HTML Chunking dialog box.
The label of this field will be displayed in
blue text if the field contains an explicit
setting. Settings made in this field for an
individual element interact with chunk
boundary settings made for the stylesheet
in the HTML tab of the Stylesheet
Properties dialog:
• When the Element HTML chunking
properties option in the HTML tab of
the Stylesheet Properties dialog box is
checked, chunk boundaries will be
created based on the settings made for
each individual element in the
document via this Chunk boundary
field. Settings made for the element in
this field will be disregarded if
Element HTML chunking properties is
not checked in the Stylesheet
Properties dialog box.

Arbortext Styler Window and Editors 815

Property Description Default Value
• Explicit settings made here take
precedence over any DITA chunk
boundary setting identified for the
element with the activation of the
DITA topic file boundaries setting in
the HTML tab of the Stylesheet
Properties dialog box. When there is
not an explicit setting for the element
in this field, and if one does not exist
in the entire derivation chain, the
activation of the DITA topic file
boundaries option will determine the
chunk boundary for the element,
otherwise the element will not form a
chunk boundary.
Persistent file Defines the filename for the chunk
name created from the element and its content,
if the element has been identified as a
chunk boundary. The available options
are Yes, No, and <Derive>. When the field
is set to <Derive>, and the value can be
resolved, a tool tip for the field describes
the origin of the filename setting and the
resolved value is displayed in either the
From attribute or the From XPath field,
depending on the way in which it was
extracted originally.
When the field is set to Yes, the From
attribute and From XPath controls are
activated, allowing you to define the
object from which the filename should be
extracted:
When this field is set to No, the
publishing process will generate
filenames for the chunks based on their
hierarchy within the document. For DITA
documents, this means that persistent
filenames is supplied by the DITA
composition pipeline, based on source
topic filenames.
• From attribute - select this option to
indicate that the chunk's filename will

816 User's Guide

Property Description Default Value
be extracted from one of the element's
attributes. Enter the attribute name
manually or select it from the drop
down menu. Note that, if you enter an
invalid attribute name here, Arbortext
Styler will display an error message
when you click OK to exit the dialog
box.
• From XPath - select this option to
indicate that the chunk's filename will
be extracted from a specified location.
Enter an XPath expression in the field
- note that, if you enter an invalid
XPath expression here, Arbortext
Styler will display an error message
when you click OK to exit the dialog
box.
Note
If you enter the name of a
namespaced element in this field,
you will not be prompted to
declare the namespace if it does
not already exist. Ensure you have
declared the namespace for the
stylesheet by creating an element
with the applicable prefix, or the
XPath expression you enter in this
field will not be valid
This field and its controls will be disabled
if the Chunk boundary field is set to No.
The From attribute and From XPath fields
are disabled if the Persistent filename
field is set to No, regardless of the setting
in the Chunk boundary field.
The label of this field will be displayed in
blue text if the field contains an explicit
setting.

Arbortext Styler Window and Editors 817

Property Description Default Value

Generated Text Category

The Generated text category provides options for specifying generated text, and its
formatting characteristics, for an element, context, or condition.
The following table describes the properties in the Generated text category.
Property Description Default value
Before-text Displays the generated content to be
added before the element content. Click
Edit to open the Generated Text Editor, in
which you can specify or edit the
generated text.
After-text Displays the generated content to be
added after the element content. Click
Edit to open the Generated Text Editor, in
which you can specify or edit the
generated text.

818 User's Guide

Property Description Default value
Numbers and Add a number or a symbol before an None
bullets element. The Number option is enabled
for contexts and conditions of titles
within elements given the Division or
Formal Block style, and for elements
mapped to the List Item, Block,
Paragraph, Inline, or Hidden styles. The
Bullet option is enabled only for list
items.
Select None to leave the element blank.
Click the Details button after you have
specified the Number or Bullet option to
open the Number Details dialog box or the
Bullet dialog box, respectively. Here you
can specify formatting, additional text,
and position settings for the numbers/
symbols.
Repeat title or This option is commonly used to generate Selected
continuation text continued titles at the top or bottom of
(Print/PDF only)
pages for tables or other formal blocks
that span multiple pages. Select Yes in
either the At top after break field or the At
bottom before break field, depending on
where on the page you want the title to
repeat. When selected, these options
enable the associated Edit buttons that
invoke the Generated Text Editor. Use the
editor to specify the generated text that is
output at the top or bottom of the next
column or page whenever the element
breaks across a column or page.
Select No for either of these options to
simply display the title on the first page
of element content.
This option is available only when:
• The selected context has the Title
style for Base (All Outputs) or
Print/PDF outputs.

Arbortext Styler Window and Editors 819

Property Description Default value
• The selected context has a parent or
grandparent. If not, it is not possible
for the stylesheet to determine the
scope of the repeating title.

Derivation Mechanism for Generated Text Properties

When you hover over any Generated Text Property, a tooltip is displayed to reflect
whether the values are Specified Explicitly, or they are derived. If you want to
derive the Generated Text Properties, right-click on the property value and select
Derive All Generated Text Properties. When you choose to derive the Generated
Text Properties, that selection applies to all the properties. It is not possible to
derive some of the properties and specify others explicitly. For more details, see
Deriving Property Values on page 223.

Property Sets Category

Use the Property sets category to reference property sets from elements, contexts,
conditions or other property sets. Property sets are predefined sets of formatting
properties that can be applied to contexts or conditions, or combined to create
additional property sets.
The following table describes the properties on the Property sets category.
Property Description
Available property sets Lists property sets that have been configured for the
stylesheet, but have not been applied to the context
or condition selected in the Elements list, or the
property set selected in the Property Sets list.
When a property set is selected in the Property Sets
list view, it does not appear in the Available property
sets list of the Property sets category because a
property set cannot reference itself.
Used property sets Lists the property sets that have been applied to the
element, context, or condition selected in the
Elements list or the property set selected in the
Property Sets list.
Add Click to move the property set(s) selected in the
Available property sets list to the Used property sets
list.
Remove Click to remove the selected property set(s) from the
Used property sets list and return it to the Available
property sets list.

820 User's Guide

Property Description
Go To Click to access the property set selected in the Used
property sets list for edit. The Property Sets list
opens, with the selected property set highlighted for
edit.
Up and down arrows Move the selected property sets up or down in the
Used property sets list.
The order of property sets is important. If property
sets that have been applied to a context, condition,
or another property set have conflicting properties,
the last property set in the list will override the
previously listed property sets.
Description A read only field that provides a description of the
formatting properties set in the selected property set.
This field is empty when multiple property sets are
selected.

Note
When two or more contexts, conditions, or property sets are selected in the
Elements or Property Sets lists, all the controls on the Property sets category
are disabled, unless all the selected objects reference the same property sets.

Footnote Category
The Footnote category provides options for specifying how footnotes are
configured. Footnote properties can only be applied to element contexts or
conditions and as such the category is not available when a property set is selected
in the Property Sets list. Also, the category is only available when Outputs to edit
is set to Base (All Outputs) and cannot be used to set footnotes to appear
only in certain outputs of the document.
The following table describes the properties in the Footnote category.
Property Description Default Value
Element is not Indicates that the selected element is not Selected for all
footnote related related to footnotes. elements except
those with the
Footnote style.
Element contains Indicates that the selected element Selected for
footnote text contains text for footnotes. When you elements with the
select this option, two other options are Footnote style.

Arbortext Styler Window and Editors 821

Property Description Default Value
set automatically:
• The associated Generates reference
mark and footnote checkbox is
selected
• The Hidden property in the Text
category is set to Yes
Generates Indicates that the selected element Checked when
reference mark generates both the associated reference the Element
and footnote contains footnote
mark and the footnote itself. This
checkbox is associated with the Element text option is
contains footnote text option. selected.
If the selected element does not have an
ID equivalent attribute, this checkbox is
selected by default and cannot be
changed.
Element Indicates that the selected element
references references another element that contains
footnote and
the text for the footnote and generates the
generates
reference mark associated reference mark.
If the selected element does not have an
IDREF, IDREFS, or CDATA attribute,
this option is not available.
When you select this option, the Hidden
property in the Text category is set to
Yes.

822 User's Guide

Property Description Default Value
Reference Provides a list of the IDREF, IDREFS,
attribute and CDATA attributes for the selected
element that could be used to reference
the footnote element.
This list is only available when the
Element references footnote and
generates reference mark option is
selected.
Generates Indicates that the element not only
footnote references the element containing the
footnote text, but also generates the
footnote.
This checkbox is only available when the
Element references footnote and
generates reference mark option is
selected.

Block border Category

The Block border category provides options for configuring border rules and
background color for elements with a block structure. The properties in the Block
border category only apply when Structure type in the Breaks category is set to
Block.
Border rules and backgrounds configured in this category apply in these outputs:
• Print/PDF via the PTC APP engine
• Chunked HTML outputs (EPUB, HTML Help, Web)
• HTML File output
The following table describes the properties in the Block border category.
Property Description Default Value
Border properties
Sides Select the sides of the block on which the No (all)
border should appear — Top, Left, Right,
Bottom
Choose Yes to activate the border for each
required side.

Arbortext Styler Window and Editors 823

Property Description Default Value

Note
Other properties in the Border
properties field are disabled if no
sides are activated.
A border rule setting is not inherited to
child elements.
Thickness Set the thickness of the rule applied as the 1px
border.
You can choose a measure, enter it
manually or use a Size definition object
from the stylesheet.
Offset Set the distance of the border rule from 0px
the block edge.
You can choose a measure, enter it
manually or use a Size definition object
from the stylesheet.
Color Specify the color of the border rule. Black
Style Specify the rule style. Single
Some Arbortext Styler rule styles are not
supported in HTML output. For more
information, see Differences in Output
Support on page 1084.
Rounded corners Specify whether borders should be joined No
with a rounded corner.
Note
The Rounded corners option is only
available if you have activated two
adjoining borders.
Radius If you have selected Yes for Rounded 1px
corners, set the stretch of the curve of the
corner.
You can choose a measure, enter it
manually or use a Size definition object
from the stylesheet.

824 User's Guide

Property Description Default Value
Background properties
Color Choose a background color for the block. None
A background color setting is inherited to
all child elements until a different setting
is encountered.
For more information, see Adding Border Rules to Block Elements on page 202.

Side by Side Category

The Side by side category provides options for specifying the alignment of block
elements that will be displayed next to each other in output.
The following table describes the properties on the Side by side category.
Property Description Default Value
Align side by side Specifies whether the current element No
with following starts a side by side region. The element
will appear to the side of the element that
follows it in the source XML file, when
the document is output. The tops of the
two elements will be vertically aligned.
The choices in this field are :
• <Derive> - Specifies side by side
setting based on system default,
property set, or ancestor settings.
• Yes

This setting will continue until the

formatting process encounters one of
the following:
○ An element that sets End previous
alignment
○ The end of an element that sets
End all contained alignments
• No (default)
If you set this field to Yes, the Placement,
Horizontal offset, Width, Horizontal Gap
fields will be activated.
Placement Specifies whether the current element Left
should be on the left or right of the

Arbortext Styler Window and Editors 825

Property Description Default Value
following element(s).

826 User's Guide

Property Description Default Value
Horizontal offset Shifts the current element horizontally. 0pc
Use a positive value to move from the
page edge toward the center. A negative
value will move from the center out. The
effect depends on the Placement setting:
• Left: a positive Horizontal offset value
will shift the current element to the
right from the left indent inherited
from the parent element. A negative
value will move it to the left.
• Right: a positive Horizontal offset
value will shift the current element to
the left from the right indent inherited
from the parent element. A negative
value will move it to the right.
Note
em is not a valid unit of measurement
for this field. If a value in em is used,
either by typing in the field or
referencing a Size definition, it will be
processed as follows:
• FOSI, XSL-FO, and HTML outputs
will treat 1em as 1pc
• PTC APP will treat 1em as the current
font size
The effects of indent settings vary in
different output formats. Refer also to
Differences in Behavior of Indent Settings
Between Outputs on page 830 for further
points to keep in mind when configuring
side by side settings.
Width Specifies the width of the block allocated 12pc
for the current element.
Note that any indents specified for the
current element on the Indent category
can affect the positioning of text within
that block.

Arbortext Styler Window and Editors 827

Property Description Default Value

Note
em is not a valid unit of measurement
for this field. If a value in em is used,
either by typing in the field or
referencing a Size definition, it will be
processed as follows:
• FOSI, XSL-FO, and HTML outputs
will treat 1em as 1pc
• PTC APP will treat 1em as the current
font size
It is recommended that you do not
reference a Size definition with a value of
0 in this field. This may produce
unexpected results.
Horizontal gap Specifies the space between the block 0pc
allowed for the current element and the
content of the following element.
Note
em is not a valid unit of measurement
for this field. If a value in em is used,
either by typing in the field or
referencing a Size definition, it will be
processed as follows:
• FOSI, XSL-FO, and HTML outputs
will treat 1em as 1pc
• PTC APP will treat 1em as the current
font size
It is recommended that you do not
reference a Size definition with a negative
value in this field. This may produce
unexpected results.

828 User's Guide

Property Description Default Value
End previous Confirms whether the current element No
alignment will be placed alongside the previous
element styled with side by side
alignment.
• Yes - End the side by side alignment
set for the previous element at the
current element.
• No - Continue the side by side
alignment set for the previous
element. The current element will be
placed alongside the previous element
styled with side by side alignment.
When working with HTML outputs, a
setting of Yes in this field will end all
previous alignments, not just the one
immediately preceding the current
element.
End all contained Confirms whether any side by side Yes
alignments alignments started within the current
element will end at the end of the current
element.

Note
The Horizontal offset, Width, Horizontal gap fields in this category allow you to
either type an arbitrary size in the field or choose a defined size by selecting
from the list of Size objects configured for your stylesheet. For the latter
option, click the Select Size button next to the field for which you wish
to set the measurement and select the name of the required Size object from
the resulting list. Once you have selected a Size object the measurement it
defines will be displayed wrapped in angle brackets (< > characters) in the
relevant field. For example, the Size object InchSize defines a
measurement of 1.00in:

Arbortext Styler Window and Editors 829

Differences in Behavior of Indent Settings Between Outputs
The effect of indent settings in general is as follows. Note that the current element
is the element being styled with side by side alignment.
• The Horizontal offset value determines where the aligning edge occurs relative
to the align side margin. Positive values move from the align side margin
toward the center of the page, and negative values move toward the page edge.
For example, if Placement is Left, then the Horizontal offset determines where
the left edge of the current element occurs relative to the left margin. A
positive Horizontal offset moves the edge of the current element to the right.
• The Width value determines the amount of space reserved for the current
element, starting at the aligning edge and moving toward the page center.
• The available horizontal space for the current element is defined by a
combination of Horizontal offset and Width values. Indent settings made for the
current element in the Indent category control the position of its content within
that horizontal space.
• You may find that position and indent settings mean that the current element
overlaps the following content. If this is the case the indent set for the
following content will be ignored on the side adjacent to the current element
until the following content has passed the bottom of the current element and
the current element’s Spacing after measure. The edge of the following content
block adjacent to the current element will be separated from the current
element by the current element’s Horizontal gap measure. Once the following
content block has passed the bottom of the current element its indents will
become effective, creating the wrapping effect shown below.

• If position and indent settings mean that the current element does not overlap
the following content, the following content will not wrap around the current
element.

830 User's Guide

 Caution
When working with HTML outputs, the current element’s indent settings must
be specified in the same object (context, property set, or condition) that holds
its side by side properties. You may see unexpected results if this is not the
case.

Indent behavior is consistent with these general rules in print/PDF output

generated via the PTC APP engine and in HTML outputs.
You will encounter some different effects in output generated via the FOSI and
XSL-FO print engines:
• When Placement is Right, FOSI and XSL-FO engines ignore the Horizontal
offset value configured for the current element. They use the left indent and
first line indent settings from the Indent category to determine the left edge of
the current element instead.
• When Horizontal gap for the current element is greater than zero, the position
of the following content is determined by adding the Horizontal gap value and
the indents set for the following content to the adjacent edge of the current
element.
If it is not possible for the following content to have an indent of 0 (for
example with hanging shaped numbered content), use FOSI edited source to
produce output with the correct gap between side by side items.

PDF tags Category

The PDF tags category provides options for assigning PDF tags and attributes
(PTC APP only). Settings made here will be reflected in tagged PDF output.
Refer to Generating Accessible PDF Output on page 138 for information about
tagged PDF output.

Note
Properties in this category are not inheritable.

The following table describes the properties in the PDF tags category.

Arbortext Styler Window and Editors 831

Property Description Default Value
PDF tags (PTC Choose PDF tags for the selected
APP only) element, context, condition, or property
set, using the fields in this group.
Select (No tag) to specify that a PDF tag
should not be generated for the item.
Select (Artifact) to generate an artifact
instead of a PDF tag. Artifacts are
generally meant to wrap content that
should not be accessed by screen readers,
for example, headers/footers.
This group is disabled if the print engine
for your environment is not PTC APP, or
if the Generate tagged PDF option is not
enabled in stylesheet properties (Print/
PDF tab).
You can use this group to configure
primary and secondary (nested) PDF tags
to be generated for an element, context,
condition, or property set. For example, a
list item may require PDF tags to
represent its constituent parts:
• The list item — LI tag (Element tag)
• The generated label for the list item,
for example a bullet — Lbl tag
(Before-text tag, child of LI)
• The content of the list item — LBody
tag (Element content tag, child of LI)
Use Arbortext Styler’s Validate Stylesheet
feature to confirm that the PDF tags you
have assigned are valid for the current
element style.
Element tag Select the primary PDF tag to be assigned
to the element.
Before-text tag Select the secondary PDF tag that will be
output for any before-text generated text
configured for the element.
Choose (No tag) if a PDF tag is not
required for the element’s generated text.
This tag will be contained within the
primary Element tag.

832 User's Guide

Property Description Default Value
Element content Select the secondary PDF tag that will be
tag output for the element’s content.
Choose (No tag) if a separate PDF tag is
not required for the element’s content.
This tag will be contained within the
primary Element tag.
PDF attribute The attribute that will be assigned to the
primary PDF tag in tagged PDF output.
Select an attribute from the drop down
list. You may also use RowSpan, ColSpan
or Lang — you will need to enter these
manually as values for these attributes are
set automatically during publishing. The
value you set for these attributes will
override that automatically set.
Note
You cannot set an attribute for an
element set to output an Artifact or
(No tag).
Click Add or Edit to open the PDF
Attribute Dialog Box on page 979. Here
you can create or update any of the PDF
attribute settings. Click Delete to remove
a setting.
The attribute list will show explicitly set
attributes and those derived from a
property set. Explicit attributes are shown
in bold, blue text. Only explicit attributes
can be deleted.
This field will be disabled if the print
engine for your environment is not PTC
APP, or if the Generate Tagged PDF
option is not enabled in stylesheet
properties.

Arbortext Styler Window and Editors 833

Property Description Default Value
XPath An XPath expression corresponding to
the setting made in the PDF Attribute
dialog box to provide the value of the
PDF attribute.
This field will be disabled if the print
engine for your environment is not PTC
APP, or if the Generate Tagged PDF
option is not enabled in stylesheet
properties.

HTML tag Category

The HTML tag category provides options for assigning HTML tags and attributes.
Settings made here will be reflected in HTML outputs.

Note
Properties in this category are not inheritable.

The following table describes the properties in the HTML tag category.

834 User's Guide

Property Description Default Value
HTML tag Choose an HTML tag for the selected
element, context, condition, or property
set.
The list of available tags in the drop down
list depends on whether the item being
styled is block or inline. It also reflects
the setting of the Generate HTML5 option
in the HTML tab of the Stylesheet
Properties dialog box.
Select (No tag) to specify that an HTML
tag should not be generated for the item.
Styling will have no effect.
Note
You cannot assign an HTML tag for
an element assigned any of the
following styles: Cross Reference,
Custom Table, Definition List,
Definition List Item, Document,
Footnote, Index, Link, Link Target
(block), Preformatted (block), Table,
Table of Contents, and No Style. The
HTML tag control is disabled if the
item has any of these styles. Refer to
HTML Tags Permitted for Element
Styles on page 836HTML Tags
Permitted for Element Styles below
for information on the style/HTML
tag combinations that are permitted.
If you assign a tag to a property set that is
not permitted for the element style it gets
assigned to, the value will be ignored in
output and the default tag for the style
used.
Use Arbortext Styler’s Validate Stylesheet
feature to confirm that the HTML tag you
have assigned is valid for the current
element style.

Arbortext Styler Window and Editors 835

Property Description Default Value

Note
It is possible that Validate Stylesheet
will not flag all instances of
unsuitable tag usage, especially if the
output is valid but just does not
display well. Always review your
output to confirm it looks correct, and
make tagging changes as required if
not.
HTML attribute The attribute that will be assigned to the
HTML tag in HTML output. Choose an
attribute from the drop down list or
manually enter any valid XML attribute
name.
If you enter an attribute that is
automatically set during publishing, e.g.
rowspan, colspan, lang, the value you
supply for the attribute will override that
automatically set. Note that this does not
apply for the ID attribute.
Click Add or Edit to open the HTML
Attribute dialog box. Here you can create
or update any of the HTML attribute
settings, including referencing a custom
JavaScript function to be called. Click
Delete to remove a setting.
Some HTML4 attributes are not allowed
in HTML5. Refer to HTML Attribute
Dialog Box on page 979 for further
information.
Appropriate CSS should be used when
generating HTML5 instead.
XPath An XPath expression corresponding to
the setting made in the HTML Attribute
dialog box to provide the value of the
HTML attribute.

HTML Tags Permitted for Element Styles

The table below lists the element styles for which you are permitted to assign
HTML tags, and the tags that you can use:

836 User's Guide

Style Tags Permitted
Block (block) (No tag), address, blockquote, div, p
HTML5 tags: article, aside, figure, nav, section
Block (inline) (No tag), abbr, acronym, b, bdo, big, cite, code, dfn, em, font, i,
kbd, q, samp, small, span, strong, sub, sup, tt, var
HTML5 tags: mark, time
Division address, blockquote, div, p
HTML5 tags: article, aside, figure, nav, section
Formal Block address, blockquote, div, p
HTML5 tags: article, aside, figure, nav, section
Hidden (block) (No tag), a, div
Hidden (No tag), a, span
(inline)
Index Term (No tag), span
Inline (block) (No tag), address, blockquote, div, p
HTML5 tags: article, aside, figure, nav, section
Inline (inline) (No tag), abbr, acronym, b, bdo, big, cite, code, dfn, em, font, i,
kbd, q, samp, small, span, strong, sub, sup, tt, var
HTML5 tags: mark, time
Link Target abbr, acronym, b, bdo, big, cite, code, dfn, em, font, i, kbd, q,
(inline) samp, small, span, strong, sub, sup, tt, var
HTML5 tags: mark, time
List — div, ul
Bulleted
List — div, ol
Numbered
Paragraph (No tag), address, blockquote, div, p
(block) HTML5 tags: article, aside, figure, nav, section
Paragraph (No tag), cite, code, q, span, aside
(inline)
Preformatted (No tag), abbr, acronym, address, b, bdo, big, blockquote, cite,
(inline) code, dfn, div, em, font, i, kbd, p, q, samp, small, span, strong,
sub, sup, tt, var
HTML5 tags: article, aside, figure, mark, nav, time

Arbortext Styler Window and Editors 837

Style Tags Permitted
Title div, h1, h2, h3, h4, h5, h6
HTML5 tags: figcaption
Table of HTML5 tags: div, nav
Contents

RTF Category
When Arbortext Import/Export is installed and licensed, and one or more element
contexts are selected in the Elements list, the RTF category is added to the
Arbortext Styler window. This category lets you map Arbortext Styler element
contexts to RTF-specific styles and fields to be included in exported documents.
The following table describes the properties in the RTF category.

838 User's Guide

Property Description Default Value
RTF style name The controls in this group let you specify
generation the type of style names to be generated
with the exported document. Refer to
Publishing RTF With and Without Using
Word Style Names on page 658 for
information on working with style names.
The options are:
• Default (Automatic) / Default (None) -
this option is selected by default, but
the name of the option depends on the
value of the Generate RTF style names
automatically checkbox in the RTF tab
of the Stylesheet Properties dialog
box. If that option is checked, this
option will be named Default
(Automatic). If that option is not
selected, this option displays its
default name of Default (None).
○ If the state is Default (Automatic),
the selected context in an exported
document will be assigned a
generated RTF style name which
is the same as the element context
name when expressed as an XSL
context. For example, the context
title in sect1 will generate
the RTF style name sect1/
title, as in XSL terminology.
Word has a style name length limit
of 253 characters. If a generated
style name is greater than 253
characters (which is unlikely) the
name will be truncated to that
limit.
○ If the state is Default (None), the
selected context in an exported
document will not be assigned an
RTF style name. The selected
context, whether of Block or
Inline structure type, will be
assigned RTF formatting

Arbortext Styler Window and Editors 839

Property Description Default Value
information as defined by
Arbortext Styler properties
without referring to a style name.
Each corresponding instance of
paragraphs and character runs in
the RTF document will be
independently styled within the
document body, using local
overrides of the formatting
defined by Word’s Normal style
(for paragraphs) and Default
Paragraph Font (inline character
styling).
You must deselect the Default
(Automatic) / Default (None) option if
you want to select one of the other
options.
• User-defined - The selected context in
an exported document will be
assigned a default style name based
on the XSL context selector, which
can be modified by selections in the
RTF style type group.
• Automatic - The selected context in an
exported document will be assigned a
generated RTF style name which is
the same as the element context name.
This setting persists for the context
regardless of the state of the Generate
RTF style names automatically option
in the Stylesheet Properties dialog
box..

840 User's Guide

Property Description Default Value
• None - The selected context in an
exported document will not be
assigned an RTF style name. This
setting persists for the context
regardless of the state of the Generate
RTF style names automatically
checkbox. The selected context,
whether of Block or Inline
structure type, will be assigned RTF
formatting information without
referring to a style name.
RTF style type The controls in this group let you specify
the type of style to use for user-defined
style names. By default, Arbortext Styler
sets the style type corresponding to the
selected context's structure type, as
defined in the Breaks category. If the
context has a Block structure, you will
be given the option to specify paragraph
styles in the RTF style type field. If the
context is of Inline structure you will
be allowed to specify character styles.
The paragraph or character style option
will be checked for you automatically
depending on the selected element's
structure, and the other option will be
unavailable.
• Paragraph - The selected context will
be exported as a named paragraph
style.
• Character - The selected context will
be exported as a named character style
• RTF style name - The name to assign
to the exported paragraph or character
style, as applicable. Enter a new style
name or select from the list of
supplied style names.
• List paragraph style - The selected
context will be exported as a named
list paragraph style. This option is

Arbortext Styler Window and Editors 841

Property Description Default Value
only available if the selected element
is of Block structure, since it is an
alternative to the Paragraph style
name option associated with that
structure type.
• RTF list names - The name to assign
to the exported list paragraph style.
Click the Edit button to access a list of
valid list style names
RTF field The controls in this group specify the
characteristics of any Word fields to be
exported with the selected context. Click
the Edit button to display the Field dialog
box, with which you specify the
characteristics of the Word field to be
exported with the selected context.
Refer to Publishing Word Fields,
Instructions, and Switches on page 663
for information about exporting fields.

842 User's Guide

Property Description Default Value

Graphic Category
The Graphic category provides options for specifying the pages in a PDF graphic
to be included in print/PDF output generated by the PTC APP engine.
For information on inserting PDF graphics into XML content, see Vector Graphics
in Arbortext Editor help.
The properties in the Graphic category apply for contexts and conditions of
elements styled as Graphic, and for property sets.
The following table describes the properties in the Graphic category.

Arbortext Styler Window and Editors 843

Property Description Default Value
PDF graphic options (print/PDF only)
Page selection Choose the method of determining which Use a custom
pages of a PDF graphic to output: page range
• <Derive>
• Show all pages from PDF — include
all pages
• Use a custom page range — include a
range of pages
Specify the range in the Page range
field
• Use Graphic 'view' role attribute — use
the value of the attribute of the
element styled as Graphic that has the
View role as the page number to
include
Page range Specify the range of pages to include — 1
some examples are given below:
• Simple range, for example 1–3
• Range with open start, for example -3
(all pages up to and including 3)
• Range with open end, for example 3–
(all pages from page 3 to last page)
• Range with open start and end, i.e. -
(all pages)
You can also use a combination of page
range and single pages, separated by a
comma, for example: or
1–3, 5
1–3, 10–15
For more information, see PDF Graphics on page 570.

Page Sets - Page Size Category

Use the settings in the Page Size category to specify the page size and orientation
of pages formatted by your page set.
• Page size - Provides a list of available page sizes.

844 User's Guide

 You can also specify a custom size by specifying dimensions in the Width and
Height fields. The value of this field will change to Custom.

Note
Refer to Units of measurement in Arbortext Editor help for information on
valid units.

• Portrait - Prints all content in portrait format

If this setting is selected, click Landscape to change it. Making this change
will swap the values in the Width and Height fields.
• Landscape - Prints all content in landscape format

If this setting is selected, click Portrait to change it. Making this change will
swap the values in the Width and Height fields.
• Width - Specifies the width of the page on which the document is printed. The
field is populated automatically when you select a standard page size. If you
make a change to Width or Height when you have selected a standard page size
in the Page size list, that setting will change to Custom when you leave the
field.
• Height - Specifies the height of the page on which the document is printed.
The field is populated automatically when you select a standard page size.
• Preview - Displays the results of the settings made in this category.
Refer to Setting a Page Size and Orientation for a Page Set on page 182 for
examples and further information to assist you in configuring the page size
settings for a page set.
You can also use the settings in the Page Size category to specify the margins for
your page set. You can specify margins for single-sided page sets, double-sided
page sets, and double-sided page sets with mirror margins.
Margins specified by the properties in this category are guides only. They are only
used to provide the correct positioning for regions that are given measures relative
to the margins (see the Position category on page 853 of the Page Regions list). If
a page set contains regions that all have absolute positioning, the margins will
have no effect.

Note
Refer to Units of measurement in Arbortext Editor help for information on
valid units.

Arbortext Styler Window and Editors 845

The Page Size category always includes the following options for margins:
• Top - Specifies the distance from the top of the page to the top of the body of
the document.
• Bottom - Specifies the distance from the bottom of the page to the bottom of
the body of the document.
The category contains the following options when you are creating a page set for a
single-sided document (with the Double-sided option deselected):
• All pages - sets the left and right margins for every page formatted by this page
set:
○ Left - Specifies the distance from the left edge of the page to the left edge
of the document content.
○ Right - Specifies the distance from the right edge of the page to the right
edge of the document content.
The tab contains the following options when you are creating a page set for a
double-sided document (with the Double-sided option selected):
• Mirror margins - Specifies that the margins configured for a left page should be
mirrored on right pages throughout the page set.
• Left pages - Sets the left and right margins for the left pages that will be
formatted with this page set.
When Mirror margins is selected, the fields in this group are unavailable. The
settings made in the Right pages field will be mirrored on left pages.
○ Left - Specifies the distance from the left edge of the page to the left edge
of the document content
○ Right - Specifies the distance from the right edge of the page to the right
edge of the document
• Right pages - Sets the left and right margins for the right pages that will be
formatted with this page set.
When Mirror margins is selected, the Left setting will be applied to the outside
margins and the Right setting will form the inside margins of all pages.
○ Left - Specifies the distance from the left edge of the page to the left edge
of the document content
○ Right - Specifies the distance from the right edge of the page to the right
edge of the document
When margins are not to be mirrored, this field will be deactivated if your
stylesheet is set to generate print/PDF output via the FOSI or XSL-FO
print engines. This will ensure that the content width is always the same

846 User's Guide

 for left and right pages. Please switch to the PTC APP engine if you wish
to apply different content widths in left and right pages.
Refer to Setting Margins in a Page Set on page 185 for examples and further
information to assist you in configuring the margins for a page set.
The Width, Height, Top, Bottom, Left, and Right fields allow you to either type an
arbitrary size in the field or choose a defined size by selecting from the list of Size
objects configured for your stylesheet. For the latter option, click the Select Size
button next to the field for which you wish to set the measurement and select
the name of the required Size object from the resulting list. Once you have
selected a Size object the measurement it defines will be displayed wrapped in
angle brackets (< > characters) in the relevant field. For example, the Size object
InchSize defines a measurement of 1.00in:

Page Sets - Page Types Category

Use the properties in the Page Types category to specify the page types that should
be used to provide layout for the pages formatted by your page set.
When the page set is single sided, you may select page types for these pages:
• Right and left pages - select a single page type to format both left and right
pages
You must select a page type in this field or the page set will not be valid.
• First page
When the page set is set to be double sided, you may select page types for these
pages:
• Right pages

You must select a page type in this field or the page set will not be valid.
• First page when right
• Left pages
• First page when left
• Blank pages

If you do not set this field, the left page will be used for left blank pages and
the right page will be used for blank right pages.
• Blank left pages and Blank right pages - these settings will only be available if
you are publishing to print or PDF via the PTC APP engine.

Arbortext Styler Window and Editors 847

 FOSI and XSL-FO engines do not support a differentiation between left and
left for blank pages. You can only specify one page type to provide layout for
all blank pages.
For each of these options, use the drop down menu to select a page type from the
list of page types configured for your stylesheet. For most of the fields you also
have an option to select a Same as option to use the same page type selected for
other types of page.
Use the Go To button to open the selected Page Type object in the Page Types list,
with cursor focus on the object to allow you to edit it.
Refer to Defining Page Regions on page 190 for examples and further information
to assist you in configuring the page types for a page set.

Page Sets - Columns Category

Use the properties in the Columns category to specify the default number of
columns and their placement in a page set.
• Initial number of columns - Specifies the default number of columns in the
page set.
You have the option to change the number of columns for an element
formatted by the page set. Change the value of the Columns property in the
Breaks category for the element. In this case you can use the settings on the
Columns property categories to style the columns for the element.
• Column horizontal alignment - Controls how to place the columns horizontally
within a region when the total width of the columns and gutters is less than the
region width. If relative column or gutter widths have been set, a value in this
field will have no effect since there is no left over space to be used.
The options are:
○ Left: align the set of columns and gutters to the first edge of the region
○ Center: leave equal space either side of the total columns and gutters in the
region
○ Right: align the set of columns and gutters to the last edge of the region
The setting in this field does not affect the alignment of content within the
columns.
• Vertical justification - Controls the vertical justification of content.

○ Top - Arbortext Styler does not vertically justify content across columns
and pages (ragged bottom).
○ Justified - Arbortext Styler vertically justifies content across columns and
pages (flush bottom). Some elements that occur on a page must have

848 User's Guide

 variable spacing set in the Spacing category for the Elements list to
achieve this effect.

Note
If you select the Justified option and the amount of variation specified
for the elements on the page in the Spacing category is insufficient,
Arbortext Styler may use up to three times the amount of variation
specified.

• Balance columns - When this option is activated, Arbortext Styler distributes

content evenly among multiple columns before a forced page break, when the
content does not fill the page. Checking this option ensures that the last
column of a page is not empty.
• Default gutter width - set the width of gutters that will separate default columns
in the page set, if the Initial number of columns field has a value of more than
1. Default columns will be equally sized to fill the entire width of the region,
less the gutters.
This value will not be used if columns have been specifically configured for
an individual element layout in the Columns property categories.
• Gutter rules - you may configure rules for the default gutters in your page set:

○ Gutter rules: select this option to draw a rule around the default gutters
between default columns in a page set.
○ Thickness: the width of the rule
○ Color: the color of the rule
○ Style: the line style of the rule
These options are not available if your stylesheet is set to generate print/PDF
output with the FOSI or XSL-FO engines.
The Default gutter width and Thickness fields allow you to either type an arbitrary
size in the field or choose a defined size by selecting from the list of Size objects
configured for your stylesheet. For the latter option, click the Select Size button
next to the field for which you wish to set the measurement and select the
name of the required Size object from the resulting list. Once you have selected a
Size object the measurement it defines will be displayed wrapped in angle
brackets (< > characters) in the relevant field. For example, the Size object
InchSize defines a measurement of 1.00in:

Arbortext Styler Window and Editors 849

Refer to Setting Columns in a Page Set on page 186 for examples and further
information to assist you in defining a column layout for a page set.

Page Sets - x Columns Category

Use the properties in the x columns categories to configure column layouts that
should apply when an element formatted by the page set is set to display a
particular number of columns. Select the category that applies to the number of
columns, up to 8.
The number of columns for an element is set in the Columns property in the
Breaks category for an element, or the Initial number of columns property in the
Columns category for a page set.
Any of the x columns categories contains options that you can select to specify the
widths of the columns and gutters in a page:
• Unequal columns - select this option to specify that the columns in the page
are not of equal width. A Width field will be activated for each column in the
table. If you do not select this option, a single Width field will cover all the
columns in the layout.
This setting only applies when your stylesheet is set to generate print/PDF
output via the PTC APP engine. The option is not available if your stylesheet
specifies FOSI or XSL-FO as the print engine.
• Unequal gutters - select this option to specify that the gutters between the
columns in the page are not of equal width. A Gutter field will be activated for
each gutter in the table. If you do not select this option, a single Gutter field
will cover all the gutters in the layout.
This setting only applies when your stylesheet is set to generate print/PDF
output via the PTC APP engine. The option is not available if your stylesheet
specifies FOSI or XSL-FO as the print engine.
If print/PDF will be generated with the FOSI or XSL-FO engine, the value of
the Default gutter width field in the Columns category will be used instead.
• Restore Defaults - reset the fields to the default values for the layout:

○ Unequal columns option unchecked

○ Unequal gutters option unchecked
○ Gutter field set to value of Default gutter width property in the Columns
category.
○ Width fields for each column in layout set to 1* relative value

850 User's Guide

The Width and Gutter fields allow you to either type an arbitrary size in the field
or choose a defined size by selecting from the list of Size objects configured for
your stylesheet. For the latter option, click the Select Size button next to the
field for which you wish to set the measurement and select the name of the
required Size object from the resulting list. Once you have selected a Size object
the measurement it defines will be displayed wrapped in angle brackets (< >
characters) in the relevant field. For example, the Size object InchSize defines
a measurement of 1.00in:

The Width and Gutter fields also take relative values, represented by an integer
followed by an asterisk. Relative values are transformed into widths once all
absolute column and gutter widths have been subtracted from the region width, by
distributing the remaining space among the columns and gutters that have relative
widths. Each relative column and gutter will be allocated a proportion of the
remaining space according to its relative value.
For example, in a four column layout where the Width values of the columns are
1in, 2*, 1* and 1*, column 2 will receive half the space remaining after 1 inch
has been subtracted for column 1. Columns 3 and 4 will each receive a quarter of
that remaining space.
Refer to Setting Columns in a Page Set on page 186 for examples and further
information to assist you in defining a column layout for a page set.

Page Sets - Page Numbers Category

Use the properties in the Page numbers category to specify the page number style
and format to be used by the page set.
The following options are available:
• Number style - the options in this list allow you to implement numbering in
Latin or non-Latin language formats:
○ 1, 2, 3, ...
○ A, B, C,...
○ a, b, c, ...
○ I, II, III, ...
○ i, ii, iii, ...
○ ①, ②, ③, ... (circled decimal numbering scheme, implemented to support
the Zenkaku numeric numbering scheme)
○ ァ,ィ,ゥ, ... (Japanese - katakana gojuon numbering scheme)

Arbortext Styler Window and Editors 851

 ○ イ, ロ, ハ, ... (Japanese - katakana-iroha numbering scheme)
○ あ, い, う, ... (Japanese - hiragana numbering scheme)
○ い, ろ, は, ... (Japanese - hiragana-iroha numbering scheme)
○ 一, 二, 三, ... (Chinese - simp-chinese-informal numbering scheme,
implemented to support the Kanji numeric 1 numbering scheme)
○ 子, 丑, 寅, ... (CJK earthly-branch numbering scheme)
○ 甲, 乙, 丙, ... (CJK heavenly-stem numbering scheme)
○ 가, 나, 다, ... (Korean - hangul numbering scheme)
○ ㄱ, ㄴ, ㄷ, ... (Korean - hangul consonant numbering scheme)
○ ๑ , ๒ , ๓, ... (Thai)
○ ۱, ۲, ۳, ... (Arabic indic numbering scheme)
○ ۱, ۲, ۳, ... (Urdu)
• Format - Displays the generated text that has been configured to set up the
page number format. Click the Edit button to open the Generated Text Editor,
which will allow you to add or make changes to the generated text.
Refer to Configuring Page Numbers for a Page Set on page 199 for examples and
further information to assist you in using page numbers in your page set's headers
and footers.

Page Sets - Other Category

Use the properties in the Other category to configure miscellaneous settings for
the pages formatted by your page set. The settings you make here apply across all
pages in the page set.
• Change bar placement — Provides a list of possible positions for change bars:

○ Left: on left margin

○ Right: on right margin
○ Inside: on inside margin
○ Outside: on outside margin
○ Alternate: on alternate margins
Refer to Adding Change Bars on page 524 for further information on
configuring change bars.
• Make last page a multiple of — Specifies a multiplier for the number of pages
that the page set should output, including blank pages if necessary. The
options are:
○ Select one of the given choices, from 1 to 32

852 User's Guide

 ○ Enter a value up to 64
The default value is 1. Values between 1 and 64 (inclusive) are valid.
For example, setting a value of 10 means that a page set will output 10, 20,
30... pages as required to accommodate content.
Refer to Defining Number of Pages for a Page Set on page 184 for further
information on setting the extent of a page set.

Page Regions - Position Category

Use the properties in the Position category to specify the position at which a page
region should appear on a page. You can also specify whether the region and its
content should be rotated.
• Region reference point - identifies the part of the region that will be placed
according to the values in the X position and Y position fields. The region will
also rotate about this point, if it is set to rotate in the Rotation type field.
Note the red “x” indicator in the Preview window. It shows the current position
of the selected region reference point, when values for X position and Y
position have been set.
• X position - the horizontal position of the region. Select an area of the page
and then set a distance from this position.
Enter a positive value to move the region toward the center of the page, or a
negative value to move it outwards.
For choices of From page left, From left margin, From page center, or From
margin center, positive values move right. For choices of From page right or
From right margin, positive values move left.
• Y position - the vertical position of the region. Select an area of the page and
then set a distance from this position.
Enter a positive value to move the region toward the center of the page, or a
negative value to move it outwards.
For choices of From page top, From top margin, From page center, or From
margin center, positive values move down. For choices of From page bottom
or From bottom margin, positive values move up.
• Width - the width of the region. Select Absolute and specify an absolute
measure, or add a measure that is relative to the page or between margins
measures.
Note the + character It indicates a measure relative to the page or between
margins measure selected in the Width field.

Arbortext Styler Window and Editors 853

• Height - the height of the region. Select Absolute and specify an absolute
measure, or add a measure that is relative to the page or between margins
measures.
Note the + character. It indicates a measure relative to the page or between
margins measure selected in the Height field.
• Preview with page set - allows you to preview the position of your region with
reference to the settings of a particular page set. Select a page set from the
drop down list of page sets configured for your stylesheet.
Changing the page set in this field affects the preview only. It has no effect on
the stylesheet itself.
• Rotation type - identifies what should be rotated. Select Content to rotate text
and graphic content without affecting the region. Select Region to rotate the
region and its content together.
The option you select will be rotated around the point identified in the Region
reference point field.
• Rotation angle: the angle to which to rotate counter clockwise.

The rotation of the content can be set to 0, 90, 180 or 270 degrees.
The rotation of the region can be set in increments of 0.1 degrees.
Different rotation options are available, depending on the type of content the
region contains. The print engine set for your stylesheet also has an effect on
the options provided here:
Angles -
Print engine Content type Option degrees
FOSI/XSL-FO Generated Region Increments of
Content 0.01
Content 0, 90, 180, 270 or
360
Main Content Region 0 or 90
Flow

PTC APP Generated Region Increments of

Content 0.01
Content 0, 90, 180, 270 or
360
Main Content Region Increments of
Flow 0.01
Content 0, 90, 180, 270 or
360

854 User's Guide

The X position, Y position, Width, and Height fields allow you to either type an
arbitrary size in the field or choose a defined size by selecting from the list of Size
objects configured for your stylesheet. For the latter option, click the Select Size
button next to the field for which you wish to set the measurement and select
the name of the required Size object from the resulting list. Once you have
selected a Size object the measurement it defines will be displayed wrapped in
angle brackets (< > characters) in the relevant field. For example, the Size object
InchSize defines a measurement of 1.00in:

Refer to Defining Page Regions on page 190 for examples and further information
to assist you in configuring the page layout settings for a page set.

Page Regions - Text Category

Use the properties in Text category for a page set to define the text content that
should be output in a page region. Text content can take two forms:
1. Document content - the main body text of the document
2. Generated content - generated text such as a header
• Type - indicates what form text content in the region should take:

○ None: no text content

○ Main content flow: document content
○ Generated: generated content
If you select this option, select the relevant Generated Content object in
the Generated content field.
• Generated content - select the Generated Content object that represents the
generated content definition.
Generated Content objects are configured in the Generated Contents list.
• Go To - opens the selected generated content object in the Generated Contents
list and places cursor focus on the object to allow you to edit it.
• Vertical alignment - select Top, Center, or Bottom to align generated content in
the region.
This field is only available when the Type field is set to Generated.
• Interior padding - shrink the content area of the region by adding a margin
inside any of the region’s sides.

Arbortext Styler Window and Editors 855

 Add an absolute measure in the Top, Bottom, Left, and Right fields as
appropriate.
The Top, Bottom, Left, and Right fields allow you to either type an arbitrary size in
the field or choose a defined size by selecting from the list of Size objects
configured for your stylesheet. For the latter option, click the Select Size button
next to the field for which you wish to set the measurement and select the
name of the required Size object from the resulting list. Once you have selected a
Size object the measurement it defines will be displayed wrapped in angle
brackets (< > characters) in the relevant field. For example, the Size object
InchSize defines a measurement of 1.00in:

Refer to Defining Page Regions on page 190 for examples and further information
to assist you in configuring the page layout settings for a page set.

Page Regions - Graphic Category

Use the properties in the Graphic category to define any graphic that should be
output in a page region. The graphic will be drawn under any text content that also
appears in the region.
• Underlay region text with graphic - check this option to configure graphic
content for the region. If this option is not checked, all other controls in the
category are disabled.
Text content for the region is defined in the Text category for page regions. If
the region generates text content, the graphic configured here underlays the
text.
• Graphic path - identify the graphic to be output in the region:

○ External: enter a path to the required graphic. Enter the path manually or
use the Browse button to open the file picker dialog.
○ Use Xpath: enter an XPath expression that will produce a string
representing a path to the graphic. Select the option then click Edit to
launch the Edit Graphic XPath dialog box on page 949.
This option is only available when the stylesheet is set to generate print/
PDF output with the PTC APP engine.
• Horizontal scaling - define changes to the width of the graphic:

○ None: do not change the size of the graphic (default)

856 User's Guide

 ○ Fit region: increase or decrease the width of the graphic to the width of the
region
○ Percentage: scale the width of the graphic to a percentage of its original
width
○ Absolute: scale the width of the graphic to a specified size
○ Preserve aspect: when a vertical scaling measure has been configured for
the graphic, make the required changes to the horizontal size to maintain
the proportion
For output generated with the FOSI or XSL-FO print engines, graphics can
only be scaled proportionally. If the Horizontal scaling or Vertical scaling fields
are set to Fit Region, Percentage or Absolute, the other one will automatically
change to Preserve Aspect. Setting one to None will set the other to None.
Set your environment to publish with the PTC APP engine if you want to
make non-proportional sizing changes to the graphic.
• Vertical scaling - define changes to the height of the graphic:

○ None: do not change the size of the graphic (default)

○ Fit region: increase or decrease the height of the graphic to the height of
the region
○ Percentage: scale the height of the graphic to a percentage of its original
height
○ Absolute: scale the height of the graphic to a specified size
○ Preserve aspect: when a horizontal scaling measure has been configured
for the graphic, make the required changes to the vertical size to maintain
the proportion
• X offset - specify the distance from the left edge of the region at which the
graphic should be placed.
A positive value will move the graphic to the right of the left edge. A negative
value will move it to the left.
• Y offset - specify the distance from the top edge of the region at which the
graphic should be placed.
A positive value will move the graphic downwards from the top edge. A
negative value will move it up.
The Horizontal scaling, Vertical scaling, X offset, and Y offset fields allow you to
either type an arbitrary size in the field or choose a defined size by selecting from
the list of Size objects configured for your stylesheet. For the latter option, click
the Select Size button next to the field for which you wish to set the
measurement and select the name of the required Size object from the resulting

Arbortext Styler Window and Editors 857

list. Once you have selected a Size object the measurement it defines will be
displayed wrapped in angle brackets (< > characters) in the relevant field. For
example, the Size object InchSize defines a measurement of 1.00in:

Refer to Defining Page Regions on page 190 for examples and further information
to assist you in configuring the page layout settings for a page set.

Supported Graphic Formats

PTC APP supports these graphic types for an underlay in a page region:
• BMP
• EPS
• GIF
• JPG
• PDF
• PNG
• TIFF
FOSI and XSL-FO support the full range of graphic types supported by PTC
Arbortext.
For more information, see Supported Graphic File Formats in Arbortext Editor
help

Page Regions - Borders Category

Use the properties in the Borders category to define any borders that should be
drawn around a page region.
Note that region borders are only supported in output generated by the PTC APP
print engine. You must set your Arbortext Styler environment to use the PTC APP
print engine.
The fields in this category are not available if your stylesheet is set to generate
print/PDF output with the FOSI or XSL-FO engines.
• Borders - check one or more of the Top, Bottom, Left, and Right options to
specify which sides of the region should display borders. If none of these
fields are checked, all other controls in the category will be disabled.
• Thickness - the width of the border
• Offset - the position of the border in relation to the sides of the region

858 User's Guide

 A positive value will move the border inward from the relevant sides of the
region. A negative value will move them outward.
• Color - the color of the border. Select a color from the color palette.
• Style - the type of line drawn for the border
• Rounded corners - check this option to confirm that border corners should be
rounded. Enter a value in the Radius field to define the appearance of the
rounded corner.
This field is only enabled when adjacent sides have borders defined. Corners
can only be rounded when adjacent borders are drawn. For example, if the top
and left borders are drawn, only the corner between them will be rounded. The
upper right corner and the bottom left corner will be drawn straight.
The background color of the region will be contained within the rounded
corner.
• Radius - the degree and direction of the curve of the rounded corner.

Enter a positive value to curve the corner outwards, and a negative value to
curve it inwards. Greater values provide a more gradual curve.
The Thickness, Offset, and Radius fields allow you to either type an arbitrary size
in the field or choose a defined size by selecting from the list of Size objects
configured for your stylesheet. For the latter option, click the Select Size button
next to the field for which you wish to set the measurement and select the
name of the required Size object from the resulting list. Once you have selected a
Size object the measurement it defines will be displayed wrapped in angle
brackets (< > characters) in the relevant field. For example, the Size object
InchSize defines a measurement of 1.00in:

Refer to Defining Page Regions on page 190 for examples and further information
to assist you in configuring the page layout settings for a page set.

Page Regions - Other Category

Use the properties in the Other category for page regions to specify the
background color for a page region. You can also configure preferences for
avoiding other regions or clipping the region at the edge of a page (available for
PTC APP only).

Arbortext Styler Window and Editors 859

• Background color - select a background color from the color palette. The
default value for this field is None.
• Opacity (PDF only) - set the transparency/opacity at which the graphic will be
displayed, as a percentage.

Note
PDF graphics (and EPS and CGM graphics) use the opacity values of the
objects in the PDF graphic. A setting in this field for these graphic types
will be ignored.

• Clip region at page edge - select this option to terminate the region at the page
edge if it is going to overrun. Note that content in the region will also be cut
off at the page edge. It will not wrap.
Do not select this option if you are creating a region that should overflow the
page edge, for example a bleed tab.
This option is not available if your stylesheet is set to generate print/PDF
output with the FOSI or XSL-FO engines.
• Avoid - use the controls in this field to specify that the text content of
preceding regions should flow around this region, if it is laid over preceding
regions. You can increase the area to be avoided by applying Top margin,
Bottom margin, Left margin, and Right margin measures in addition to this
region’s size.
The order in which regions are drawn onto a page is defined in the Page types
category for a page set.
○ Underlaid regions avoid this region: select this option to specify that the
content of underlaid regions should avoid this one
This option is not available if your stylesheet is set to generate print/PDF
output with the FOSI or XSL-FO engines.
The Top margin, Bottom margin, Left margin, and Right margin fields allow you to
either type an arbitrary size in the field or choose a defined size by selecting from
the list of Size objects configured for your stylesheet. For the latter option, click
the Select Size button next to the field for which you wish to set the
measurement and select the name of the required Size object from the resulting
list. Once you have selected a Size object the measurement it defines will be
displayed wrapped in angle brackets (< > characters) in the relevant field. For
example, the Size object InchSize defines a measurement of 1.00in:

860 User's Guide

Refer to Defining Page Regions on page 190 for examples and further information
to assist you in configuring the page layout settings for a page set.

Indexes - General Category

Use the properties in the General category to specify the scope of indexes
generated by an index definition object.
• Scope - specify the scope in which the index should appear, for example the
whole document, or a chapter. Type the name of the scoping element or select
it from the drop down list.
• Use for chunked HTML outputs (EPUB, HTML Help, and Web) - check this
option to confirm that the index should be used in chunked HTML outputs.
You can designate multiple indexes for chunked output. Index terms from all
indexes assigned to chunked output will be merged into one. If no index is
specified for chunked output, then all indexes are used for chunked output. .
Refer to Indexing Overview on page 378 for further information on creating
indexes.

Indexes - Format Category

Use the properties in the Format category to define the appearance of indexes
generated by an index definition object.
• Page or reference number position - Indicates the display style to be used for
the page or reference numbers in the index entries. If you set the value of this
field to Right aligned, the next three options in the Page or Reference
Numbers section are activated.
• Minimum space or leaders between entry and page number - Sets the minimum
length of the entry fill area, i.e. the space between the index entry text and the
page or reference number. See the note at the end of this description for input
options.
• Leader dots - If checked, leader dots fill the space between the index text and
the page or reference number. If deselected, the entry fill area is blank.
• Spacing - Sets the amount of space between individual leader dots. See the
note at the end of this description for input options.
• Display character headings - Check the option to display character headings in
the index. Defines the display of the initial letter headings in the index, e.g.

Arbortext Styler Window and Editors 861

 “A”, providing titles for the groups of index entries where they are sorted by
their initial letter.
• Alignment - Select an option by which to align the heading character in
relation to the index area.
• Bold - Check the box to display the character heading in bold text.
• Italic - Check the box to display the character heading in italic text.
• All caps - Check the box to display the character heading as capital letters,
regardless of whether the first letter of the index entry is capitalized.
• Arbortext Editor preview - Provides a dynamic graphical representation of the
index format settings, as they will appear in Arbortext Editor output.
• Print/PDF Preview - Provides a dynamic graphical representation of the index
format settings, as they will appear in Print/PDF output.
Refer toModifying the Appearance of an Index on page 390 for further
information on index formatting.

Custom Tables - Elements Category

This categories includes the properties needed to define the elements that will
make up your custom table, and the roles they will perform in the table.
• Available elements - Lists the elements available for defining the custom table
and their associated style. The set of elements displayed in this list depends on
the setting of the next two options.
• Show possible table elements: If this option is selected, the list contains any
elements in the stylesheet that are mapped to the Unstyled style and are
permitted to perform the role of Table.
• Show possible title, row, and cell elements: If this option is selected, the list
contains any elements in the stylesheet that are associated with the element(s)
assigned the Table role and that are permitted to perform the role of Title,
Header row, Row, Header cell, or Cell in your table. Note that
Arbortext Styler selects this option automatically when you have selected an
element that can perform the role of Table in your custom table.
• Custom table elements - Lists the elements currently defined for the custom
table.
The list provides the Element name and the current Role in the custom table, if
defined. When you select a role, it becomes a dropdown list that enables you
to assign one of the following roles to a custom table element:
○ Table
○ Title

862 User's Guide

 ○ Header row
○ Row
○ Header Cell
○ Cell
Note that the element assigned the Table role has the Custom Table style
applied automatically in Arbortext Styler. You can apply other styles to the
other table elements. You can also assign the Table role to more than one
element, if required.
• Add - Moves the element selected in the Available elements list to the Custom
table elements list.
• Remove - Moves the element selected in the Custom table elements list to the
Available elements list.
Refer to Creating and Styling a Custom Table on page 405 for examples and
further information to assist you in using setting up and using custom tables.

Custom Tables - Cells Category

This category includes properties with which you can generate cells for the body
of a custom table via XPath, and define your own order for the columns in the
table if necessary. You must specify Table and Row elements for your custom
table in the Elements category before adding generated cells.

Note
Any cell generation or column reordering settings made in this category will
be ignored in print/PDF output via FOSI if the Use style properties for Print/
PDF with FOSI engine option in the Format category on page 866 is checked.

• Generated cells - configure XPath expressions to generate cells for the custom
table, when no cell element exists in the content model of the element being
styled as a custom table. The cells generated will form columns in the body of
the table. Generated cells can appear in the table as well as those elements
given the role of Cell in the Elements category.
The field displays a list of cell elements that will be generated for the table,
and the expressions that will provide their content. Content via XPath can
either be extracted from document content or provided as text. Use the
accompanying buttons to create and manage the list:
○ New: open the Generated Cell dialog box on page 977, in which you can
add a new specification for a generated cell.

Arbortext Styler Window and Editors 863

 ○ Edit: open the Generated Cell dialog box to edit an existing cell generation
specification.
○ Delete: delete a cell generation specification from the list.
When a custom table cell is generated, Arbortext Styler creates an SFE to hold
its formatting properties. The SFE will be named _sfe:GeneratedCell_
generatedcellname_customtablename.
• Cell order - define the order in which columns in the body of the table should
be ordered in output. This may differ from the order in which cells appear in
document content.
The list provides fields in which you can specify the method of defining
column order:
○ Document order: select this option to output columns in the order in which
the cells appear in document content.
○ Specified: select this option to create your own order for columns.
The field displays a list of cells that will form columns in the body of the
table and the order in which they will appear. Use the up and down arrows
to change the order of the columns.

Note
If the table contains any specifically defined cell elements, only those
elements will create cells. A cell element can be defined in two ways:
○ Assigning the role of Cell to an element in the Elements category for
custom tables.
○ Generating a cell via XPath
Cells created by assuming that children of the element defined as a Row
should be classed as cells will be suppressed.

Refer to Creating and Styling a Custom Table on page 405 for examples and
further information to assist you in setting up and using custom tables.

Custom Tables - Header Cells Category

This category includes properties with which you can generate cells for the header
of a custom table via XPath, and define your own order for the header columns if
necessary.

864 User's Guide

 Note
Any cell generation or column reordering settings made in this category will
be ignored in print/PDF output via FOSI if the Use style properties for Print/
PDF with FOSI engine option in the Format category for custom tables on page
866 is checked.

• Generated header cells - configure XPath expressions to generate cells for the
custom table, when no cell element exists in the content model of the element
being styled as a custom table. The cells generated will form columns in the
header of the table. Generated cells can appear in the header as well as those
elements given the role of Cell in the Elements category for custom tables.
The field displays a list of cell elements that will be generated for the header,
and the expressions that will extract them from document content. Use the
accompanying buttons to create and manage the list:
○ New: open the Generated Cell dialog box on page 977, in which you can
add a new specification for a generated cell.
○ Edit: open the Generated Cell dialog box to edit an existing cell generation
specification.
○ Delete: delete a cell generation specification from the list.
When a custom table header cell is generated, Arbortext Styler creates an SFE
to hold its formatting properties. The SFE will be named
_sfe:GeneratedHeaderCell_generatedheadercellname_
customtablename.
If you create a generated header cell, but no element has been assigned the
Header Row role in the Elements category, Arbortext Styler will also generate
a Header Row, and create an SFE to hold its formatting properties. This SFE
will be named _sfe:GeneratedHeaderRow_customtablename.
• Header cell order - define the order in which columns in the header of the table
should be ordered in output. This may differ from the order in which cells
appear in document content.
The list provides fields in which you can specify the method of defining
column order:
○ Document order: select this option to output columns in the order in which
the cells appear in document content.
○ Specified: select this option to create your own order for columns.

Arbortext Styler Window and Editors 865

 The field displays a list of cells that will form columns in the header of the
table and the order in which they will appear. Use the up and down arrows
to change the order of the columns.

Note
If the table contains any specifically defined cell elements, only those
elements will create cells. A cell element can be defined in two ways:
○ Assigning the role of Cell to an element in the Elements category for
custom tables
○ Generating a cell via XPath
Cells created by assuming that children of the element defined as a Row
should be classed as cells will be suppressed.

Refer to Creating and Styling a Custom Table on page 405 for examples and
further information to assist you in setting up and using custom tables.

Custom Tables - Format Category

This category includes properties to define the appearance of a custom table, by
setting column widths and table rules. These will be applied to the table that
results after cell generation and column reordering have taken effect.
• Column widths - Contains the following options that determine the width(s) of
columns in your custom table:
○ Default for columns with unspecified widths - Specifies the default column
width for columns that have not been assigned a specific width since they
do not correspond with any of the other settings made in this category.
The following units of measure are allowed for this option:
◆ in - inches
◆ cm - centimeters
◆ mm - millimeters
◆ pc - picas
◆ pt - points
◆ px - pixels
◆ pi - a measurement for picture or symbol fonts

866 User's Guide

 ◆ * - a modifier for proportional column widths - use this unit to ensure
that unmeasured columns divide remaining column space once defined
column widths have been applied to other columns.
For example, assume the following values are set for proportional
column widths:
1* 1* 2*
In this case, the first and second column would each get 25% of the
available column width, and the third column would get 50% of the
available column width.
◆ % - a modifier to set a percentage of the remaining column width
available
○ Optional defaults for all columns - Specifies the default column widths,
separated by a space, for any number of columns.
For example, assume the following values are entered in this field:
1in 1* 3*
In this case, the first column has a fixed value of one inch. If there are two
columns in the table, the second column gets all of the remaining column
width. If there is a third column, then the second column gets 25% of the
remaining column width, and the third column gets 75% of the remaining
width.
○ Table attribute with widths for all columns - Specifies the attribute on the
element(s) assigned the Table role that contains the default column
widths for the custom table.
If more than one element is assigned the Table role, the attribute list
contains the common attributes for those elements.
• Default rules - Specifies how the table rules are displayed.

The following rules values are available. Note that this table also presents the
value that you must set for the attribute specified in the Rules attribute field to
get the required rule effect.

Rule Descriptions for Tables

Rules value Attribute value Description

All all All outer frame and
inner rules are displayed.
Bottom bottom Only bottom frame rules
are displayed.
Columns cols Only vertical frame and

Arbortext Styler Window and Editors 867

 Rule Descriptions for Tables (continued)
Rules value Attribute value Description
inner rules are displayed.
Frame only frame-only Only outer frame rules
are displayed.
Left left Only left frame rules are
displayed.
None none No rules are displayed.
Right right Only right frame rules
are displayed.
Rows rows Only horizontal frame
and inner rules are
displayed.
Sides sides Only left and right frame
rules are displayed.
Top top Only top frame rules are
displayed.
Top and bottom topbot Only top and bottom
frame rules are
displayed.

Note
If you are specifying the rules attribute in your document, enter those
values listed in this table under the Attribute value column.

• Rules attribute - Specifies the attribute on the element(s) assigned the Table
role that contains the default table rules value for the custom table.
If more than one element is assigned the Table role, the attribute list contains
the common attributes for those elements.
• Use style properties instead of formatting as custom table for Print/PDF -
Determines whether the custom table definition is used for print/PDF output
generated with the FOSI engine.
By default, the elements in the custom table definition are formatted in all
outputs according to the custom table definition. The matching contexts in the
stylesheet have a very limited impact on formatting. Some properties are
recognized, such as font properties, but others are ignored.

868 User's Guide

 If you enable this option, the style properties in the stylesheet for the
individual elements that make up the custom table definition are used in print/
PDF output generated by the FOSI engine. The custom table definition itself is
ignored. For all other outputs (including print/PDF generated by the other
engines), the custom table definition is used.
Refer to Creating and Styling a Custom Table on page 405 for examples and
further information to assist you in setting up and using custom tables.

Custom Tables - Background Color

Category
This include properties to configure background colors for the rows in a custom
table. Use combinations of colors and numbers of rows to define a single
background color or a repeating pattern. In this category these combinations are
referred to as components.

Note
Any background color settings made in this category will be ignored if the Use
style properties instead of formatting as a custom table for Print/PDF option in
the Format category for custom tables on page 866 is checked.

• Header row background color — select the background color for header row(s)
in the custom table.
This control is disabled if you have not defined a header element for your
custom table, either by specifying an element as a header row or by
configuring the generation of header cells.
The default color in this field in None. No color will be applied to the
background so whatever color is behind the cell will be visible.
• Body rows background color repeating pattern — configure the background
color for the body rows in the custom table.
Use the Add Component option to add the required number of colors / number
of rows components in the pattern. You can define a pattern of up to five
alternating colors.
To select a single color to apply throughout the table body, use a single color /
number of rows component.
○ Number of rows — the number of consecutive rows to which the
background color should apply.

Arbortext Styler Window and Editors 869

 If you wish to set a repeating pattern of background colors for the table, set
this field to the number of rows that should display the specified color
before switching to the color defined by the next component in the list.
If you wish to set one background color for the whole table, you should
create a single component with a single row, and specify the desired
background color.
○ Color — the background color to be applied to the number of rows
specified in the adjacent Number of rows field. This may apply once for the
whole table or as part of a repeating pattern.
The default color in this field in None.
○ — remove the selected component from the pattern. If you delete a
component in the middle of a pattern, the following components will be
moved up in the order.
• Add Component — add a new color to the background color pattern.

You may add up to five components.

• Restart pattern after page or column break — check this option to continue the
same pattern in the table after it breaks over a page or column.
This option is only available when the stylesheet is set to generate print/PDF
output with the PTC APP engine. It will be ignored in Editor and HTML
outputs, and print/PDF output published with the FOSI or XSL-FO engines.
Please refer to Publishing Engine Overview for information about publishing
engines in the PTC Arbortext environment.
Refer to Using Background Color in Custom Tables on page 417 for examples and
further information to assist you in using configuring background color for your
custom table.

Menus
This topic describes the Styler menu in Arbortext Editor, and the menus in the
Arbortext Styler interface

Styler Menu in Arbortext Editor

TheStyler menu in Arbortext Editor includes the following fields:

870 User's Guide

Menu option Description Enabled Keyboard
shortcut
New Creates a new stylesheet Always No
Stylesheet (.style), makes it the current
Arbortext Editor stylesheet, and
opens it in Arbortext Styler.
The Stylesheet Properties dialog
box opens when you elect to create
a new stylesheet, allowing you to
set basic publishing and chunking
settings to be applied via your
stylesheet.
See Opening and Creating
Stylesheets on page 30 for further
information.
New Empty Creates a new empty stylesheet Always No
Stylesheet (.style) and opens it in
Arbortext Styler.
The Stylesheet Properties dialog
box opens when you elect to create
a new stylesheet, allowing you to
set basic publishing and chunking
settings to be applied via your
stylesheet.
See Opening and Creating
Stylesheets on page 30 for further
information.
Open Launches the Open Stylesheet Always No
Stylesheet dialog box, which lists stylesheets
in the document and document type
directories that can be edited with
Arbortext Styler. Makes the
selected stylesheet the current
Arbortext Editor stylesheet and
opens it in Arbortext Styler.

Arbortext Styler Window and Editors 871

Menu option Description Enabled Keyboard
shortcut
Edit Stylesheet Opens the stylesheet (.style) Only if current No
currently associated with the stylesheet is a
document for edit in Arbortext .style file.
Styler.
Convert Converts the current FOSI to a Only if current No
Stylesheet stylesheet (.style). The stylesheet is a
conversion handles only a subset of .fos file.
FOSI features; you can use
Arbortext Styler to add features that
were not converted.

File Menu
The File menu in Arbortext Styler includes the following fields:
Menu option Description Enabled Keyboard
shortcut
New Creates a new stylesheet that Always CTRL+N
includes elements from the current
DTD, schema, or free-form
document, makes it the current
Arbortext Editor stylesheet, and
displays it in the current Arbortext
Styler window, replacing the
stylesheet that was previously
being edited in Arbortext Styler.
The Stylesheet Properties dialog
box appears when you select this
option, allowing you to set basic
publishing and chunking settings to
be applied via your stylesheet.
Open Launches the Open Stylesheet Always CTRL+O
dialog box, which lists stylesheets
in the document and document type
directories that can be edited with
Arbortext Styler. Select one of the
stylesheets listed and click OK to
make the selected stylesheet the
current Arbortext Editor stylesheet
and open it in Arbortext Styler, thus
replacing the stylesheet that was
previously being edited in
Arbortext Styler.

872 User's Guide

Menu option Description Enabled Keyboard
shortcut
Close Closes Arbortext Styler. Always No
Save Opens the Save Stylesheet As Always CTRL+S
dialog box the first time you save a
stylesheet. After saving the
stylesheet for the first time,
choosing Save automatically saves
the changes you have made in the
current Arbortext Styler session
since the last save.
Save As Opens the Save Stylesheet As Always No
dialog box, in which you can save
the current stylesheet with a new
name or to a different location.
Update Updates the .genfos file
Generated associated with your stylesheet.
Stylesheet for
For more information, see Saving
Editor
Stylesheets on page 46.
Export Enables you to export a stylesheet Always No
to several different formats:
• PTC APP, FOSI or XSL-FO
Based on the effective print
engine for the current
environment
• XSL-EPUB
• XSL-HTML File
• XSL-HTML Help
• XSL-Web
• XSL-FO RTF
For each option you select you will
be presented with a dialog box
prompting you to enter the filename
and (optionally) the title of the new
format stylesheet before you
complete the export.
Export CSS Generates a CSS file for the Always
selected HTML output. The output
options are:
• XSL-EPUB
• XSL-HTML File

Arbortext Styler Window and Editors 873

Menu option Description Enabled Keyboard
shortcut
• XSL-HTML Help
• XSL-Web
The CSS file will be generated
according to the Create CSS rules
for option set for the output type in
the HTML tab of the Stylesheet
Properties dialog box.
Revert Undoes all changes made since the Always No
last save.
Modules Opens the Modules dialog box, in Always CTRL+M
which you can create a module
hierarchy for your stylesheet by
creating, adding, deleting, and
reordering stylesheet modules.
Move to Opens the Move to Module dialog When one or No
Module box, allowing you to select a more objects
module to which to move the are selected,
selected object(s). none of the
This option is valid for all selections are
definition types and can be invoked in read-only
from within any list view. modules, and
the stylesheet
has one or
more modules.
Copy to Opens the Copy to Module dialog When one or No
Module box, allowing you to select a more objects
module to which to copy the are selected,
selected object(s). none of the
This option is valid for all selections are
definition types and can be invoked in read-only
from within any list view. modules, and
the stylesheet
has one or
more modules.

874 User's Guide

Menu option Description Enabled Keyboard
shortcut
Save as Opens the Save as Merged When any No
Merged Stylesheet dialog box, in which you modules are
Stylesheet can save a stylesheet containing included in the
modules as a single stylesheet with stylesheet.
all referenced modules included in
the file.
Stylesheet Opens the Stylesheet Properties Always No
Properties dialog box, in which you can
change the stylesheet's title,
description, permitted publishing
types, and settings for chunking in
chunked HTML outputs. You can
also specify the default print engine
for your stylesheet and set options
for exporting to RTF format.

Edit Menu
The Edit menu in Arbortext Styler includes the following fields:
Menu option Description Enabled Keyboard
shortcut
Undo Undoes the last action performed in After CTRL+Z
Arbortext Styler. performing an
action that
modifies the
stylesheet.
Redo Redoes the last action that was After an CTRL+Y
undone. action has
been undone.
Cut Deletes the selected element, When a CTRL+X
context, condition, or property set selected object
and stores it in a paste buffer can be
(clipboard). deleted.
Copy Makes a copy of the selected When a CTRL+C
element, context, condition, or selected object
property set and stores it in a paste can be copied.
buffer.
Paste Inserts the contents of the paste When the CTRL+V
buffer at the selected location. contents of the
paste buffer
can be
inserted at the

Arbortext Styler Window and Editors 875

Menu option Description Enabled Keyboard
shortcut
selected
location.
Properties Enables you to perform the When the No
following operations for contexts, selected
conditions or property sets: context,
• Cut - Deletes the properties of condition or
the selected context, condition, property set
or property set and stores it in a has been
paste buffer (clipboard). If the mapped to a
selected object has properties style and
for more than one type of includes
output, the Cut Properties specifically
dialog box opens. defined
• Copy - Copies the properties of properties
the selected context, condition,
or property set and stores it in a
paste buffer.
• Paste - Opens the Paste
Properties dialog box.
• Delete - clears the values of any
properties set for the selected
context, condition, or property
set.
Delete Deletes the selected object. When a DELETE
This option is valid for all selected object
can be
definition types and can be invoked
deleted.
from within any list view.
Rename Enables you to rename the selected When an F2
object. element is
selected.
This option is valid for all
definition types and can be invoked
from within any list view.
Select All Selects all of the objects in the list. Always No
This option is valid for all
definition types and can be invoked
from within any list view.
Find Where Opens the Find Where Used dialog Always CTRL+F
Used box, enabling you to list the uses of
a selected object, and any
references to it, in your stylesheet.

876 User's Guide

Menu option Description Enabled Keyboard
shortcut
This option is valid for all
definition types and can be invoked
from within any list view.
Find Explicit Opens the Find Explicit Properties Always CTRL
Properties dialog box, enabling you to list the +SHIFT+F
occurrences of an explicitly set
property in your stylesheet.
This option is valid for elements
and property sets and can be
invoked from within any list view.
Style Provides a list of available styles When an
that you can apply to the selected element is
element. selected.
Style Helper Opens the Style Helper wizard that When an
walks you through the process of element is
electing a style for an element. selected.
Edit Style Opens a dialog box associated with When an ENTER
Details the selected style, allowing you element
input certain additional details. mapped to a
style is
selected.
Move Up Moves the selected context, When either a
condition or conditions up one in context, a
the list of contexts or conditions for condition or
the element, relative to its siblings, valid set of
increasing its priority in the conditions is
processing order. selected.
The button will not be available if
the first context or condition for the
element is selected.
You are permitted to select and
move multiple conditions provided
they are adjacent to each other and
do not come first in the list of
conditions for the element.
Move Down Moves the selected context, When either a
condition or conditions down one context, a
in the list of contexts or conditions condition or
for the element, relative to its valid set of
siblings, reducing its priority in the conditions is
processing order. selected.

Arbortext Styler Window and Editors 877

Menu option Description Enabled Keyboard
shortcut
The button will not be available if
the last context or condition for the
element is selected.
You are permitted to select and
move multiple conditions provided
they are adjacent to each other and
do not come last in the list of
conditions for the element.
Increase Level Moves the selected condition or When a CTRL+
conditions one to the right in the condition or RIGHT
list of conditions for the element, conditions in a ARROW
thus reducing its/their nesting level list of more
in the parent. than one
conditions is
You are permitted to select and
selected, and
move multiple conditions provided
its potential
they are adjacent to each other.
position is
valid within
its parent.
Decrease Level Moves the selected condition one to When a CTRL+
the left in the list of conditions for condition or LEFT
the element, thus reducing its conditions in a ARROW
nesting level in its parent. list of more
You are permitted to select and than one
move multiple conditions provided conditions is
they are adjacent to each other. selected, and
its potential
position is
valid within
its parent.

878 User's Guide

Menu option Description Enabled Keyboard
shortcut
Edit Object Enables you to specify the type of When a styled No
Source source you want to edit for the element is
object, generates the source, and selected.
then opens the Source Editor.
You may elect to edit source in the
following formats:
• PTC APP, FOSI, or XSL-FO
Based on the effective print
engine for the current
environment
• XSL-EPUB
• XSL-HTML File
• XSL-HTML Help
• XSL-Web
• XSL-FO RTF
Note that the name of the menu
option changes depending on the
type of object that is selected in the
list view. For example, a header
object is selected in the Headers
list, the menu option will be Edit
Header Source.
Please refer to Editing Stylesheet
Source Overview on page 703 for a
table of support for edited source in
the various output formats.
Delete Object Enables you to delete all element Always No
Source Edits source edits you have made, or only
those edits made to a specific
source.
Note that the name of the menu
option changes depending on the
type of object that is selected in the
list view. For example, if a context
is selected in the Elements list, the
menu option will be Delete Context
Source Edits.

Arbortext Styler Window and Editors 879

View Menu
The View menu in Arbortext Styler includes the following fields:

880 User's Guide

Menu item Description Enabled Keyboard
shortcut
List View Allows you to activate one of the Always Individual
list views in Arbortext Styler,
displaying the sets of objects
configured for your stylesheet:
• Elements: show list of
elements, contexts and
conditions. If the display of
Styler Formatting Elements or
User Formatting Elements is
enabled, these elements also
appear in the list.
Equivalent of clicking on the
tab.
• Property Sets: show list of
property sets.
Equivalent of clicking on the
tab.
• Page Sets: show list of page
sets.
Equivalent of clicking on the
tab.
• Page Types: show list of page
types.
Equivalent of clicking on the
tab.
• Page Regions: show list of page
regions.
Equivalent of clicking on the
tab.
• Generated Contents: show list
of generated content objects.
Equivalent of clicking on the
tab.
• Table of Contents: show list of
table of contents format objects.

Arbortext Styler Window and Editors 881

Menu item Description Enabled Keyboard
shortcut
Equivalent of clicking on the
tab.
• Indexes: show list of index
definition objects.
Equivalent of clicking on the
tab.
• Custom Tables: show list of
custom table objects.
Equivalent of clicking on the
tab.
• Cross References: show list of
cross reference objects.
Equivalent of clicking on the
tab.
• Sizes: show list of size
definitions.
Equivalent of clicking on the
tab.
• Combined Fonts: show list of
combined font definitions.
Equivalent of clicking on the
tab.
Collapse All Expand elements in the Elements When the No
list to show contexts and Elements list
conditions. is active.
Expand All Collapse elements in the Elements When the No
list to show only the element Elements list
names. is active.
Toolbars Allows you to set the toolbar Always No
display for the Arbortext Styler
interface. All of the toolbars are
enabled by default, but you can turn
any or all of them off.
Only Elements Displays in the Elements list only Always, but No
in Document the elements that are actually used applies only to
in the document. the Elements

882 User's Guide

Menu item Description Enabled Keyboard
shortcut
This setting is stored in the list.
stylerdocelementsonly
preference for Arbortext Editor.
Deactivate this option to display all
elements configured for the
stylesheet in the list.
Only Elements Displays in the Elements list only Always, but
in Document the elements that belong to the applies only to
Type current document type. the Elements
list.
This setting is stored in the
stylerdoctypeelementson
ly preference for Arbortext Editor.
Deactivate this option to display all
elements configured for the
stylesheet in the list.
Styler Displays all Styler Formatting Always, but No
Formatting Elements (SFE) configured for the applies only to
Elements stylesheet in the Elements list. This the Elements
setting is stored in the list.
stylerlistsfes preference for
Arbortext Editor.
User Displays all User Formatting Always, but No
Formatting Elements (UFE) configured for the applies only to
Elements stylesheet in the Elements list. This the Elements
setting is stored in the list.
stylerlistufes preference for
Arbortext Editor.
Show When this option is selected, Always No
Duplicate Arbortext Styler displays duplicate
Definitions elements definitions that are
contained in both the main
stylesheet and associated modules.
This setting is stored in the
stylershowduplicatedefs
preference for Arbortext Editor.
Back Navigate backwards When a No
navigation
history is
available
Forward Navigate forwards When you No
have
navigated

Arbortext Styler Window and Editors 883

Menu item Description Enabled Keyboard
shortcut
backwards
through a
navigation
history
Source Enables you to select a source you Always No
want to view and displays a read-
only version of the source in a text
editor.
You may elect to view the source in
any of the following formats:
• PTC APP, FOSI, or XSL-FO
Based on the effective print
engine for the current
environment
• XSL-EPUB
• XSL-HTML File
• XSL-HTML Help
• XSL-Web
• XSL-FO RTF

884 User's Guide

Menu item Description Enabled Keyboard
shortcut
Tags in When selected, the tags wrapping Always No
Generated Text generated text are displayed in the
document in Arbortext Editor.
This setting is stored in the
gentexttagdisplay
preference for Arbortext Editor.
Note
If you have set Before-text or
After-text generated text for the
element, the tags shown in
Arbortext Editor view will
reflect exactly any tags shown
in these fields in Arbortext
Styler.
Configure Invokes the Configure Columns Always No
Columns dialog box, from which you can set
the columns that you would like to
see displayed in the Arbortext
Styler interface, and their order.
Note that not all columns are valid
in all list views.

Insert Menu
The Insert menu in Arbortext Styler includes the following fields:
Menu Option Description Enabled Keyboard
shortcut
Element Opens the Elements list if this is Always No
not already active, and adds a new
unstyled element
NamedElement.
Add Elements Enables you to add new elements to Always No
from the stylesheet that are declared in
Document or the DTD or schema and any
Doctype declared, undeclared, or
namespaced elements in the
document.
Context Opens the New Context dialog box, When one F10
in which you can create a new styled element
context for the element selected in is selected in

Arbortext Styler Window and Editors 885

Menu Option Description Enabled Keyboard
shortcut
the Elements list. the Elements
list and the
Elements list
is active
Condition Opens the New Condition dialog When one or F11
box, in which you can create a more contexts
condition for the contexts selected of the same
in the Elements list. styled element
are selected in
the Elements
list and the
Elements list
is active.
Property Set Opens the Property Sets list if this Always No
is not already active, and adds a
new property set New Property
Set.
Page Set Opens the Page Sets list if this is Always No
not already active, and adds a new
page set New Page Set.
Page Type Opens the Page Types list if this is Always No
not already active, and adds a new
page type New Page Type.
Page Region Opens the Page Regions list if this Always No
is not already active, and adds a
new page region object New Page
Region.
Generated Opens the Generated Contents list Always No
Content if this is not already active, and
adds a new generated content
object New Generated
Content.
Table of Opens the Tables of Contents list if Always No
Contents this is not already active, and adds
a new TOC object New Table of
Contents.
Index Opens the Indexes list if this is not Always No
already active, and adds a new
index definition object New
Index.
Custom Table Opens the Custom Tables list if this Always No
is not already active, and adds a

886 User's Guide

Menu Option Description Enabled Keyboard
shortcut
new custom table object New
Custom Table. The custom table
object is crossed through as it is
invalid until you specify a table and
row element.
Cross Opens the Cross References list if Always No
Reference this is not already active, and adds
a new cross reference format object
New Cross Reference.
Size Opens the Sizes list if this is not Always No
already active, and adds a new size
definition New Size.
Combined Opens the Combined Fonts list if Always No
Font this is not already active, and adds
a new combined font definition
New Combined Font.

Tools Menu
The Tools menu in Arbortext Styler includes the following fields:
Menu option Description Enabled Keyboard
shortcut
Format Opens the Footnotes dialog box, in Always No
Footnotes which you can set a default
footnote configuration for your
stylesheet.
Validate Page Opens the Validate Page Sets dialog Always No
Sets box, in which you can identify any
page set errors that would occur if
you published the current document
with your stylesheet, and navigate
to the elements or page sets that
contain errors.
Validate Validates the current stylesheet, Always No
Stylesheet producing a list of errors if any
exist.
List Unused Opens the Unused Definitions Always No
Definitions dialog box, which displays a list of
objects that are available for use
but that have not yet been used or
referenced in the current stylesheet.
List Elements Opens the Elements Not in Always No

Arbortext Styler Window and Editors 887

Menu option Description Enabled Keyboard
shortcut
Not in Document Type window, which
Document displays a list of elements in the
Type stylesheet that are not declared in
the current document type.
List HTML/CSS Displays the HTML/CSS Defects List When No
Defects window. stylesheet is
set to create
The window lists each context or
CSS rules for
condition that has explicit
property sets
properties specified for HTML
output. Styling from these for any HTML
properties will not be reflected in output
HTML or CSS output if the Create
CSS rules for option in the HTML
tab of the Stylesheet Properties
dialog is set to Property Sets.
Note that the window shows
explicit properties specified for all
outputs, including those that are not
configured to use property sets for
CSS rules.
This menu option is not available if
neither of the Create CSS rules for
fields in the HTML tab are set to
Property Sets.
Language Opens the Stylesheet Properties Always CTRL+L
Properties dialog box, with the Language tab
on page 1040 selected.
Export Opens the Export Generated Text When the No
Generated for Translation dialog box, allowing stylesheet
Text... you to export generated text into includes target
XLIFF files for translation. language
definitions
Import Opens the Import Generated Text When the No
Generated Translation dialog box, allowing stylesheet
Text... you to import XLIFF files includes target
containing translations of generated language
text. definitions
View Generates statistics about If the No
Translation translations of generated text. stylesheet
Status Results are displayed in a includes target
translation status report: language
definitions

888 User's Guide

Menu option Description Enabled Keyboard
shortcut
• Language - a list of the target
languages configured for the
stylesheet
• Translated - the number of
translation units in the
stylesheet that have
translations. The column
differentiates between the
translation units whose
translations have been marked
as current in the stylesheet, and
those that have not.
• Not Translated - the number of
translation units in the
stylesheet that do not have
translations.
• Last Import Date - the date the
XLIFF file containing
translations for this stylesheet
was last imported.
• Export Date - the date the
XLIFF file containing
translations for this stylesheet
was exported.
Note that this date is captured
in the exported XLIFF file. If
the exported XLIFF file is not
translated and subsequently
imported, the export date will
not show in this report.
To locate any missing or out of date
translations (translation defects) in
the stylesheet, use the Tools ▶ List
Translation Defects menu option.
List Lists all missing or out of date If the No
Translation translations of generated text. stylesheet
Defects Results are displayed in the includes target
Translation Defects Window. language
definitions

Arbortext Styler Window and Editors 889

Menu option Description Enabled Keyboard
shortcut
Advanced Allows you to manage edits to the Wherever No
Edited Source base sources in the stylesheet: each action is
• Edit PTC APP Root Template permitted
Source: Toggles the availability
of tags from the PTC APP root
template for edit.
PTC APP root template tags
display in the Functions list,
grouped in namespaces.
For more information, see
Editing PTC APP Root
Template Source
on page 712.
• Edit FOSI Resource Description:
Opens a Source Editor window
in which you can edit the FOSI
resource description.
• Delete FOSI Resource
Description Edits: Deletes any
FOSI resource description edits
you may have made. This menu
option is only enabled if you
have edited the FOSI resource
description.
• Edit Common XSL Source:
Invokes a Source Editor
window in which you can make
a source edit that will apply to
all XSL outputs
• Delete Common XSL Source:
Remove all source edits that are
common to all XSL outputs.
• Edit XSL Root Template:
Enables you to specify the type
of XSL source you want to edit,
generates the source for the root
template, then opens the Source
Editor.
• Delete XSL Root Template Edits:
Enables you to delete either all
XSL root template source edits

890 User's Guide

Menu option Description Enabled Keyboard
shortcut
you have made, or only those
edits made to a specific source.
This menu option is only
enabled if you have edited the
XSL root template for the
specified source.
• Delete All Source Edits: Enables
you to delete either all of the
source edits made to all
sources, or all edits that have
been made to individual
sources.
Namespace Invokes the Namespaces Always No
Declarations Declarations dialog box, which
displays a read-only list of
namespace associations currently
declared for the stylesheet.

Preview Menu
The Preview menu in Arbortext Styler includes the following fields:
Menu option Description Enabled Keyboard
shortcut
Arbortext Updates the display of the Always CTRL+E
Editor document in Arbortext Editor using
the current stylesheet settings.
Print Displays the document in the Print Always CTRL+P
Preview window using the current
stylesheet settings.
PDF Generates a PDF file using the Always. You ALT+P,D
current stylesheet settings, and then must have
displays it in Acrobat Reader. Acrobat
Reader
installed to
view the
resulting PDF
file.
EPUB Generates an EPUB file (.epub) Always. You ALT+P,E
using the current stylesheet must have
settings, and then displays it in Calibre
Calibre E-book Viewer. installed to
view the

Arbortext Styler Window and Editors 891

Menu option Description Enabled Keyboard
shortcut
resulting
EPUB file.
HTML File Generates an HTML file using the Always. You CTRL+H
current stylesheet settings, and then must have a
displays it in a browser. browser
installed to
view the
resulting
HTML file.
HTML Help Generates an HTML Help file Always. You ALT+P,H
(.chm) using the current stylesheet must have
settings, and displays it in Microsoft
Microsoft's HTML Help viewer. HTML Help
Workshop
installed.
Web Generates an Arbortext Editor web Always. You ALT+P,W
document using the current must have a
stylesheet settings, and displays it browser
in a browser. installed to
view the
resulting web
document.
RTF Generates an RTF version of the Always. A ALT+P,R
document using the current Windows
stylesheet settings, and displays it application
in the application associated with must be
the .rtf extension. associated
with the .rtf
file extension.

Options Menu
The Options menu in Arbortext Styler includes the following fields:

892 User's Guide

Menu option Description Enabled Keyboard
shortcut
Resolve Resolves any conditions (displays Always No
Conditions the conditions settings on the
properties tabs) applied to a context
when the context is selected within
a document. This setting is stored
in the
stylerresolveconditions
preference for Arbortext Editor.
Show Contexts When selected, context names in Always No
as XSL the Elements list are displayed in
XSL syntax, for example book/
chapter[1]. When this option is
deselected, context names are
displayed as verbose, user-friendly
descriptions, for example first
chapter in book. This setting is
stored in the
stylercontextformatxsl
preference for Arbortext Editor.
Highlight When this option is selected, Always No
Unstyled unstyled elements are highlighted
Elements in the Arbortext Editor view, as
well as in all Arbortext Styler
previews, by displaying them in
pink tags. This option also
generates new lines before and after
these elements in Arbortext Styler
previews. This setting is stored in
the stylershowunstyled
preference for Arbortext Editor.

Arbortext Styler Window and Editors 893

Menu option Description Enabled Keyboard
shortcut
Confirm When this option is selected, Always No
Deletions Arbortext Styler prompts you to
confirm when you elect to delete an
object. This setting is stored in the
stylerconfirmdeletes
preference for Arbortext Editor.
Note that the prompt does not
appear when you are electing to
delete a context or condition.
Synchronize When this option is selected, Always No
Elements with placing the cursor inside an element
Editor in Arbortext Editor causes that
element to be selected in the
Elements list in Arbortext Styler.

Help Menu
The Help menu in Arbortext Styler includes the following fields:
Menu option Description Enabled Keyboard
shortcut
Arbortext Opens the Arbortext Styler Help Always No
Styler Center in a separate window.
About Displays Arbortext Styler version Always No
Arbortext and copyright information.
Styler

Toolbars
Use the Arbortext Styler toolbars to quickly access Arbortext Styler functionality.
You can move all of the toolbars, by clicking on the dotted line to the left of the
toolbar and dragging it to the required location. In this way you can dock a toolbar
at a different place on the interface or place it completely independently from the
interface. You can select which toolbars to display in the interface through the
View ▶ Toolbars menu choice. Arbortext Styler has the following toolbars:

• Standard
• Elements
• Modules
The following table describes the buttons on the Standard toolbar.

894 User's Guide

Standard Toolbar

Button Description
Inserts an object of the relevant type into the active list view.
Note that the icon for the button changes depending on the list
view that is currently active - the icon shown here is displayed
when the Elements list is active, for example, and clicking it will
insert a new unnamed element into the Elements list.
Click on the arrow to the right of the icon to select a different
object to insert: when you have selected an object type the
relevant list view will open and a new unnamed object will be
placed in that list.
Saves the current stylesheet. If the stylesheet has not previously
been saved, this button opens the Save Stylesheet As... dialog
box.
Undo the previous editing operation
Redo reverses the change made by the last undo.
Cuts the selected object from the list and stores it in a paste
buffer (clipboard).
Makes a copy of the selected object and stores it in a paste
buffer.
Inserts the contents of the paste buffer at the selected location.
Returns cursor focus back to the object previously selected.
Returns cursor focus to the object selected before the Back
action. This button is only active if a previous Back action has
been carried out.
Displays the document in Arbortext Editor using the current
stylesheet settings.
Displays the document in the Print Preview window using the
current stylesheet settings.
Displays the document as a PDF file in Acrobat Reader using
the current stylesheet settings.
Displays the document as an EPUB (.epub) file in the Calibre
E-book Viewer, using the current stylesheet settings. You must
have Calibre installed to perform this action.
Displays the document as an HTML file in a browser using the
current stylesheet settings.
Displays the document as HTML Help using the current
stylesheet settings.

Arbortext Styler Window and Editors 895

Standard Toolbar (continued)
Button Description
Displays the document in a browser as a Web document using
the current stylesheet settings.
Displays the document in Microsoft Word in RTF format using
the current stylesheet settings.

The following table describes the buttons on the Elements toolbar. Note that, even
if the toolbar is selected via the View ▶ Toolbars menu option, the buttons on the
Elements toolbar will only be accessible when the Elements list is active.

Elements Toolbar

Button Description
Opens the New Context dialog box, in which you can create a
new context for the current element.
Opens the New Condition dialog box, in which you can create a
new condition for the selected context(s).
Moves the selected context or condition up one in the list of
contexts or conditions for the element, relative to its siblings,
increasing its priority in the processing order.
Moves the selected context or condition down one in the list of
contexts or conditions for the element, relative to its siblings,
reducing its priority in the processing order.
Moves the selected condition one to the right in the list of
conditions for the element, thus increasing its nesting level in its
parent.
Moves the selected condition one to the left in the list of
conditions for the element, thus reducing its nesting level in its
parent.
Provides a list of styles you can apply to the currently selected
element.
Opens a dialog box where you can provide additional details
about the style of the selected element. This toolbar button is
only available when the assigned style for the element requires
additional details, for example Division or Index Term.
Opens the Style Helper wizard that walks you through the
process of electing a style for the selected element

The following table describes the buttons on the Modules toolbar.

896 User's Guide

Modules Toolbar

Button Description
Opens the Modules dialog box, in which you can create a
module hierarchy for your stylesheet by creating, adding,
deleting, and reordering stylesheet modules.
Opens the Move to Module dialog box, allowing you to select a
module to which to move the selected object(s).
This option is valid for all definition types and can be invoked
from within any list view.
Opens the Copy to Module dialog box, allowing you to select a
module to which to copy the selected object(s).
This option is valid for all definition types and can be invoked
from within any list view.
Opens the Save as Merged Stylesheet dialog box, in which you
can save a stylesheet containing modules as a single stylesheet
with all referenced modules included in the file.

PTC APP Source Editor

The PTC APP Source Editor enables you to make changes to the JavaScript-based
PTC APP source for a stylesheet object. It is accessed from Arbortext Styler via
the following option:
• Edit ▶ Edit Object Source ▶ APP (name of menu option depends on which list
view is currently active)
The PTC APP Source Editor contains the following menu options:

File Menu in PTC APP Source Editor

Menu option Description

Apply Apply any changes made in the PTC APP Source Editor
window to the stylesheet.
Apply and Close Apply any changes made in the PTC APP Source Editor to
the stylesheet and close the window.
Close Close the PTC APP Source Editor window. Any changes
that have not been saved will be lost.

Arbortext Styler Window and Editors 897

Edit Menu in PTC APP Source Editor

Menu option Description

Undo Undo the last action, if possible.
Redo Redo the last action that was undone, if possible.
Cut Cut the selection and places it on the clipboard.
Copy Copy the selection to the clipboard.
Paste Paste the contents of the clipboard to the cursor location.
Delete Delete the selection.
Find Invoke the Find/Replace dialog box.

Help Menu in PTC APP Source Editor

Menu option Description

Edited Source Help Open the help topic associated with the PTC APP Source
Editor.
FOM Reference Open the Formatting Object Model Reference.
Manual

Display Features
The PTC APP Source Editor facilitates viewing/editing of PTC APP source by
providing advanced display features:
• Syntax highlighting — tokens are displayed in different colors:
○ Comments — green
○ JavaScript keywords — blue
○ Literal values (quoted strings and numbers) — dark red
• Line numbering — automatic non-editable line numbers starting at 1, with line
wrap off
• Auto-indent — when you press ENTER, the cursor is placed on the next line
in the most likely column:
○ After a { — the next line is indented two characters more than the
previous line
○ After a } — the next line is indented two characters less than the previous
line
○ General — the same indent as the previous line
• Auto-completion

898 User's Guide

 ○ When entering the member operator . — if the type to the left of the
member operator can be determined, a list of possible members is
presented
○ When entering ( — if the identifier to the left is a function that can be
determined, a description of the available parameters is presented
• JavaScript syntax validation — performed when you elect to close the PTC
APP Source Editor

Any syntax errors discovered are listed.

Source Editor
The Source Editor enables you to make changes to the source code. It is accessed
from within Arbortext Styler via the following options:
• Edit ▶ Edit Object Source (name of menu option depends on which list view is
currently active)
• Tools ▶ Advanced Edited Source ▶ Edit FOSI Resource Description
• Tools ▶ Advanced Edited Source ▶ Edit Common XSL Source
• Tools ▶ Advanced Edited Source ▶ Edit XSL Root Template
The Source Editor contains the following menu options:

File Menu in Source Editor

Menu option Description

Apply and Close Apply any changes made in the Source Editor to the
stylesheet and close the window.
Apply Apply any changes made in the Source Editor window to
the stylesheet.
Close Close the Source Editor window. Any changes that have
not been saved will be lost.

Edit Menu in Source Editor

Menu option Description

Undo Undoes the last action, if possible.
Repeat Repeats the last action, if possible. The option changes to
Can't Repeat if a repeat is not possible.
Cut Cuts the selection and places it on the clipboard.
Copy Copies the selection to the clipboard.
Paste Pastes the contents of the clipboard to the cursor location.

Arbortext Styler Window and Editors 899

Edit Menu in Source Editor (continued)
Menu option Description
Delete Deletes the selection.
Delete Markup Delete the currently selected markup.
Change Markup Opens the Change Markup dialog box.
Modify Attributes Opens the Modify Attributes dialog box.
Delete All Attributes Deletes all attributes of the currently selected element.
Select Element Select the content of the element at the cursor position.
Content
Select Element Select the element at the cursor position.
Split Split the selected markup.
Join Join the selected markup.
Edit Selection as Opens the XML Source Editor.
XML source

Find Menu in Source Editor

Menu option Description

Find/Replace Opens the Find/Replace dialog box, allowing you to search
for elements and element content.
Go To Opens the Go To dialog box, allowing you to select and
jump to an identified location in your source.
Find Next Repeats the last Find operation specified from the current
cursor location.
Find Selection Searches forward from the current cursor location to the
next match using the highlighted section in your document
as the search string.
Replace Replaces matched Find What text with the Replace With
text from the Find/Replace dialog box or from the previous
substitute command. It then locates the next occurrence of
the text string to replace. Replace is disabled if no text is
selected or if the selection contains markup from a
different find operation.
Replace All Replaces all occurrences of the Find What text with the
Replace With text from the Find/Replace dialog box or
from the previous substitute command. Replace All is
disabled if no text is selected or if the selection contains
markup from a different find operation.
Find Element Start Moves the cursor to the start tag of the element tag pair
containing the cursor.

900 User's Guide

Find Menu in Source Editor (continued)
Menu option Description
Find Element End Moves the cursor to the end tag of the element tag pair
containing the cursor.
Find Tag/Attribute Opens the Find Tag/Attribute dialog box, allowing you to
search for a particular element, attribute or attribute value.

View Menu in Source Editor

Menu option Description

Collapse Element If your cursor is placed next to an element tag, this option
Content collapses the element content. It also collapses the content
of expanded entity tags, and SGML comments. Choosing
this menu command again collapses the next element up in
the hierarchy.
Document Map This submenu contains the following options:
• Document Map - toggles the display of the source in
Document Map format.
• Synchronize Views - manually synchronizes the cursor
position in both panes of the Source Editor window,
when the window is split. Selecting this option places
the cursor in the same place in both panes.
• Auto Synchronize - manually synchronizes the cursor
position in both panes of the Source Editor window,
when the window is split. Selecting this option keeps
the cursor in the same place in both panes at all times.
• No Text in Map - Suppresses the display of text in the
Document Map.
• Line Text in Map - Displays any text in the Document
Map in a single line that does not wrap.
• Wrap Text in Map - Displays any text in the Document
Map in lines that wrap when the end of a line is
reached.
• Full End Tags - Displays tag names and icons.
• Partial End Tags - Displays tag icons.
• No End Tags - Suppresses the display of tags.
• Expand Attributes - Displays all attributes associated
with each element in the Document Map window.
Font Size This submenu contains the following options:

Arbortext Styler Window and Editors 901

View Menu in Source Editor (continued)
Menu option Description
• Increase - Increases the size of the font in the pane
with the focus. Font size in percent is shown in the
status bar. The limit is 500% of the default size.
• Decrease - Decreases the size of the font in the pane
with the focus. Font size in percent is shown in the
status bar. The limit is 40% of the default size.
Full Tags Displays all tags and tag names.
Partial Tags Displays the tags as icons.
No Tags Suppresses the display of tags.

Insert Menu in Source Editor

Menu option Description

Markup Opens the Insert Markup dialog box.
Symbol Adds a symbol to your document.
Comment Adds a comment tag pair at the cursor location. Only text
can be inserted inside the comment tags; no markup is
allowed. Text inside the comment tags is visible only in
the Edit pane, not in the Print Preview window or in print
output.
File Opens the Insert File dialog box. Use this dialog box to
select a file to copy into the current document at the cursor
location.
Bookmark Opens the Bookmarks dialog box.
Quickmark Inserts a Quickmark at the cursor location.

Tools Menu in Source Editor

Menu option Description

Macro The submenu contains the following options:
• Macros - Play and edit an existing macro.
• Record New Macro - Record the steps you perform and
save them as a macro for later use.
• Cancel Recording - Cancel the recording of a macro.
Context Rules Ensures markup is valid by making sure it is inserted in
the proper context in the document. Context rules are
turned on if a check mark appears next to Context Rules.

902 User's Guide

Window Menu in Source Editor

Menu option Description

No Split Turns a split window into a single-pane window.
Left-Right Split Splits a single-pane window or top-bottom split window
into two side-by-side panes.
Top-Bottom Split Splits a single-pane window or side-by-side split window
into panes, one above and one below.

Help Menu in Source Editor

Menu option Description

Edited Source Help Open the help topic associated with the Source Editor.

Generated Text Editor

The Generated Text Editor is invoked when electing to manage generated text in
the following locations within Arbortext Styler:
• The Edit buttons from the Generated text category for the Elements list.
• The Edit buttons in the Repeat title or continuation text (Print/PDF only) field
from the Generated text category for the Elements list.
• The Edit button from the Page numbers category for the Page Sets list.
• The Edit button in the properties area of the Generated Contents list.
• The Edit button in the properties area of the Cross References lists.
• The Edit buttons in the Custom Content dialog box, accessed via the
Customize Table of Contents dialog box.
• The Edit button for the RTF field field from the RTF category for the Elements
and Property Sets lists.

Generated Text Editor Menus

This section describes the menus in the Generated Text Editor window.

Note
If your schema or DTD contains a table model, then the Generated Text Editor
window for a header or footer in a page set opens with a table template
containing a single row and three columns.

Arbortext Styler Window and Editors 903

 Note
Numbers and bullets for titles and list items in the Generated text category are
automatically entered into the Before-text generated text field. When you edit
this field, you cannot insert content before the bullet or number.

File Menu in Generated Text Editor

Menu option Description

Apply and Close Apply the settings in the Generated Text Editor window to
the stylesheet and close the window. Apply does not save
the stylesheet. Use preview to see the generated text
results.
Apply Apply the settings in the Generated Text Editor window to
the stylesheet. Apply does not save the stylesheet. Use
preview to see the generated text results.
Close Close the Generated Text Editor window. Any changes that
have not been saved will be lost.

Edit Menu in Generated Text Editor

Menu option Description

Undo Reverses the last change.
Redo or Repeat Reverses undo or repeats the last change.
Cut Deletes the selected region and stores it in a paste buffer
(clipboard).
Copy Makes a copy of the selection and stores it in a paste
buffer.
Paste Inserts the contents of the paste buffer at the cursor
location.
Delete Removes the selection.
Delete Markup Removes the selected markup.
Change Markup Opens the Change Markup dialog box.
Modify Attributes Opens the Modify Attributes dialog box.
Delete all attributes Removes all attributes associated with the selected
markup.
Modify processing Opens the dialog box that was used to insert the original
instruction processing instruction.

904 User's Guide

 Note
Menu options in the Insert menu are enabled in the Generated Text Editor
when applicable, depending on the document object for which generated text
is being set. The full list is given here but all options may not be available
every time the Generated Text Editor is invoked.

Insert Menu in Generated Text Editor

Menu Option Description

Markup Opens the Insert Markup dialog box. This option is not
supported for Word fields.
Table Opens the Insert Table dialog box. This option is not
supported for Word fields.
Graphic Allows you to browse for a graphic to insert into your
document. This option is not supported for Word fields.
Symbol Allows you to select a symbol to insert into your
document.
Page Number For headers and footers, adds the current page number
when you publish to print or PDF. This option is not
available for Word fields.
Final Page Number For generated content objects, opens the Final Page
Number dialog box, in which you can select the scope of
the final page number to be inserted in the generated text,
for example in the format Page x of y pages. This option is
not available for Word fields.
Note that page numbering is only generated in print/PDF
output.
Element Number For numbered elements, inserts the number as configured
in the numbering details dialog box (where applicable).
Element Label And For numbered elements, inserts the number and label as
Number configured in the numbering details dialog box.
Division Reference Opens the Insert Division Reference dialog box, to allow
you to add a reference to a division, for example, “Chapter
1 - Introduction.”
This option is not available for Word fields.
Element Content Opens the Insert Element Content dialog box.
Attribute Content Opens either the Insert Attribute Content dialog box or the
Insert Attribute Content (Headers and Footers) dialog box,

Arbortext Styler Window and Editors 905

Insert Menu in Generated Text Editor (continued)
Menu Option Description
depending on the location from which the Generated Text
Editor is invoked.
XPath String Opens the Insert XPath String dialog box.
Leaders, Rule, or Opens the Insert Leaders, Rule, or Space dialog box. This
Space option is not available for Word fields.
Cross Reference Opens the Insert Cross Reference dialog box. This option
is not available for Word fields.
Table of Contents Opens the Insert Table of Contents dialog box. This option
is not available for Word fields.
Index Opens the Insert Index dialog box. This option is not
available for Word fields.
Begin Change Bar Enables you to indicate the beginning of a change bar.
This option is not available for Word fields.
End Change Bar Enables you to indicate the end of a change bar. This
option is not available for Word fields.

906 User's Guide

Insert Menu in Generated Text Editor (continued)
Menu Option Description
User Formatting Enables you to insert an existing User Formatting
Element Element, or create a new one.
Advanced Allows you to insert advanced information that supports
content creation, linking, chunking, and publishing into
your generated text:
• Metadata: include a metadata item with the document
in HTML or PDF output.
• Internal Link: insert the _sfe:InternalLink
element, which will support the dynamic generation of
an internal link between documents. The content of the
link is based on further information you supply in the
generated text.
• External Link: insert the _sfe:ExternalLink
element, which will support the dynamic generation of
an external link between documents. The content of
the link is based on further information you supply in
the generated text.
• Attribute Modifier: allows you to insert the name of the
attribute from the source document whose value
should be used as the value of a particular attribute for
the element you are creating in the gentext. Using this
method you can dynamically generate objects such as
graphics whose properties are extracted from the
attributes of another object.

Table Menu in Generated Text Editor (not Available for Word Fields)

Main menu Submenu option Description

Insert Use Table ▶ Insert to insert table
rows, columns, and grids.
Row Above Inserts a new row above the cell
containing the cursor. The attributes
for the new row are copied from the
row containing the cursor. If you
have more than one row selected,
that number of rows will be inserted.
The attributes for the new rows are
copied from the top row of the

Arbortext Styler Window and Editors 907

Table Menu in Generated Text Editor (not Available for Word Fields)
(continued)
Main menu Submenu option Description
current selection.
Row Below Inserts a new row below the cell
containing the cursor. The attributes
for the new row are copied from the
row containing the cursor. If you
have more than one row selected,
that number of rows will be inserted.
The attributes for the new rows are
copied from the bottom row of the
current selection.
Column Left Inserts a new column to the left of
the cell containing the cursor. The
attributes for the new column are
copied from the column containing
the cursor. If you have more than
one column selected, that number of
columns will be inserted. The
attributes for the new columns are
copied from the left-most column of
the current selection.
Column Right Inserts a new column to the right of
the cell containing the cursor. The
attributes for the new column are
copied from the column containing
the cursor. If you have more than
one column selected, that number of
columns will be inserted. The
attributes for the new columns are
copied from the right-most column
of the current selection.
Rows and Columns Displays the Insert Rows and
Columns dialog box.
Grid Above For OASIS Exchange tables, inserts
a new grid of cells above the grid
containing the cursor. The new grid
will have the same attributes (for
example, width, number of columns,
column dimensions, etc.) as the grid
containing the cursor, and will

908 User's Guide

Table Menu in Generated Text Editor (not Available for Word Fields)
(continued)
Main menu Submenu option Description
contain two rows.
To display this command, Full
Menus must be turned on. Go to
Tools ▶ Preferences in Arbortext
Editor, and choose the Window
category. Activate the Full Menus
option.
Grid Below For OASIS Exchange tables, inserts
a new grid of cells below the grid
containing the cursor. The new grid
will have the same attributes (for
example, width, number of columns,
column dimensions, etc.) as the grid
containing the cursor, and will
contain two rows.
To display this command, Full
Menus must be turned on. Go to
Tools ▶ Preferences in Arbortext
Editor, and choose the Window
category. Activate the Full Menus
option.
Delete Use Table ▶ Delete to delete table
rows, columns, and grids.
Row Removes the entire row of cells
containing the cursor.
Column Removes the entire column of cells
containing the cursor.
Cells Invokes the Delete Cells dialog box,
allowing you to select the treatment
of cells to be removed from the
table.
Grid For OASIS Exchange tables,
removes the entire grid of cells
containing the cursor.

Arbortext Styler Window and Editors 909

Table Menu in Generated Text Editor (not Available for Word Fields)
(continued)
Main menu Submenu option Description
To display this command, Full
Menus must be turned on. Go to
Tools ▶ Preferences, and choose the
Window category. Turn on Full
Menus.
Table Deletes the entire table in which the
cursor is currently placed.
Select Use Table ▶ Select to select rows,
columns, and grids. This submenu
provides the following commands:
Cell Selects and highlights the cell
containing the cursor.
Row Selects and highlights all of the cells
in the row containing the cursor.
Column Selects and highlights all of the cells
in the column containing the cursor.
Grid For OASIS Exchange tables, selects
and highlights all of the cells in the
grid containing the cursor.
To display this command, Full
Menus must be turned on. Go to
Tools ▶ Preferences, and choose the
Window category. Turn on Full
Menus.
Table Selects and highlights all of the cells
in all the grids in the table.
Deselect All Cancels all the highlighted
selections in cells.
Span Cells Combines two or more cells. The
contents of the cells is preserved and
distributed across the newly spanned
cell. You may span cells
horizontally, vertically, or a
combination of both.
Unspan Cells Splits cells which have been
spanned. Any content is placed in
the upper left-most cell.

910 User's Guide

Table Menu in Generated Text Editor (not Available for Word Fields)
(continued)
Main menu Submenu option Description
Convert to Header Converts the currently selected row
Row (s) to header row(s). For tables that
span page boundaries, header rows
print at the top of each page.
Arbortext Editor automatically
converts the text in the new header
row(s) to bold.
Convert to Footer Converts the currently selected row
Row (s) to footer row(s). For tables that
span page boundaries, footer rows
print at the bottom of each page.
According to the OASIS Exchange
table specification, footer rows must
occur just after the header rows (if
any) at the top of the table. If the
selected row(s) are not in this
position, they will be moved there
and placed under any existing footer
rows.
Convert to Body Converts the currently selected
Row header or footer row(s) to body row
(s). The selected row(s) are
automatically moved to the top of
the body rows, just below any
remaining header and footer rows.
Split Grid For OASIS Exchange tables, splits
the current grid into two separate
grids. The row containing the cursor
becomes the first row in the second
grid.
To display this command, Full
Menus must be turned on. Go to
Tools ▶ Preferences, and choose the
Window category. Turn on Full
Menus.
Distribute Columns Resizes the columns of the selected
Evenly table so they are all the same width.
Table Properties Opens the Table Properties dialog
box.

Arbortext Styler Window and Editors 911

Tools Menu in Generated Text Editor

Menu option Description

Spelling Invokes a spell check for the text content of the table.
Thesaurus Looks up a selected word in the built in thesaurus.
Word Count Provides the total number of words in the table.
Show spaces Displays dots to indicated spaces.
Show Command Line Shows or hides the Command line.

Translation Menu in Generated Text Editor

Menu option Description

Translate Mark the current piece of generated text for translation.
Do Not Translate Deactivate translation for the current piece of generated
text, if it is currently set as needing translation.
Based on Text Allow Arbortext Styler to assess whether the unit should
Content be translated, based on its text content.
The menu label is suffixed with Arbortext Styler’s current
assessment, given the current content of the unit. For
example, the label will read Based on Text Content (Do not
Translate) if the translation unit is empty.
All translation units have the value Based on Text Content
initially — this is the default value.
Add Note Launch the Translation Note dialog box on page 1055, in
which you can enter a note to be included with a
translation unit in the XLIFF file for the translator.
This menu option is disabled if translation is not activated
for the translation unit.
This menu option will be named Edit Note if a translation
note already exists for this translation unit
Delete Note Delete the existing translation note.
Languages Lists the source language and the target languages
specified in the stylesheet.
Select a language from the list to view the translation of
the generated text. You can also modify the translation.
The changes get saved in the stylesheet.
This menu option is disabled if translation is not turned on
for the generated text.

912 User's Guide

Format Menu in Generated Text Editor (not Available for Word Fields)

Menu option Description

Font Opens the Modify Font dialog box.
Hard (unbreakable) Inserts an unbreakable space.
space
Interword (breakable) Inserts a breakable space.
space
End-of-sentence Inserts a space at the end of sentence.
space
The space inserted by this field will differ, depending on
the way in which the document is published:
• Arbortext Styler and FOSI: 0.42em
• PTC APP: 0.25em, i.e. PTC APP’s normal word space
width
New line Inserts a hard return (new line).
Note
Inserting a new line is useful for generating a line
break within a block of text. However, you should not
use this option to insert multiple new lines to create
space between separate blocks of text. Instead, wrap
the blocks of text in a User Formatting Element and
set the User Formatting Element's space before or
space after properties with the Spacing category.
Print/PDF • Specified horizontal space - Invokes the Specified
horizontal space dialog box to allow you to insert a
space with a width of your choice.
• No line break region - Inserts a tag pair that defines a
region protected from line breaks.
• Discretionary hyphen - Inserts a discretionary hyphen,
which identifies a position at which a word can break
if hyphenation is needed.
These options are not supported for Word fields.

Arbortext Styler Window and Editors 913

 Note
Options on the Format menu are implemented using proprietary processing
instructions that are not supported by other publishing systems. If you want to
use your stylesheet with publishing systems other than Arbortext Editor , you
should add User Formatting Elements instead of using the options on this
menu. See Adding User Formatting Elements to Generated Text on page 517
for more information.

914 User's Guide

 32
Arbortext Styler Dialog Boxes
Dialog Boxes........................................................................................................... 918
Add/Edit JavaScript Library Dialog Box ..................................................................... 918
Add Module Dialog Box............................................................................................ 918
Add Namespace Declaration Dialog Box ................................................................... 919
Add New Elements Dialog Box ................................................................................. 920
Add Target Language Dialog Box ............................................................................. 921
Attribute Modifier Dialog Box .................................................................................... 921
Attribute Test Dialog Box.......................................................................................... 921
Bullet Dialog Box ..................................................................................................... 923
Condition Dialog Box ............................................................................................... 925
Configure Columns Dialog Box................................................................................. 926
Content Test Dialog Box........................................................................................... 927
Context Dialog Box.................................................................................................. 929
Convert Stylesheet Dialog Box ................................................................................. 934
Copy To Module Dialog Box ..................................................................................... 935
Cross Reference Details Dialog Box ......................................................................... 935
Custom Content Dialog Box ..................................................................................... 936
Customize Table of Contents Dialog Box ................................................................... 937
Cut Properties Dialog Box ........................................................................................ 939
Definition List Details Dialog Box .............................................................................. 939
Delete Properties Dialog Box.................................................................................... 941
Division Details Dialog Box....................................................................................... 941
Division Reference Dialog Box ................................................................................. 942
Division Title Number Dialog Box.............................................................................. 942
Document Language Mapping Dialog Box................................................................. 948
Duplicate Translation Unit IDs in Module ................................................................... 949
Edit Graphic XPath Dialog Box ................................................................................. 949
Edit Module Dialog Box............................................................................................ 950
Edit Uses List Dialog Box ......................................................................................... 950
Edit XPath Override for Current Level Dialog Box ...................................................... 951
Elements Not in Document Type Window .................................................................. 952

915
Export PTC APP Template Dialog Box ...................................................................... 953
Export CSS dialog box............................................................................................. 954
Export FOSI Stylesheet Dialog Box........................................................................... 954
Export Generated Text for Translation Dialog Box ...................................................... 955
Export XSL-EPUB Stylesheet Dialog Box .................................................................. 956
Export XSL-FO Stylesheet Dialog Box ...................................................................... 957
Export XSL-FO RTF Stylesheet Dialog Box ............................................................... 958
Export XSL-HTML File Stylesheet Dialog Box............................................................ 958
Export XSL-HTML Help Stylesheet Dialog Box .......................................................... 959
Export XSL-Web Stylesheet Dialog Box .................................................................... 960
Field Dialog Box ...................................................................................................... 960
Final Page Number Dialog Box................................................................................. 961
Find Explicit Properties Dialog Box ........................................................................... 962
Find Explicit Properties Results Window.................................................................... 963
Find Where Used Dialog Box ................................................................................... 964
Find Where Used Results Window............................................................................ 965
Footnote Number Dialog Box ................................................................................... 966
Footnotes Dialog Box .............................................................................................. 968
Formal Block Title Number Dialog Box ...................................................................... 971
Generated Cell Dialog Box ....................................................................................... 977
Graphic Details Dialog Box....................................................................................... 978
HTML/PDF Attribute Dialog Box ............................................................................... 979
HTML/CSS Defects List ........................................................................................... 982
Import Generated Text Translation Dialog Box ........................................................... 983
Import Generated Text Translation — Translation has not Changed ............................ 983
Import Generated Text Translation — Translation Identical to Source .......................... 984
Import Generated Text Translation — Translation Already Current .............................. 984
Incompatible Document Types for Stylesheet Dialog Box ........................................... 985
Index Details Dialog Box .......................................................................................... 985
Index Term (Attribute Model) Details Dialog Box ........................................................ 986
Index Term (Element Model) Details Dialog Box......................................................... 987
Index Term (Nesting Element Model) Details Dialog Box ............................................ 989
Insert Attribute Content Dialog Box ........................................................................... 990
Insert Attribute Content Dialog Box (Headers and Footers) ......................................... 993
Insert Cross Reference Dialog Box ........................................................................... 994
Insert Element Content Dialog Box ........................................................................... 995
Insert Element Content Dialog Box (Headers and Footers) ......................................... 998
Insert Index Dialog Box .......................................................................................... 1000
Insert Leaders, Rule or Space Dialog Box ............................................................... 1001
Insert Metadata Dialog Box .................................................................................... 1002
Insert Symbol Dialog Box ....................................................................................... 1003
Insert Table of Contents Dialog Box ........................................................................ 1004
Insert XPath String Dialog Box ............................................................................... 1004
Link Details Dialog Box .......................................................................................... 1005
Link Target Details Dialog Box ................................................................................ 1006
List Item Number Dialog Box .................................................................................. 1007
Modules Dialog Box............................................................................................... 1012

916 User's Guide

Move to Module Dialog Box.................................................................................... 1014
Namespace Declarations Dialog Box ...................................................................... 1014
New Custom Counter Dialog Box............................................................................ 1015
New Module Dialog Box......................................................................................... 1016
New User Formatting Element Dialog Box ............................................................... 1017
No Stylesheet Found Dialog Box ............................................................................ 1017
Number Details Dialog Box .................................................................................... 1017
Numbering Restart Dialog Box ............................................................................... 1023
Open Stylesheet Dialog Box................................................................................... 1024
Paragraph Styles for Nested Lists Dialog Box .......................................................... 1025
Paste Properties Dialog Box................................................................................... 1025
Save As Merged Stylesheet Dialog Box .................................................................. 1026
Save Stylesheet As Dialog Box .............................................................................. 1026
Start At Dialog Box ................................................................................................ 1027
Start of HTML Chunk Test Dialog Box ..................................................................... 1030
Stylesheet Properties Dialog Box............................................................................ 1031
Table of Contents Condition Dialog Box................................................................... 1049
Tables of Contents Details Dialog Box..................................................................... 1050
Table of Contents Format Dialog Box ...................................................................... 1050
Table of Contents Format Details Dialog Box ........................................................... 1052
Translation Defects Window ................................................................................... 1054
Translation Note Dialog Box ................................................................................... 1055
Unused Definitions Dialog Box ............................................................................... 1056
Use Exported FOSI For Dialog Box......................................................................... 1056
Use Stylesheet For Dialog Box ............................................................................... 1058
Validate Page Sets Dialog Box ............................................................................... 1059
XPath Predicate Dialog Box ................................................................................... 1060
XPath Test Dialog Box ........................................................................................... 1061

This section provides a full description for each of Arbortext Styler’s dialog
boxes.

Arbortext Styler Dialog Boxes 917

Dialog Boxes
Many of Arbortext Styler’s features are controlled by values entered by the user in
dialog boxes.

Add/Edit JavaScript Library Dialog Box

This dialog box displays when you click the Add button in the Associated
JavaScript Libraries field of the HTML File or HTML Chunk tabs of the Stylesheet
Properties dialog box. It allows you to provide a reference to a JavaScript library,
which will be associated with the stylesheet and included in any HTML output.
Enter the path to the required JavaScript library in the Library field. The path can
be in these formats:
• an HTTP URL
• a file reference, if the location of the library will always be the same
The path you add here is included in the <head> section of HTML files
generated using the stylesheet, in this format:
<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.2.6/jq

Note
The path is not validated by Arbortext Styler.

This dialog box appears if you choose to edit the path of an existing library
reference.

Add Module Dialog Box

The Add Module dialog box opens when you select the Add button in the Modules
dialog box. It enables you to add an existing module to the stylesheet's module
hierarchy. The module is added to the hierarchy as the last child node of the
selected node when you select the Add button. Before adding the module to the
hierarchy, Arbortext Styler checks to make sure the module is not currently in the
hierarchy and does not reference any other module currently in the hierarchy. If
either of these cases are present, the operation fails.
The Add Module dialog box contains the following options:
• Look in - Enables you to select the folder in which you want to look for the
module. Any .style files that currently exist in the selected folder display in
the list below this control. If you select an existing file in this list, the File
name, Title, and Description fields are populated with information from the

918 User's Guide

 selected stylesheet. You can edit the title and description information, if
desired.
• File name - Enables you enter the name of the module or select a .style file
from the current folder.
• Files of type - Determines the type of the file that Arbortext Styler will search
for. The only choice available is a .style file.
• Title - Enables you to provide a name for the stylesheet module - this name
will appear in the Elements list, the Modules dialog box, and anywhere else the
selected module is mentioned. If you do not provide a name, the base filename
of the module appears instead.
• Description - Enables you to provide a short description of the stylesheet
module that displays in a small popup (tooltip) when the cursor hovers over
the module's name in the Elements list, Modules dialog box, and anywhere
else the selected module is mentioned
• Reference using relative path - check this option to have the reference to the
module encoded in the modularized stylesheet using relative file paths rather
than the full path. The option is checked by default, ensuring the reference
uses relative path information.

Note
If you add a module to the Arbortext-path\custom\
stylermodules directory and leave Reference using relative path
checked, the module reference will work even if you later move the
module to another location on the file system.

Add Namespace Declaration Dialog Box

The Add Namespace Declaration dialog box opens when you enter a prefixed/
namespaced element or attribute for which there is no associated URL. It enables
you to complete the namespace declaration. If you mistyped the namespace prefix,
select Cancel and enter the correct prefix in the Elements list.

Note
You must understand XML namespaces to use this option. Refer to the World
Wide Web Consortium (W3C) web site (www.w3.org/TR/REC-xml-names/)
for information on XML namespaces.

Arbortext Styler Dialog Boxes 919

The Add Namespace Declaration dialog box contains the following fields:
• New prefix - Shows the namespace prefix you included when creating your
element, in a read only field.
• New namespace name - Enables you to enter the namespace name (URI) for
the new namespace prefix. If you enter a URI that is already associated with
another prefix, the existing prefix will be used.
Note that the name you enter here is subject to case sensitivity, i.e.
www.book.com is different to www.Book.com. You should also note that
http://www.book.com is considered different to www.book.com under
W3C naming conventions.
• Existing namespace associations - Provides a list of the namespaces currently
declared in the stylesheet. This list is only a reference and cannot be used to
select a namespace.

Add New Elements Dialog Box

The Add New Elements dialog box opens when you elect to add new elements via
the Insert ▶ Add Elements from Document or Doctype menu option. Use the dialog
box to add new elements from the specified sources to the stylesheet.
The Add New Elements dialog box contains the following options:
• Document Type or Schema- Specifies the full path and file name of the DTD
or schema referenced by the doctype of your document. If you are using a
free-form XML document, None will display in this field.
• Include declared elements from this document type - When checked, this
option indicates that all declared elements in the DTD or schema will be added
to the stylesheet. By default, this field is selected. This field is disabled if you
are using a free-form XML document.
• Document - Specifies the full path and file name of the document. If the
document has not been saved, this field will show the value (unsaved).
• Include declared elements from this document - When checked, this option
indicates that all declared elements in the document will be added to the
stylesheet. This field is selected by default.
This option can only be edited if the Include declared elements from this
document type option has been deselected.
• Include namespaced elements from this document - When checked, this option
indicates that all namespaced elements in the document will be added to the
stylesheet. This field is selected by default.

920 User's Guide

 This field is not available when the Include declared elements from this
document is not selected.
• Include undeclared elements from this document - When checked, this option
indicates that all undeclared elements in the document will be added to the
stylesheet. This field is not selected by default.
This field is not available when the Include declared elements from this
document is not selected.

Add Target Language Dialog Box

This dialog box displays when you click the Add button to add a target language
in the Language tab of the Stylesheet Properties dialog box. It allows you to
provide a language into which generated text can be translated.
Enter a language code manually or choose one from the drop down list. You are
not permitted to add the value of the Source Language field as a target language.

Attribute Modifier Dialog Box

The Attribute Modifier dialog box opens when you choose the Insert ▶ Advanced ▶
Attribute Modifier menu option in the Generated Text Editor for an element. It
allows you to specify the attribute on the current element whose value should be
set to the value of another attribute from another element, when declared in
generated text.
The Attribute Modifier dialog box contains the following options:
• Attribute name - Contains a list of attributes declared for the element. Select
from the list the attribute whose value you want to set, or enter an attribute
name manually. Use the latter option to enter the name of an undeclared
attribute if required.
Once you have specified the attribute, click OK to exit the dialog box. Arbortext
Styler inserts an AttributeModifier tag pair whose only attribute is the name of the
attribute specified in the Attribute Name field in the dialog box. You may then use
items from the Insert menu in the Generated Text Editor to specify the element
and attribute combination in the source document that contains the value to which
the value of this attribute should be set.

Attribute Test Dialog Box

The Attribute Test dialog box opens when you carry out one of the following
actions in the Condition dialog box while creating a condition for an element or a
table of contents (TOC):

Arbortext Styler Dialog Boxes 921

• Choosing the New Attribute Test button
• Highlighting an existing attribute test, and choosing Edit
The title of the dialog box will be either New Attribute Test or Edit Attribute Test,
depending on which operation you used to invoke the dialog box. It allows you to
create or edit an attribute test for an element condition or a TOC condition.
The Attribute Test dialog box contains the following options. The available
options, or their intended uses, may differ slightly depending on whether you are
creating a test for an element condition or a TOC condition:
• Test attribute of - Controls the element whose attribute's value is to be tested.
The options are:
○ Current Element (available if creating a condition for an element) - select
this option to test an attribute of the element for which you are creating the
condition. The name of the current element is displayed in a read only
field.
○ Title Element (available if creating a condition for a table of contents) -
select this option to test an attribute of the title elements included in the
TOC. If there is only one element styled as Title in the stylesheet, the name
of that element is displayed in a read only field, otherwise the field is
hidden.
○ Parent - select this option to test an attribute of the direct parent of either
the current element or the TOC title element.
○ Ancestor - select this option to test an attribute of an ancestor of either the
current element or the TOC title element. Select an ancestor from the drop
down list or type an element name in the Ancestor field.
• Attribute Name - Provides a list of valid attributes for the selected element if
the element is in the DTD or schema used by the document. If there is no DTD
or schema, but the selected element is in the document, the list includes all
attributes defined in the document for the selected element. If the selected
element is not in the DTD, schema, or document, the list is empty, and you can
type in an attribute name.
• Attribute Value - Choose the test type and the value of the attribute that you
want to test, where applicable. The options are:
○ Assigned any value (default)
○ Not assigned a value
○ Includes whole word - Select this option then specify an alphanumeric
character string as the word the attribute value must include.
○ Comparison - Select this option, choose an operator (=, <, >, <=, >=, or !
=), then enter an alphanumeric character string in the text box for

922 User's Guide

 Arbortext Styler to compares with the matching attribute in a document.
This text field will include a drop down list of values if the selected
attribute has an enumerated set of values.
If one of the numeric operators <, <=, >, or >= is chosen, the attribute
value and the value it is being compared with must both be numeric or the
test will fail. The values will be compared after being converted to
numbers. For example, “09” would be considered greater than “2”.
If the attribute value and the value being compared are both numeric, use =
and != operators to carry out a numeric comparison. As an example, this
will ensure that the value “01” is considered equal to “1” or “1”.

Note
In pre-5.4 releases of Arbortext Styler, a "not equal" (defined with the !
= comparison option) attribute test of a condition would succeed when
publishing with the FOSI engine and fail in XSL-based outputs when
the attribute in question was unassigned. In 5.4, XSL outputs changed
so that the results match those obtained with the FOSI engine. Please
refer to the release notes for release 5.4 for further information.

Bullet Dialog Box

The Bullet dialog box opens if you have an element that is styled as a list item in
the Elements list, and you choose Bullet as the marker option on the Generated
text category then click the Details button. Use this dialog box to specify the type
of bullets you want to use.
The Bullet dialog box contains options listed below.
Note that bullet properties will only have the desired effect if the selected output is
configured to format list items as tables. This setting is made in the HTML tab of
the Stylesheet Properties dialog box. Please refer to Stylesheet Properties —
HTML File on page 1033 for information.
• Bullet character - Previews the five default bullet characters. Clicking on one
of the previews selects that character to be used as your bullet.
• Character - Launches the Symbol dialog box, in which you can specify a new
character to be used as a bullet. Note that you must click on a preview in the
Bullet Character field before you select the Character option - the selected
preview will then be replaced with the character chosen from the Symbol
dialog box.

Arbortext Styler Dialog Boxes 923

• Font - Launches the Modify Font dialog box, in which you can change font
formatting characteristics such as font family, point size, and style.
• Bullet position - sets the position of the bullet in the list entry:

○ Indent at - Specifies the amount by which to indent the bullet, relative to

the left margin. See the note at the end of this description for input options.
• Text position - sets the position of the text in the list entry:

○ Follow bullet with - Specifies the amount of space between the bullet and
the following text. Choices are Tab, Em-Space, Single Space, and No
Space. The default is Single Space, which adds a single, non-breaking
space.
○ Tab to - When you select Tab as the Follow bullet with value, this field
allows you to specify the amount of space that the tab adds between the
number and the following text. See the note at the end of this description
for input options.
○ Indent following lines - Specifies the amount by which to indent following
lines if the first line of the list item wraps. See the note at the end of this
description for input options. To align the text in the first and subsequent
lines, set this to the same value as set in the Tab to field.
• Preview - Displays a graphical preview of how your list will appear.

Note
The Indent at, Tab to, and Indent following lines fields of this dialog box allow
you to either type an arbitrary size in the field or choose a defined size by
selecting from the list of Size objects configured for your stylesheet. For the
latter option, click the Select Size button next to the field for which you
wish to set the measurement and select the name of the required Size object
from the resulting list. Once you have selected a Size object the measurement
it defines will be displayed wrapped in angle brackets (< > characters) in the
relevant field. For example, the Size object InchSize defines a measurement of
1.00in:

924 User's Guide

Condition Dialog Box
The Condition dialog box opens when you choose to create a new condition via
the Insert ▶ Condition menu option, or edit an existing condition by choosing the
Edit ▶ Edit Condition menu option. The title of the dialog box will be either New
Condition or Edit Condition, depending on which operation you used to invoke it.
Use the options in this dialog box to create or edit a condition for the element
selected in the Elements list.
The Condition dialog box contains the following options:
• Condition for - Confirms the context(s) to which the condition that is being
created or edited applies. This is a read-only field and is based on the active
element selection in the Elements list.
• Condition type - Allows you to specify the type of condition that you are
creating or editing, thus giving it a status and priority in relation to any other
conditions created for the context.

Note
Not all types are always valid for all conditions: whether a condition type
is permitted depends on its position relative to any other sibling conditions
created for the context. Use the following general rules when selecting a
type:
○ An If condition is valid at any position
○ An Else-If condition is valid if the preceding sibling condition is either an
If condition or another Else-If condition
○ An Else condition is valid if the preceding sibling condition is an If
condition or an Else-If condition

• Condition is true if - Allows you to set the level to which conditions should be
matched:
○ All tests are true - all of the tests created for the condition must be matched
if the condition is to match
○ Any test is true - if any number of the tests created for the condition can be
matched, the condition will match. At least one of the tests must match.
When the condition is matched, the formatting properties created for the
condition will be applied to the context.
• Tests - Lists the tests configured for the condition. This field is empty when no
tests have been configured yet. A condition must have at least one test.

Arbortext Styler Dialog Boxes 925

• New Attribute Test - Opens the Attribute Test dialog box, in which you can
create a new test for an attribute value.
• New Content Test - Opens the Content Test dialog box, in which you can create
a test for element content.
• New XPath Test - Opens the XPath Test dialog box, in which you can create a
test for an object defined by an XPath expression.
• New Chunk Test - Opens the Start of HTML Chunk Test dialog box, in which
you can create a new start of HTML chunk test.
• Edit - Opens the relevant dialog box for the test selected in the Tests list, in
which you can modify the selected test.
• Delete - Deletes the test selected in the Tests list.

Note
You are not prompted before the test is deleted.

Configure Columns Dialog Box

The Configure Columns dialog box opens when you carry out one of the following
actions in the Arbortext Styler UI:
• Choose the View ▶ Configure Columns menu option.
• Right click on the list view column headers and then select Configure Columns
from the shortcut menu.
Use this dialog box to set the display of your columns in the object list view. The
dialog box includes the following options:
• Show, Hide, and Reorder Columns - shows the columns available in the
Arbortext Styler interface and the order in which they are set to display from
left to right. Check the box next to the column name to activate it for display
in the list view.
• Up and down arrows - click the arrows to move the selected column in the
view order. Note that the view order runs from left to right so, for example,
moving a column upwards in the list will move it to the left in the actual list
view display.

926 User's Guide

 Note
Not all columns will be visible for all lists, even if you activate all columns for
display in this dialog box. The table below shows the columns that are
available for each list:
There is just one set of preferences for all list views. Adjusting these settings
for a given list view actually affects all of them.

Columns in UI for each List View

RTF Prece-
Style/ dence Source Com-
Style Field Category Module Edits ment
Elements • • • • • •
Property • • • •
Sets
Page Sets • • • •
Page • • • •
Types
Page • • • •
Regions
Generated • • • •
Contents
Tables of • • •
Contents
Custom • • •
Tables
Cross • • •
Referen-
ces
Sizes • • •
Combined • • •
Fonts

Content Test Dialog Box

The Content Test dialog box opens when you carry out one of the following
actions in the Condition dialog box, while creating a condition for an element or a
table of contents (TOC):

Arbortext Styler Dialog Boxes 927

• Choosing the New Content Test button
• Highlighting an existing content test and choosing Edit
The title of the dialog box will be either New Content Test or Edit Content Test,
depending on which operation you used to invoke it. It allows you to create or edit
a content test for an element condition or a TOC condition.
The Content Test dialog box contains the following options. The available options,
or their intended uses, may differ slightly depending on whether you are creating a
test for an element condition or a TOC condition:
• Element whose content to test - Specifies the element whose content is to be
tested. Choose one of the following options:
○ Current Element (available if creating a condition for an element) - select
this option to test the content of the element for which you are creating the
condition. The name of the current element is displayed in a read only
field.
○ Title Element (available if creating a condition for a table of contents) -
select this option to test the content of the title elements included in the
TOC. If there is only one element styled as Title in the stylesheet, the name
of that element is displayed in a read only field, otherwise the field is
hidden.
○ Parent - select this option to test the content of the direct parent of either
the current element or the TOC title element.
○ Ancestor - select this option to test the content of an ancestor of either the
current element or the TOC title element. Select an ancestor from the drop
down list, or type an element name in the field.
• Test type - Determines whether to test for the presence or absence of the
specified content. Choose Includes to test for the presence of the specified
content. Choose Does not include to test for the absence of the specified
content.
• Test depth - Determines the level to which to test for the specified content.
Select one of the following options:
○ Choose At top level to test only in the direct child elements of the specified
element.
○ Choose At any level to test in all descendant elements of the specified
element.

928 User's Guide

 The value set in this field decides which elements are displayed for selection
in the Content to test for field.
• Content to test for - Indicates the content for which Arbortext Styler should
test. Choose one the following options:
○ Select (Any element or text) (default) - test for the presence or absence of
any element or text in the specified element.
○ Select (Text content) - test for the presence or absence of text content in the
specified element.
○ Select a specific descendant element from the list to confirm that Arbortext
Styler should test for the presence or absence of that child element in the
specified element. The elements included in the list depend on the value
selected in the Test depth field:
◆ If Test depth is set to At top level, only the direct child elements of the
specified element are included in the list.
◆ If Test depth is set to At any level, all possible descendant elements of
the specified element are included in the list.
◆ If the document is free-form XML, or the element entered in the
Element whose content to test field is not declared in the document
type, all elements in the document are included in the list.
The list includes Styler Formatting Elements, User Formatting Elements,
and descendant elements.
You can also type an element name in the Content to test for field.

Context Dialog Box

The Context dialog box opens when you choose to create a new condition via the
Insert ▶ Context menu option, or edit an existing condition by choosing the Edit ▶
Edit Context menu option. The title of the dialog box will be either New Context or
Edit Context, depending on which operation you used to invoke it. Use the options
in this dialog box to create or edit a context for the element selected in the
Elements list.
The Context dialog box contains the following options:
• Element: elementname - Displays a read-only description of the context. The
associated window lists the selected element, along with any ancestors or
parents that have been selected.
• New Ancestor - Allows you to specify that the element to which the context
applies must occur inside a specific ancestor, which you choose from a list of
valid ancestor elements. The ancestor can occur at any level (parent,
grandparent, great-grandparent and so on). An asterisk wildcard is inserted

Arbortext Styler Dialog Boxes 929

 between the element and the new ancestor to represent that any number of
levels can occur between the two. This allows you to create a context that
formats the selected element any time it is found within the ancestor element.
For example, if para is the element for which you are creating a context, and
table is the ancestor element, the resulting context is para anywhere in
table. The formatting for this context is applied to any para element within
a table element, including both of the following situations:
<table>
<para>...</para>

<table>
<title>...</title>
<tgroup>
<tbody>
<row>
<entry>
<para>

• New Parent - Enables you to specify that the element selected in the Context
window must occur immediately within another element, which you choose
from a list of valid parent elements. For example, if you are creating a context
for title, and you select chapter as the parent element, the resulting
context (title in chapter) only applies to title elements whose parent
element is chapter:
<chapter>
<title>

The title in chapter context does not apply to the following hierarchy
because section, not chapter, is the parent element of title:
<chapter>
<section>
<title>

• Edit - Enables you to change the selected ancestor, parent, or wildcard. When
you highlight the ancestor, parent, or wildcard and select Edit, a dropdown
menu appears containing elements from your document. Select a new ancestor
or parent from the menu. You can also edit the highlighted element directly.
• Delete - Removes the selected ancestor, parent, or wildcard. You cannot
remove the element for which you are creating the context.
• Position - Specifies the position of an element in the context relative to sibling
elements of the same type. Highlight the element in the context hierarchy to
which the position should apply, then select one of the following options:
○ any (the default)

930 User's Guide

 ○ first
○ last
○ not first
○ not last
○ only
○ not first or last
○ XPath Predicate - Opens the XPath Predicate dialog box, in which you can
specify an XPath expression to test for an attribute.

Note
If you enter the name of a namespaced element in the XPath Predicate
dialog box, you will not be prompted to declare the namespace if it
does not already exist. Ensure you have declared the namespace for the
stylesheet by creating an element with the applicable prefix, or the
XPath expression you enter in this field will not be valid

• Edit predicate - This button is enabled when the position of a selected context
is defined via an XPath predicate. Clicking the button opens the XPath
Predicate dialog box, in which you can modify the predicate.
• At start of HTML chunk - When selected, this option indicates that an element is
the first element in an HTML chunk. Highlight the element in the context
hierarchy to which the position should apply, then select the option.
• At top level of document - When selected, this option indicates that the element
is the top-level element in the document.
Select this option when an element sometimes (but not always) occurs as the
top level element of the document.
If the element is always used as the top level element in documents, it is
preferable to apply the Document style to the element rather than use this
option. See the description of the Document style in Applying Styles on page
37 for further information.

Arbortext Styler Dialog Boxes 931

 Caution
It is important that the top level element in the document instance is either
given the Document style or has a context where At top level of document
is checked. If the outermost element of a document instance is not so
styled, publishing may fail.

• Include in ancestor and parent lists - Contains options by which you can
specify that User Formatting Elements and/or Styler Formatting Elements are
included in the lists of valid ancestors and parents. Refer to Elements
Overview on page 264 for more information on elements of these types.

932 User's Guide

 Note
You may encounter anomalies in the display of a context defined using an
XPath predicate, or a position qualifier other than “any” on a parent or
ancestor, if you are publishing with FOSI. If the source element is
subsequently declared in the generated text of another element, any context(s)
defined using the methods described will not be included in the FOSI output.
You will be presented with a warning message. To overcome this, use one of
the alternatives:
• Context with XPath predicate: include the XPath test in a condition of the
original element, rather than a context.

Arbortext Styler Dialog Boxes 933

• Create special contexts for the cases where the element occurs in generated
text. These contexts should not use XPath or position qualifiers on parents or
ancestors, and should be placed above contexts that do in the Elements list.
For example, you could define a table element with three contexts, each one of
which uses an XPath predicate to set the font size of the table content based on
the value of the pgwide attribute of the table (for example, the context
table[@pgwide=90]) You might then decide that you want the title of
your book to include a table, and set the generated text of the title in book
context to always output a table, based on the Insert ▶ Markup ▶ table menu
option. If you then publish your document for print via FOSI you will see
warning messages advising you that each of the contexts that contain the
XPath predicate will be ignored for the table output in the title of book
context, for example:
[A31450] ERROR: Cannot evaluate XPath expression in stylesheet.
An XPath Predicate is used in a Styler context for an element
that occurs in generated text. (The predicate may have been
generated by Styler to represent a position qualifier on a parent
or ancestor.) This context will be ignored in FOSI-based outputs.

Element: table. XPath expression: table[@pgwide=90].

To overcome this anomaly, create conditions based on XPath tests for the
table, rather than contexts. For example, the condition If XPath
expression (@pgwide=90) is true for the table will provide the same
output for the table based on the pgwide attribute, but will not cause errors
when publishing when the table is used in generated text for the title of the
book.
In both cases, however, if the context with the XPath predicate or the position
qualifier is not the one that should be output in the generated text anyway, and
its omission by FOSI has no bearing on the required output of your document,
you may simply ignore the error message.

Convert Stylesheet Dialog Box

The Convert Stylesheet dialog box opens when you select the Styler ▶ Convert
stylesheet menu option in Arbortext Editor. When you select OK, Arbortext Editor
converts the FOSI to a stylesheet. The conversion handles only a subset of FOSI
features; you can use Arbortext Styler to add features that were not automatically
converted.

934 User's Guide

Copy To Module Dialog Box
The Copy to Module dialog box opens when you select the File ▶ Copy to Module
menu option or the Copy to Module button in the Print/PDF Pages Sets and other
dialog boxes. It enables you to copy the selected stylesheet definitions to an
existing module in the stylesheet's module hierarchy.
All Arbortext Styler object types are considered mergeable definitions and can be
moved between modules:
• Elements, including Styler Formatting Elements and User Formatting
Elements
• Property sets
• Page sets
• Header and Footer objects
• Table of contents format objects
• Cross reference objects
• Custom table objects
• Size definitions
• Combined Font definitions
The Copy to Module dialog box contains the following option:
• Copy selected definition to - Enables you to select a module in the module
hierarchy of the current stylesheet as the target for the copied definitions. The
hierarchy is presented as a tree with the root module at the top of the tree. Any
additional modules in the hierarchy appear as nodes in the tree. You can use
the controls in the tree to open and close module nodes. The title or base
filename of a module also appears in the tree. Read-only modules have a lock
icon over their regular icon and the title text grayed out. You cannot copy
definitions to read-only modules.
The position of a node in the module hierarchy determines its precedence in
the hierarchy. Mergeable definitions in nodes higher in the hierarchy override
identically named definitions that are lower in the hierarchy.

Cross Reference Details Dialog Box

The Cross Reference Details dialog box opens when you apply the Cross
Reference style to an element in the Elements list, via the Edit ▶ Style menu
option. The dialog box is used to associate a Cross Reference object with the
selected element in order to provide setup and formatting for the cross reference
the element generates.
The Cross Reference Details dialog box contains the following options:

Arbortext Styler Dialog Boxes 935

• Reference attribute - Provides a list of IDREF or IDREFS attributes for the
element selected in the Elements list. This is the attribute used to specify the
target element’s ID.
• Select a cross reference format - Provides a list of cross reference objects
configured for the stylesheet. If you select an object and click OK, details of
the associated cross reference will be displayed in the Generated text category
for the selected element in the Elements list, in the After-text field.

Custom Content Dialog Box

The Custom Content dialog opens when you click either the Add or the Edit button
next to a table of contents title context in the Customize Table of Contents dialog
box. The dialog box enables you to modify the format of the entry for the
specified context in a table of contents.
Note that any custom content settings made in this dialog box will not appear in
the table of contents when it is output in chunked HTML (EPUB, HTML Help,
and Web) formats, or when it is used to form PDF bookmarks and the print engine
is not FOSI.
The Custom Content dialog box contains the following options:
• For title context - this read only field displays the name of the title context for
which you are creating the custom content.
• Number - this read only field displays the generated text setting currently in
effect for the context, to define its numbering in the table of contents. The
buttons next to the field allow you to make changes to that setting:
○ Edit: click this button to open the Custom Number generated text editor.
The editor displays in tagged editor form the markup that was displayed in
the Number field in the dialog box. You may delete the tag to remove title
numbering for the entries based on this context, or enter text or further
markup as required. If you make changes in this editor to create custom
numbering for the context, the Reset Number button is activated.
○ Reset: click this button to remove custom numbering for the context and
revert to default numbering for the context in the table of contents.
Note that the numbering of the entry set here is the number of the title in the
entry itself, not its page number.
• Text - this read only field displays the generated text setting currently in effect
for the context, to define its label in the table of contents. The buttons next to
the field allow you to make changes to that setting:
○ Edit: click this button to open the Custom Text generated text editor. The
editor displays in tagged editor form the markup that was displayed in the

936 User's Guide

 Text field in the dialog box. You may delete the tag to remove text labels
for the entries based on this context, or enter text or further markup as
required. If you make changes in this editor to create custom label text for
the context, the Reset Text button is activated.
○ Reset: click this button to remove custom labeling for the context and
revert to default labeling based on the set position for the context in the
table of contents.
Please refer to Customizing the Content of a TOC on page 360 for some examples
on how to customize the content of your table of contents.

Customize Table of Contents Dialog Box

The Customize Table of Contents dialog box opens when you click the Customize
button for a table of contents format object, in the properties area of the Table of
Contents list . The dialog box displays a list of title contexts configured for
your stylesheet (every context of every element with the Title style) and allows
you to pick which ones you want to include in any table of contents (TOC)
generated when the table of contents format object is referenced in the generated
text of an element in your stylesheet.
Note that the list of contexts in the dialog box mirrors that in the Elements list in
your stylesheet. If you want to include a context that does not appear in the dialog
box, you must create a new context in the Elements list. The order in which title
contexts will be matched when the TOC is built is defined by the order of the
contexts for an element on page 282 as they appear in the Elements list. You can
change the hierarchy of contexts for an element in the Elements list.
The Customize Table of Contents dialog box contains the following options for
each title context:
• Include - select this option to specify that occurrences of this title context
should be extracted for display in the table of contents when they appear in
your document.
When this dialog box is first opened for a table of contents format object, the
exclude/include checkbox settings it displays are based on the levels setting
for the object that have been made for it in Titles to include field in the
properties area. Any explicit exclude/include settings you subsequently make
in this dialog box will override those settings.
If this option is checked, the Add button is enabled for the context to allow you
to add some custom content to its entry in the table of contents. If you deselect
this option, both Custom Content buttons are disabled for the context.
• Level - the hierarchy level at which the title context will appear in the final
table of contents. Note that these indent levels may not be the same as element

Arbortext Styler Dialog Boxes 937

 nesting levels or chunk levels. Use the arrows to increase or decrease the level,
or type a level into the field.

Note
Hierarchy levels are used directly in inline TOCs, but are only used as
guidelines for PDF bookmarks and online TOCs in chunked HTML
outputs (EPUB, HTML Help, and Web). The online TOC is the TOC that
appears in the left frame of the window. In these outputs the hierarchy in
the TOC simply reflects the hierarchy of the content. The levels assigned
to TOC contexts continue to affect the formatting of TOCs that appear as
part of document content in Arbortext Editor, print, PDF, and HTML
outputs.

• Custom Content - buttons that allow you to configure any custom numbering
or generated text that should be applied to the title when it appears in the table
of contents:
○ Add/Edit - the title of this button depends on the current custom content
setting for the context: if no custom content currently exists the button will
be named Add. If you have already included some custom content for the
context, however, the button will be labeled Edit.
Clicking on the button will open the Custom Content dialog box, in which
you can make or amend your settings.
Note that you must have selected the Include option next to the title
context for the Add / Edit button to be available.
○ Delete - this button is only available if custom content already exists
for the context. Clicking the button will delete the custom content for the
context.
• Condition each title must match - this read only field displays a condition
specified for the title contexts that are to be included in the table of contents,
for example a condition that tests for the presence of the toc=”yes” attribute.
Each one of the title contexts that have the Include option checked must match
this condition to be included in the table of contents. Click the Edit button to
launch the Table of Contents Condition dialog box, in which you can create a
new condition or edit the existing one. Click the Delete button to remove a
condition once it has been defined.
If any of the contexts in the group box appear in the Arbortext Styler error color
(red by default, unless set via the stylererrorcolor preference), or if the
message below appears after the list of contexts, this means that some title
contexts set to appear in the TOC do not specify a direct parent. These contexts

938 User's Guide

will not produce bookmarks when publishing with FOSI if you have selected this
option for the TOC object in the properties area of the Tables of Contents list. For
example, the context title everywhere is not acceptable, whereas title
in book is permitted.
The text of the error message is shown below:
Title contexts must specify an immediate parent for the title to appear
in PDF bookmarks when PDF is produced by the FOSI engine. Contexts that
do not meet this criteria are displayed in red, or in the configured
Styler error color, above
Note that this does not apply if you electing to include a UFE context in a table of
contents. In this case, ensure that you specify an ancestor context, i.e. UFE
anywhere in xxxx. UFEs are always wrapped by a SFE and so specifying a
direct parent in the UFE’s context will therefore not correctly identify the UFE
itself.

Cut Properties Dialog Box

The Cut Properties dialog box displays when you use the Edit ▶ Properties ▶ Cut
operation to cut the properties of a context, condition, or property set that has
properties for more than one type of output. The dialog box enables you to select
which output properties you would like to cut, either for deletion or for paste into
another context, condition or property set.
The Cut Properties dialog box contains the following option:
• Properties to cut - Displays a list of those outputs for which specific properties
have been set. Select the output properties you would like to cut. Use CTRL
+left click or SHIFT+left click to select multiple properties. By default, the
output type currently displayed in the Outputs to edit field is initially selected
when the dialog box opens.

Definition List Details Dialog Box

The Definition List Details dialog box displays when you apply the Definition List
style to an element, via the Edit ▶ Style menu option. It permits you to choose the
elements that should form the components of the definition list, and set the
appearance of the list.
The Definition List Details dialog box contains the following options:
• Item element (wraps term and definition) - Choose an element to perform the
list entry role, wrapping the terms and definitions, in a definition list. The drop
down list in this field displays those elements that are permitted as children of

Arbortext Styler Dialog Boxes 939

 the original element given the Definition List style in the Elements list. Leave
this field blank if your document type does not use a wrapper element.
• Term element - Choose an element to contain the terms of the definition list.
This list contains the elements that are permitted as children of the element
selected in the Item element field, if one was chosen. If an item element was
not selected, this list contains those elements that are permitted as children of
the original element given the Definition List style in the Elements list.
• Definition element - Choose an element to contain the definitions in the
definition list. This list contains the elements that are permitted as children of
the element selected in the Item element field, if one was chosen. If an item
element was not selected, this list contains those elements that are permitted as
children of the original element given the Definition List style in the Elements
list.
• Term width - Specify the space allowed to accommodate the term element. See
the note at the end of this description for input options.
• Gutter width - Specify the space between the term element and the definition
element in each list entry. See the note at the end of this description for input
options.

Note
The Term width and Gutter width fields of this dialog box allow you to either
type an arbitrary size in the field or choose a defined size by selecting from the
list of Size objects configured for your stylesheet. For the latter option, click
the Select Size button next to the field for which you wish to set the
measurement and select the name of the required Size object from the
resulting list. Once you have selected a Size object the measurement it defines
will be displayed wrapped in angle brackets (< > characters) in the relevant
field. For example, the Size object InchSize defines a measurement of 1.00in:

940 User's Guide

Delete Properties Dialog Box
The Delete Properties dialog box displays when you use the Edit ▶ Properties ▶
Delete operation to delete the properties of a context, condition, or property set
that has properties for more than one type of output. The dialog box enables you
to select which output properties you would like to delete for that object.
The Delete Properties dialog box contains the following option:
• Properties to delete - Displays a list of those outputs for which specific
properties have been set. Select the output properties you would like to delete.
Use CTRL+left click or SHIFT+left click to select multiple properties. By
default, the output type currently displayed in the Outputs to edit field is
initially selected when the dialog box opens.

Division Details Dialog Box

The Division Details dialog box displays when you apply the Division style to an
element, via the Edit ▶ Style menu option. It provides the options for you to define
the element's position in the division hierarchy in your document. You can also
access this dialog box by selecting the Edit ▶ Edit Style Details menu choice to
modify the settings for an element that has been assigned the Division style.
The Division Details dialog box contains the following options:
• Division level - Specifies the hierarchical level for the selected element.
• Division nesting - Defines the level to which the selected element is permitted
to nest. Arbortext Styler will create contexts for this division and for titles
within this division based on the entry made in this field. For example, if you
enter 3 as the Number of levels of this element to style for the section
element in the DocBook DTD, Arbortext Styler creates the following contexts:
○ section in section in section
○ section in section
○ section everywhere
○ title in section in section in section
○ title in section in section
○ title in section

Note
The Division nesting option is not available if the document type does not
permit the selected element to nest within itself.

Arbortext Styler Dialog Boxes 941

Division Reference Dialog Box
The Division Reference dialog box displays when you carry out one of the
following actions:
• Select Insert ▶ Division Reference in the Generated Text Editor for a header or
footer object.
• Elect to modify an existing division reference by highlighting a
DivisionReference element in the Generated Text Editor and selecting the Edit ▶
Modify Attributes menu option.
It allows you to insert or modify a reference to a division title in a header or
footer.
The Division Reference dialog box contains the following options:
• All divisions - Provides a list of all elements styled as Division in your
stylesheet. You can select one or more divisions, included nested levels of
division, from this list.
• Selection criteria - Specify the occurrence of the division whose content you
want to enter in the header or footer. Choose from First division started on the
page or Last division started on the page.
• Cross reference format - Provides a list of cross reference objects configured
for your stylesheet. Select the object that defines the formatting you want to
apply to the reference.

Division Title Number Dialog Box

This dialog box displays if you select a context or condition for the title of a
division from the Elements list, define it as a numbered division by selecting the
Number option in the Generated text category, then click the Details button to
format the number.
The Division Title Number dialog box contains the options listed below.
Note that some number position properties have no effect in chunked HTML
outputs (EPUB, HTML Help, and Web). Refer to Differences in Output Support
on page 1084 for information. This is also the case with HTML File output, unless
it is configured to format titles as tables. This setting is made in the HTML tab of
the Stylesheet Properties dialog box. Please refer to Stylesheet Properties —
HTML File on page 1033 for information.
• Number format - Displays the element’s number (in red) based on the style
selected in the Number style field.
If you require punctuation (non-alphanumeric) characters before or after the
number, or before or after the previous level number indicated, for example,
#.1 or (1), enter it in this field. Note that if you enter punctuation here it will

942 User's Guide

 appear both in the title itself and in any references to the title. If you do not
want the punctuation to appear in references to the title, for example in cross
references, enter it in the Suffix (does not appear in references) field instead.
This field displays a number character (#) if Arbortext Styler is unable to
detect a number for the previous element when one has been requested in the
Previous level number field.
• Start at - invokes the Start At dialog box, in which you can define the number
at which the numbering should start.
• Number style - Specifies the numbering style.

The available options are:

○ (none): Do not to display the number.
Selecting this option enables you to perform operations such as having an
automatically generated label for the element that can be cross referenced,
or cross referencing the element, without having to display the number.
○ 1, 2, 3,...
○ A, B, C,...
○ a, b, c,...
○ I, II, III,...
○ i, ii, iii,...
○ 01, 02, 03,...
○ 001, 002, 003,...
○ 0001, 0002, 0003,...
Choosing one of the last three styles causes the number to be padded on
the left by two, three, or four spaces respectively. If you have entered an
XPath expression in the XPath override for current level option that returns
a string, this option is disabled.
○ ①, ②, ③... (circled decimal numbering scheme, implemented to support
the Zenkaku numeric numbering scheme)
○ ァ,ィ,ゥ... (Japanese - katakana numbering scheme)
○ イ, ロ, ハ... (Japanese - katakana-iroha numbering scheme)
○ あ, い, う... (Japanese - hiragana numbering scheme)
○ い, ろ, は... (Japanese - hiragana-iroha numbering scheme)
○ 一, 二, 三... (Chinese - simp-chinese-informal numbering scheme,
implemented to support the Kanji numeric 1 numbering scheme)
○ 子, 丑, 寅... (CJK earthly-branch numbering scheme)

Arbortext Styler Dialog Boxes 943

 ○ 甲, 乙, 丙... (CJK heavenly-stem numbering scheme)
○ 가, 나, 다 ... (Korean - hangul numbering scheme)
○ ㄱ, ㄴ, ㄷ... (Korean - hangul-consonant numbering scheme)
○ ๑ , ๒ , ๓... (Thai)
○ ۱, ۲, ۳... (Arabic-indic numbering scheme)
○ ۱, ۲, ۳... (Urdu)
• Restart - Launches the Numbering Restart dialog box, in which you can
specify the element at which to restart numbering. The available options are:
○ (Previous division level): number the first occurrence of the current
division title in its parent division element as 1, and continue numbering
the current division titles in sequence until a new parent division level
starts.
Selecting this option will give you compound numbering based on your
division settings. For example, if you have specified compound numbering
for the divisions, the numbering of the sections in your document could
appear as follows:
Chapter 1
Section 1.1
Section 1.2
Section 1.3

Chapter 2
Section 2.1
Section 2.2
etc.
○ (No restart): continue numbering whenever the division title appears and
regardless of the parent or division level to which it belongs.
○ Select a specific element from the list supplied: the list contains all
element contexts styled as Division, Block, or Document that are permitted
as ancestors of the current title's division.
If you have entered an XPath expression in the XPath override for current level
field, this option is disabled.
• Previous level number - Specifies the element in the previous division level
whose number should be shown before the number of the current element, if
compound numbering is required for the current level. The following options
are available (note that the list does not include the division that is the parent
of the current title context):

944 User's Guide

 ○ (None): use the current element's number only, do not provide compound
numbering
○ (Previous): add the number of any element with a higher division level that
is entered as the direct parent of the current element in the document
○ Select a specific element from the list supplied: the list contains all
numbered elements that are valid ancestors of the division whose title is
being styled

Note
Publishing errors will occur if you choose the second or third option and
the previous element is not numbered.

The Number format field will display a number character (#) if Arbortext
Styler is unable to detect a number for the previous element as set here.
• Insert En-dash - Inserts an en-dash at the cursor position in the Number format
field.
• Label - Allows you to enter a text string to be displayed before the number in
the title, for example Chapter . To localize the label, use the Advanced Edit
button.
• Advanced Edit - Opens a Generated Text Editor window, in which you can set
the position of the label with reference to the number. You may also configure
translation settings for the label. Refer to Maintaining Translations of
Generated Text on page 528 for further information on how to translate
content.
By default, the label is placed before the number. These may be swapped
round either in this dialog or in the resulting translation.
You are not permitted to delete the number or add text to both sides of the
number. In addition, no font or spacing controls are provided in this instance
of the generated text editor. Set the font using the Font button in the number
dialog.
• XPath override for current level - Allows you to enter an XPath expression to
determine the number or maker for the current level, rather than it being
judged automatically based on content.
Click the Edit button to access the dialog box in which you can enter your
expression.
• Edit - Invokes the Edit XPath Override for Current Level dialog box, in which
you can enter or edit an XPath expression.

Arbortext Styler Dialog Boxes 945

• Delete - Removes the expression from the Edit XPath Override for Current
Level field, thus reverting to content based level calculation for the division.
The button is only accessible if an XPath expression has been entered in the
field.
• Custom counter - Specifies the counting sequence to which this element
belongs. The available options are:
○ (new): Invoke the New Custom Counter dialog box, in which you can create
a new counting sequence
○ (none): Do not include this element in any counting sequence
○ custom counter name: Select an existing counting sequence, within which
this element should be included. Note that multiple elements can be
included in a single counting sequence - if other elements are included in
the selected sequence the element names will be displayed in the Counted
with field.
• Keep number at beginning of line - Determines whether the number is placed at
the beginning of the line. This option is checked by default. When this box is
not checked, the number is still automatically placed at the beginning of the
line (see the entry for the generated text for the title in the Before-text field on
the Generated text category for the title element). You can subsequently click
Edit for the generated text field to add content, or other information, before the
number using the Generated Text Editor.
The Alignment and Follow number with controls are not available when this
option is deselected. The Font button is also not available, but you can use the
Format menu in the Generated Text Editor to modify the number's font.
• Font - Invokes the Modify Font dialog box, allowing you to format the
appearance of the numbering.
Note that this button is disabled if the Keep number at beginning of line option
is unchecked, for example if you are numbering an inline element. If you wish
to apply font settings, use one of the following options:
1. In the Generated Text Editor, choose the Format ▶ Touchup ▶ Font menu
option. You will be presented with the Modify Font dialog box.
To invoke the Generated Text Editor, navigate to the Generated text
category for the numbered element. Click the Edit button next to the
Before-text field.
2. In the document, wrap the numbered in a User Formatting Element (UFE)
and make the required font setting for the UFE.
• Alignment - Defines how numbers align relative to other division title
numbers. For example, if you select Left alignment and you have divisions

946 User's Guide

 numbered 1 through 10, the 1 in both numbers align. If you select Right
alignment, the 0 in the number 10 aligns with the 1.
• Align at - Specifies the position at which left or right alignment of the number
occurs, relative to the left margin. See the note at the end of this description
for input options.
• Suffix (does not appear in references) - Defines punctuation that appears after
the number in the title being styled, but does not appear in references to that
title, for example cross references or table of contents entries.
• Follow number and suffix with - Specifies the amount of space between the
number and the title content that follows. The available options are:
○ Single Space: adds a single, non-breaking space
○ Em-Space: adds an em-space
○ Tab: adds the amount of space specified in the Tab to field
○ No Space: places the title text immediately adjacent to the number
• Tab to - Specifies the position at which title content starts after the title
number, used when the Follow number with field is set to Tab. See the note at
the end of this description for input options.
Note that a setting made in this field will have different results in the various
output formats, if the label of the title (the number plus any suffix) is longer
than the Tab to value allowed:
○ FOSI outputs: the text of the title immediately follows the extra long label,
with no intervening space. The long label pushes the title body text
forward as required.
○ XSL-FO outputs: the text of the title starts where it is meant to start (at the
position identified by the Tab to value) even if the label is extra long. The
title text will overwrite the label.
○ HTML outputs (when the Format titles as tables stylesheet property is
selected): the table column for the title body is determined by the value set
in the Tab to field, thus setting the right side of the title label field. If the
title label doesn't fit in the given field it will break, if possible. Any label
text that still does not fit into the field will not be visible in the browser.
Note that, for chunked HTML outputs (EPUB, HTML Help, and Web),
titles are never output as tables. In these instances any Tab to value is
ignored and a single space will be output after the label, regardless of the
size of the label.
○ RTF: output: similar to the effect seen for FOSI outputs except that a space
is included between the label and the start of the title body text.

Arbortext Styler Dialog Boxes 947

• Indent following lines - Specifies the amount by which to indent text on
following lines if the title text wraps to the next line(s). See the note at the end
of this description for input options. To left align the text on the first and
following lines, specify the same value in this field as you specify in the Tab to
field.
• Preview - Provides a dynamic graphical representation of the settings made in
this dialog box.
• Counted with - Provides a list of other elements in the stylesheet that are
included in the same counting sequence as the element being styled. Note that
the window only appears if the Custom counter field has a value other than
(none).

Note
The Align at, Tab to, and Indent following lines fields of this dialog box allow
you to either type an arbitrary size in the field or choose a defined size by
selecting from the list of Size objects configured for your stylesheet. For the
latter option, click the Select Size button next to the field for which you
wish to set the measurement and select the name of the required Size object
from the resulting list. Once you have selected a Size object the measurement
it defines will be displayed wrapped in angle brackets (< > characters) in the
relevant field. For example, the Size object InchSize defines a measurement of
1.00in:

Document Language Mapping Dialog Box

This dialog box displays when you click the Add or Edit buttons to create or edit a
document language mapping in the Language tab of the Stylesheet Properties
dialog box. It allows you to create a mapping between a language code in a
document and a recognized Arbortext Styler language and language code.
In both fields, you may enter a language code manually or choose it from the drop
down list. You are not permitted to enter more than one mapping for a single
Document language.

948 User's Guide

The title of the dialog box is Add Document Language Mapping or Edit Document
Language Mapping, depending on whether you are creating a new mapping or
accessing an existing one.

Duplicate Translation Unit IDs in Module

This dialog box may display when you elect to add a module to a stylesheet. It
contains a message to advise you that one or more translation units in the module
have the same IDs as translation units in the stylesheet. This is not permitted. IDs
of translation units in a stylesheet must be unique to enable Arbortext Styler to
match a translation in an XLIFF file with the correct source generated text in the
stylesheet.
Refer to Ensuring Translation Units have Unique IDs in Managing Translation
Units on page 532 for information on how Arbortext Styler ensures translation
units have unique IDs.
• Click Yes if you wish to continue adding the module to the stylesheet.
Arbortext Styler will regenerate the duplicated IDs to make them unique.
• Click No to terminate the action.
If you have exported an XLIFF file for the module and there are outstanding
translations that have not yet been imported, you will need to import them
before having Arbortext Styler regenerate the IDs for the module.

Edit Graphic XPath Dialog Box

This dialog box displays when you select the Edit button next to the Use Xpath
field when configuring a graphic for a page region, in the Graphic category of the
Page Regions list. It allows you use an XPath expression to define the graphic that
should display in the region.
You must understand XPath and its syntax to use this option. Refer to the World
Wide Web Consortium (W3C) web site (www.w3.org/TR/xpath) for information
on the XPath standard.
The Edit Graphic XPath dialog box contains the following option:
• XPath Expression - Provides a free text field in which you can enter a valid
XPath expression. Note that relative expressions are evaluated relative to the
element being styled.

Arbortext Styler Dialog Boxes 949

 Note
You must enter element names as they appear in the Elements list,
including any namespace prefixes.

Edit Module Dialog Box

The Edit Module dialog box opens when you select the Edit button in the Modules
dialog box. It enables you to add or edit information that describes a selected
module in the Modules dialog box.
The Edit Module dialog box contains the following options:
• Module title - Enables you to provide a name for the stylesheet module that
displays in the Modules dialog box, the Module column in the Elements list for
an element that is part of the module, and similar locations. If you do not
provide a name, the filename root of the module appears instead.
• Module description - Enables you to provide a short description of the
stylesheet module that displays in a small popup (tooltip) when the cursor
hovers over the module's name in the locations detailed above.

Edit Uses List Dialog Box

The Edit Uses List dialog box opens when you select the <Edit This List> option
from the Outputs to Edit list in Arbortext Styler. Use this dialog box to add or
remove output types from the Properties to Edit list of options, or create an option
for the list that is a set of output types. Creating a set of output types in this way
allows you to apply the same formatting properties to several output types in a
single click.
The Edit Uses List dialog box contains the following options:
• Uses - Provides a list of valid output types.
• Preview of “Outputs to Edit” list - Lists the uses that will be displayed in the
Outputs to Edit list.
• Add - Allows you to select uses from the Uses list and click Add to add them
to the Preview of “Outputs to Edit” list. There are two options:
○ Select a single use and click Add to include it as a single entry
○ Select multiple uses using CTRL+left click or SHIFT+left click and click
Add to add them as a combined use

950 User's Guide

 Note
When uses are combined, any property settings that you make when you
have selected the combined entry from the Outputs to edit list are made to
all the uses in the entry.

• Remove - Removes the selected use from the Preview of “Properties to Edit”
list.

Edit XPath Override for Current Level

Dialog Box
This dialog box opens when you select the Edit button next to the XPath override
for current level field in several numbering-related dialog boxes invoked from the
Generated text category. Use this dialog box to enter an XPath expression that is
used to determine a number or marker to use for the current numbering level.
You must understand XPath and its syntax to use this option. Refer to the World
Wide Web Consortium (W3C) web site (www.w3.org/TR/xpath) for information
on the XPath standard.
The Edit XPath Override for Current Level dialog box contains the following
options:
• Expression type - Contains the following options that determine the type of
XPath expression used:
○ XPath expression returns an integer number - When selected, specifies that
the XPath expression should return a number, which must evaluate to an
integer.
○ XPath expression returns a string - When selected, specifies that the XPath
expression should return a string.
• Expression - Enables you to enter an XPath expression.

You must enter element names exactly as they appear in the Elements list,
including any namespace prefixes.

Arbortext Styler Dialog Boxes 951

 Note
If you enter the name of a namespaced element in this field, you will not
be prompted to declare the namespace if it does not already exist. Ensure
you have declared the namespace for the stylesheet by creating an element
with the applicable prefix, or the XPath expression you enter in this field
will not be valid

Note
Some XPath expressions, especially expressions that use the preceding
axis, can cause slow performance when generated text is produced for
large documents. See XPath Performance on page 1078 for hints on
creating more suitable expressions.

Elements Not in Document Type Window

The Elements Not in Document Type window opens when you choose the Tools ▶
List Elements Not in Document Type menu option. It displays a list of elements in
the stylesheet that are not declared in the current document type.
As well as the list of elements, the window also contains a number of controls to
help you navigate and update the list:
• Go To - opens the Elements list and places cursor focus on the selected element
to allow you to edit it, or delete it if you wish to tidy up your stylesheet. The
element cannot be deleted from within the dialog box.
• Display - displays the selected element in the Elements list. Cursor focus
remains on the entry in the Elements Not in Current Document Type list. With
this option you can elect to find subsequent results from the list without
having to continually return to the results list.
• Refresh - updates the Elements Not in Current Document Type list by rerunning
the original search. The list will be updated if elements have been added to, or
deleted from, the stylesheet.
The note at the bottom of the window advises you that the stylesheet may be used
for another document type defining these elements. Be aware of these reasons
why elements can be listed as not belonging to the current document type but
should not be removed from the stylesheet:

952 User's Guide

• The stylesheet may be configured to be used with multiple document types
and an element in the list originates in a document type other than the current
one.
• Namespaced elements can be used in documents and styled in the stylesheet
without being defined in the document type
• DITA elements are separated in different document types, for example
bookmap and topic.
Column display for this window follows the same rules as for the Find Where
Used Results Window on page 965

Export PTC APP Template Dialog Box

This dialog box opens when you choose File ▶ Export ▶ APP in Arbortext Styler.
Use this dialog box to export your .style stylesheet as a .3f template file.

Note
Your stylesheet must be set to use PTC APP as the print/PDF engine to access
this menu option.

The Export PTC APP Template dialog box contains the following options:
• File name - Specifies the path and file name to which you want to export the
stylesheet. You can edit the field directly, or use the Browse button to modify
it.
If the stylesheet has never been saved, the file name consists of a path and file
name based on the document directory, and the default stylesheet name, plus a
.3f extension.
Once exported, you can use the .3f file in a standalone PTC Advanced Print
Publisher installation if required.

Note
The template can only be opened successfully in a compatible PTC Advanced
Print Publisher release - you will see an error message if you try to open the
document in an earlier release.

Arbortext Styler Dialog Boxes 953

Export CSS dialog box
This dialog box opens when you choose File ▶ Export CSS in Arbortext Styler and
choose one of the HTML output options. Use it to export the CSS information for
that output from your stylesheet as an external file. CSS information will be
generated according to the settings made in the Create CSS rules for field of the
HTML tab of the Stylesheet Properties dialog box.
The Export CSS dialog box contains the following options:
• File name - Specifies the path and file name to which you want to export the
CSS file. If the file has never been saved, the field contains a path and file
name based on the document directory, the default stylesheet name with a
suffix that details the output format selected, plus a .css extension. You can
edit the path and file name, or Browse to an existing location.
• Title - Specifies the name of the CSS file. If you do not specify a title, the title
of the stylesheet displays in this field.

Note
Arbortext Editor truncates the path and file name if they exceed 57
characters.

Export FOSI Stylesheet Dialog Box

This dialog box opens when you choose File ▶ Export ▶ FOSI in Arbortext Styler.
Use this dialog box to export your .style stylesheet as a .fos stylesheet.

Note
Your stylesheet must be set to use FOSI as the print/PDF engine to access this
menu option.

The Export FOSI Stylesheet dialog box contains the following options:
• File name - Specifies the path and file name to which you want to export the
stylesheet. You can edit the field directly, or use either the Browse or Use For
buttons to modify it. Select Use for to determine the available choices.
If your stylesheet has not been saved before, Arbortext Editor fills in this field
with a path that would make the stylesheet the default stylesheet either for the
document or for the current document type.

954 User's Guide

 If you do not have write permission for the location in which the stylesheet
was previously saved, Arbortext Editor provides a path that combines the
previous file name with the current document directory.
• Title - Specifies the name of the stylesheet that displays in the Select
Stylesheet dialog box and the dialog boxes associated with the Publishing
types you select. If you do not specify a title, the path and file name of the
stylesheet display in these dialog boxes.
• Publishing types - Specifies the publishing types for which the stylesheet can
be used. Choices are Print/PDF and HTML File. The stylesheet title or its path
and file name display in the stylesheet list in the dialog boxes associated with
the publishing types selected.
For example, if you select Print/PDF as the publishing type for which the
stylesheet is to be used, the stylesheet is added to the Stylesheet list in the
Preview, Print, and Publish to PDF File dialog boxes in Arbortext Editor.
• Use for - Opens the Use FOSI for dialog box, in which you can select a use for
your stylesheet. Arbortext Styler will provide a name and location for your
stylesheet based on the option you choose. If you continue with the export
based on these default details the stylesheet will always be used as the default
stylesheet for certain documents.

Export Generated Text for Translation

Dialog Box
This dialog box displays if you select Tools ▶ Export Generated Text in Arbortext
Styler. It allows you to specify the languages for which an XLIFF file should be
created and exported, and define the XLIFF files for each language, as part of the
process of creating translations of the generated text in your stylesheet.
The dialog box displays the following fields:
• Destination folder - the directory location to which the XLIFF file(s) should be
exported. The field will default to the directory in which the stylesheet is
located. Enter the directory path directly into the field, or choose the Browse
button to open an Explorer window and browse for a location.
• File name base - the base of the name of the XLIFF file for each language
selected in the Language field. A default file name base will be provided,
based on the following rules:
○ The first part of the file name will be the name of the stylesheet, suffixed
with _style.
○ If you have selected a single language in the Language field, the provided
file name base will include the language suffix too. For example, if you

Arbortext Styler Dialog Boxes 955

 have only selected French in the Language field, the file name base will be
stylesheetname_style_fr.
You are free to enter your own file name base in this field.
The full file name of the XLIFF file will be displayed in the File name field.
• Languages to export - the languages for which an XLIFF file should be
exported. The list provided includes the source language and the target
languages specified for the stylesheet in the Language tab of the Stylesheet
Properties dialog box on page 1031. Use the Select All or Deselect All buttons
to choose or reject all target languages defined for the stylesheet.
○ Language - a list of the target languages set for the stylesheet. Use the
checkboxes to select those languages for which you wish to export an
XLIFF file during this export action.
○ File name - the full name of the XLIFF file that will be exported for each
selected language. This is made up of the value of the File name base field
plus the relevant language suffix.
• Include only generated text that does not have a current translation - check this
box to specify that the exported XLIFF file should not contain translation units
for those translation units in the stylesheet that are marked as current.
Click OK to begin the export, and Cancel to return to the stylesheet without
exporting any translations.
If the XLIFF files cannot be created, you will be notified.
If a destination file of the same name already exists, you will be prompted with an
option to overwrite it or to cancel the export action.
If there are no instances of generated text for translation in the stylesheet, the
XLIFF file will not be created. You will be notified if this is the case:
[A16796] There are no translations in this stylesheet to export. No files generated.

Export XSL-EPUB Stylesheet Dialog Box

This dialog box opens when you choose File ▶ Export ▶ XSL-EPUB in Arbortext
Styler. Use this dialog box to export your .style stylesheet as an .xsl
stylesheet, a format used for transforming a document into EPUB ready XHTML
content.
The Export XSL-EPUB Stylesheet dialog box contains the following options:
• File name - Specifies the path and file name to which you want to export the
stylesheet. If the stylesheet has never been saved, the file name consists of a
path and file name based on the document directory, the default stylesheet

956 User's Guide

 name with -epub appended, plus an .xsl extension. You can edit the path
and file name, or Browse to an existing location.
• Title - Specifies the name of the stylesheet that displays in the Select
Stylesheet and Publish for EPUB dialog boxes in Arbortext Editor. If you do
not specify a title, the path and file name of the stylesheet display in these
dialog boxes.

Note
Arbortext Editor truncates the path and file name if they exceed 57
characters.

Export XSL-FO Stylesheet Dialog Box

This dialog box opens when you choose File ▶ Export ▶ XSL-FO in Arbortext
Styler. Use this dialog box to export your .style stylesheet as an .xsl
stylesheet, a format that can be used to generate print or PDF output.

Note
Your stylesheet must be set to use XSL-FO as the print/PDF engine to access
this menu option.

The Export XSL-FO Stylesheet dialog box contains the following options:
• File name - Specifies the path and file name to which you want to export the
stylesheet. You can edit the path and file name, or Browse to an existing
stylesheet.
If the stylesheet has never been saved, the file name consists of a path and file
name based on the document directory, the default stylesheet name with -fo
appended, plus an .xsl extension.
• Title - Specifies the name of the stylesheet that will display in the Select
Stylesheet, Preview, Print, and Publish to PDF File dialog boxes in Arbortext
Editor.
If you do not specify a title, the path and file name of the stylesheet display in
these dialog boxes.

Arbortext Styler Dialog Boxes 957

 Note
Arbortext Editor truncates the path and file name if they exceed 57
characters.

Export XSL-FO RTF Stylesheet Dialog

Box
The Export-FO RTF Stylesheet dialog box lets you export your .style stylesheet
as an RTF-specific .xsl stylesheet. Reviewing the exported XSL-FO stylesheet
may aid in troubleshooting export issues.
The Export-FO RTF Stylesheet dialog box has the following controls:
• File name - Specifies the path and file name to which you want to export the
stylesheet. If the stylesheet has never been saved, the file name consists of a
path and file name based on the document directory, the default stylesheet
name with -rtf appended, plus an .xsl extension. You can edit the path
and file name, or Browse to an existing stylesheet.
• Title - Specifies the name of the stylesheet that will display in the Select
Stylesheet and Export to RTF dialog boxes in Arbortext Editor. If you do not
specify a title, the path and file name of the stylesheet display in these dialog
boxes.

Note
Arbortext Editor truncates the path and file name if they exceed 57
characters.

Export XSL-HTML File Stylesheet Dialog

Box
This dialog box opens when you choose File ▶ Export ▶ XSL-HTML File in
Arbortext Styler. Use this dialog box to export your .style stylesheet as an
.xsl stylesheet, a format that can be used to transform documents into a single
HTML file.
The Export XSL-HTML Stylesheet dialog box contains the following options:

958 User's Guide

• File name - Specifies the path and file name to which you want to export the
stylesheet. If the stylesheet has never been saved, the file name consists of a
path and file name based on the document directory, the default stylesheet
name with -html appended, plus an .xsl extension. You can edit the path
and file name, or Browse to an existing stylesheet.
• Title - Specifies the name of the stylesheet that displays in the Select
Stylesheet and Publish to HTML File dialog boxes in Arbortext Editor. If you
do not specify a title, the path and file name of the stylesheet display in these
dialog boxes.

Note
Arbortext Editor truncates the path and file name if they exceed 57
characters.

Export XSL-HTML Help Stylesheet Dialog

Box
This dialog box opens when you choose File ▶ Export ▶ XSL-HTML Help in
Arbortext Styler. Use this dialog box to export your .style stylesheet as an
.xsl stylesheet, a format that can be used for generating HTML Help.
The Export XSL-HTML Help Stylesheet dialog box contains the following options:
• File name - Specifies the path and file name to which you want to export the
stylesheet. If the stylesheet has never been saved, the file name consists of a
path and file name based on the document directory, the default stylesheet
name with -htmlhelp appended, plus an .xsl extension. You can edit the
path and file name, or Browse to an existing stylesheet.
• Title - Specifies the name of the stylesheet that displays in the Select
Stylesheet and Publish for HTML Help dialog boxes in Arbortext Editor. If you
do not specify a title, the path and file name of the stylesheet display in these
dialog boxes.

Note
Arbortext Editor truncates the path and file name if they exceed 57
characters.

Arbortext Styler Dialog Boxes 959

Export XSL-Web Stylesheet Dialog Box
This dialog box opens when you choose File ▶ Export ▶ XSL-Web in Arbortext
Styler. Use this dialog box to export your .style stylesheet as an .xsl
stylesheet, a format used for transforming a document into a set of multiple web
pages using PTC Arbortext’s Web publishing capabilities.
The Export XSL-Web Stylesheet dialog box contains the following options:
• File name - Specifies the path and file name to which you want to export the
stylesheet. If the stylesheet has never been saved, the file name consists of a
path and file name based on the document directory, the default stylesheet
name with -web appended, plus an .xsl extension. You can edit the path
and file name, or Browse to an existing stylesheet.
• Title - Specifies the name of the stylesheet that displays in the Select
Stylesheet and Publish for Web dialog boxes in Arbortext Editor. If you do not
specify a title, the path and file name of the stylesheet display in these dialog
boxes.

Note
Arbortext Editor truncates the path and file name if they exceed 57
characters.

Field Dialog Box

The Field dialog box let you specify the characteristics of one or more Word fields
to be exported with the selected context. Refer to Publishing Word Fields,
Instructions, and Switches on page 663 for information on fields, instructions, and
switches.
The Field dialog box has the following controls:
• Field Name - A list of supported Word fields from which you select the field to
export. Note that certain fields may export values that may replace the context
content.
• Field Description - A summary of the selected field's operation in the exported
document.
• Field Instructions and Switches area - A listing of the instructions and switches
associated with the selected field
○ Use - When checked, the switch or instruction (and associated value) will
be included as part of the exported field. Unchecking an instruction or
switch removes any displayed value and specifies the switch or instruction

960 User's Guide

 is not to be included as part of the exported field. Instructions required to
be exported cannot be unchecked.
○ Type - The switch name or instruction type. Simple switches are single
characters preceded with a backslash. Value switches are single characters
preceded with a backslash followed by Instructions of the following types:
STRING, BOOKMARK, FILENAME, VARIABLE NAME, EXPRESSION,
INDEXENTRY 1, INDEXENTRY 2, and INDEXENTRY 3.
○ Value - The switch or instruction value. Press F2 to edit an instruction
value directly. Choose Edit Value to use the Generated Text Editor to edit
the value. Using either method to delete the entire value will uncheck the
switch or instruction.
○ Description - A summary of the switch or instruction.
• Value - The value of the selected instruction or switch.
• Edit Value - Opens the Generated Text Editor with which you can insert text,
graphics, symbols, and so on before the context content.
• Delete Field - Removes all field exporting related to the selected context.
• OK - Closes the dialog box, committing any field changes.
• Cancel - Closes the dialog box without committing any field changes.
• Help - Displays this help topic.

Final Page Number Dialog Box

The Final Page Number dialog box displays if you select Insert ▶ Final Page
Number when creating generated text for a header or footer object.
The dialog box allows you to define the scope of the final page number
calculation you wish to use, when implementing Page x of y numbering.
The Final Page Number dialog box contains the following options:
• Document - select this option if you want to use the number of the final page
of the whole document
• Division - select this option if you want to use the final page number of a
division or divisions. The Division field contains the following lists, which are
only enabled when the Division option is selected:
○ Available divisions: lists all division elements configured for the stylesheet
that do not appear in the Selected divisions list. Recursive divisions are
shown, for example if the section element is styled to three levels you
will see the contexts section, section in section, and section
in section in section in the list. Use the Add button to select
divisions.

Arbortext Styler Dialog Boxes 961

 ○ Selected divisions: lists those division elements that have been chosen to
scope final page numbering for the header or footer. The final page
number in the header or footer will restart at 1 whenever an element listed
in this field is encountered, provided they share the same header/footer and
page set.
Ensure that you select divisions that are set to start a new page set, and
where the end of the division is not followed by other content on the same
page. If the content of a page that uses a header or footer that inserts the
final page number of one or more divisions is not part of the referenced
divisions, a question mark character (?) will be inserted for the final page
number and an error message displayed. For example:
[A30216] WARNING: Ignoring reference to scoped time-independent
variable "finalfoliostr.tiv_scope1 that occurs outside of all
scoping elements

Find Explicit Properties Dialog Box

This dialog box opens when you choose Edit ▶ Find Explicit Properties in
Arbortext Styler. It can also be invoked via the CTRL+SHIFT+F keyboard
shortcut. Use this dialog box to specify a property and value and execute a search
for all objects in the stylesheet that have that property and value set explicitly.
Note the following about explicit properties:
• An explicit property is one that is set directly for the object, not applied via
property set. Explicit properties can be set in a property set but applied
property sets do not produce explicit properties.
• When a property is explicitly set its label is bold and blue.
• Default property values are not explicit.
• Derived property values are not explicit.
The Find Explicit Properties dialog box contains the following options:
• Category - a list of property categories in Arbortext Styler. Select one to list
the properties from that category in the Property field.
• Property - a list of the properties from the category selected in the Category
field. Select the required property from the drop down list.
• Assigned any value: select this option to find all occurrences where the
property is set, regardless of the value.
• Equals: select this option to search for a single value of the property. The field
will provide the same controls as the property offers in the Arbortext Styler
UI, for you to select from the available values for the property.

962 User's Guide

 Note
Property values that are calculated via XPath expression (for example the
Start At property value for a page number) will not be available for search.
You will be able to search for instances where the property is set, but not
for the actual value.

• List results in - confirm if the results should be shown in a single or in multiple

windows.
○ Most recent results window: list the results of this search in the same
window
○ Open a new results window: list the results of this search in a new window
Clicking Find once you have specified the property will open the Find Explicit
Properties Results dialog box, which displays a list of the occurrences of the
property in the current stylesheet.

Find Explicit Properties Results Window

This window opens when you click Find in the Find Explicit Properties dialog box
in Arbortext Styler, where you specify a property and value whose occurrences
you want to list. This dialog box displays the results of the search.
The Find Explicit Properties Results window has as its title the property and value
specified in the Find Explicit Properties dialog box. The main area of the window
displays a list of occurrences of the specified property in the current stylesheet,
and gives information in a set of columns. The columns are of two types:
• Information about the property - will always be displayed in this dialog box:
○ Name - the name of the object in the stylesheet that has the property
explicitly set, with an icon to indicate its type.
○ Output - the output for which the property is set.
○ Value - the value of the property found.
• Information about the object that has the property explicitly set - columns may
be hidden or displayed according to your particular preference, via the
Configure Columns dialog box:

○ Source Edits
○ Precedence Category
○ Module
○ Comment

Arbortext Styler Dialog Boxes 963

 These columns correspond to those available in the object list views in the
main Arbortext Styler window.
The window also contains a number of controls for navigating and updating the
list:
• Go To - opens the list view tab that contains the object selected in the Find
Explicit Properties Results list and places cursor focus on the property to allow
you to edit it. You can also execute this action by pressing the ENTER key,
double clicking on the object in the list or right clicking on the object in the
list and selecting Go To from the shortcut menu.
• Display - opens the list view tab that contains the object selected in the Find
Explicit Properties Results list and displays it in the list. Cursor focus remains
on the entry in the Find Explicit Properties Results list. With this option you
can choose to find subsequent results from the list without having to
continually return to the results list. You can also execute this action by
clicking on the spacebar or right clicking on the object in the list and selecting
Display from the shortcut menu.
• Refresh - updates the Find Explicit Properties Results list by rerunning the
original search and adding new objects that meet the search criteria, and
removing those objects that do not match, or that have been deleted.

Find Where Used Dialog Box

This dialog box opens when you choose Edit ▶ Find Where Used in Arbortext
Styler. It can also be invoked with the CTRL+F keyboard shortcut. Use this dialog
box to select the object whose uses in the current stylesheet you wish to list.
The Find Where Used dialog box contains the following options:
• Find what - a field in which you can select some options that will assist you in
identifying the object:
○ Category - a drop down list from which you can select the type of object
for which Arbortext Styler should search.
○ Name - a combo box that displays all objects in the stylesheet that are of
the type you selected in the Category field. You may also enter a name of
your choice if you wish to list the occurrences of an undefined reference.
• List results in - confirm if the results should be shown in a single or in multiple
windows.
○ Most recent results window: list the results of this search in the same
window
○ Open a new results window: list the results of this search in a new window.

964 User's Guide

Clicking Find once you have made a selection will open the Find Where Used
Results dialog box, which displays a list of the uses of the selected object in the
current stylesheet.

Find Where Used Results Window

This window opens when you click OK in the Find Where Used dialog box in
Arbortext Styler, in which you select a particular object whose uses you wish to
list. This window displays the results of the requested search.
You can maintain multiple lists of results from the same session if you select the
Open a new results window option when requesting consecutive searches in the
Find Where Used dialog box.
An object is presented as a result of a Find Where Used search if any of the
following are true:
• It references the object specified in the find criteria
• It is the object defined in the find criteria
• It contains generated text that contains an instance of the object defined in the
find criteria
The Find Where Used Results window has as its title the object category and name
selected in the Find Where Used dialog box. The main area of the window displays
a list of uses of the selected object in the current stylesheet, and gives information
about the object and its use in a set of columns. The columns are of two types:
those that are pertinent to the use of the object and therefore must always be
displayed in this window and those that provide information about the object
itself. The columns that fall in the latter category may be hidden or displayed
according to your particular preference, via the Configure Columns dialog box.
• The columns that cannot be hidden are:
○ Name - the name of the use of the object in the stylesheet: an element
context or condition, the page set(s) in which the object is referenced, the
element to which the property set has been assigned, etc.
○ Location - a description of the object's use in the stylesheet
○ Output - the output for which the object use is applicable. This column is
blank if the object is not applied to any type of output.
• The columns whose display can be toggled are (note that these columns
correspond to those available in the object list views in the main Arbortext
Styler window):
○ Source Edits
○ Precedence Category
○ Module

Arbortext Styler Dialog Boxes 965

 ○ Comment
The window also contains a number of controls via which you can navigate and
update the list:
• Go To - opens the list tab that contains the object selected in the Find Where
Used Results list and places cursor focus on the object in that list to allow you
to edit it. Note that this action can also be executed by pressing the ENTER
key, double clicking on the object in the list or right clicking on the object in
the list and selecting Go To from the shortcut menu.
• Display - opens the list tab that contains the object selected in the Find Where
Used Results list and displays it in the list. Cursor focus remains on the entry
in the Find Where Used Results list. With this option you can elect to find
subsequent results from the list without having to continually return to the
results list. Note that this action can also be executed by clicking on the
spacebar or right clicking on the object in the list and selecting Display from
the shortcut menu.
• Refresh - updates the Find Where Used Results list by rerunning the original
search and adding new objects that meet the search criteria, and removing
those objects that do not match, or that have been deleted.

Footnote Number Dialog Box

This dialog box displays if you select a numbered footnote area context (i.e. a
context that has the prefix (Footnote Area Properties) appended to its
name) from the Elements list, and then select the Details button next to the
Numbers and Bullets field in the Generated text category for the context. Use this
dialog box to specify how you would like footnote numbers to appear in your
document.
The Footnote Number dialog box contains the following options:
• Number format - Displays the element’s number in red text, based on the
numbering style selected in the Style field in the Footnotes dialog box. If you
want to display punctuation (non-alphanumeric) characters before and after
the number, add them into this field.
• XPath override for current level - Allows you to enter an XPath expression to
determine the number or maker for the current level, rather than it being
judged automatically based on content.
Click the Edit button to access the dialog box in which you can enter your
expression.
• Edit - Invokes the Edit XPath Override for Current Level dialog box, in which
you can enter or edit an XPath expression.

966 User's Guide

• Delete - Removes the expression from the Edit XPath Override for Current
Level field, thus reverting to content based level calculation for the division.
The button is only accessible if an XPath expression has been entered in the
field.
• Font - Invokes the Modify Font dialog box, allowing you to format the
appearance of the numbering.
• Alignment - Defines how numbers align relative to other footnote numbers.
For example, if you select Left alignment and you have footnotes numbered 1
through 10, the 1 in both numbers align. If you select Right alignment, the 0 in
the number 10 aligns with the 1.
• Align at - Specifies the position at which left or right alignment of the number
occurs, relative to the left margin. See the note at the end of this dialog
description for input options.
• Follow number with - Specifies the amount of space between the footnote
number and the content that follows. The available options are:
○ Single Space: adds a single, non-breaking space
○ Em-Space: adds an em-space
○ Tab: adds the amount of space specified in the Tab to field
○ No Space: places the footnote text immediately adjacent to the number
• Tab to - Specifies the position at which footnote content starts after the
footnote number, used when the Follow number with field is set to Tab. See the
note at the end of this description for input options.
• Indent following lines - Specifies the amount by which to indent text on
following lines if the footnote text wraps to the next line(s). To left align the
text on the first and following lines, specify the same value in this field as you
specify in the Tab to field. See the note at the end of this description for input
options.
• Preview - Provides a dynamic graphical representation of the settings made in
this dialog box.

Arbortext Styler Dialog Boxes 967

 Note
The Align at, Tab to, and Indent following lines fields of this dialog box allow
you to either type an arbitrary size in the field or choose a defined size by
selecting from the list of Size objects configured for your stylesheet. For the
latter option, click the Select Size button next to the field for which you
wish to set the measurement and select the name of the required Size object
from the resulting list. Once you have selected a Size object the measurement
it defines will be displayed wrapped in angle brackets (< > characters) in the
relevant field. For example, the Size object InchSize defines a measurement of
1.00in:

Footnotes Dialog Box

This dialog box displays when you select Tools ▶ Format Footnotes. Use this
dialog box to specify the global formatting properties for footnotes generated by
your stylesheet.
The Footnotes dialog box contains the following options:
• Width - Specifies horizontal size of the footnotes. The options are:

○ Column: place footnotes in columns if a page is arranged over multiple

columns
○ Page: footnotes will always be displayed across the entire width of the
page
• Style - Specifies the numbering style. The available options are:

○ 1, 2, 3,...
○ ①, ②, ③... (circled decimal numbering scheme, implemented to support
the Zenkaku numeric numbering scheme)
○ ۱, ۲, ۳... (Arabic-indic numbering scheme)
○ ۱, ۲, ۳... (Urdu)
○ ๑ , ๒ , ๓... (Thai)
○ a, b, c,...

968 User's Guide

 ○ A, B, C,...
○ i, ii, iii,...
○ I, II, III,...
○ あ, い, う... (Japanese - hiragana numbering scheme)
○ ァ,ィ,ゥ... (Japanese - katakana numbering scheme)
○ い, ろ, は... (Japanese - hiragana-iroha numbering scheme)
○ イ, ロ, ハ... (Japanese - katakana-iroha numbering scheme)
○ ㄱ, ㄴ, ㄷ... (Korean - hangul-consonant numbering scheme)
○ 가, 나, 다 ... (Korean - hangul numbering scheme)
○ 一, 二, 三... (Chinese - simp-chinese-informal numbering scheme,
implemented to support the Kanji numeric 1 numbering scheme)
○ 子, 丑, 寅... (CJK earthly-branch numbering scheme)
○ 甲, 乙, 丙... (CJK heavenly-stem numbering scheme)
• Available contexts - Provides a list of contexts you can select to restart
footnote numbering. The list contains all contexts of elements that are one of
the following styles:
○ Block
○ Division
○ Document
○ Formal Block
Note that contexts defined using a specific occurrence or an XPath expression
are not included in this list - only elements, contexts, and recursive division
contexts such as section in section.
Highlight a context and use the Add button to add that context to the list of
Contexts that restart footnote numbering. The contexts you select should not
be able to occur inside of each other.
• Contexts that restart footnote numbering - Determines which contexts in your
document restart footnote numbering. This enables you to scope footnote
numbering based on the elements in your document. If no contexts are added
to this list, footnote numbering is continuous throughout the document. Use
the Remove button to remove contexts from the list.
• Space above footnote - Indicates the minimum amount of space to leave
between the top of the first footnote and the bottom of the body text on the
page. See the note at the end of this description for input options. The amount
of space applied to the page could be greater than the value set here,
depending on the size of the content on the page and the value set for the Line
spacing option in the Spacing category for the footnote context.

Arbortext Styler Dialog Boxes 969

 Note
If you have assigned a separator for your footnotes by checking the Insert
separator option in this dialog box, and set a value in the Space below
separator field, that space forms part of the space above the footnote. You
must ensure that the value of the Space above footnote field takes this into
account.

• Insert separator - Determines whether a separator rule is drawn before your

footnotes. If you do not enable this option, the remaining controls in the
Separator Rule section of the dialog box, which define the appearance and
position of the separator rule, are not available.
• Rule Length - Indicates the width of the separator rules. There are two options
available:
○ Column or page width: the rule will fit into the page's columns if the page
is set to break into columns, or will span the entire page if not columns
have been defined.
○ Specified length: the rule will take the width of the value set in the Amount
field. See the note at the end of this description for input options for the
Amount field.
• Rule thickness - Indicates the thickness of the separator rule. See the note at
the end of this description for input options.
• Space below separator - Indicates the space to leave below the separator rule,
before the next footnote starts. Enter a value that is less than or equal to the
amount in the Space above footnote field plus the Rule thickness. See the note
at the end of this description for input options.
• Left indent - Indicates the position of the separator rule relative to the left
margin. See the note at the end of this description for input options.
• Right indent - Indicates the position of the separator rule relative to the right
margin. See the note at the end of this description for input options.
• Alignment - Indicates whether the separator rule should be aligned to the Left
or the Right, or be Centered.

970 User's Guide

 Note
The Space above footnote, Amount, Rule thickness, Space below separator,
Left indent, Right indent, and Alignment fields of this dialog box allow you to
either type an arbitrary size in the field or choose a defined size by selecting
from the list of Size objects configured for your stylesheet. For the latter
option, click the Select Size button next to the field for which you wish
to set the measurement and select the name of the required Size object from
the resulting list. Once you have selected a Size object the measurement it
defines will be displayed wrapped in angle brackets (< > characters) in the
relevant field. For example, the Size object InchSize defines a measurement of
1.00in:

Formal Block Title Number Dialog Box

This dialog box displays if you select a context or condition for the title of a
formal block from the Elements list, define it as a numbered block by selecting the
Number option in the Generated text category, then click the Details button to
format the number.
The Formal Block Title Number dialog box contains the options described below.
Note that some number position properties have no effect in chunked HTML
outputs (EPUB, HTML Help, and Web). Refer to Differences in Output Support
on page 1084 for information. This is also the case with HTML File output, unless
it is configured to format titles as tables. This setting is made in the HTML tab of
the Stylesheet Properties dialog box. Please refer to Stylesheet Properties —
HTML File on page 1033 for information.
• Number format - Displays the element’s number (in red text) based on the style
selected in the Number style field.
If you require punctuation (non-alphanumeric) characters before or after the
number, or before or after the previous level number indicated, for example,
#.1 or (1), enter it in this field. Note that if you enter punctuation here it will
appear both in the title itself and in any references to the title. If you do not
want the punctuation to appear in references to the title, for example in cross
references, enter it in the Suffix (does not appear in references) field instead.

Arbortext Styler Dialog Boxes 971

 This field displays a number character (#) if Arbortext Styler is unable to
detect a number for the previous element when one has been requested in the
Previous level number field.
• Start at - invokes the Start At dialog box, in which you can define the number
at which the numbering should start.
• Number style - Specifies the numbering style.

The available options are:

○ (none): Do not display the number.
Selecting this option enables you to perform operations such as having an
automatically generated label for the element that can be cross referenced,
or cross referencing the element, without having to display the number.
○ 1, 2, 3,...
○ A, B, C,...
○ a, b, c,...
○ I, II, III,...
○ i, ii, iii,...
○ 01, 02, 03,...
○ 001, 002, 003,...
○ 0001, 0002, 0003,...
Choosing one of the last three styles causes the number to be padded on
the left by two, three, or four spaces respectively. If you have entered an
XPath expression in the XPath override for current level option that returns
a string, this option is disabled.
○ ①, ②, ③... (circled decimal numbering scheme, implemented to support
the Zenkaku numeric numbering scheme)
○ ァ,ィ,ゥ... (Japanese - katakana numbering scheme)
○ イ, ロ, ハ... (Japanese - katakana-iroha numbering scheme)
○ あ, い, う... (Japanese - hiragana numbering scheme)
○ い, ろ, は... (Japanese - hiragana-iroha numbering scheme)
○ 一, 二, 三... (Chinese - simp-chinese-informal numbering scheme,
implemented to support the Kanji numeric 1 numbering scheme)
○ 子, 丑, 寅... (CJK earthly-branch numbering scheme)
○ 甲, 乙, 丙... (CJK heavenly-stem numbering scheme)
○ 가, 나, 다 ... (Korean - hangul numbering scheme)
○ ㄱ, ㄴ, ㄷ... (Korean - hangul-consonant numbering scheme)

972 User's Guide

 ○ ๑ , ๒ , ๓... (Thai)
○ ۱, ۲, ۳... (Arabic-indic numbering scheme)
○ ۱, ۲, ۳... (Urdu)
• Restart - Launches the Numbering Restart dialog box, in which you can
specify the element at which to restart numbering. The available options are:
○ (Parent): number the first occurrence of the current formal block title in its
parent division element as 1, and continue numbering the current formal
block titles in sequence until a new parent division level starts.
○ (No Restart): continue numbering whenever the formal block title appears
and regardless of the parent or division element to which it belongs.
○ Select a specific element from the list supplied: the list contains all
element contexts styled as Division, Block, or Document that are permitted
as ancestors of the current title's division.
If you have entered an XPath expression in the XPath override for current level
field, this option is disabled.
• Previous level number - Specifies the element in the previous division level
whose number should be shown before the number of the current element, if
compound numbering is required for the current level. The following options
are available (note that the list does not include the formal block that is the
parent of the current title context):
○ (None): use the current element's number only, do not provide compound
numbering
○ (Previous): use the number of the parent element of the formal block and
its title
○ Select a specific element from the list supplied: the list contains all
numbered elements that are valid ancestors of the formal block whose title
is being styled

Note
Publishing errors will occur if you choose the second or third option and
the previous element is not numbered.

The Number format field will display a number character (#) if Arbortext
Styler is unable to detect a number for the previous element as set here.
• Insert En-dash - Inserts an en-dash at the cursor position in the Number format
field.

Arbortext Styler Dialog Boxes 973

• Label: Allows you to enter a text string to be displayed before the number in
the title, for example Chapter.
• Advanced Edit - Opens a Generated Text Editor window, in which you can set
the position of the label with reference to the number. You may also configure
translation settings for the label. Refer to Maintaining Translations of
Generated Text on page 528 for further information on how to translate
content.
By default, the label is placed before the number. These may be swapped
round either in this dialog or in the resulting translation.
You are not permitted to delete the number or add text to both sides of the
number. In addition, no font or spacing controls are provided in this instance
of the generated text editor. Set the font using the Font button in the number
dialog.
• XPath override for current level - Allows you to enter an XPath expression to
determine the number or maker for the current level, rather than it being
judged automatically based on content.
Click the Edit button to access the dialog box in which you can enter your
expression.
• Edit - Invokes the Edit XPath Override for Current Level dialog box, in which
you can enter or edit an XPath expression.
• Delete - Removes the expression from the Edit XPath Override for Current
Level field, thus reverting to content based level calculation for the formal
block. The button is only accessible if an XPath expression has been entered in
the field.
• Custom counter - Specifies the counting sequence to which this element
belongs. The available options are:
○ (new): Invoke the New Custom Counter dialog box, in which you can create
a new counting sequence.
○ (none): Do not include this element in any counting sequence
○ custom counter name: Select an existing counting sequence, within which
this element should be included. Note that multiple elements can be
included in a single counting sequence - if other elements are included in
the selected sequence the element names will be displayed in the Counted
with field.
• Keep number at beginning of line - Determines whether the number is placed at
the beginning of the line. This option is checked by default. When this box is
not checked, the number is still automatically placed at the beginning of the
line (see the entry for the generated text for the title in the Before-text field in
the Generated text category for the title element). You can subsequently click

974 User's Guide

 Edit for the generated text field to add content, or other information, before the
number using the Generated Text Editor.
The Alignment and Follow number with controls are not available when this
option is deselected. The Font button is also not available, but you can use the
Format menu in the Generated Text Editor to modify the number's font.
• Font - Invokes the Modify Font dialog box, allowing you to format the
appearance of the numbering.
Note that this button is disabled if the Keep number at beginning of line option
is unchecked, for example if you are numbering an inline element. If you wish
to apply font settings, use one of the following options:
1. In the Generated Text Editor, choose the Format ▶ Touchup ▶ Font menu
option. You will be presented with the Modify Font dialog box
To invoke the Generated Text Editor, navigate to the Generated text
category for the numbered element, and click the Edit button next to the
Before-text field.
2. In the document, wrap the numbered in a User Formatting Element (UFE)
and make the required font setting for the UFE.
• Alignment - Defines how numbers align relative to other formal block title
numbers. For example, if you select Left alignment and you have formal
blocks numbered 1 through 10, the 1 in both numbers align. If you select Right
alignment, the 0 in the number 10 aligns with the 1.
• Align at - Specifies the position at which left or right alignment of the number
occurs, relative to the left margin. See the note at the end of this description
for input options.
• Suffix (does not appear in references) - Defines punctuation that appears after
the number in the title being styled, but does not appear in references to that
title, for example cross references or table of contents entries.
• Follow number and suffix with - Specifies the amount of space between the
number and the title content that follows. The available options are:
○ Single Space: adds a single, non-breaking space
○ Em-Space: adds an em-space
○ Tab: adds the amount of space specified in the Tab to field
○ No Space: places the title text immediately adjacent to the number
• Tab to - Specifies the position at which title content starts after the title
number, used when the Follow number with field is set to Tab. See the note at
the end of this description for input options.

Arbortext Styler Dialog Boxes 975

 Note that a setting made in this field will have different results in the various
output formats, if the label of the title (the number plus any suffix) is longer
than the Tab to value allowed:
○ FOSI outputs: the text of the title immediately follows the extra long label,
with no intervening space. The long label pushes the title body text
forward as required.
○ XSL-FO outputs: the text of the title starts where it is meant to start (at the
position identified by the Tab to value) even if the label is extra long. The
title text will overwrite the label.
○ HTML outputs (when the stylesheet property Format titles as tables is
selected): the table column for the title body is determined by the value set
in the Tab to field, thus setting the right side of the title label field. If the
title label doesn't fit in the given field it will break, if possible. Any label
text that still does not fit into the field will not be visible in the browser.
Note that, for chunked HTML outputs (EPUB, HTML Help, and Web),
titles are never output as tables. In these instances any Tab to value is
ignored and a single space will be output after the label, regardless of the
size of the label.
○ RTF: output: similar to the effect seen for FOSI outputs except that a space
is included between the label and the start of the title body text.
• Indent following lines - Specifies the amount by which to indent text on
following lines if the title text wraps to the next line(s). See the note at the end
of this description for input options. To left align the text on the first and
following lines, specify the same value in this field as you specify in the Tab to
field.
• Preview - Provides a dynamic graphical representation of the settings made in
this dialog box.
• Counted with - Provides a list of other elements in the stylesheet that are
included in the same counting sequence as the element being styled. Note that
the window only appears if the Custom counter field has a value other than
(none).

976 User's Guide

 Note
The Align at, Tab to, and Indent following lines fields of this dialog box allow
you to either type an arbitrary size in the field or choose a defined size by
selecting from the list of Size objects configured for your stylesheet. For the
latter option, click the Select Size button next to the field for which you
wish to set the measurement and select the name of the required Size object
from the resulting list. Once you have selected a Size object the measurement
it defines will be displayed wrapped in angle brackets (< > characters) in the
relevant field. For example, the Size object InchSize defines a measurement of
1.00in:

Generated Cell Dialog Box

The Generated Cell dialog box opens when you click the New or Edit button in the
Generated Cells field in the Cells or Header Cells tabs of the Custom Tables list.
The title of the dialog box will be either New Generated Cell, Edit Generated Cell,
New Generated Header Cell or Edit Generated Header Cell, depending on which
button you used to invoke it. Use the options in this dialog box to create or edit a
generated cell definition or header cell definition for a custom table object.
The Generated Cell dialog box contains the following options:
• Name - a text field in which you can enter a name for your generated cell
definition.
• XPath - a text field in which you can enter the XPath expression that identifies
the document elements to be used as cells in the custom table.
The XPath expression will be evaluated with the current row or header row
element as the context node. If you are generating a header cell and no header
row element has been specified in the Elements category for the custom table
object, the table element will act as the context node.
The results of the XPath expression will be treated as a string. It is not possible
to generate markup within a cell.
If an error in evaluating the XPath expression occurs during publishing, an
empty cell will be created.

Arbortext Styler Dialog Boxes 977

The following conditions must be met when creating a cell generation definition.
If all are not satisfied you will see a warning message when you click OK to exit
the dialog. The dialog will remain open for you to make the necessary corrections.
• Both the name and the XPath expression exist.
• The name is unique within the applicable custom table definition. No other
constraints apply.
• The XPath expression starts with a letter, and consists of letters, digits,
periods, dashes, or underscores. Spaces are not permitted.
• The XPath expression is syntactically valid.

Graphic Details Dialog Box

The Graphic Details dialog box displays when you apply the Graphic style to an
element, via the Edit ▶ Style menu option. It provides the options for you to define
the attributes in the graphic element that set the graphic's display in your
document. You can also access this dialog box by selecting the Edit ▶ Edit Style
Details menu choice to modify the settings for an element that has been assigned
the Graphic style.
When a stylesheet is created, an element mapped as a graphic element in the
.dcf file is mapped to the Graphic style in Arbortext Styler, and its attribute
roles are set based on .dcf settings. Any changes you make to the graphic
settings in Arbortext Styler take precedence over the initial settings in the .dcf
file.
The Graphic Details dialog box contains the following options:
• Make primary graphic element - Indicates that the selected element is always
used as the default graphic element, if you apply the Graphic style to more
than one element. Arbortext Editor inserts the primary graphic element when
users select the Insert ▶ Graphic menu option (note that the set
promptgraphictags preference must be set to off).
• Attributes - Lists the permitted attributes of the selected element, and the role
that is currently set for each element. The role defines the type of control that
the attribute has on the display of the graphic, based on the value set for the
attribute.
• Attribute role - Lists the roles you can apply to a graphic attribute. Each
attribute can have only one role, and each role can apply to only one attribute.
Once you assign a role to an attribute, it is unavailable from the Attribute role
list.
○ Entity name - Identifies the attribute that holds the graphic entity name.
○ File name - Identifies the attribute that holds the graphic path and file
name.

978 User's Guide

 ○ Magnification - Identifies the attribute that supplies the value for the
percent magnification at which the graphic is displayed.
○ Scale to fit - Identifies the attribute whose value turns on the scale-to-fit
feature for the graphic.
○ Scale to fit height - Identifies the attribute that supplies the value for the
height dimension when scaling the graphic.
○ Scale to fit width - Identifies the attribute that supplies the value for the
width dimension when scaling the graphic.
○ Vertical adjust amount - Identifies the attribute that supplies the value for
the vertical offset at which the graphic is displayed.
○ Vertical adjust percent - Identifies the attribute that supplies the percentage
of the height of the graphic to offset vertically when displayed.
○ Horizontal adjust amount - Identifies the attribute that supplies the value
for the horizontal offset at which the graphic is displayed.
○ Horizontal adjust percent- Identifies the attribute that supplies the
percentage of the width of the graphic to offset horizontally when
displayed.
○ View - Identifies the attribute that supplies the view to display for an
intelligent graphic.
An attribute with the View role can also be used to define the number of a
page from a PDF that is to be inserted as a graphic. Refer to Bitmap and
Vector Graphics for information.
○ Other - Indicates that no role has been assigned to the selected attribute.
Select this option to remove an attribute's role. Once you change an
attribute's role to Other, its previous role becomes available from the
Attribute role list.

HTML/PDF Attribute Dialog Box

The HTML/PDF Attribute dialog box opens when you carry out one of the following
actions for elements, contexts, conditions, or property sets:
• Click Add or Edit in the Attributes field of the PDF tags or HTML tag property
categories
In this dialog you can configure attributes and values for the PDF tags and HTML
tags assigned to elements in your source document. The attributes and tags will be
included when the document is published as tagged PDF or semantic HTML
output.

Arbortext Styler Dialog Boxes 979

 Note
Take care when configuring attributes to override values set in normal
composition, e.g.id, class, style, align, lang, rowspan, colspan. Changes to
these may cause unwanted effects in output. For example, if the id attribute is
used as a link target, overriding the value of this attribute could result in
broken links.

The title of the dialog box will be either Add HTML Attribute, Edit HTML Attribute,
Add PDF Attribute, or Edit PDF Attribute, depending on the operation you used to
invoke it.
The HTML/PDF Attribute dialog box contains the following options:
• HTML or PDF attribute - select an attribute from the drop down list, or enter an
attribute name manually.
For HTML attributes, you can enter any valid XML attribute name. Refer to
HTML4 Attributes not Permitted for HTML5 Output on page 981 for a list of
attributes that are not permitted if you are generating HTML5 output.
For PDF attributes, you can manually enter RowSpan, ColSpan, or Lang
• Synchronize with HTML or PDF attribute - check this option to use the value set
as the value for an equivalent attribute in the other tagged output type.
Select the equivalent attribute from the drop down list, or use the suggested
one.
Deselect the option if you don’t plan to generate the other tagged output type
from the same source, or wish to provide a different attribute and value for the
element in the other tagged output.
The table below list the tags that synchronize by default:
Semantic HTML Attribute Tagged PDF Attribute
alt Alt
rowspan RowSpan
colspan ColSpan
title Title
title (for abbr tag) E
lang Lang

• Value - select the method by which to set the attribute value:

○ From attribute: specify the attribute on the element, context, or condition

whose value should be used as the HTML/PDF attribute value. Select an

980 User's Guide

 attribute from the drop down list or manually enter a valid XML attribute
name.
○ From XPath: enter a valid XPath expression that will extract the
information to form the HTML/PDF attribute value.
○ Function: specify an HTML function that will be passed as the value for
event-based attributes such as onclick and onmouseover. Enter the name of
an HTML Function object or select one from the drop down list of objects
in the stylesheet.
For more information, see Custom JavaScript Functions on page 749.
○ Text: enter the attribute value as text.
To unset an attribute in tagged output, choose this option then leave the
field blank to set the value to an empty string.

HTML4 Attributes not Permitted for HTML5 Output

The list below describes those attributes that are not permitted on HTML tags if
you are generating HTML5 output (if the Generate HTML5 option is checked in the
HTML tab of the Stylesheet Properties dialog box):
HTML Attribute Not Permitted for These HTML Tags
align caption, img, table, hr, div, h1—h6, p, col,
colgroup, tbody, td, tfoot, th, thead, tr
bgcolor table, tr, td, th, body
cellpadding table
cellspacing table
char col, colgroup, tbody, td, tfoot, th, thead, tr
charoff col, colgroup, tbody, td, tfoot, th, thead, tr
clear br
frame table
height td, th
rules table
size hr
type li, ol, ul
valign col, colgroup, tbody, td, tfoot, th, thead, tr
width hr, table, td, th, col, colgroup, pre

Arbortext Styler Dialog Boxes 981

HTML/CSS Defects List
This window displays when you select the Tools ▶ List HTML/CSS Defects menu
option. It provides a list of contexts or conditions for which properties for HTML
output have been specified explicitly, rather than via property sets. For the entries
in the list, the listed property setting will not be reflected in HTML or CSS output
if the Create CSS rules for option in the Stylesheet Properties dialog box has the
value Property Sets.
Each entry in the HTML/CSS Defects List window includes information about the
object and its use in a set of columns. The columns are of two types: those that are
pertinent to the use of the object and therefore must always be displayed in this
dialog box, and those that provide information about the object itself. The
columns that fall in the latter category may be hidden or displayed according to
your particular preference, via the Configure Columns dialog box.
• The columns that cannot be hidden are:
○ Name - the name of the use of the object in the stylesheet: an element,
context or condition
○ Location - the type of property that has been specified explicitly, for
example Font size or Space after precedence.
○ Output - the HTML output type for which the property has been set for this
context, condition, or element. The value of this field could also be Base
(All Outputs).

You may order the list by any of these columns, by clicking the column
header.
• The columns whose display can be toggled are (note that these columns
correspond to those available in the object list views in the main Arbortext
Styler window):
○ Precedence Category
○ Module
○ Source Edits
○ Comment
The window also contains a number of controls that you can use to navigate and
update the list:
• Go To - highlights the selected element/context/condition in the Elements list
and places cursor focus on the explicitly set property in the relevant category.
Note that you can also execute this action by pressing the ENTER key, double

982 User's Guide

 clicking on the property in the list or right clicking on the property in the list
and selecting Go To from the shortcut menu.
• Display - highlights the selected element/context/condition in the Elements list
and opens the relevant category. Cursor focus remains on the entry in the
HTML/CSS Defects List window. With this option you can elect to find
subsequent results from the list without having to continually return to the
results list. Note that this action can also be executed by clicking on the
spacebar or right clicking on the object in the list and selecting Display from
the shortcut menu.
• Refresh - updates the HTML/CSS Defects List window by rerunning the original
search and adding to the results any new properties that have been set
explicitly, and removing those properties that are included in a property set.

Import Generated Text Translation Dialog

Box
The Import Generated Text Translation dialog box displays if you select Tools ▶
Import Generated Text in Arbortext Styler.
The dialog presents a standard Windows file browser to allow you to search for
XLIFF file(s) (.xlf) that contain the generated text translation(s) you wish to
import into your stylesheet. The file picker allows you to select multiple files.
Click Import to begin the import of the generated text translation(s). Click Cancel
to close the dialog box without importing any translations.

Import Generated Text Translation —

Translation has not Changed
This dialog box may display during import of a translation of generated text. It
contains a message to advise you that a translation unit in the XLIFF file has not
changed since the previous import.
If the translation in the stylesheet is not marked as current, you will be prompted
to confirm if it should be marked as current:
• Click Yes if you do want the existing translation in the stylesheet to be marked
as current.
For example, you may have changed the generated text in the stylesheet since
the XLIFF file was exported, but do not want the translation in the XLIFF file
to be changed.
• Click No or No to All if you do not want the existing translation in the
stylesheet to be marked as current.

Arbortext Styler Dialog Boxes 983

 For example, you may have made a change to the generated text in the
stylesheet, since the XLIFF file was exported, that will subsequently require a
change to the translation.

Import Generated Text Translation —

Translation Identical to Source
This dialog box may display during import of a translation of generated text. It
contains an Arbortext Styler message to advise you that a translation unit in the
XLIFF file has not been translated, and its content remains the same as that of the
equivalent translation unit in the stylesheet. If the translation unit in the stylesheet
is not marked as current, you will be prompted to confirm if it should be marked
as such:
• Click Yes if you do want the translation unit in the stylesheet to be marked as
current.
For example, if you want the content of the translation unit in the stylesheet
and the XLIFF file to remain the same, without translation.
• Click No or No to All if you do not want the translation unit in the stylesheet to
be marked as current.
For example, if the translation unit will be translated later, or if not all
translation units in the file were translated.

Import Generated Text Translation —

Translation Already Current
This dialog box may display during import of a translation of generated text. It
contains an Arbortext Styler message to advise you that a translation unit in the
XLIFF file has been translated, but the corresponding translation unit in the
stylesheet is already marked as current. You will be prompted to confirm if you
wish to continue with the import of this translation unit:
• Click Yes or Yes to All if you do want to import the translation for this
translation unit.
For example, you may have refined the translation since the last import.
• Click No or No to All if you do not want to import the translation for this
translation unit.
For example, after importing the translation, you may have selected for import
the original XLIFF file that was exported.

984 User's Guide

Incompatible Document Types for
Stylesheet Dialog Box
The Incompatible Document Types for Stylesheet dialog box displays to indicate
an error when you attempt to open the same .style stylesheet to style multiple
documents of different document types in the same Arbortext Styler session. The
error will occur if any of the following conditions has not been met in all the
documents:
• Their document type configuration files (.dcf files) have the same values for
the following attributes of the Options element:
○ implyScaleToFit
○ scaleToFitOverridesScale
○ idAttribute - the name of the attribute that is treated as an ID attribute
See Document Type Configuration Files in Arbortext Editor help for further
information about document type configuration files.
• Their case sensitivity setting is the same
If any of the conditions are not met, this dialog box contains an error message that
advises you that the stylesheets are incompatible for sharing, followed by a
confirmation of the condition in which there is an anomaly. Make the necessary
changes in the .dcf file for the document type that is causing the error.
For further information on working with document types, please refer to Elements
and Document Types on page 278.

Index Details Dialog Box

The Index Details dialog box displays when you apply the Index style to an
element, edit the style details of an element already styled as Index, or edit an
index inserted in generated text. It provides the options for you to define the
parameters and format of your index, when it is displayed in your document.
The Index Details dialog box contains the following options:
• Index - Defines the index definition object that will be used to provide the
scope and styling of the index. Select from the list of index definition objects
configured for the stylesheet.
The index definition object controls the scope and formatting of an index
associated with it. It also defines the index terms to be included in the index -
the index will include any index terms associated with the index definition
object.
• Language - Defines the language used to sort the index.

Arbortext Styler Dialog Boxes 985

 Pick an explicit language from the list or select (Document language) to use
the language that has been assessed in the source document for the location the
index is inserted, based on the language settings in the stylesheet. Refer to
Language Settings on page 32 for information on stylesheet language.

Note
The environment variable APTIXLANG has no effect when a .style file
is in use. The language must be set in the .style file. See the Arbortext
Editor online help for more information on APTIXLANG.

• Advanced Parameters (FOSI and XSL-FO only) - Allows you to enter

parameters that can be passed for processing for indexes based on FOSI and
XSL-FO code. The parameters should be entered using the same syntax and
semantics as those used in the equivalent useparam attribute of usetext in a
FOSI document, in Arbortext Editor.

Note
This option is not available for documents created via an PTC APP
template.

• Go to - opens the selected index definition object in the Indexes list.

Index Term (Attribute Model) Details

Dialog Box
The Index Term (Attribute Model) Details dialog box displays when you select the
Index Term (Attribute Model) style for an element. It allows you to define the
attributes of the selected element that should be used to output content for an
index entry. You can also access this dialog box by selecting the Edit ▶ Edit Style
Details menu choice to modify the settings for an element that has been assigned
the Index Term (Attribute Model) style.
The Index Term (Attribute Model) Details dialog box contains the following options:
• Indexes tab - specifies the indexes in which the index term being styled with
this dialog box will be included.
○ Available indexes - a list of the index definition objects configured for the
stylesheet. Select an index object then click Add to specify that the index
term should appear in the indexes formatted by that index object.

986 User's Guide

 ○ Selected indexes - the indexes in which the index term will be included.
Select an index object then click Remove to confirm that the index term
should not appear in indexes formatted by that index object.
• Roles tab - specifies the attributes of the index term element that hold index
entry content, and defines a role for each attribute in an index entry.
○ Available attributes - Lists the permitted attributes of the selected element.
Click Add to specify that the attribute holds index entry content for this
element.
○ Index term attributes - Lists the attributes that have been identified as index
entry content holders, and the role that is currently set for each. The role
defines the level at which the value of the attribute will be output in the
index. Click Remove to confirm that the attribute does not hold index entry
content for this element.
○ Attributes role - Defines the possible roles for an attribute in the index
entry. Check the relevant box to assign the role to the selected attribute -
the role will be deactivated for selection with any other attribute.

Index Term (Element Model) Details

Dialog Box
The Index Term (Element Model) Details dialog box displays when you select the
Index Term (Element Model) style for an element. It allows you to define the
elements that should be used to output content for an index entry. You can also
access this dialog box by selecting the Edit ▶ Edit Style Details menu choice to
modify the settings for an element that has been assigned the Index Term (Element
Model) style.
The Index Term (Element Model) Details dialog box contains the following options:
• Indexes tab - specifies the indexes in which the index term being styled with
this dialog box will be included.
○ Available indexes - a list of the index definition objects configured for the
stylesheet. Select an index object then click Add to specify that the index
term should appear in the indexes formatted by that index object.
○ Selected indexes - the indexes in which the index term will be included.
Select an index object then click Remove to confirm that the index term
should not appear in indexes formatted by that index object.
• Roles tab - specifies the elements that hold index entry content, and defines a
role for each element in an index entry.
○ Available elements - Lists the elements that are permitted to perform a role
in the index term being styled. The list contains child elements of the index

Arbortext Styler Dialog Boxes 987

 term element that are unstyled or styled as Inline or Hidden. The element
being styled is automatically classed as the wrapper element for an index
term. You can also configure the roles of its children in the index term, if
required. This allows you to configure more than one element (plus
children) as index term elements. It also permits a child element to be part
of multiple index models.
Click Add to specify that the element holds index entry content.
○ Index term elements - Lists the elements that have been identified as index
entry content holders, and the role that is currently set for each. The role
defines the level at which the value of the attribute will be output in the
index.
Click Remove to confirm that the element does not hold index entry
content.
○ Element role - Defines the possible roles for an element within the index
term. To set a role for an element, highlight the element in the Index term
elements list, then select a role from the Element role list. Once you have
assigned a role to an element, that role will be deactivated for selection
with another element.
○ Name of optional 'sort as' attribute - Allows you select an attribute of the
element given the Level 1 term role to use as a sorting attribute. The index
entry will be included under a heading other than the one determined by
default alphabetic sorting by the first letter of the entry. For example, see
the sample index below, which contains two entries:
<index>
<indexterm>
<primary>Taylor</primary>
<secondary>Justine</secondary>
</indexterm>
<indexterm>
<primary>Taylor</primary>
<secondary>Simon</secondary>
</indexterm>
</index>
With default alphabetic sorting these two entries will be placed under the
same character headings in the index, i.e. “T”, as their primary terms both
start with the same letter. However, if you select the sortas attribute as an
option for sorting in the Name of optional 'sort as' attribute field, you can
add a sortas attribute to each of the primary index terms in the document,
to allow them to be placed in other groups:
<index>

988 User's Guide

 <indexterm>
<primary sortas="J">Taylor</primary>
<secondary>Justine</secondary>
</indexterm>
<indexterm>
<primary sortas="S">Taylor</primary>
<secondary>Simon</secondary>
</indexterm>
</index>
Now the first index entry will appear in the “J” group in the index, while
the second entry will be grouped under “S”.
Note that you can use any of the attributes permitted for the level 1
indexterm element for sorting, and the index entry will be grouped under
the character heading representing the first letter of the sorting attribute's
value.

Index Term (Nesting Element Model)

Details Dialog Box
The Index Term (Nesting Element Model) Details dialog box displays when you
select the Index Term (Nesting Element Model) style for an element. It allows you
to define the elements that should be used to output content for a nested index
entry. You can also access this dialog box by selecting the Edit ▶ Edit Style Details
menu choice to modify the settings for an element that has been assigned the
Index Term (Nesting Element Model) style.
The Index Term (Nesting Element Model) Details dialog box contains the following
options:
• Indexes tab - specifies the indexes in which the index term being styled with
this dialog box will be included.
○ Available indexes - a list of the index definition objects configured for the
stylesheet. Select an index object then click Add to specify that the index
term should appear in the indexes formatted by that index object.
○ Selected indexes - the indexes in which the index term will be included.
Select an index object then click Remove to confirm that the index term
should not appear in indexes formatted by that index object.
• Roles tab - specifies the elements that hold index entry content, and defines a
role for each element in an index entry.
○ Available elements - Lists the elements that are permitted to perform a role
in the index term being styled. The list contains child elements of the index

Arbortext Styler Dialog Boxes 989

 term element that are unstyled or styled as Inline or Hidden. The element
being styled is automatically classed as the wrapper element (index term
role). You can also configure the roles of its children in the index term, if
required. This allows more than one element to be an index term, and each
index term element to designate the elements that will perform other roles.
It also permits and element that’s not the index term to be part of multiple
index models.
Click Add to specify that the element holds index entry content.
○ Index term elements - Lists the elements that have been identified as index
entry content holders, and the role that is currently set for each. The role
defines the level at which the content of the element will be output in the
index.
Click Remove to confirm that the element does not hold index entry
content.
○ Element role - Defines the possible roles for an element within the index
term. To set a role for an element, highlight the element in the Index term
elements list, then select a role from the Element role list. Once you have
assigned a role to an element, that role will be deactivated for selection
with another element.

Insert Attribute Content Dialog Box

This dialog box displays when you select Insert ▶ Attribute Content in the
Generated Text Editor for an element or a cross reference object. It allows you to
specify an attribute from the current document whose value should be inserted
into the generated text.
The Insert Attribute Content dialog box contains the following options:
• Element selection - Defines the element in the document that contains the
required attribute. Once you have defined the element that contains the
required attribute here, select the attribute itself from the list contained in the
Attribute to insert field.

The dialog box contains the following selection options:

○ Current Element - The element whose generated text you are setting
○ Nearest Ancestor - An ancestor of the current element. Arbortext Styler
will locate the context of this ancestor element that is closest in location to
the current element and use its attribute content. Select the element name
in the Name field. If the specified element is the same as the element that
contains the generated text, then Arbortext Styler inserts the attribute value
for that element.

990 User's Guide

 ○ By name and occurrence-within-ancestor - A specific occurrence of an
element within a particular ancestor.
◆ Name - The element for which Arbortext Styler should search. You can
select an element from the list or type in the element’s name.

Note
If you enter the name of a namespaced element in this field, you
will not be prompted to declare the namespace if it does not already
exist. Ensure you have declared the namespace for the stylesheet
by creating an element with the applicable prefix, or the element
selection you enter in this field will not be valid.

◆ Occurrence - The occurrence of the selected element in its ancestor.

◆ Within - The ancestor element within which the selected element
occurs.
○ If ID matches IDREF - The element that contains an ID attribute whose
value matches the value of the IDREF attribute on the element whose
generated text you are setting.
◆ Name of IDREF attribute on xxx element (where xxx is the name of the
element whose generated text you are setting) - the attribute on the
element whose generated text you are setting
Note that this occurrence option is only enabled if the element whose
generated text you are setting has an IDREF attribute, and will only match
elements that have an ID attribute.
○ By XPath - The element matched by an XPath expression
◆ Expression - the XPath expression that will match the required
element. Note that the expression must result in a node-set of element
nodes.

Arbortext Styler Dialog Boxes 991

 Note
If you enter the name of a namespaced element in this field, you
will not be prompted to declare the namespace if it does not already
exist. Ensure you have declared the namespace for the stylesheet
by creating an element with the applicable prefix, or the XPath
expression you enter in this field will not be valid.

• Attribute to insert - Specifies the attribute of the selected element whose value
should be extracted and inserted into generated text.
Note that if the specified element does not have a value assigned to the
specified attribute, Arbortext Styler inserts an empty string.
The following example illustrates how Within and Occurrence work. Suppose you
have the following markup in your document:
<Section>
<Author surname="..."/>
<SectInfoRef/>
</Section
and you want the SectInfoRef element to generate text based on the value of
the surname attribute of the Author element. To accomplish this you would set
the following options in the Insert Attribute Content dialog box, accessed from the
Generated Text Editor, for the SectInfoRef element:
• Select By name and occurrence-within-ancestor
• Name: Author
• Occurrence: 1st
• Within: section
• Attribute to insert: surname
This tells Arbortext Styler to insert the value of the surname attribute of the first
Author element that occurs anywhere inside the Section element that contains
the SectInfoRef element.
On the other hand, if your document contained the following markup shown
below, while it would still work to set Within to Section, it would not work to
set Within to SectInfo, because SectInfo is not an ancestor of
SectInfoRef.
<Section>
<SectInfo>
<Author surname="..."/>
</SectInfo>
<SectInfoRef/>
</Section>

992 User's Guide

Insert Attribute Content Dialog Box
(Headers and Footers)
This dialog box displays when you select Insert ▶ Attribute Content in the
Generated Text Editor for Header and Footer objects. It allows you to specify an
attribute from the current document whose value should be inserted into the
generated text for the header or footer object.
The Insert Attribute Content dialog box contains the following options:
• Element selection - Defines the element in the document that contains the
required attribute. Once you have defined the element that contains the
required attribute here, select the attribute itself from the list contained in the
Attribute to insert field.

○ By name and occurrence - A specific occurrence of an element within the

current document:
◆ Name - The element for which Arbortext Styler should search. You can
select an element from the list or type in the element’s name.

Note
If you enter the name of a namespaced element in this field, you
will not be prompted to declare the namespace if it does not already
exist. Ensure you have declared the namespace for the stylesheet
by creating an element with the applicable prefix, or the element
selection you enter in this field will not be valid

◆ First started on page - The first occurrence of the named element that
occurs on the page or, if there are no occurrences of the element on the
page, the most recent occurrence of the element on a previous page.
◆ Last started on page - The last occurrence of the named element that
occurs on the page, or, if there are no occurrences of the element on the
page, the most recent occurrence of the element on a previous page.
◆ Specific occurrence within document - A specific occurrence of the
named element within the whole document.
○ By XPath - The element matched by an XPath expression.
◆ Expression - the XPath expression that will match the required
element. Note that the expression must result in a node-set of element
nodes.
The XPath expression must start navigation from the root of the
document. There is no way for it to start somewhere relative to the

Arbortext Styler Dialog Boxes 993

 content on the current page, or relative to content in the header.
Generally this means the expression should start with a slash, i.e. /.

Note
If you enter the name of a namespaced element in this field, you
will not be prompted to declare the namespace if it does not already
exist. Ensure you have declared the namespace for the stylesheet
by creating an element with the applicable prefix, or the XPath
expression you enter in this field will not be valid.

• Attribute to insert - Specifies the attribute of the selected element whose value
should be extracted and inserted into generated text.
Select the menu option View ▶ Generated Text ▶ Show in Arbortext Editor to have
your generated text displayed when you preview the document in Editor view.

Note
Insertion of attribute content into the AttributeModifier construct in
generated text is not supported. You will see this error message:
[A61092] Element "_gte:AttributeContentPage" cannot be within "_gte:AttributeModifier".

Insert Cross Reference Dialog Box

This dialog box displays when you select Insert ▶ Cross Reference in the
Generated Text Editor for an element. Use it to insert a cross-reference object to
form generated text for the selected element.

Note
The Insert ▶ Cross Reference command will not be available if the element
selected in the Elements list does not have an IDREF or IDREFS attribute.

The Insert Cross Reference dialog box contains the following options:

994 User's Guide

• Cross reference format - Provides a list of available cross reference objects
configured for the stylesheet
• Reference attribute - Provides a list of available IDREF or IDREFS attributes
for the element selected in the Elements list. Choose the attribute that will be
used to reference another element by ID.
Select the menu option View ▶ Generated Text ▶ Show in Arbortext Editor to have
your generated text displayed when you preview the document in Arbortext Editor
view.

Insert Element Content Dialog Box

This dialog box displays when you select Insert ▶ Element Content in the
Generated Text Editor for an element or a cross reference object. It allows you to
insert the content of the current element, or another element, in the generated text
for an element.
Please note that when you insert element content, all attributes of copied elements
are also copied, including any ID attribute with an assigned value. You may need
to make further changes to your document if the copied or copy element is to be
used as the target of a cross reference, to avoid the ambiguity introduced by the
presence of multiple elements with the same ID attribute value.
The Insert Element Content dialog box contains the following options:
• Element selection - Defines the element in the document whose content should
be inserted. Once you have defined the element, select the type of content to
be extracted from the options contained in the Insert field.
The dialog box contains the following selection options:
○ Current Element - The element whose generated text you are setting
○ By name and occurrence-within-ancestor - A specific occurrence of an
element within a particular ancestor.
◆ Name - The element for which Arbortext Styler should search. You can
select an element from the list or type in the element’s name.

Note
If you enter the name of a namespaced element in this field, you
will not be prompted to declare the namespace if it does not already
exist. Ensure you have declared the namespace for the stylesheet
by creating an element with the applicable prefix, or the element
selection you enter in this field will not be valid

Arbortext Styler Dialog Boxes 995

 ◆ Occurrence - The occurrence of the selected element in its ancestor.
Select All to insert the content of all occurrences of the named
element that occur within the element specified in the Within field.
If the Only content radio button is selected in the Insert group, the
combined content from all occurrences is inserted inline, and each
piece is wrapped by a Styler Formatting Element
(_sfe:CollectionItem), contexts of which can be formatted to
include separators to place each piece of content in a legible list.
For example, suppose you include three occurrences of a
productname element in a document based on the XML DocBook
doctype (for example the sample document Arbortext-path/
samples/styler/transport.xml) as shown below:
<productname>XML DocBook doctype</productname>
<productname>Arbortext Editor</productname>
<productname>Arbortext Styler</productname>

It is possible, using the All option, to output a list of these product

names in a single line, for example as the title of a formalpara
element. Set the generated text for the title in formalpara
context to insert All occurrences of the productname element from
within the relevant element. Preview the document for print and you
will see that the title of the formalpara element contains the list
XML Docbook doctype, Arbortext Editor, and Arbortext Styler as its
generated text. If you examine the SFE _sfe:CollectionItem
you will see that there are four contexts for that element, each dealing
with a specific position of an entry in a collection: first, not
first or last, last and everywhere else. Since we have
three entries in our list we need to examine the first, not first
or last and last contexts - look at the generated text for each one:
? first (deals with the first element in the list, in this case
XMLDocbook doctype): no generated text
? not first or last (deals with entries that are neither the first
not the last ones in the list, in this case Arbortext Editor, the second
entry): set to insert a comma before element content
? last (deals with the last entry in the list, in this case Arbortext
Styler): set to insert a comma and the text “and” before element
content
You can see that these SFEs have been set to construct a coherent list
out of a set of entries extracted from the document content.

996 User's Guide

 If the Element and content radio button is selected in the Insert group,
the _sfe:CollectionItem UFE does not wrap the items, since
there are already elements to separate them.
◆ Within - The ancestor element within which the selected element
occurs.
○ If ID matches IDREF - The element that contains an ID attribute whose
value matches the value of the IDREF attribute on the element whose
generated text you are setting. Note that this option is not available when
you are creating generated text for a cross reference object.
◆ Name of IDREF attribute on xxx element (where xxx is the name of the
element whose generated text you are setting) - the attribute on the
element whose generated text you are setting
Note that this occurrence option is only enabled if the element whose
generated text you are setting has an IDREF attribute, and will only match
elements that have an ID attribute.
○ By XPath - The element matched by an XPath expression
◆ Expression - the XPath expression that will match the required
element. Note that the expression must result in a node-set of element
nodes.

Note
If you enter the name of a namespaced element in this field, you
will not be prompted to declare the namespace if it does not already
exist. Ensure you have declared the namespace for the stylesheet
by creating an element with the applicable prefix, or the XPath
expression you enter in this field will not be valid

• Insert - Determines what type of content to insert in the generated text. The
options are:
○ Only content: all the content of the element, including markup, but not the
element itself.
○ Element and content: inserts both the element and its content.
The inserted content and/or element (and any child elements they include) will
be formatted via normal Arbortext Styler rules. It may be desirable to create a
special context for the element if you want it to be formatted differently when
it appears in this generated text. For example, if the element <x> inserts
element <y> and its content, you might want to create a context for y

Arbortext Styler Dialog Boxes 997

 anwhere in x to control how element <y>'s contents will format when used
in <x>'s generated text.
The following example illustrates how Within and Occurrence work. Suppose you
have the following markup in your document:
<Section>
<Author>...</Author>
<SectInfoRef/>
</Section>
and you want the SectInfoRef element to generate information including the
content of the Author element. You would carry out the following steps to
enable this:
• Select By name and occurrence-within-ancestor
• Name: Author
• Occurrence: 1st
• Within: Section
This tells Arbortext Styler to insert the content of the first Author element that
occurs anywhere inside the Section element that contains the SectInfoRef
element. Note that the example would work just as well if the SectInfoRef
occurred before the Author element.
On the other hand, assume you had the following markup:
<Section>
<SectInfo>
<Author>...</Author>
</SectInfo>
<SectInfoRef/>
</Section>
While it would still work to set Within to Section, it would not work to set
Within to SectInfo, because SectInfo is not an ancestor of SectInfoRef.
Select the menu option View ▶ Generated Text ▶ Show in Arbortext Editor to have
your generated text displayed when you preview the document in Arbortext Editor
view.

Insert Element Content Dialog Box

(Headers and Footers)
This dialog box displays when you select Insert ▶ Element Content in the
Generated Text Editor for Header and Footer objects. It allows you to specify that
the content of the specified element should be used as generated text in the header
or footer object.

998 User's Guide

Please note that when you insert element content, all attributes of copied elements
are also copied, including any ID attribute with an assigned value. You may need
to make further changes to your document if the copied or copy element is to be
used as the target of a cross reference, to avoid the ambiguity introduced by the
presence of multiple elements with the same ID attribute value.
The Insert Element Content dialog box contains the following options:
• Element selection - Defines the element in the document whose content should
be inserted. Once you have defined the element, select the type of content to
be extracted from the options contained in the Insert field.
The dialog box contains the following selection options:
○ By name and occurrence - A specific occurrence of an element within the
current document.
◆ Name - The element for which Arbortext Styler should search. You can
select an element from the list or type in the element’s name.

Note
If you enter the name of a namespaced element in this field, you
will not be prompted to declare the namespace if it does not already
exist. Ensure you have declared the namespace for the stylesheet
by creating an element with the applicable prefix, or the element
selection you enter in this field will not be valid

◆ First started on page - The first occurrence of the named element that
occurs on the page or, if there are no occurrences of the element on the
page, the most recent occurrence of the element on a previous page.
◆ Last started on page - The last occurrence of the named element that
occurs on the page, or, if there are no occurrences of the element on the
page, the most recent occurrence of the element on a previous page.
◆ Specific occurrence within document - A specific occurrence of the
named element within the whole document.
○ By XPath - The element matched by an XPath expression
◆ Expression - the XPath expression that will match the required
element. Note that the expression must result in a node-set of element
nodes.
The XPath expression must start navigation from the root of the
document. There is no way for it to start somewhere relative to the

Arbortext Styler Dialog Boxes 999

 content on the current page, or relative to content in the header.
Generally this means the expression should start with a slash, i.e. /.

Note
If you enter the name of a namespaced element in this field, you
will not be prompted to declare the namespace if it does not already
exist. Ensure you have declared the namespace for the stylesheet
by creating an element with the applicable prefix, or the XPath
expression you enter in this field will not be valid

• Insert - Determines the way in which the selected element's content is

extracted and inserted in the generated text. The options are:
○ Only content: all the content of the element, including markup, but not the
element itself.
○ Element and content: inserts both the element and its content.
The inserted content and/or element (and any child elements they include) will
be formatted via normal Arbortext Styler rules. It may be desirable to create a
special context for the element if you want it to be formatted differently when
it appears in this header/footer. For example, if the element <x> inserts
element <y> and its content, you might want to create a context for y
anwhere in _sfe:HeaderorFooter to control how element <y>'s
contents will format when used in the header/footer.
Select the menu option View ▶ Generated Text ▶ Show in Arbortext Editor to have
your generated text displayed when you preview the document in Editor view.

Note
Insertion of element content into the AttributeModifier construct in
generated text is not supported. You will see this error message:
[A61092] Element "_gte:ElementContentPage" cannot be within "_gte:AttributeModifier".

Insert Index Dialog Box

This dialog box displays when you select Insert ▶ Index in the Generated Text
Editor for an element. It allows you insert an index in generated text.
The Insert Index dialog box contains the following options:
• Language - Defines the language by which to sort the index.

1000 User's Guide

 Note
The environment variable APTIXLANG has no effect when a .style file
is in use. The language must be set in the .style file. See the Arbortext
Editor online help for more information on APTIXLANG.

• Advanced Parameters - Allows you to enter parameters that can be passed for
processing for a FOSI-based index (and, since it also uses FOSI processing
methods, an index based on XSL-FO code). The parameters should be entered
using the same syntax and semantics as those used in the equivalent useparam
attribute of usetext in a FOSI document, in Arbortext Editor.

Note
This option is not available for documents created via an PTC APP
template.

Insert Leaders, Rule or Space Dialog Box

The Insert Leaders, Rule or Space dialog box displays when you select Insert ▶
Leaders, Rule or Space in the Generated Text Editor for an element or for a
header, footer or cross reference object. It allows you to insert fills such as leader
dots, rules, space and character fills in generated text.

Note
Fixed length space and fixed length rules will display in Arbortext Editor but,
otherwise, the properties set in this dialog box are only applicable to Print and
PDF output.

The Insert Leaders, Rule or Space dialog box contains the following controls:
• Type - Allows you to select the type of character fill you require: Space, Rule,
Leader dots, or Leader text.
• Thickness - This field is activated when Type is set to Rule and allows you to
set the thickness of the rule.
• Text - This field is activated when Type is set to Leader text and allows you to
identify the character or characters to be used as leader text. If you choose
more than one character, the fill area will include as many repetitions of the

Arbortext Styler Dialog Boxes 1001

 complete text as possible. This may result in the fill area not being completely
filled since a subset of the text string will not be used.
• Spacing of leader dots and text - This field is activated when Type is set to
Leader dots or Leader text and controls the spacing between leader dots, or
between the leader text repetitions specified in the Text field. The options are
as follows:
○ Normal font spacing: select this option to use default global settings for
spacing
○ Other: select this option if you want to override the default setting and use
a specific amount of space between the fill characters. The specific amount
is the space to allow for each dot, or each repetition of leader text
characters, with the dot or text flushed left in each occurrence.
○ Amount: enter the specific amount of space to apply between fill
characters. If the value is smaller than the width of the dot or the text, it
causes text to overlap, and no warning is issued.
• Length - This field allows you to set the width of the fill area and is active for
all fill types. The options are:
○ Specified: select this option to draw a fill area of a specific width
○ Amount: enter the specific width to which to draw the fill area.
○ Stretch to fit: select this option if you want to set the fill area to stretch so
the content on the line always extends to the margin
○ Minimum: enter the minimum width to which the fill area should always be
drawn. If there is insufficient room in the line to insert the minimum
length, the space, rule, or leaders will start on the following line.
• Formatting - This field allows you to apply additional formatting properties to
the fill characters. The available settings are for:
○ Color: Click the button to open a color palette, within which you can select
a default color or create a custom color.
○ Vertical offset: Enter a measure by which to lift the rule or leaders from the
horizontal text baseline. A positive offset raises the rule or leaders, while a
negative offset lowers them.

Insert Metadata Dialog Box

The Insert Metadata dialog box displays when you select Insert ▶ Advanced ▶
Metadata in the Generated Text Editor for an element. It allows you to enter
metadata types and their associated values in the generated text of a specific
element. The metadata information is then passed to the output document when
the source document is published to PDF or HTML formats:

1002 User's Guide

• PDF: one set of metadata for the whole PDF document is permitted, which
will be displayed in the Document Properties dialog box for the PDF
document. You can view metadata items Title, Author, Subject, and Keywords
in the Description tab, whilst all other items will be retained in the Custom tab.
• HTML: a set of metadata for each HTML chunk is permitted, and will be
visible when accessing the source of the HTML chunk.
The Insert Metadata dialog box contains the following controls:
• Static: choose from a list of standard metadata types or type in one of your
choice. Once you have made your selection here and closed the dialog box by
clicking OK, the Generated Text Editor contains two tags: MetaName and
MetaValue. The MetaName tag contains the name of the metadata type you
entered in the Static field, while the MetaValue field is blank. Type the
required value for the metadata item in this field, or use the menu items from
the Insert menu in the Generated Text Editor to generate the metadata value.
• Dynamic: choose this option to advise that you wish to generate the name of
the metadata type dynamically. Once you have made your selection here and
closed the dialog box by clicking OK, the Generated Text Editor contains two
empty tags, MetaName and MetaValue. In both fields you may either enter
the required information manually, or use the menu items from the Insert menu
in the Generated Text Editor to generate the required value for the metadata
type and its associated value.

Insert Symbol Dialog Box

The Insert Symbol dialog box displays when you make the following selections:
• Selecting Insert ▶ Symbol in the Generated Text Editor for an element or for a
header, footer or cross reference object, in order to insert symbols (glyphs) in
generated text
• Selecting the Insert ▶ Symbol menu option in the Generated Text Editor for the
page number format of a page set
• Selecting the Character button in the Bullet dialog box, in order to specify
bullet characters for lists
The Symbols dialog box contains the following controls (note that the Character
Entities tab is always disabled):

• Font - Lists the fonts available on your workstation. When a font is selected,
all of the symbols available in that font are displayed in the character list.
• Subset - Lists the Unicode subsets for which the selected font contains
symbols. If a selected font does not contain Unicode subsets, this list is not
displayed. When a subset is selected, the cursor moves in the Character list to

Arbortext Styler Dialog Boxes 1003

 highlight the first symbol in that subset. If you select a symbol in the character
list, the Subset list shows the subset that contains the selected symbol.
• Character list - Lists the symbols available in the selected font. When a
symbol is selected in the list, the symbol's Character code and description are
displayed at the bottom of the dialog box.
• Recently Used Symbols - Lists the most recently inserted symbols from the
current session.
• Character Code - The hexadecimal character code and description of the
selected symbol.
• OK/Insert - If you are selecting a symbol to use as a bullet, choosing OK selects
the specified symbol and closes the dialog box.
If you are inserting a symbol in the Generated Text Editor, choosing Insert
adds the selected symbol to your generated text and appends it to the list of
symbols available from the Insert Symbol toolbar button.

Insert Table of Contents Dialog Box

The Insert Table of Contents dialog box displays when you select Insert ▶ Table of
Contents in the Generated Text Editor for an element. It allows you to insert a
table of contents format object into the generated text of a specific element. An
inline table of contents will be output at the location of the host element in the
final output document when it is published.
The Insert Table of Contents dialog box contains the following controls:
• Tables of contents - lists the table of contents format objects configured for the
stylesheet. Choose one from the list to specify that a table of contents based on
this format object should be generated.

Insert XPath String Dialog Box

This dialog box displays when you select Insert ▶ XPath String from the Generated
Text Editor for an element or for a generated content or cross reference object. It
allows you use an XPath expression to extract element or attribute content to be
inserted as generated text.
You may also embed the output of a JavaScript or ACL function as a string in an
element’s generated text. Please refer to Accessing Scripts from Arbortext Styler
on page 746 for further information.
You must understand XPath and its syntax to use this option. Refer to the World
Wide Web Consortium (W3C) web site (www.w3.org/TR/xpath) for information
on the XPath standard.

1004 User's Guide

 Note
It is not necessary to substitute &lt; for <, &amp; for &, or &quote; for ".

The Insert XPath String dialog box contains the following option:
• XPath Expression - Provides a free text field in which you can enter a valid
XPath expression.

Note
You must enter element names as they appear in the Elements list,
including any namespace prefixes.

Avoid using the XPath functions position() or last() since they are not
valid in this context. Some alternatives are given below:
• Instead of position(), use count(preceding-sibling::*)+1
• To test whether an element is the last child of its parent, that is to test
position() = last(), use count(following-sibling::*) = 0
• To test whether an element is the first child of its parent, use
count(preceding-sibling::*) = 0
The use of certain XPath expressions in generated text can cause increased
processing times. Please refer to XPath Performance on page 1078 for information
and suggested alternatives.

Link Details Dialog Box

This dialog box displays when you assign the Link style to an element in the
Elements list. You can also access this dialog box by selecting the Edit ▶ Edit Style
Details menu option if you want to modify the settings for an element that has
already been assigned the Link style.
When a stylesheet is created, an element mapped as a link element in the .dcf
file is mapped to the Link style in Arbortext Styler, and its attribute roles are set
based on .dcf settings. Any changes you make to the link settings in Arbortext
Styler take precedence over the default settings in the .dcf file.
The Link Details dialog box contains the following options:
• Make primary link element - Indicates that the selected element is always used
as the default link element, if you apply the Link style to more than one

Arbortext Styler Dialog Boxes 1005

 element. Arbortext Editor inserts the primary link element when users select
the Insert ▶ Link menu option.
• Web target attribute - When you are specifying that the element should
generate a link to an external source, this field specifies the CDATA attribute
that defines the URL of the link target. If the element does not have any
CDATA attributes, it cannot be a link to a web target.
If the selected element has CDATA attributes, they are listed in the Web target
attribute field. If the element has only one CDATA attribute, it automatically
displays in this field. Choose none if you don't want an attribute to serve as
the web target attribute.
• Document target attribute - When you are specifying that the element should
generate a link to content within the document, this field specifies the CDATA,
IDREF, or IDREFS attribute that defines the ID of the link target. If the
element does not have any CDATA, IDREF, or IDREFS attributes, it cannot
serve as a link to a document target.
If the selected element has CDATA, IDREF, and IDREFS attributes, they are
listed in the Document target attribute field. If the element has only one
IDREF or IDREFS attribute, it automatically displays in this field. Choose
none if you don't want an attribute to serve as the document target attribute.

Link Target Details Dialog Box

This dialog box displays when you assign the Link Target style to an element in
the Elements list. You can also access this dialog box by selecting the Edit ▶ Edit
Style Details menu option if you want to modify the settings for an element that
has already been assigned the Link Target style.
When a stylesheet is created, an element mapped as a link target element in the
.dcf file is mapped to the Link Target style in Arbortext Styler, and its attribute
roles are set based on .dcf settings. Any changes you make to the link target
settings in Arbortext Styler take precedence over the default settings in the .dcf
file.
The Link Target Details dialog box contains the following options:
• Make primary link target element - Indicates that the selected element is always
used as the default link target element, if you apply the Link Target style to
more than one element. Arbortext Editor inserts the primary link target
element when users select the Insert ▶ Link Target menu option.
• ID (name) attribute - Specifies the attribute of the selected element that
contains the target ID for the link.

1006 User's Guide

List Item Number Dialog Box
This dialog box displays if you select a context or condition for a list item from
the Elements list, define it as a numbered list item by selecting the Number option
in the Generated text category, then click the Details button to format the number.
The List Item Number dialog box contains options listed below.
Note that some number style and number position properties may only have the
desired effect in HTML outputs if the selected output is configured to format list
items as tables. This setting is made in the HTML tab of the Stylesheet Properties
dialog box. Please refer to Stylesheet Properties — HTML File on page 1033 for
information.
• Number format - Displays the element’s number (in red text) based on the style
selected in the Number style field.
If you require punctuation (non-alphanumeric) characters before or after the
number, or before or after the previous level number indicated, for example,
#.1 or (1), enter it in this field. Note that if you enter punctuation here it will
appear both in the list item itself and in any references to the list item. If you
do not want the punctuation to appear in references to the list item, for
example in cross references, enter it in the Suffix (does not appear in
references) field instead.

This field displays a number character (#) if Arbortext Styler is unable to

detect a number for the previous element when one has been requested in the
Previous level number field.
• Start at - invokes the Start At dialog box, in which you can define the number
at which the numbering should start.
• Number style - Specifies the numbering style.

The available options are:

○ (none): Do not to display the number.
Selecting this option enables you to perform operations such as having an
automatically generated label for the element that can be cross referenced,
or cross referencing the element, without having to display the number.
○ 1, 2, 3,...
○ A, B, C,...
○ a, b, c,...
○ I, II, III,...
○ i, ii, iii,...
○ 01, 02, 03,...
○ 001, 002, 003,...

Arbortext Styler Dialog Boxes 1007

 ○ 0001, 0002, 0003,...
Choosing one of the last three styles causes the number to be padded on
the left by two, three, or four spaces respectively. If you have entered an
XPath expression in the XPath override for current level option that returns
a string, this option is disabled.
○ ①, ②, ③... (circled decimal numbering scheme, implemented to support
the Zenkaku numeric numbering scheme)
○ ァ,ィ,ゥ... (Japanese - katakana numbering scheme)
○ イ, ロ, ハ... (Japanese - katakana-iroha numbering scheme)
○ あ, い, う... (Japanese - hiragana numbering scheme)
○ い, ろ, は... (Japanese - hiragana-iroha numbering scheme)
○ 一, 二, 三... (Chinese - simp-chinese-informal numbering scheme,
implemented to support the Kanji numeric 1 numbering scheme)
○ 子, 丑, 寅... (CJK earthly-branch numbering scheme)
○ 甲, 乙, 丙... (CJK heavenly-stem numbering scheme)
○ 가, 나, 다 ... (Korean - hangul numbering scheme)
○ ㄱ, ㄴ, ㄷ... (Korean - hangul-consonant numbering scheme)
○ ๑, ๒, ๓... (Thai)
○ ۱, ۲, ۳... (Arabic-indic numbering scheme)
○ ۱, ۲, ۳... (Urdu)
Support for these numbering styles in HTML outputs varies by browser.
Please refer to Numbering List Items on page 474 for a summary of the
differences between browsers.
• Restart - Launches the Numbering Restart dialog box, in which you can
specify the element at which to restart numbering. The available options are:
○ (Parent list element): number the first occurrence of the current
list item in its parent list element as 1, and continue numbering the current
list item items in sequence until a new parent list element starts.
○ (No Restart): continue numbering whenever the list item appears and
regardless of the parent list element to which it belongs.
○ Select a specific element from the list supplied
If you have entered an XPath expression in the XPath override for current level
field, this option is disabled.
• Previous level number - Specifies the element whose number should be shown
before the number of the current element, if compound numbering is required

1008 User's Guide

 for the current level. The following options are available (note that the list
does not include the element being styled):
○ None: use the current element's number only, do not provide compound
numbering
○ Previous: for first level list items, add the number of the direct parent of
the list to which the list item belongs. For non-first level list items, add the
number of the list item at the previous level.
○ Select a specific element from the list supplied - the list contains all
numbered elements that are valid ancestors of the list whose list items are
being styled

Note
Publishing errors will occur if you choose the second or third option and
the previous element is not numbered.

The Number format field will display a number character (#) if Arbortext
Styler is unable to detect a number for the previous element as set here.
• Insert En-dash - Inserts an en-dash at the cursor position in the Number format
field.
• Label: Allows you to enter a text string to be displayed before the number in
the list item, for example Step. To localize the label, use the Advanced Edit
button.
• Advanced Edit - Opens a Generated Text Editor window, in which you can set
the position of the label with reference to the number. You may also configure
translation settings for the label. Refer to Maintaining Translations of
Generated Text on page 528 for further information on how to translate
content.
By default, the label is placed before the number. These may be swapped
round either in this dialog or in the resulting translation.
You are not permitted to delete the number or add text to both sides of the
number. In addition, no font or spacing controls are provided in this instance
of the generated text editor. Set the font using the Font button in the number
dialog.
• XPath override for current level - Allows you to enter an XPath expression to
determine the number or maker for the current level, rather than it being
judged automatically based on content.

Arbortext Styler Dialog Boxes 1009

• Edit - Invokes the Edit XPath Override for Current Level dialog box, in which
you can enter or edit an XPath expression.
• Delete - Removes the expression from the Edit XPath Override for Current
Level field, thus reverting to content based level calculation for the list. The
button is only accessible if an XPath expression has been entered in the field.
• Custom counter - Specifies the counting sequence to which this element
belongs. The available options are:
○ new: Invoke the New Custom Counter dialog box, in which you can create
a new counting sequence
○ none: Do not include this element in any counting sequence
○ Select an existing counting sequence, within which this element should be
included. Note that multiple elements can be included in a single counting
sequence - if other elements are included in the selected sequence the
element names will be displayed in the Counted with field.
• Keep number at beginning of line - Determines whether the number is placed at
the beginning of the line. This option is checked by default. When this box is
not checked, the number is still automatically placed at the beginning of the
line (see the entry for the generated text for the title in the Before-text field in
the Generated text category for the title element). You can subsequently click
Edit for the generated text field to add content, or other information, before the
number using the Generated Text Editor.
The Alignment and Follow number with controls are not available when this
option is deselected. The Font button is also not available, but you can use the
Format menu in the Generated Text Editor to modify the number's font.
• Font - Invokes the Modify Font dialog box, allowing you to format the
appearance of the numbering.
Note that this button is disabled if the Keep number at beginning of line option
is unchecked, for example if you are numbering an inline element. If you wish
to apply font settings, use one of the following options:
1. In the Generated Text Editor, choose the Format ▶ Touchup ▶ Font menu
option. You will be presented with the Modify Font dialog box
To invoke the Generated Text Editor, navigate to the Generated text
category for the numbered element, and click the Edit button next to the
Before-text field.
2. In the document, wrap the numbered in a User Formatting Element (UFE)
and make the required font setting for the UFE.
• Alignment - Defines how numbers align relative to other list item numbers. For
example, if you select Left alignment and you have steps numbered 1

1010 User's Guide

 through 10, the 1 in both numbers align. If you select Right alignment, the 0
in the number 10 aligns with the 1.
• Align at - Specifies the position at which left or right alignment of the number
occurs, relative to the left margin. See the note at the end of this description
for input options.
• Suffix (does not appear in references) - Defines punctuation that appears after
the number in the list item being styled, but does not appear in references to
that list item, for example cross references.
• Follow number and suffix with - Specifies the amount of space between the
number and the list item content that follows. The available options are:
○ Single Space: adds a single, non-breaking space
○ Em-Space: adds an em-space
○ Tab: adds the amount of space specified in the Tab to field
○ No Space: places the list item text immediately adjacent to the number
• Tab to - Specifies the position at which list item content starts after the
number, used when the Follow number with field is set to Tab. See the note at
the end of this description for input options.
Note that a setting in this field will have different results in the various output
formats, if the label of the list item (the number plus any suffix) is longer than
the Tab to value allowed:
○ FOSI outputs: the text of the list item immediately follows the extra long
label, with no intervening space. The long label pushes the list item body
text forward as required.
○ XSL-FO outputs: the text of the list item starts where it is meant to start (at
the position identified by the Tab to value) even if the label is extra long.
The list item text will overwrite the label.
○ HTML outputs (when the stylesheet property Format list items as tables is
selected): the table column for the list item body is determined by the
value set in the Tab to field, thus setting the right side of the list item label
field. If the label doesn't fit in the given field it will break, if possible. Any
label text that still does not fit into the field will not be visible in the
browser.
○ RTF: output: similar to the effect seen for FOSI outputs except that a space
is included between the label and the start of the list item body text.
• Indent following lines - Specifies the amount by which to indent text on
following lines if the list item text wraps to the next line(s). See the note at the
end of this description for input options. To left align the text on the first and

Arbortext Styler Dialog Boxes 1011

 following lines, specify the same value in this field as you specify in the Tab to
field.
• Preview - Provides a dynamic graphical representation of the settings made in
this dialog box.
• Counted with - Provides a list of other elements in the stylesheet that are
included in the same counting sequence as the element being styled. Note that
the window only appears if the Custom counter field has a value other than
(none).

Note
The Align at, Tab to, and Indent following lines fields of this dialog box allow
you to either type an arbitrary size in the field or choose a defined size by
selecting from the list of Size objects configured for your stylesheet. For the
latter option, click the Select Size button next to the field for which you
wish to set the measurement and select the name of the required Size object
from the resulting list. Once you have selected a Size object the measurement
it defines will be displayed wrapped in angle brackets (< > characters) in the
relevant field. For example, the Size object InchSize defines a
measurement of 1.00in:

Modules Dialog Box

The Modules dialog box opens when you select the File ▶ Modules menu option. It
enables you to control the module hierarchy of your stylesheet, by creating new
modules, adding or removing existing modules and changing the position of
modules in the hierarchy.
The Modules dialog box contains the following options:
• Module Hierarchy - Displays the module hierarchy of current stylesheet. The
hierarchy is presented as a tree with the root module at the top of the tree. Any
additional modules in the hierarchy appear as nodes in the tree. You can use
the controls in the tree to open and close module nodes. The title or base
filename of a module also appears in the tree. Read-only modules have a lock
icon over their regular icon and the title text grayed out.

1012 User's Guide

 The position of a node in the module hierarchy determines its precedence in
the hierarchy. Mergeable definitions in nodes higher in the hierarchy override
identically named definitions that are lower in the hierarchy. The following
stylesheet components are considered mergeable definitions:
○ Elements
○ Property sets
○ Page sets
○ Header and footer objects
○ Table of contents format objects
○ Cross reference objects
○ Custom table objects
○ Size definitions
○ Combined font definitions
• New - Opens the New Module dialog box, in which you can create a new
module. The new module is added to the hierarchy as the last child module of
the selected module.
• Add - Opens the Add Module dialog box, where you can add existing .style
files as an additional module to the hierarchy. The module is added to the
hierarchy as the last child module of the selected module.
• Remove - Removes the selected module from the hierarchy. The module is
only removed from the module hierarchy. It is not deleted from the file system.
• Edit - Opens the Edit Module dialog box, where you can edit the name and
description of the selected module.
• Move Up - Enables you to move the selected module up one position in its
level in the hierarchy.
• Move Down - Enables you to move the selected module down one position in
its level in the hierarchy.

Note
You can only reorder modules at the same level in the hierarchy. To move a
module to a different level in the hierarchy, remove the module from the
hierarchy and add it back at the desired level.

Arbortext Styler Dialog Boxes 1013

Move to Module Dialog Box
The Move to Module dialog box opens when you select the File ▶ Move to Module
menu option. It enables you to move the selected stylesheet components to an
existing module in the stylesheet's module hierarchy.
The following stylesheet components are considered mergeable definitions and
can be moved between modules:
• Elements
• Property sets
• Page sets
• Page types
• Page regions
• Generated contents objects
• Table of contents format objects
• Cross reference objects
• Custom table objects
• Size definitions
• Combined font definitions
The Move to Module dialog box contains the following option:
• Move selected definition to - Enables you to select a module in the module
hierarchy of current stylesheet as the target to which to move the selected
definitions. Read-only modules have a lock icon over their regular icon and
the title text grayed out. You cannot move definitions to read-only modules.
The position of a module in the module hierarchy determines its precedence in
the hierarchy. Mergeable definitions in nodes higher in the hierarchy override
identically named definitions that are lower in the hierarchy.

Namespace Declarations Dialog Box

The Namespace Declarations dialog box opens when you select the Tools ▶
Namespace Declarations menu option. It lists the namespace associations that
currently exist for the stylesheet, both the required namespaces and those that
have been added to the stylesheet by the user, via the Add Namespace Declaration
dialog box.

1014 User's Guide

 Note
When the same prefix is used for multiple namespaces (URIs), only one is
displayed in this list.

Some namespaces must be present in all stylesheets, regardless of the document

type, as they are required by Arbortext Styler:
• _acl: java:com.arbortext.epic.Acl
• _dtd: http://www.arbortext.com/namespace/Styler/
UserElements
• _gte: http://www.arbortext.com/namespace/Styler/
GeneratedTextElements
• _js: java:com.arbortext.epic.internal.js.JavaScript
• _sfe: http://www.arbortext.com/namespace/Styler/
StylerFormattingElements
• _ufe: http://www.arbortext.com/namespace/Styler/
UserFormattingElements
• atidlm: http://www.arbortext.com/namespace/atidlm
• ch: http://www.arbortext.com/namespace/chunker
• saxon: http://saxon.sf.net/
• xsi: http://www.w3.org/2001/XMLSchema-instance

New Custom Counter Dialog Box

The New Custom Counter dialog box displays if you select new from the Custom
Counter menu in any of the following dialog boxes:

• Division Title Number dialog box

• Formal Block Title Number dialog box
• List Item Number dialog box
• Number Details dialog box
The dialog box provides a free text field in which you can type the name of a new
counting sequence for your stylesheet. Once you have entered the name and exited
the dialog box, the custom counter will be listed in the Custom Counter menu in
any of the dialog boxes listed above. You may subsequently select the counter for
other numbered elements, which will ensure that all numbered elements
referencing the same counter will be counted together and numbered
consecutively.

Arbortext Styler Dialog Boxes 1015

New Module Dialog Box
The New Module dialog box opens when you select the New button in the Modules
dialog box. It enables you to create a new module in the stylesheet's module
hierarchy. The new module is added to the hierarchy as the last child node of the
selected node and contains no definitions initially.
The New Module dialog box contains the following options:
• Save in - Enables you to select the folder in which you want to store the new
module. Any .style files that currently exist in the selected folder display in
the list below this control. If you select an existing file in this list, the File
name, Title, and Description fields are populated with information from the
selected stylesheet.
• File name - Enables you enter the name of the module or select an existing
.style file from the current folder. If you enter the name of an existing file
in this field, Arbortext Styler asks whether you want to replace the existing
file.
• Save as type - Determines the type of the new file. The only choice available
is a .style file.
• Title - Enables you to provide a short description of the stylesheet module, that
displays in the Elements list, Modules dialog box, and similar locations. If you
do not provide a description, the description of the root module appears
instead.
• Description - Enables you to provide a longer description of the stylesheet
module that displays in a small popup (tooltip) when the cursor hovers over
the module's name in the Elements list, Modules dialog box, and similar
locations.
• Reference using relative path - Enables the reference to the new module to be
encoded in the modularized stylesheet using relative file paths rather than the
full path. The default is to use relative paths.

Note
If you create a new module in the Arbortext-path\custom\
stylermodules directory and leave Reference using relative path checked,
the module reference will work even if you later move the module to another
location on the file system.

1016 User's Guide

New User Formatting Element Dialog Box
The New User Formatting Element dialog box opens when you select Insert ▶ User
Formatting Element ▶ (new) in the Generated Text Editor for an element, a header
or footer object or a cross reference object. Use this dialog box to create a new
User Formatting Element (UFE).
Specify the name of the UFE in the Name field and click OK to complete the
creation.
The UFE will be saved in the Elements list. It will automatically be prefixed with
the _ufe: namespace prefix so you do not need to enter this in the Name field.

No Stylesheet Found Dialog Box

The No Stylesheet Found dialog box displays if you open a document that does
not have an associated Arbortext Styler stylesheet, and whose document type
directory does not contain a default Arbortext Styler stylesheet.
This dialog box contains the following options:
• Select - Opens the Select Stylesheet dialog box, from which you can select an
existing stylesheet.
• None - Lets you edit your document without a stylesheet.

Number Details Dialog Box

This dialog box displays if you select a context or condition for an element other
than a division title, formal block title, footnote, or list item from the Elements
list, define it as a numbered element by selecting the Number option on the
Generated text category, then click the Details button to format the number.
The Number Details dialog box contains the following options:
• Number format - Displays the element’s number (in red text) based on the style
selected in the Number style field.
If you require punctuation (non-alphanumeric) characters before or after the
number, or before or after the previous level number indicated, for example,
#.1 or (1), enter it in this field. Note that if you enter punctuation here it will
appear both in the title itself and in any references to the title. If you do not
want the punctuation to appear in references to the title, for example in cross
references, enter it in the Suffix (does not appear in references) field instead.
This field displays a number character (#) if Arbortext Styler is unable to

Arbortext Styler Dialog Boxes 1017

 detect a number for the previous element when one has been requested in the
Previous level number field.
• Start At - invokes the Start At dialog box, in which you can define the number
at which the numbering should start.
• Number style - Specifies the numbering style.

The available options are:

○ (none): Do not to display the number.
Selecting this option enables you to perform operations such as having an
automatically generated label for the element that can be cross referenced,
or cross referencing the element, without having to display the number.
○ 1, 2, 3,...
○ A, B, C,...
○ a, b, c,...
○ I, II, III,...
○ i, ii, iii,...
○ 01, 02, 03,...
○ 001, 002, 003,...
○ 0001, 0002, 0003,...
Choosing one of the last three styles causes the number to be padded on
the left by two, three, or four spaces respectively. If you have entered an
XPath expression in the XPath override for current level option that returns
a string, this option is disabled.
○ ①, ②, ③... (circled decimal numbering scheme, implemented to support
the Zenkaku numeric numbering scheme)
○ ァ,ィ,ゥ... (Japanese - katakana numbering scheme)
○ イ, ロ, ハ... (Japanese - katakana-iroha numbering scheme)
○ あ, い, う... (Japanese - hiragana numbering scheme)
○ い, ろ, は... (Japanese - hiragana-iroha numbering scheme)
○ 一, 二, 三... (Chinese - simp-chinese-informal numbering scheme,
implemented to support the Kanji numeric 1 numbering scheme)
○ 子, 丑, 寅... (CJK earthly-branch numbering scheme)
○ 甲, 乙, 丙... (CJK heavenly-stem numbering scheme)
○ 가, 나, 다 ... (Korean - hangul numbering scheme)
○ ㄱ, ㄴ, ㄷ... (Korean - hangul-consonant numbering scheme)
○ ๑, ๒, ๓... (Thai)

1018 User's Guide

 ○ ۱, ۲, ۳... (Arabic-indic numbering scheme)
○ ۱, ۲, ۳... (Urdu)
• Restart - Launches the Numbering Restart dialog box, in which you can
specify the element at which to restart numbering. The available options are:
○ Parent: number the first occurrence of the current element in its parent
element as 1, and continue numbering the current element items in
sequence until a new parent element starts.
○ No restart: continue numbering whenever the element appears and
regardless of the parent element to which it belongs.
○ Select a specific element from the list supplied
If you have entered an XPath expression in the XPath override for current level
field, this option is disabled.
• Previous level number - Specifies the element whose number should be shown
before the number of the current element, if compound numbering is required
for the current level. These options are available (note that the list does not
include the element being styled):
○ None: use the current element's number only, do not provide compound
numbering
○ Parent: add the number of the direct parent of the current element in the
document
○ Select a specific element from the list supplied - the list contains all
numbered elements that are valid
○ Enter the identifier of the numbered context that will provide the previous
level numbering

Note
If the context you identify is a list item, include the parent list in the
identifier. This will ensure that the numbering for the element being
styled appears correctly in Editor view and in print output generated by
the FOSI engine. For example:
p in li in ol (or ol/li/p if Options ▶ Show Contexts as XSL is
selected) is valid.
p in li (or li/p) is not valid.

Publishing errors will occur if you choose one of the numbered options and
the previous element is not numbered.

Arbortext Styler Dialog Boxes 1019

 The Number format field will display a number character (#) if Arbortext
Styler is unable to detect a number for the previous element as set here.
• Insert En-dash - Inserts an en-dash at the cursor position in the Number format
field.
• Label: Allows you to enter a text string to be displayed before the number in
the title, for example Chapter .
• Advanced Edit - Opens a Generated Text Editor window, in which you can set
the position of the label with reference to the number. You may also configure
translation settings for the label. Refer to Maintaining Translations of
Generated Text on page 528 for further information on how to translate
content.
By default, the label is placed before the number. These may be swapped
round either in this dialog or in the resulting translation.
You are not permitted to delete the number or add text to both sides of the
number. In addition, no font or spacing controls are provided in this instance
of the generated text editor. Set the font using the Font button in the number
dialog.
• XPath override for current level - Allows you to enter an XPath expression to
determine the number or maker for the current level, rather than it being
judged automatically based on content.
Click the Edit button to access the dialog box in which you can enter your
expression.
• Edit - Invokes the Edit XPath Override for Current Level dialog box, in which
you can enter or edit an XPath expression.
• Delete - Removes the expression from the Edit XPath Override for Current
Level field, thus reverting to content based level calculation for the division.
The button is only accessible if an XPath expression has been entered in the
field.
• Custom counter - Specifies the counting sequence to which this element
belongs. The available options are:
○ new: Invoke the New Custom Counter dialog box, in which you can create
a new counting sequence
○ none: Do not include this element in any counting sequence
○ Select an existing counting sequence, within which this element should be
included. Note that multiple elements can be included in a single counting
sequence - if other elements are included in the selected sequence the
element names will be displayed in the Counted with field.

1020 User's Guide

• Keep number at beginning of line - Determines whether the number is placed at
the beginning of the line. This option is checked by default. When this box is
not checked, the number is still automatically placed at the beginning of the
line (see the entry for the generated text for the element in the Before-text field
on the Generated text category for the element). You can subsequently click
Edit for the generated text field to add content, or other information, before the
number using the Generated Text Editor.
The Alignment and Follow number with controls are not available when this
option is deselected. The Font button is also not available, but you can use the
Format menu in the Generated Text Editor to modify the number's font.
• Font - Invokes the Modify Font dialog box, allowing you to format the
appearance of the numbering.
Note that this button is disabled if the Keep number at beginning of line option
is unchecked, for example if you are numbering an inline element. If you wish
to apply font settings, use one of the following options:
1. In the Generated Text Editor, choose the Format ▶ Touchup ▶ Font menu
option. You will be presented with the Modify Font dialog box
To invoke the Generated Text Editor, navigate to the Generated text
category for the numbered element, and click the Edit button next to the
Before-text field.
2. In the document, wrap the numbered in a User Formatting Element (UFE)
and make the required font setting for the UFE.
• Alignment - Defines how numbers align relative to other element numbers. For
example, if you select Left alignment and you have other elements numbered
1 through 10, the 1 in both numbers align. If you select Right alignment, the
0 in the number 10 aligns with the 1.
• Align at - Specifies the position at which left or right alignment of the number
occurs, relative to the left margin. See the note at the end of this description
for input options.
• Suffix (does not appear in references) - Defines punctuation that appears after
the number in the element being styled, but does not appear in references to
that element, for example cross references or table of contents entries.
• Follow number and suffix with - Specifies the amount of space between the
number and the content that follows. The available options are:
○ Single Space: adds a single, non-breaking space
○ Em-Space: adds an em-space
○ Tab: adds the amount of space specified in the Tab to field

Arbortext Styler Dialog Boxes 1021

 ○ No Space: places the element content immediately adjacent to the
number
• Tab to - Specifies the position at which element content starts after the number,
used when the Follow number with field is set to Tab. See the note at the end
of this description for input options.
Note that a setting made in this field will have different results in the various
output formats, if the label of the element (the number plus any suffix) is
longer than the Tab to value allowed:
○ FOSI outputs: the body text of the element immediately follows the extra
long label, with no intervening space. The long label pushes the element
body text forward as required.
○ XSL-FO outputs: the body text of the element starts where it is meant to
start (at the position identified by the Tab to value) even if the label is extra
long. The element body text will overwrite the label.
○ HTML outputs (when the Format titles as table stylesheet property is
selected): the table column for the element body is determined by the value
set in the Tab to field, thus setting the right side of the element label field.
If the label doesn't fit in the given field it will break, if possible. Any label
text that still does not fit into the field will not be visible in the browser.
○ RTF: output: similar to the effect seen for FOSI outputs except that a space
is included between the label and the start of the element body text.
• Indent following lines - Specifies the amount by which to indent text on
following lines if the element content wraps to the next line(s). To left align
the text on the first and following lines, specify the same value in this field as
you specify in the Tab to field. See the note at the end of this description for
input options.
• Preview - Provides a dynamic graphical representation of the settings made in
this dialog box.
• Counted with - Provides a list of other elements in the stylesheet that are
included in the same counting sequence as the element being styled. Note that
the window only appears if the Custom counter field has a value other than
(none).

1022 User's Guide

 Note
The Align at, Tab to, and Indent following lines fields of this dialog box allow
you to either type an arbitrary size in the field or choose a defined size by
selecting from the list of Size objects configured for your stylesheet. For the
latter option, click the Select Size button next to the field for which you
wish to set the measurement and select the name of the required Size object
from the resulting list. Once you have selected a Size object the measurement
it defines will be displayed wrapped in angle brackets (< > characters) in the
relevant field. For example, the Size object InchSize defines a
measurement of 1.00in:

Numbering Restart Dialog Box

The Numbering Restart dialog box opens when you select Restart from the
Division Title Number, Formal Block Title Number, List Number , or Footnote
Number dialog boxes. The dialog box also appears when you are restarting
numbering on elements that are styled as Block, Inline, Hidden, or Paragraph. It
allows you to select the element that should trigger a numbering restart when it is
encountered in the document.

Note
As a matter of technique, a numbering restart option should only be
configured for an ancestor of the numbered element. The restarted numbering
will then apply for all instances of the numbered element within the scope of
the ancestor element. You may see unpredictable results of you do not follow
this standard.

For division titles, the Numbering Restart at list provides the following choices:

Arbortext Styler Dialog Boxes 1023

• Previous division level – restart at parent level in division, the
default
• No restart - continue numbering, do not restart
• Restart at an ancestor element - the list contains the contexts of all elements
that are permitted as ancestors of the division whose title you are styling.
For formal block titles, the Numbering Restart at list provides the following
choices:
• Parent - restart at parent element
• No restart – continue numbering, the default
• Restart at an ancestor element - the list contains the contexts of all elements
that are permitted as ancestors of the formal block whose title you are styling.
For first-level list items and list item contexts that are not inside list wrapper
elements, the Numbering Restart at list provides the following choices:
• Parent list element – restart at parent list element, the default
• No restart – continue numbering, the default
• Restart at an ancestor element - the list contains the contexts of all elements
that can be ancestors of the parent of the list item you are styling.
For all other styles, the Numbering Restart at list provides the following choices:
• Parent – restart at parent element, the default
• No restart – continue numbering, the default
• Restart at an ancestor element - the list contains the contexts of all elements
that can be ancestors of the element you are styling.

Open Stylesheet Dialog Box

This dialog box displays when you select the Styler ▶ Open Stylesheet menu
option in Arbortext Editor. It lists stylesheets in the document and document type
directories for the current document that can be edited using Arbortext Styler.
This list also includes stylesheets from other directories that were selected for the
document type during the current Arbortext Editor session. Select a stylesheet
from the list to open it for edit.
Use the Add button to locate another stylesheet to add to the list of available
stylesheets.

1024 User's Guide

Paragraph Styles for Nested Lists Dialog
Box
The Paragraph Styles for Nested Lists dialog box lists the valid style names that
can be assigned as exported list styles. Refer to Publishing Lists in RTF Files on
page 687 for information on working with lists.
• Nesting Level - The hierarchy level of the corresponding paragraph style. The
greater the number, the deeper the list in the hierarchy.
• Use RTF Style Name - The name of the list paragraph style.

Paste Properties Dialog Box

The Paste Properties dialog box displays when you select the Edit ▶ Properties ▶
Paste menu option. It enables you to paste the properties of a context, condition,
or property set that are currently stored in a paste buffer (clipboard) to the context,
condition, or property set selected in the Elements list.
The Paste Properties dialog box contains the following options:
• Copy from - Select the output for which you would like to paste properties.
Use CTRL+left click or SHIFT+left click to select multiple properties. By
default, the output types currently stored in the paste buffer are initially
selected in the Paste to field when the dialog box opens.
• Paste to - Select the output for which you would like to replace properties. Use
CTRL+left click or SHIFT+left click to select multiple properties. Note that
you can only select multiple properties in this list if a single property is
selected in the Copy from list.
By default, the output types currently stored in the paste buffer are initially
selected in this field when the dialog box opens. If you are pasting to a
property set, only a single entry will be in the list. If the selected paste target
has existing output properties that are not stored in the paste buffer, this list
indicates whether those properties will be retained.
• Delete properties of unselected uses - Enables you to delete any existing
properties for the paste target that are not stored in the paste buffer or selected
in the Copy from list. This option is unchecked by default.
• Action - Summarizes the expected results of the selected paste operation given
the selections made in the Copy from and Paste to fields.

Arbortext Styler Dialog Boxes 1025

Save As Merged Stylesheet Dialog Box
The Save As Merged Stylesheet dialog box opens when you choose File ▶ Save As
Merged Stylesheet. Note that the menu option is only available if there are
modules in the current stylesheet. Use this dialog box to merge all the stylesheets
in your module hierarchy into a single stylesheet. With this action Arbortext Styler
merges all the modules currently in the stylesheet, deletes duplicate definitions,
and removes all module-related structures. This is like flattening a document or
stylesheet. The merged stylesheet is automatically saved with a .style
extension.
This dialog box contains the following options:
• File name - Specifies the path and file name for the stylesheet. You can edit
this field directly, or use the Browse or Use For buttons to modify it. If you do
not have write permission for the location in which the modularized stylesheet
was previously saved, Arbortext Styler proposes a path that combines the
previous file name with the path to the current document directory.
• Browse - Opens the Save as Merged Stylesheet explorer dialog box, in which
you can navigate to the directory to which to save the merged stylesheet.
• Use for - Opens the Use Stylesheet For dialog box, in which you can elect to
save your stylesheet as the default Arbortext Editor stylesheet for specific
documents. The selection you make in this field determines the path and file
name of the stylesheet.
• Title - Enables you to provide a short description of the stylesheet module that
displays in the Select Stylesheet dialog box, the dialog boxes associated with
the publishing types you select, and similar locations. If you do not provide a
description, the description of the root module appears instead, with the string
(Merged) appended.
• Publishing types - Specifies the output formats for which you can use the
merged stylesheet.

Save Stylesheet As Dialog Box

The Save Stylesheet As dialog box opens when you carry out the following
actions:
• Save a stylesheet for the first time
• Choose Format ▶ Save Stylesheet As in Arbortext Editor
• Choose File ▶ Save As in Arbortext Styler.
If the stylesheet was created with Arbortext Styler, the stylesheet is automatically
saved with a .style extension.

1026 User's Guide

The Save Stylesheet As dialog box contains the following options:

Note
The label is defined in the StyleSheetInfo element for Styler stylesheets
or in the APPConfig element of the APP configuration file.

• File name - Specifies the path and file name for the stylesheet. You can edit
this field directly, or use the Browse or Use For buttons to modify it. If your
stylesheet is being saved for the first time, Arbortext Editor populates this
field with a path and file name that make the stylesheet the default stylesheet
for the document or the current document type.
• Browse - Opens the Save Stylesheet As explorer dialog box, in which you can
navigate to the directory to which to save the stylesheet.
• Use for - Opens the Use Stylesheet For dialog box, in which you can elect to
save your stylesheet as the default Arbortext Editor stylesheet for specific
documents. The selection you make in this field determines the directory
location to which the stylesheet is saved, and its file name.
• Title - Enables you to provide a short description of the stylesheet, that
displays in the Select Stylesheet dialog box, the dialog boxes associated with
the publishing types you select, and similar locations. If you do not provide a
description, the original description of the stylesheet appears instead.
• Publishing types - Specifies the output formats for which you can use the
stylesheet. If you are saving a stylesheet created with Arbortext Styler, the
choices are Print/PDF, EPUB, HTML File, HTML Help, Web, and RTF.
If you are saving a stylesheet that was not created with Arbortext Styler, the
choices are Print/PDF and HTML File.
The stylesheet title or its path and file name display in the stylesheet list in the
dialog boxes associated with the publishing types selected. For example, if
you select Print/PDF, the stylesheet is added to the Preview, Print, and Publish
to PDF File dialog boxes.

Start At Dialog Box

This dialog box displays if you carry out one of the following actions:
• Click the Start At button in any of the following dialog boxes:
○ Division Title Number dialog box
○ Formal Block Title Number dialog box

Arbortext Styler Dialog Boxes 1027

 ○ List Item Number dialog box
○ Number Details dialog box
When you invoke the dialog box using any of these options, its title is Start At.
• Click the Start At button in the Breaks category for an element, activated when
the page numbering field for the page set used by the element is set to Start At
When you invoke the dialog box using this option, its title is Page Number
Start At
The Start At dialog box allows you to define the number other than 1 at which
numbering for titles, list items or other elements, or page numbering, should start.
Note that where the element being styled appears in generated text the start at
value will revert to 1.
A start at value is not available for footnote numbering.
The Start At dialog box contains the following options:
• Fixed value - enter a value at which numbering should start. Values between 0
and 32,000 are permitted: negative values are not.
• Attribute - identify an attribute whose value represents the number at which
numbering should start. If you use this option you must first identify the
element that contains the required attribute, then provide the attribute’s name,
using the following fields:
○ The Element to get attribute from field provides the following options for
attribute selection:
◆ Current element: an attribute defined for the element being styled
◆ Parent: an attribute defined for the direct parent of the element being
styled.
◆ Ancestor: an attribute defined for any element that is a valid ancestor
of the element being styled. A drop down menu provides a list of
applicable elements.
Note that you may also type an element name into this field, even one
that is not a valid ancestor of the current element as it appears in the
current document. This is intentional so that the stylesheet can be
coded to support multiple document types.
○ The Attribute field provides a field in which you can enter the name of the
attribute that contains the required value. If you have selected Current
element or Ancestor in the Element to get attribute from field, this field also
contains a list of valid attributes from which you can select.

1028 User's Guide

 Note
If the start at value is to be obtained from an attribute, you must take steps
to ensure that there is always a suitable value available, or Arbortext Styler
will throw an error when you publish the document. Suggested steps are:
○ Ensure that the attribute is always specified in the document
○ Include a condition for the element being styled which tests if the attribute
has been specified and set the start at numbering within the attribute. Here
the numbering will only be implemented when the attribute is present.

• XPath - enter an XPath expression that can be converted to a number

If you enter an expression that is invalid or cannot be converted to a number,

you will see a warning message such as the one below in the FOSI Generated
Text Messages window when previewing FOSI outputs:
[A31451] ERROR: Invalid XPath expression for number in stylesheet.
[A30283] Cannot convert result to requested type
Element: title.
XPath expression: (invalidexpression).

Note
If you enter the name of a namespaced element in the XPath field, you will
not be prompted to declare the namespace if it does not already exist.
Ensure you have declared the namespace for the stylesheet by creating an
element with the applicable prefix, or the XPath expression you enter in
this field will not be valid

Note that, when setting a page number to start at a particular value, both the type
of page (odd or even) and the selected starting page number are linked. You must
take care to ensure that you also maintain the correct type of page upon which you
wish the numbered section to start, depending on your documentation
requirements. The FOSI, XSL-FO and PTC APP print engines deal with page
numbering and page starting in different ways.
Two settings must be taken into consideration. Firstly, a specified Start At value
will, by definition, be either an odd number or an even number. Secondly, the
position of the page can also be determined by either making an explicit setting of
Odd page or Even page in the Start new field in the Breaks category, or by the
implicit fact that the first page of a document is always an odd page. These two
determining factors can conflict; for example, it is possible to specify that the Start
At value is 4 for the first page of the document.

Arbortext Styler Dialog Boxes 1029

Using the above example, there are two default ways in which this will be
resolved in your document, depending on the print engine used to publish it:
1. XSL-FO - The first page of the document must be odd so page 4, as an even
numbered page, will be the back of the first page. The first page will be blank.
This maintains the fact that the parity of the page number will match the actual
parity of the page, so pages with odd numbers will use the odd page headers
and footers and pages with even numbers will use the even page headers and
footers.
2. FOSI and PTC APP - The page numbered 4 is permitted to be an odd page.
Whilst this avoids the blank initial page, it means that odd numbered pages use
the even page headers and footers and even numbered pages use the odd page
headers and footers.
To avoid this issue being treated in an unsatisfactory way when you publish your
document, ensure that you set the Start At field to a value that is of the correct
parity.

Start of HTML Chunk Test Dialog Box

The Start of HTML Chunk Test dialog box opens when you carry out one of the
following actions in the Condition dialog box while creating a condition for an
element or a table of contents (TOC):
• Choosing the New Chunk Test button
• Highlighting an existing chunk test and choosing Edit
The Start of HTML Chunk Test dialog box contains the following options:
• At start of HTML chunk - select this option to confirm that the test will return
true if the selected element for which you are creating the condition appears at
the start of an HTML chunk.
If you are creating the condition for a single level element or context, for
example xref everywhere, the name of the element will be displayed in
the Element to test field.
If the condition is being created for an element context in a specific ancestor,
for example title in section, the name of both the element and its
ancestor will be displayed in the Element to test field. You have the option to
pick either one to which to apply the start of chunk test. In this instance you
will have two possible tests:
1. Match the section title that appears at the start of a HTML chunk - select
title from the Element to test list
2. Match the title that appears in a section that appears at the start of a HTML
chunk - select section from the Element to test list

1030 User's Guide

 Note that selecting section here will mark the true start of the chunk,
for example if you wish to apply formatting properties such as prespace to
the chunk itself.
• Not at start of HTML chunk - select this option to confirm that the test will
return true if the selected context appears anywhere other than the start of a
HTML chunk. As above, you also have the option to select either the element
or its ancestor to which to apply the test, where applicable.
• Element to test - this field contains details of the context selected in the
Elements list, for which you are creating a condition. Highlight the element to
which you wish to apply the start of chunk test and select either At start of
HTML chunk or Not at start of HTML chunk as applicable.

If you are creating a chunk test for a TOC condition, you will be presented
with two options for the type of element that should be tested, rather than
being able to select specific elements. Choose either Title element or Parent
element to define whether it is the title itself or the parent in which it appears
whose position in the HTML chunk should be tested.

Note
Start of HTML chunk tests should only be created for conditions that are
intended to apply properties in chunked HTML outputs (EPUB, HTML Help,
and Web). Tests of this nature will return a value of false in conditions
specified for Arbortext Editor, print/PDF, HTML File or RTF outputs.

Stylesheet Properties Dialog Box

The Stylesheet Properties dialog box displays when you create a new stylesheet,
or if you select the File ▶ Stylesheet Properties menu option. It allows you to
provide information about the stylesheet and configure certain stylesheet-wide
default properties:
• General - give the stylesheet a title and short description, and assign the
publishing types for which the stylesheet is to be used
See Stylesheet Properties — General on page 1032 for further information.
• Language - configure language settings for your stylesheet.

See Stylesheet Properties — Language on page 1040 for further information.

• HTML File - configure the way in which documents published to single HTML
file output are processed.
See Stylesheet Properties — HTML File on page 1033 for further information.

Arbortext Styler Dialog Boxes 1031

• HTML Chunk - configure the way in which documents published to chunked
HTML outputs are processed.
See Stylesheet Properties — HTML Chunk on page 1037 for further
information.
• Print/PDF - configure print-specific settings for your stylesheet.

See Stylesheet Properties — Print/PDF on page 1042 for further information.

• APP Formatting - configure global spacing and hyphenation settings for your
stylesheet, applicable when generating print/PDF output with the PTC APP
engine.
See Stylesheet Properties — PTC ALD Formatting on page 1044 for further
information.
• Tables - configure global table formatting settings for your stylesheet,
applicable when generating print/PDF output with the PTC APP engine.
See Stylesheet Properties — Tables on page 1047 for further information.
• RTF - configure the publishing of documents to RTF output.

See Stylesheet Properties — RTF on page 1048 for further information.

Note
You must save your stylesheet for changes to stylesheet properties to take
effect.

Stylesheet Properties — General

The General tab of the Stylesheet Properties dialog box provides the following
options:

Note
The label is defined in the StyleSheetInfo element for Styler stylesheets
or in the APPConfig element of the APP configuration file.

• Title - Specifies the title or short description of the stylesheet, which displays
in the Select Stylesheet dialog box and the Print and Publish dialog boxes.
Enter text of your choice here. If you do not specify a title, the default

1032 User's Guide

 description of the stylesheet will remain in this field and will be displayed in
the dialog boxes.
• Description - Enables you to provide a short description of the stylesheet that
displays in a small popup (tooltip) when the cursor hovers over the stylesheet's
name in the Elements list, Modules dialog box, and similar locations.
• Publishing types - Specifies the output formats for which the stylesheet can be
used.
The choices are Print/PDF, EPUB, HTML File, HTML Help, Web, and RTF. The
choice you make here determines the location(s) in which your stylesheet will
be made available for selection. For example, if you select Print/PDF the
stylesheet will be available in the stylesheet lists in the Print Preview, Print,
and Publish to PDF File dialog boxes.

Stylesheet Properties — HTML File

The HTML File tab of the Stylesheet Properties dialog box allows you to configure
the way in which documents published to single HTML file output are processed.
The HTML File tab provides the following options:
• Create CSS rules for: Contains options by which you can specify the objects
for which CSS information should be created. The options are:
○ Contexts and conditions: Each context and condition generates its own
CSS rule. This is the default for existing and new stylesheets.
With this option you will have more precise control over style. You can
adjust formatting for an individual context or condition by making changes
either to the .style file before publishing, or to the CSS file after
publishing.
All property settings made in Arbortext Styler will be incorporated in the
CSS rules, whether they were made in property sets referenced by the
context or condition or set explicitly.
○ Property sets: Each property set in the stylesheet generates a CSS rule.
Elements in the HTML output will reference the CSS rules for the property
sets that were referenced by the context and conditions that generated the
element.
With this option you can generate a CSS file that will support HTML files
of different document types, provided the stylesheets for those document
types use the same property set names. You can maintain a consistent look
for the HTML generated from different document types.

Arbortext Styler Dialog Boxes 1033

 Note
Properties specified explicitly for contexts and conditions will not be
reflected in the HTML output or the CSS rules. A stylesheet validation
invoked via the Tools ▶ Validate Stylesheet menu option will warn you
if any outputs are configured to use the Property Sets method to
generate CSS and there are explicit properties that will not appear in
the HTML/CSS as a result. Use the Tools ▶ List Explicit Properties
menu option to locate the explicit property settings.

• CSS style location: Specifies where CSS style information should be written
on publishing. You can choose In HTML Header or External file.
Refer to Managing CSS Files in HTML Output on page 159 for further
information.
• Generate XHTML: Specifies whether the publishing processing creates HTML
or XHTML files.
This checkbox does not apply for EPUB output, which always consists of
XHTML data.
• Generate HTML5: Specifies whether the publishing processing creates HTML
or HTML5 files.
Selecting both Generate XHTML and Generate HTML5 will output HTML in
XHTML5 format.
The setting for this option has no effect in EPUB output. Arbortext Styler
generates output that conforms to the EPUB 2.0 standard as a default.
• Shrink graphics to fit: Specifies whether graphics that are too large
horizontally for the available space should be scaled down to fit that space. If
the option is not selected, graphics will extend out of the available space if
they are too large.
Shrink-to-fit scaling maintains the height-width ratio of the graphic.
This handling is independent of all other scaling and size related controls
already in place for a graphic. The existing controls will continue to have the
same effect The shrink-to-fit capability is applied after the existing graphics
settings if the graphic is still too large for the available space.

1034 User's Guide

 Note
For graphics inside table cells, it is recommended that you use a traditional
scale-to-fit sizing mechanism for the individual graphic. With just Shrink
graphics to fit set to manage these graphics, you may find that the table
column grows to accommodate the graphic in HTML outputs.

The default setting is No.

This checkbox does not apply for EPUB output. Graphics are always scaled in
this way.
• Generate semantic HTML/XHTML: configure HTML output for accessibility by
providing context for paragraph and title elements.
An element styled as Title will be tagged as one of <h1> — <h6>
(depending on its level in the hierarchy) instead of <div>. <p> tags will be
generated for elements styled as Paragraph.
• Format list items as tables: specifies how list items are formatted in the HTML
output, either as single row tables or as li elements.
This was previously controlled by the
stylerhtmlcomposelistitemastable ACL set option, which
applied to all outputs.
This option is checked as a default in existing and new stylesheets.
You should activate this setting if you wish to:
○ Control the width of the list item marker field, the justification of the
number or bullet, and any punctuation in the list item label. Such explicit
control cannot be observed without presenting the list item in table format.
○ Use specific number or bullet styles, labels and suffixes, or punctuation in
the list item label. If list items are not formatted as tables, support for these
settings varies widely.
Refer to Differences in all HTML outputs in Differences in Output Support
on page 1084 for full information.
With this option checked, the resulting HTML files will be larger and will be
less clearly presented when the HTML is processed by a screen reader such as
JAWS.
• Format titles as tables: Specifies how titles are formatted in the HTML output,
either as single row tables or as div elements.

Arbortext Styler Dialog Boxes 1035

 Checking this option will format titles as tables when necessary to achieve
number or bullet related alignment.
This was previously controlled by the
stylerhtmlcomposetitleastable ACL set option, which applied to
all outputs.
This option is checked as a default in existing and new stylesheets.
You should activate this setting if you wish to:
○ Format a title so that the text on the first line, following a number, aligns
with the text for subsequent lines of the same title.
This alignment is set in the numbering dialog by setting the Follow number
and suffix with field to Tab, and then assigning the same value to the Tab to
and Indent following line fields.
These settings will be observed in HTML output if you set titles to be
formatted as tables.
With this option checked, the resulting HTML files will be larger and will be
less clearly presented when the HTML is processed by a screen reader such as
JAWS.
• Associated JavaScript Libraries: Lists the JavaScript libraries that are
associated with the stylesheet
Use Add to open the Add JavaScript Library dialog box, and specify the path to
the required library
For more information, see Add/Edit JavaScript Library Dialog Box on page
918.
You can add references either to common libraries, such as jQuery or
AngularJS, or to custom libraries developed by your organization.
Use Edit to edit the path of an existing library reference
Use Delete to remove an association with a library

Note
JavaScript libraries cannot be managed from stylesheet modules — they
must be present in the root stylesheet.

A reference to each library listed here will be included in HTML File output
generated from the stylesheet. Libraries are added to output in the order they
are declared in this field.

1036 User's Guide

 For more information, see Associating a JavaScript Library with a Stylesheet
on page 749.

Stylesheet Properties — HTML Chunk

The HTML Chunk tab of the Stylesheet Properties dialog box allows you to
configure the way in which documents published to chunked HTML outputs are
processed.
The HTML Chunk tab provides the following options:
• Create CSS rules for: Contains options by which you can specify the objects
for which CSS information should be created. The options are:
○ Contexts and conditions: Each context and condition generates its own
CSS rule. This is the default for existing and new stylesheets.
With this option you will have more precise control over style. You can
adjust formatting for an individual context or condition by making changes
either to the .style file before publishing, or to the CSS file after
publishing.
All property settings made in Arbortext Styler will be incorporated in the
CSS rules, whether they were made in property sets referenced by the
context or condition or set explicitly.
○ Property sets: Each property set in the stylesheet generates a CSS rule.
Elements in the HTML output will reference the CSS rules for the property
sets that were referenced by the context and conditions that generated the
element.
With this option you can generate a CSS file that will support HTML files
of different document types, provided the stylesheets for those document
types use the same property set names. You can maintain a consistent look
for the HTML generated from different document types.

Arbortext Styler Dialog Boxes 1037

 Note
Properties specified explicitly for contexts and conditions will not be
reflected in the HTML output or the CSS rules. A stylesheet validation
invoked via the Tools ▶ Validate Stylesheet menu option will warn you
if any outputs are configured to use the Property Sets method to
generate CSS and there are explicit properties that will not appear in
the HTML/CSS as a result. Use the Tools ▶ List Explicit Properties
menu option to locate the explicit property settings.

• Generate XHTML: Specifies whether the publishing processing creates HTML

or XHTML files.
This checkbox does not apply for EPUB output, which always consists of
XHTML data.
• Generate HTML5: Specifies whether the publishing processing creates HTML
or HTML5 files.
Selecting both Generate XHTML and Generate HTML5 will output HTML in
XHTML5 format.
The setting for this option has no effect in EPUB output. Arbortext Styler
generates output that conforms to the EPUB 2.0 standard as a default.
• Shrink graphics to fit: Specifies whether graphics that are too large
horizontally for the available space should be scaled down to fit that space. If
the option is not selected, graphics will extend out of the available space if
they are too large.
Shrink-to-fit scaling maintains the height-width ratio of the graphic.
This handling is independent of all other scaling and size related controls
already in place for a graphic. The existing controls will continue to have the
same effect The shrink-to-fit capability is applied after the existing graphics
settings if the graphic is still too large for the available space.

Note
For graphics inside table cells, it is recommended that you use a traditional
scale-to-fit sizing mechanism for the individual graphic. With just Shrink
graphics to fit set to manage these graphics, you may find that the table
column grows to accommodate the graphic in HTML outputs.

The default setting is No.

1038 User's Guide

 This checkbox does not apply for EPUB output. Graphics are always scaled in
this way.
• Generate semantic HTML/XHTML: configure HTML output for accessibility by
providing context for paragraph and title elements.
An element styled as Title will be tagged as one of <h1> — <h6>
(depending on its level in the hierarchy) instead of <div>. <p> tags will be
generated for elements styled as Paragraph.
• Format list items as tables: specifies how list items are formatted in the HTML
output, either as single row tables or as li elements.
This was previously controlled by the
stylerhtmlcomposelistitemastable ACL set option, which
applied to all outputs.
This option is checked as a default in existing and new stylesheets.
You should activate this setting if you wish to:
○ Control the width of the list item marker field, the justification of the
number or bullet, and any punctuation in the list item label. Such explicit
control cannot be observed without presenting the list item in table format.
○ Use specific number or bullet styles, labels and suffixes, or punctuation in
the list item label. If list items are not formatted as tables, support for these
settings varies widely.
Refer to Differences in all HTML outputs in Differences in Output Support
on page 1084 for full information.
With this option checked, the resulting HTML files will be larger and will be
less clearly presented when the HTML is processed by a screen reader such as
JAWS.
• Chunk boundaries: Contains options with which you can define the places at
which a document should be broken when publishing output made up of
chunked HTML data:
○ Element HTML chunking properties - Obey the chunk boundary settings
defined for each element in the document in the HTML Chunking dialog
box that is accessed from the Breaks tab. This option is checked by default
when you create a new stylesheet.
○ DITA topic file boundaries - Use the boundaries of the input files of a DITA
document as chunk boundaries, and derive the filename of those chunks
from the filename of the input files. This option is only enabled in
stylesheets for DITA documents.

Arbortext Styler Dialog Boxes 1039

 Note that it is possible to select both options for a single document - in this
case both boundary types will be used, with an element's HTML chunking
properties taking precedence if a setting of both types exists for the same
element.
• Limit table of contents levels (does not apply to EPUB): Sets the maximum
level to which table of contents entries generated by a table of contents format
object should be extracted and displayed in an online TOC in chunked HTML
output (except EPUB). Select the option to activate the limit and add a level
number to the field, by either typing manually or using the spinner control.
When you check this option, the levels control defaults to a value of 3.
• Associated JavaScript Libraries: Lists the JavaScript libraries that are
associated with the stylesheet
Use Add to open the Add JavaScript Library dialog box, and specify the path to
the required library
You can add references either to common libraries, such as jQuery or
AngularJS, or to custom libraries developed by your organization.
For more information, see Add/Edit JavaScript Library Dialog Box on page
918.
Use Edit to edit the path of an existing library reference
Use Delete to remove an association with a library

Note
JavaScript libraries cannot be managed from stylesheet modules — they
must be present in the root stylesheet.

A reference to each library listed here will be included in chunked HTML

output generated from the stylesheet. Libraries are added to output in the order
they are declared in this field.
For more information, see Associating a JavaScript Library with a Stylesheet
on page 749.

Stylesheet Properties — Language

The Language tab of the Stylesheet Properties dialog box permits you to
configure language settings for your stylesheet. You can display it by invoking the
Stylesheet Properties dialog box and selecting the Language tab, or by choosing
the Tools ▶ Language Properties menu option in Arbortext Styler.
The Language tab provides the following options:

1040 User's Guide

• Document language specification: provides fields for you to configure the
methods of defining language throughout a document.
○ Default language: specifies the default document language of documents
formatted with this stylesheet. Select a language from the drop down list or
enter the language code manually.
When you create a new stylesheet, this value will initially be set to the
language of the current locale of the operating system.
The value set here will be used as a fallback setting if the document
language is not specified within the document scope.
A document’s default document language setting is used when assessing
how the document should be hyphenated, when the Language field for
hyphenation in the Breaks category is set to (Use document language).
○ Language attribute name: the attribute in the document that provides
language information. The attribute specified here will be analyzed on the
nearest ancestor to the current element.
When an Arbortext Styler stylesheet is in use, the value of its Language
attribute name field supersedes the value of the languageAttribute
setting in a document’s DCF file.
• Generated text: specify the languages to be observed when translating
generated text.
○ Source language: specifies the language in which generated text is
authored.
When you create a new stylesheet, this value will initially be set to the
language of the current locale of the operating system.
○ Target languages: specifies the languages for which generated text can be
exported for translation. Translations for these languages can then
subsequently be imported and correctly matched to the source.
◆ Add: open the Add Target Language dialog box on page 921, in which
you can specify a target language.
◆ Delete: delete the selected target language from the stylesheet.
See Removing a Target Language and Associated Translations in
Language Settings for Generated Text Translation on page 529 for the
implications of doing this if your stylesheet includes translations for
that language.
When multiple target languages are specified, the document language of
the input document at the point generated text is inserted determines the
language of the generated text in the output document.

Arbortext Styler Dialog Boxes 1041

 Refer to Converting a Target Language into the Source Language in Language
Settings for Generated Text Translation on page 529 for information on how to
make one of the configured target languages into the source language for
generated text.
Refer to Removing a Target Language and Associated Translations in
Language Settings for Generated Text Translation on page 529 for information
on how to delete target languages when they have current translations.
• Document language mapping: enter aliases for language codes that could be
encountered in the documents formatted via the Arbortext Styler stylesheet.
This option is useful if your documents contain general or non-standard
language codes.
○ Add: open the Document Language Mapping dialog box on page 948, in
which you can create a mapping to one of the provided languages
○ Edit: open the Document Language Mapping dialog box to edit an existing
language mapping
○ Delete: delete the selected language mapping
Initial mappings are provided in new stylesheets to cover some common cases.
Refer to Language Settings on page 32 for further information on the language
settings and language mappings for a stylesheet.

Stylesheet Properties — Print/PDF

The Print/PDF tab of the Stylesheet Properties dialog box permits you to configure
some print-specific settings for your stylesheet.
The Print/PDF tab provides the following options:
• Print Engine: select a default print engine for the stylesheet, to be used when
publishing a document associated with the stylesheet to print or PDF format in
Arbortext Editor, previewing a document in print or PDF format in Arbortext
Styler, or managing edited source for the stylesheet.
The print engine options are:
○ PTC APP: if you select PTC APP as the default print engine, you have the
option to browse for an PTC APP template (.3f file) to associate with the
stylesheet.
Note that this option is always enabled, even if PTC APP is not installed as
part of your PTC Arbortext environment. If you select this option without
PTC APP being available, you will see a warning message. PTC APP is
installed automatically with Arbortext Styler and Arbortext Publishing
Engine.

1042 User's Guide

 This is the default value for new stylesheets, and some distributed
stylesheets.
○ FOSI
○ XSL-FO
For more information, see Print engine on page 1044.

Note
The FOSI and XSL-FO print engines are on sustained support and do not
receive enhancements or maintenance fixes. PTC APP is the recommended
engine for print/PDF output.

• Line break characters: specify the characters at which a line is permitted to

break.
The default characters permitted are \ / - = _
Up to 100 characters are permitted in this field.
This setting applies when the Word breaking property in the Breaks category is
set to Break without hyphen. Words will break after these characters, where
applicable.
• Limit PDF bookmark levels opened initially: control the number of levels of
PDF bookmark that will be open in an output PDF.
Select the option to enable the control, then use the spinner to set the number
of levels.
This option is not available if your stylesheet is set to use XSL-FO as the print
engine.
• Exclude DITA FlattenedMap during formatting: do not duplicate the
FlattenedMap element and its content into the PTC APP DOM.
FlattenedMap is an element of the DITA Resolved Document for Styling
(RDS) that is generally ignored during formatting. It is a different format copy
of the ResolvedMap element in the RDS, which is used to support
formatted output. See Working with the Resolved Document for Styling on
page 623 for more information.
Select this option to optimize formatting when publishing with the PTC APP
engine. Some items in FlattenedMap may cause unwanted effects in PDF
generated with the PTC APP engine. For example, TOC entries are created for
content in the FlattenedMap unless the stylesheet is configured to avoid
this.

Arbortext Styler Dialog Boxes 1043

The following options are available when your stylesheet is set to use PTC APP as
the print engine:
• Generate tagged PDF: Specifies that a publish action with this stylesheet can
generate tagged PDF output. You will have the option to toggle the setting on
and off in the PDF publishing dialog boxes.
• Enforce valid PDF tag structure: Specifies that any PDF tag structure in PDF
output should be validated during publishing. If an invalid tag structure is
detected, errors will be written to the event log. No PDF will be generated.
This option is only available when Generate tagged PDF is selected.
• Shrink graphics to fit: Specifies whether graphics that are too large
horizontally for the available space should be scaled down to fit that space. If
the option is not selected, graphics will extend out of the available space if
they are too large.
Shrink-to-fit scaling maintains the height-width ratio of the graphic.
This handling is independent of all other scaling and size related controls
already in place for the graphic. The existing controls will continue to have
the same effect The shrink-to-fit capability is applied after the existing
graphics settings if the graphic still too large for the available space.
The default setting is Yes.
• Optional PTC APP template to associate with stylesheet: adding an PTC APP
template to your Arbortext Styler stylesheet allows you to supplement the
stylesheet with the code from the template. The stylesheet will then be able to
perform PTC APP tasks not available via the Arbortext Styler interface or
edited source.

Print engine
The print engine setting made in this tab is associated with the stylesheet. It can be
overridden by an explicit option set in the printengineoverride setting.
printengineoverride for Arbortext Editor overrides the print engine
selection settings made in Arbortext Styler. The option can only be set for the
current Arbortext Editor session, by using the set printengineoverride
command line option. The setting cannot be saved as a permanent preference.

Stylesheet Properties — PTC ALD Formatting

The APP Formatting tab of the Stylesheet Properties dialog box permits you to
configure global spacing and hyphenation settings for your stylesheet, applicable
when generating print/PDF output with the PTC APP engine.
The APP Formatting tab provides the following options:

1044 User's Guide

• Vertical Spacing

Available properties
○ Column top baseline: Specifies the measure from the top of the page region
to the baseline of the first line of text when an exact column-top to text-
baseline distance has been specified for a column. This has the effect of
dropping the top of a paragraph.
The default value is 0pt + 75% of leading.
This property sets the fParagraph.topDrop and
fParagraph.autoLeadingAboveMaximumTopDrop JavaScript
properties.
○ Cell top baseline: Works in the same way as Column top baseline, but this
setting is the measure from inside the top padding of the top of the cell to
the baseline of the first line of text within the cell.
The default value is 0pt + 75% of leading.
This property sets the fParagraph.topDropCell and
fParagraph.autoLeadingAboveMaximumTopDropCell
JavaScript properties.
For both of these properties, when % of leading is specified and leading is
defined with em units, the font size of the first character on the line is used.
If any character on the first line would extend above the page region top,
or into the top padding of the cell, the auto-leading feature will lower the
baseline of the first line as much as needed to avoid.
○ Use baseline to baseline leading (also known as professional leading):
Specifies that the measure from the baseline of the previous line to the
baseline of the current line should be calculated using the leading of the
current line.
The default value is true (selected).
When set to true (selected), this property sets the
fFrame.professionalLeading and
fParagraph.autoLeadingBbx JavaScript properties to true.
When set to false (not selected), this property sets the
fParagraph.autoLeading JavaScript property to true.
If the property is not selected, the leading is calculated by taking 25% of
the leading of the previous line (to account for descenders) and adding
75% of the current leading for the ascenders of the current line.

Arbortext Styler Dialog Boxes 1045

 ○ Reset Vertical Spacing Defaults: remove any custom settings made in these
fields.
• Horizontal Spacing

Available properties
○ Word space: Sets the basic amount of space that will be substituted for
every space character when formatting a line. The default value is 0.25em.
The Stretch setting specifies the maximum amount of extra space that can
be added to the basic word spacing when justifying a line.
The default value is 0pt.
The Shrink setting specifies the maximum amount of space that can be
removed from the basic word spacing when justifying a line.
The default value is 0pt.
These properties sets the fStyle.wordSpace,
fStyle.wordSpaceExtra, and fStyle.wordSpaceSquash
JavaScript properties.
○ Letter space: Sets the basic amount of space that will be added to the right
of a letter when formatting a line. The default value is 0pt.
The Stretch setting specifies the maximum amount of extra space that can
be added to the letter spacing when justifying a line
The default value is 0pt.
The Shrink setting specifies the maximum amount of space that can be
removed from the letter spacing when justifying a line
The default value is 0pt.
These properties sets the fStyle.letterSpace,
fStyle.letterSpaceExtra, and
fStyle.letterSpaceSquash JavaScript properties.
○ Reset Horizontal Spacing Defaults: remove any custom settings made in
these fields.

Note
Stretch and Shrink settings only apply when vertical justification is active.

• Hyphenation

Available properties

1046 User's Guide

 ○ Maximum consecutive hyphens: Sets the maximum number of hyphens
that may appear consecutively down the right hand edge of a column. The
default value is 2, with a range between 1–10 permitted.
This property sets the fStyle.hyphenationMaxNum JavaScript
property.
○ Minimum word size to hyphenate: Sets the minimum word size that can be
hyphenated. The default value is 4, with a range between 1–10 permitted.
This property sets the fStyle.hyphenationCharsMin JavaScript
property.
○ Minimum characters before hyphen: Sets the minimum number of
characters from a word that must be left in front of a hyphen. The default
value is 1, with a range between 1–10 permitted.
This property sets the fStyle.hyphenationCharsBefore
JavaScript property.
○ Minimum characters after hyphen: Sets the minimum number of characters
from a word that must be left after the hyphen when a word is hyphenated.
The default value is 1, with a range between 1–10 permitted.
This property sets the fStyle.hyphenationCharsAfter JavaScript
property.
○ Reset Hyphenation Defaults: remove any custom settings made in these
fields.

Stylesheet Properties — Tables

The Tables tab of the Stylesheet Properties dialog box permits you to configure
some global table formatting settings for your stylesheet, applicable when
generating print/PDF output with the PTC APP engine.
The Tables tab provides the following options:
• Use stylesheet settings: Select this option to apply the settings made in this tab
when formatting tables for print/PDF output.
If this option is not selected, tables will be formatted according to the relevant
set commands or environment variables set for your PTC Arbortext
environment.
• Allow rows to break across pages: Specifies whether page breaks are permitted
in table rows
The default value is true.
This setting is controlled by the set deepcontentsplitting option if
stylesheet properties are not being used.

Arbortext Styler Dialog Boxes 1047

• Default rule thickness: Specifies the rule thickness for tables

The default value is 1pt, with a range of 0–100 in any unit permitted.
This setting is controlled by the set tabledefaultrulethickness
option if stylesheet properties are not being used.
• Minimum row height: Specifies the default published height for table rows with
content
The default value is 15pt, with a range of 0–100 in any unit permitted.
This setting is controlled by the set tableminimumrowheight option if
stylesheet properties are not being used.
• Default cell padding: Specifies the default cell margins used for tables in
published output
You can set individual values for Top, Bottom, Left, and Right margins. The
default value for each is 5pt, with a range of 0–100 in any unit permitted.
These settings are controlled by the APTTBLCELLMARGT,
APTTBLCELLMARGB, APTTBLCELLMARGL, and APTTBLCELLMARGR
environment variables if stylesheet properties are not being used.

Stylesheet Properties — RTF

The RTF tab of the Stylesheet Properties dialog box permits you to make some
configuration settings that will apply when you export a document to RTF output.
The RTF tab provides the following options:
• Embed Graphics - When checked, all (RTF-supported) graphics will be
embedded in the RTF file. When unchecked, all graphics files will be exported
as linked graphics using the INCLUDEPICTURE Word field.
• Generate RTF style names automatically - When checked, RTF style names
will be generated for any context in which the user has not explicitly requested
a user-defined style name or no RTF style name. Refer to Publishing RTF
With and Without Using Word Style Names on page 658 for information on
working with style names.
• Use built-in list paragraph styles - When checked, RTF style names will be
generated for list items that use the built-in list paragraph styles (such as List
Bullet, List Bullet 2, List Number, List Number 2, etc.). Style names are
determined by the context’s style and name. Refer to Publishing Lists in RTF
Files on page 687 for information on working with lists.
• Template file - Specifies the path and file name of a Word template file in RTF
format, i.e. a Word template (*.dot file) that has been saved from Word as
an RTF file. The specified RTF template will be used when styling contexts

1048 User's Guide

 exported to RTF when the context is assigned a style name that also is part of
the RTF template. Choose Browse to navigate to a template.
If the selected file can be found on the importexportpath, the fully-
qualified pathname will be truncated when saved to reflect its location relative
to the location initially found on the importexportpath.
This ensures the same process can be followed on the PE server to find the
corresponding instance of the RTF template file on the server (which is
required for proper declaration of the styles).
If no template file is specified, only the Word styles defined in Arbortext-
path\lib\cpix\lib\word-builtin-styles.rtf (or at alternate
CPIX directory location referenced by APTIMPORTEXPORTCPIX) will be
used.
For the .dot file to be available on the reader's (of the exported document)
system, it must be installed in one of the following locations:
○ The Word Templates directory, as defined in Word options.
○ The same directory as the Word file that references the .dot template.
If the .dot file is not important to the recipients of the exported RTF file, the
formatting properties defined by the RTF version of the .dot file will still be
used in the destination file because the formatting properties will be embedded
in the stylesheet section of the RTF file.

Table of Contents Condition Dialog Box

The Table of Contents Condition dialog box displays when you click the Edit
button for the Condition each title must match field in the Customize Table of
Contents dialog box, when creating custom content settings for a table of contents
format object. The dialog box is used to create conditions that must be matched by
each title context defined to be included in any table of contents (TOC) generated
from the object. If a title context matches the condition’s tests, it will be included
in the TOC.
The Table of Contents Condition dialog box contains the following options:
• Condition is true if - Allows you to set the level to which conditions should be
matched:
○ All tests are true - all of the tests created for the condition must be matched
if the condition is to match
○ Any test is true - if any number of the tests created for the condition can be
matched, the condition will match. At least one of the tests must match.

Arbortext Styler Dialog Boxes 1049

 When the condition is matched for a title context, that context will be included
in the TOC.
• Tests - Lists the tests configured for the condition. This field is empty when no
tests have been configured yet. A condition must have at least one test.
• New Attribute Test - Opens the Attribute Test dialog box, in which you can
create a new test for an attribute value.
• New Content Test - Opens the Content Test dialog box, in which you can create
a test for element content.
• New XPath Test - Opens the XPath Test dialog box, in which you can create a
test for an object defined by an XPath expression.
• New Chunk Test - Opens the Start of HTML Chunk Test dialog box, in which
you can create a new start of HTML chunk test.
• Edit - Opens the relevant dialog box for the test selected in the Tests list, in
which you can modify the selected test.
• Delete - Deletes the test selected in the Tests list.

Note
You are not prompted before the test is deleted.

Tables of Contents Details Dialog Box

The Tables of Contents Details dialog box displays when you assign the Table of
Contents style to an element, via the Edit ▶ Style menu option. It is used to assign
a table of contents format to the element selected in the Elements list.
The dialog box provides a list of table of contents format objects configured for
the stylesheet. If you select an object and click OK, a reference to that object will
be included in the generated text for the selected element. Navigate to the
element's Generated text category and refer to the After-text field for details. When
the document is published, a table of contents of the selected format will be
inserted into the document by the element selected in the Elements list.

Table of Contents Format Dialog Box

The Table of Contents Format dialog box displays when you click the Format
button in the Properties area for a table of contents format object. It is used to set
or change the formatting of the selected object.
The Table of Contents Format dialog box contains the following options:

1050 User's Guide

• Indent levels - Indents second and subsequent levels by a certain amount. You
can adjust the indent in the Table of Contents Format Details dialog box,
accessed by clicking the Details button.
• Details - opens the Table of Contents Format Details dialog box, in which you
can change apply specific details for numbering and indenting to the table of
contents.
• Show page numbers - Generates page numbers for the associated table of
content entries. You can accept the default settings for page numbers, or you
can specify new settings for leader dots and aligning page numbers in the
subsequent fields.
This option is selected by default. Note that page numbers, and any settings
made for the display of page numbers, will only be displayed in table of
contents generated in print or PDF outputs.
○ Right align page numbers - This option is available when the Show page
numbers option is selected.

◆ Text right indent - Specifies the amount by which to indent an entry's

text, relative to the right margin. The default setting is 2 picas. This
option can be set to prevent the text in titles extending all the way to
the right margin, i.e. into the area used for page numbers. See the note
at the end of this description for input options.
◆ Minimum space or leaders before page number - Specifies the width of
the fill area that must exist between the entry text and the page number.
When a table of contents entry is formatted, if less space than this
minimum is available the text will be split across lines and the page
number, along with space or leaders, will appear on the last line. See
the note at the end of this description for input options.
◆ Leader dots - Specifies that the fill area between the text and page
number contains leader dots. if this option is not selected, the fill area
will be blank. The leader dot option is available when Right align page
numbers is selected.

? Spacing - Sets the amount of space between individual leader dots.

See the note at the end of this description for input options.
Arbortext Styler will not insert a break before or after a leader dot.
If Arbortext Styler cannot fit in a string of leader dots that is the
minimum length because the table of content entry is too long, it
will break the table of content entry before the last word.
• Arbortext Editor / HTML Preview - Provides a dynamic graphical representation

Arbortext Styler Dialog Boxes 1051

 of the table of contents in Editor view or in HTML output, based on the
settings made in this dialog box.
• Print / PDF Preview - Provides a dynamic graphical representation of the table
of contents in print or PDF output, based on the settings made in this dialog
box.

Note
The Text right indent, Minimum space or leaders before page number, and
Spacing fields of this dialog box allow you to either type an arbitrary size in
the field or choose a defined size by selecting from the list of Size objects
configured for your stylesheet. For the latter option, click the Select Size
button next to the field for which you wish to set the measurement and
select the name of the required Size object from the resulting list. Once you
have selected a Size object the measurement it defines will be displayed
wrapped in angle brackets (< > characters) in the relevant field. For example,
the Size object InchSize defines a measurement of 1.00in:

Table of Contents Format Details Dialog

Box
The Table of Contents Format Details dialog box displays when you click the
Details button in the Table of Contents Format dialog box, accessed when you click
the Format button in the Properties area for a table of contents format object. It
provides options by which you can set indent levels and numbering in the table of
contents.
The Table of Contents Format Details dialog box contains the following options:
• Level to edit - Selects the level for which you wish to set numbering and indent
options.
• Numbered - Specifies that table of contents entries are to be numbered at the
selected level. If this option is selected, the associated Align number, Align at,
Follow number with, Tab to and Indent following lines fields are made available
and can be modified.

1052 User's Guide

 Note that title element whose content makes up the entries on this level must
have its numbering option activated for this option to have any effect. If the
title is not numbered, the first line of the table of contents entry is left-aligned
at the position defined in the Align at field or, if Follow number with is set to
Tab, at the location specified in the Tab to field. Additional lines are aligned at
the location specified in Indent following lines.
○ Include label with number - Specifies whether the numbers for entries in
this level of the table contents include the label specified for the source
division title element in the Division Title Number dialog box, or just the
number. The default is Label plus number.
○ Align number - Specifies whether the entry number is aligned to the Right
or the Left.
○ Align at - Specifies the horizontal position at which the numbers of entries
should be aligned. If the title is not numbered, the first line of the table of
contents entry is left-aligned to the position defined in this field. See the
note at the end of this description for input options.
○ Follow number with - Sets the amount of space that appears between the
title number and the title text in the entry. The available options are:
◆ Single Space: adds a single, non-breaking space (the default)
◆ Em-Space: adds an em-space
◆ Tab: adds the amount of space specified in the Tab to field
◆ No Space: places the title text immediately adjacent to the number
○ Tab to - Specifies the position at which title text starts after the title
number, used when the Follow number with field is set to Tab. See the note
at the end of this description for input options.
○ Indent following lines - Specifies the amount by which to indent following
lines if the first line of the entry content wraps. To align the text in the first
and subsequent lines, set this to the same value as set in the Tab to field.
See the note at the end of this description for input options.
• Not numbered - Specifies that table of contents entries are not to be numbered
at the selected level. If this option is selected, the associated Indent first line,
and Indent following lines fields are made available and can be modified.
○ Indent first line - Sets the amount by which the first line of a table of
contents entry is to be aligned. See the note at the end of this description
for input options.
○ Indent following lines - Sets the amount by which subsequent lines of table
of contents entry are to be aligned, if the entry wraps onto additional lines.
See the note at the end of this description for input options.

Arbortext Styler Dialog Boxes 1053

 Note
The Align at, Tab to, Indent first line, and Indent following lines fields of this
dialog box allow you to either type an arbitrary size in the field or choose a
defined size by selecting from the list of Size objects configured for your
stylesheet. For the latter option, click the Select Size button next to the
field for which you wish to set the measurement and select the name of the
required Size object from the resulting list. Once you have selected a Size
object the measurement it defines will be displayed wrapped in angle brackets
(< > characters) in the relevant field. For example, the Size object InchSize
defines a measurement of 1.00in:

Translation Defects Window

This dialog box displays if you choose Tools ▶ List Translation Defects in
Arbortext Styler. It provides a list of missing or incomplete translations in the
stylesheet, where generated text has been marked for translation.
The window contains the following columns. The columns are of two types: those
that are pertinent to the type of defect found for the translation and therefore must
always be displayed in this dialog box, and those that provide information about
the defect itself. The columns that fall in the latter category may be hidden or
displayed according to your particular preference, via the Configure Columns
dialog box:
• The columns that cannot be hidden are:
○ Name - the name of the object in the stylesheet that displays a translation
defect: an element context or condition, a page set, a Generated Content
object, a Tables of Contents object or a Cross Reference object.
○ Location - a description of the object's location in the stylesheet
○ Output - the output for which the object use is applicable. This column is
blank if the object is not applied to any type of output.
○ Language - the target language in which the defect appears.
○ Defect - the type of defect encountered for the object. The possible values
are Missing or Not current.

1054 User's Guide

 ○ Source - the source language version of the generated text item that
displays the translation defect.
• The columns whose display can be toggled are (note that these columns
correspond to those available in the object list views in the main Arbortext
Styler window):
• Precedence Category
• Module
• Source Edits
• Comments
The window also contains a number of controls with which you can navigate and
update the list:
• Go To - opens the list tab that contains the object selected in the Translation
Defects Window and places cursor focus on the object in that list to allow you
to edit it. Note that this action can also be executed by pressing the ENTER
key, double clicking on the object in the list or right clicking on the object in
the list and selecting Go To from the shortcut menu.
• Display - opens the list tab that contains the object selected in the Translation
Defects Window and displays it in the list. Cursor focus remains on the entry in
the Translation Defects Window. With this option you can elect to find
subsequent results from the list without having to continually return to the
results list. Note that this action can also be executed by clicking on the
spacebar or right clicking on the object in the list and selecting Display from
the shortcut menu.
• Refresh - updates the Translation Defects Window by rerunning the original
search and adding new objects that meet the search criteria, and removing
those objects that do not match, or that have been deleted.

Translation Note Dialog Box

This dialog box displays when you select the Translation ▶ Add Note menu option
(or the Translation ▶ Edit Note option if a translation note already exists) in the
Generated Text Editor for an element or context. It presents a free text field in
which you can enter a note to accompany the translation unit displayed in the
editor. When the stylesheet is subsequently exported, the note will be included in
the XLIFF file within the translation unit’s description. It can then be passed to the
translator to supply additional information.
The title of the dialog box is Add Translation Note or Edit Translate Note,
depending on whether you are creating a new note or accessing an existing one.

Arbortext Styler Dialog Boxes 1055

Unused Definitions Dialog Box
The Unused Definitions dialog box opens when you choose the Tools ▶ List
Unused Definitions menu option. It displays a list of those objects that are
available for use but which have not yet been used or referenced in the current
stylesheet.
As well as the list of unused definitions, the window also contains a number of
controls via which you can navigate and update the list:
• Go To - opens the list tab that contains the object selected in the Unused
Definitions list and places cursor focus on the object in that list to allow you to
edit it, or delete it if you wish to tidy up your stylesheet. The object cannot be
deleted from within the dialog box.
• Display - opens the list tab that contains the object selected in the Unused
Definitions list and displays it in the list. Cursor focus remains on the entry in
the Unused Definitions list. With this option you can elect to find subsequent
results from the list without having to continually return to the results list.
• Refresh - updates the Unused Definitions list by rerunning the original search
and adding new objects whose use has been removed, and removing those
objects that have been referenced somewhere in the stylesheet.
The note at the bottom of the dialog box advises you to take care when deleting a
definition if there is a chance it could appear in a module that is referenced by
another stylesheet. In this case the object may appear in the list since it is not used
by, or referenced from, the current stylesheet.

Note
For element definitions, unused User Formatting Elements (UFE) are shown
in the Unused Definitions window, whereas unused Styler Formatting
Elements (SFE) are not. SFEs should never be deleted and as such are not
displayed in this list. UFEs, however, are displayed if they are not referenced
and there are no instances of the UFE in any gentext.

Column display for this dialog box follows the same rules as that for the Find
Where Used Results Window on page 965

Use Exported FOSI For Dialog Box

The Use Exported FOSI for dialog box opens when you choose the Use for button
in the Export FOSI Stylesheet dialog box. Use the options in this dialog box to
export your FOSI to a location that will ensure Arbortext Editor uses it as the
default Arbortext Editor stylesheet for certain types of document

1056 User's Guide

 Note
You can override this setting for a specific individual document by associating
a stylesheet with the document - see Associating a stylesheet with your
document in Arbortext Editor help for information.

The Use FOSI for dialog box contains the following options:
• Document - Arbortext Editor will automatically use this stylesheet to display
this document in Arbortext Editor in future sessions. An export instigated with
this option activated exports the stylesheet to the document directory with the
same base name as the document (for example, if your document is
mydoc.xml, your stylesheet will be saved as mydoc.fos in the document
directory).
• Documents of same document type in same directory - In future sessions,
Arbortext Editor will automatically use this stylesheet to display all documents
in the document directory that use the current document's document type,
unless you have already specified a stylesheet for a particular document. An
export instigated with this option activated exports the stylesheet to the
document directory with the same base name as the document type (for
example, if you are using the axdocbook document type and your document
is mydoc.xml, your stylesheet will be exported as axdocbook.fos to the
document directory).
• All documents of same document type - In future sessions, Arbortext Editor
will automatically use this stylesheet to display all documents using the
current document's document type, unless you have specified a stylesheet
using one of the above designations. An export instigated with this option
activated exports the stylesheet to the document type directory with the same
base name as the document type (for example, if you are using the
axdocbook document type and your document is mydoc.xml, your
stylesheet will be exported as axdocbook.fos to the document type
directory).

Note
This option is unavailable if a stylesheet already exists in the document
type directory or if you do not have write permission for the directory.

Arbortext Styler Dialog Boxes 1057

• Stylesheet - Displays a description for the exported stylesheet, based on the
title of the original stylesheet. This field is read only.
• For document - Displays the path to the document for which the export
settings are being made. This field is read only.

Use Stylesheet For Dialog Box

The Use Stylesheet for dialog box opens when you choose the Use for button in
the Save Stylesheet As dialog box. Use the options in this dialog box to save your
stylesheet as the default Arbortext Editor stylesheet for specific documents.

Note
• You can override this setting for a specific individual document by associating
a stylesheet with the document - see Associating a stylesheet with your
document in Arbortext Editor help for information.
• The label is defined in the StyleSheetInfo element for Styler stylesheets
or in the APPConfig element of the APP configuration file.

This dialog box contains the following options:

• Document - In future sessions, Arbortext Editor will automatically use this
stylesheet to display this document. Instigating a save action with this option
selected saves the stylesheet in the document directory with the same base
name as the document (for example, if your document is mydoc.xml, your
stylesheet will be saved as mydoc.style or mydoc.fos in the document
directory).
• Documents of same document type in same directory - In future sessions,
Arbortext Editor will automatically use this stylesheet to display all documents
in the document directory that use the current document's document type,
unless you have already specified a stylesheet for a particular document.
Instigating a save action with this option selected saves the stylesheet in the
document directory with the same base name as the document type (for
example, if you are using the axdocbook document type and your document
is mydoc.xml, your stylesheet will be saved as axdocbook.style or
axdocbook.fos in the document directory).
• All documents of same document type - In future sessions, Arbortext Editor
will automatically use this stylesheet to display all documents using the
current document's document type, unless you have specified a stylesheet
using one of the above designations. Saves the stylesheet in the document type
directory with the same base name as the document type (for example, if your

1058 User's Guide

 document is mydoc.xml, your stylesheet will be saved as
axdocbook.style or axdocbook.fos in the document type directory).

Note
This option is unavailable if a stylesheet already exists in the document
type directory or if you do not have write permission for the directory.

• Stylesheet - Displays a description for the exported stylesheet, based on the

title of the original stylesheet. This field is read only.
• For document - Displays the path to the document for which the export
settings are being made. This field is read only.

Validate Page Sets Dialog Box

The Validate Page Sets dialog box opens when you choose the Tools ▶ Validate
Page Sets menu option. It displays a structured view of your document,
highlighting all the elements that have page sets applied to them.
This dialog box contains the following options:
• Document tree - Your document is displayed as a structured element tree.
Elements with page sets applied are preceded by a page icon . Other
elements are preceded by an element icon . If there is a page set error, the
icon has a red X superimposed ).
• Go to Element - Opens the Elements list with the relevant context of the
element selected, and repositions the cursor in your document at the point
where the selected element occurs.
• Go to Page Set - Opens the Page Sets list with the selected page set
highlighted, enabling you to edit the page set applied by the selected element.
• Next Error - Highlights the next element in the tree structure that contains a
page set error.
• Refresh - Refreshes the view of the document tree structure.
• Require XSL-FO Compliance - Indicates whether Arbortext Styler should
maintain strict XSL-FO compliance when validating page sets.
Arbortext Styler has the ability to process nested XSL-FO page sets, so by
default they are not reported as validation errors. However, if you plan to
export your stylesheet as XSL-FO, nested page sets are not strictly XSL-FO
compliant. If you set this option, Arbortext Styler reports nested XSL-FO page
sets as validation errors.

Arbortext Styler Dialog Boxes 1059

 This option is not available if the stylesheet is set to use PTC APP or FOSI as
the print/PDF engine.
• Error Status - Provides a numeric count of the page set errors found in the
document. Provides a more detailed description of the error when you select
an element with an error.

XPath Predicate Dialog Box

The XPath Predicate dialog box displays when you select XPath Predicate
from the Position list in the Context dialog box. Use this dialog box to create or
edit an XPath predicate.
Type the XPath predicate in the text box. Use valid XPath predicate syntax,
omitting the square brackets surrounding the predicate as these are applied
automatically by Arbortext Styler.
The read-only Context field shows the context for which the predicate is being
written

Note
If you enter the name of a namespaced element in this field, you will not be
prompted to declare the namespace if it does not already exist. Ensure you
have declared the namespace for the stylesheet by creating an element with the
applicable prefix, or the XPath expression you enter in this field will not be
valid

Note
With DITA document types, predicates should only be attached to the element
defined by the context. The use of general contexts such as image
anywhere in topic[@outputclass=’tpdr’] should be avoided. They
will not work in Edit view, and Arbortext Styler will not indicate that the
context matches when you position the cursor in the edit window inside an
element that should match. They will also not match in print/PDF output
generated by the FOSI print engine.
Instead, use a context such as image[ancestor::topic/
@outputclass=’tpdr’].

1060 User's Guide

 Note
You must understand XPath and its syntax to use this option. Refer to the
World Wide Web Consortium (W3C) web site (www.w3.org/TR/xpath) for
information on the XPath standard.

The use of certain XPath expressions can cause increased processing times. Please
refer to XPath Performance on page 1078 for information and suggested
alternatives.

XPath Test Dialog Box

The XPath Test dialog box opens when you carry out one of the following actions
in the Condition dialog box while creating a condition for an element or a table of
contents (TOC):
• Elect to create a new XPath test for the condition by clicking the New XPath
Test button.
• Select to edit an existing XPath test for a condition by highlighting the
existing XPath test and clicking the Edit button.
In this dialog you can create a test based on the result of an XPath expression.
Using XPath extension functions provided by PTC Arbortext, your XPath
expression can invoke JavaScript or ACL scripting. Please refer to Accessing
Scripts from Arbortext Styler on page 746 for more information.
The title of the dialog box will be either New XPath Test or Edit XPath Test,
depending on the operation you used to invoke the dialog box.

Note
You must understand XPath and its syntax to use this option. Refer to the
World Wide Web Consortium (W3C) web site (www.w3.org/TR/xpath) for
information on the XPath standard.

The XPath Test dialog box contains the following option:

• Enter an XPath expression - enter an XPath expression to test. You must enter
a valid XPath expression: if the XPath expression is invalid, Arbortext Styler
will display an error message when you try to close the dialog box.
If you are creating an XPath test for a TOC condition, the XPath expression
you enter here will be evaluated for each title being considered for inclusion in

Arbortext Styler Dialog Boxes 1061

 the TOC, with the title forming the context node for the purposes of
evaluation.

Note
If you enter the name of a namespaced element in this field, you will not
be prompted to declare the namespace if it does not already exist. Ensure
you have declared the namespace for the stylesheet by creating an element
with the applicable prefix, or the XPath expression you enter in this field
will not be valid.

Avoid using the XPath functions position() or last() since they are not
valid in this context. Some alternatives are given below:
• Instead of position(), use count(preceding-sibling::*)+1
• To test whether an element is the last child of its parent, that is to test
position() = last(), use count(following-sibling::*) = 0
• To test whether an element is the first child of its parent, use
count(preceding-sibling::*) = 0
The use of certain XPath expressions can cause increased processing times. Please
refer to XPath Performance on page 1078 for information and suggested
alternatives.

1062 User's Guide

 33
Debugging Stylesheets
Performance Profiling for Arbortext Styler or FOSI Stylesheets ................................. 1064
XPath Performance ............................................................................................... 1078

This section provides some information and suggestions that will help you
perform preliminary analysis on a stylesheet that is experiencing poor
performance.

1063
Performance Profiling for Arbortext Styler
or FOSI Stylesheets
Introduction
Processing performance information can be output for APP and FOSI output
(Editor and print/PDF ) with Arbortext Styler stylesheets via the set debug
command. The output is divided into four functional areas:
1. Context matching, also known as e-i-c matching when processing with FOSI
2. Condition matching, also known as att-matching when processing with FOSI
3. Generated text processing
4. Evaluation of XPath expressions (APP only)
Each of these information types appears in its own section in the output, allowing
you to ascertain which type of processing is causing your problem. Once you have
isolated the functional area you can continue to produce processing information
related to this area only if you wish, since a full set of data can be fairly lengthy.
See Sample output for an example of the type of information that will be output.
This section also contains instructions on how to produce the correct diagnostic
information in order to investigate some commonly encountered stylesheet
problems, plus some sample output for your reference.

How to Output Diagnostic Information

In general, diagnostic information can be output to a nominated file using the
command line instruction set debug=diagnostic type,=filename,
where:
• diagnostic type is the type of information you wish to output, either a
full set of those available or a specific type (see Diagnostic information types
for a list of types)
• filename is the absolute path to the file where the diagnostic information
will be written. The filename must not contain spaces.
The debug instruction is usually activated via the Arbortext Editor command line
while the document that appears to contain a problem is open. Note, though, that
if you are trying to find out why a document is slow to open, the instruction must
be given before the document opens to have any effect.

1064 User's Guide

Diagnostic Information Types
The specific debug settings listed below will each output a particular type of
diagnostic information, when included as the diagnostic type parameter of the
set debug command:
10.25 - context/e-i-c matching
10.26 - condition/att matching
10.27 - generated text processing
5.27 - partial generated text processing
11.10 - evaluation of XPath expressions (APP only)
To produce diagnostic data for all of these functional areas, write the diagnostic
types as a range, i.e. set debug=10.25-27,=filename.
To request only certain types of data in the output, which are not necessarily
consecutive in number order, separate the entries with a comma. For example, the
command set debug=10.25,10.27,=filename will output context
matching and generated text processing speeds.
If you have narrowed down the problem to a specific functional area and are
trying out fixes, you can reduce the number of lines of diagnostic output to a
single type by using a specific debug setting. For example, the command set
debug=10.27,=filename will output data relating to the processing of
generated text only.

Functional Areas of Diagnostic Output

Once the diagnostic output has been written to the selected file, you will see data
relating to one or all of the following types for each occurrence of each element
defined for the document. (See Sample Output of set debug Command for an
example output file that contains performance data against all three types.) Each
line in the output file contains a particular type of information for an element in
the document, giving the number of occurrences of that element in the document
(events), the total time to process all of those occurrences, and hence the average
time for processing a single occurrence.
As already explained, the data is divided into four main types. The list below
contains suggestions as to what could be causing the problem with your stylesheet
if you have isolated the issue to one of these functional areas:
• Context/e-i-c matching
If context/eic matching is slow, it is almost always due to the use of XPath
predicates. There may be one slow phrase in one predicate that is slowing the
whole document, or it may be the case that there are so many expressions that
their combined processing time is extremely slow.

Debugging Stylesheets 1065

 It is useful to note the number of context matching passes that may be
involved to complete an action being taken with the document - this may give
you an indication of why a perceived slowdown is occurring:
○ When updating generated text, context matching usually happens once per
element for most of the elements in the document: although multiple
matches may be required for some elements
○ When the document is published for print, content matching occurs at least
twice for every element in the document, as well as a subsequent pass for
each element in each header and footer in each page of the document.
• Condition/att matching
There are two common sources of slowness with condition/att matching
processes:
○ The use of particular XPath tests: see XPath Performance on page 1078 for
the types of test that will cause marked slowdowns in document processing
○ The inclusion of edited FOSI source that uses <specval attloc=
"system-func" .../> to call ACL functions. ACL functions are
generally fast, but if they make use of the particular XPath expressions
described in XPath performance, they will be considerably slower.
The number of condition/att matching passes that may be involved to
complete an action being taken with the document is similar to that required
for context/eic matching. Again, this may give you an indication of why
processing is slow.
• Generated text processing
Slow processing of generated text is almost always due to the use of one of the
following functions in Arbortext Styler's Generated Text Editor:
○ Insert ▶ XPath String
○ Insert ▶ Element Content - in this instance most cases are fast, but some
combinations of parameters can be slow:
◆ Electing to choose the element using an XPath expression, via the By
XPath field.
◆ Electing to search for a specific occurrence of an element within
another element, rather than searching for it within the root document
element.
For these instances it is useful to refer to XPath Performance on page 1078 for
a list of expressions that commonly cause a marked slowdown of generated
text processing.

1066 User's Guide

 It is also useful to note the number of generated text processing passes that
may be involved to complete an action being taken with the document - this
may give you an indication of why a perceived slowdown is occurring:
○ When updating generated text, generated text processing happens once for
every element in the document.
○ When the document is published for print, generated text processing
occurs once for every element in the document, as well as a subsequent
pass for each element in each header and footer on each page of the
document
• Evaluation of XPath expressions
It may be the case that a single XPath expression takes extensive processing
time. It may also be true that there are so many instances of an expression in a
stylesheet that combined processing time is slow. The 11.10 flag for an PTC
APP publishing action outputs information about XPath processing, allowing
you to identify occurrences that are causing slowdown in formatting/
publishing:
Debugging with this flag lists information about each XPath expression:
○ Node name
○ Total time taken to process the expression
○ Count of times the expression was evaluated
○ Maximum processing time for a single evaluation

Note
If there are multiple formatting passes, eic matching, att matching, and (less
frequently) generated text processing are sometimes repeated for the second
pass. Header and footer processing, however, is always repeated for each page
for the second pass.

Investigating Common Stylesheet Problems

This section contains a selection of problems that may be encountered when
working with Arbortext Styler stylesheets. In most cases the suggested steps to
produce the relevant performance information are detailed, giving you a start point
at which to begin tracing the root cause of the problem. In each example the
filename to which the diagnostic information will be written is D:\
diagnosis.txt.
• Document is slow to open

Debugging Stylesheets 1067

 To determine why a document seems slow to open, follow the steps given
below:
1. Before opening the document, enter the instruction set debug=10.25-
27,=D:\diagnosis.txt in the Editor command line
2. Open your document
3. After the document has opened, refer to the output in D:\
diagnosis.txt
• Update of generated text is slow
To determine why the update of generated text is slow, follow the steps given
below:
1. Before opening the document, enter the instruction set debug=10.25-
27,=D:\diagnosis.txt in the Editor command line
2. Open your document
3. After the document has opened, refer to the output in D:\diagnosis.txt
If your document is already open, you can enter the debug command shown in
point 1 above and then deactivate and reactivate the generated text option by
selecting the menu option View ▶ Generated Text ▶ Show twice. The diagnostic
information will then be passed to the output file as normal.
• Print publishing is slow
To determine why print preview, print or PDF publishing actions are slow,
follow the steps given below:
1. Open your document
2. Enter the instruction set debug=10.25-27,=D:\diagnosis.txt
in the Editor command line
3. Select one of the following menu options (note that, for the purpose of
tracking timing, it does not make any difference which one you choose):
○ File ▶ Print Preview
○ File ▶ Print
○ File ▶ Publish ▶ PDF File
4. Once the selected formatting is complete, refer to the output in D:\
diagnosis.txt

Sample Output of set debug Command

The data shown below is the output for the command set debug=10.25-
10.27,=filename, (i.e. a request to provide performance information related
to context/eic matching, condition/att matching and generated text processing) run

1068 User's Guide

when previewing the Arbortext Article sample document for print. This sample
document is based on the XML DocBook V4.0 doctype. The information in each
line is arranged in the following columns:
• Column 1: the element being assessed
• Column 2: the number of occurrences of that element in the document
• Column 3: the total time taken to process all occurrences of the element in the
document
• Column 4: the average time taken to process a single occurrence of the
element (i.e. Column 3 divided by Column 2)
• Column 5: the type of information requested displayed in the request
Note that the times shown are given in milliseconds - a time of 1000.00 msecs
equals one second.

============= Start timing data for operation: computing generated text

===============
———————————————————— (context/eic matching)
————————————————————
Element _font: 108 2.182 total 0.020 average (context/eic
events msecs msecs matching)
Element _gtlink: 15 events 0.288 total 0.019 average (context/eic
msecs msecs matching)
Element _sfe: 108 2.410 total 0.022 average (context/eic
BeforeOrAfterText: events msecs msecs matching)
Element _tiv: 30 events 0.547 total 0.018 average (context/eic
msecs msecs matching)
Element abstract: 5 events 0.108 total 0.022 average (context/eic
msecs msecs matching)
Element article: 131 2.574 total 0.020 average (context/eic
events msecs msecs matching)
Element articleinfo: 1 events 0.020 total 0.020 average (context/eic
msecs msecs matching)
Element atidmd: 30 events 0.664 total 0.022 average (context/eic
Bookmark: msecs msecs matching)
Element atidmd: 2 events 0.047 total 0.023 average (context/eic
DocumentMetaData: msecs msecs matching)
Element atidmd: 32 events 0.698 total 0.022 average (context/eic
Outline: msecs msecs matching)
Element atidmd: 42 events 0.929 total 0.022 average (context/eic

Debugging Stylesheets 1069

Title: msecs msecs matching)
Element 1 events 0.021 total 0.021 average (context/eic
authorgroup: msecs msecs matching)
Element bmrk__bot_ 14 events 0.312 total 0.022 average (context/eic
of_div*: msecs msecs matching)
Element bmrk__top_ 14 events 0.318 total 0.023 average (context/eic
of_div*: msecs msecs matching)
Element bmrk__ 14 events 0.310 total 0.022 average (context/eic
within_div_title*: msecs msecs matching)
Element copyright: 1 events 0.020 total 0.020 average (context/eic
msecs msecs matching)
Element corpauthor: 1 events 0.021 total 0.021 average (context/eic
msecs msecs matching)
Element emphasis: 21 events 0.474 total 0.023 average (context/eic
msecs msecs matching)
Element figure: 5 events 0.098 total 0.020 average (context/eic
msecs msecs matching)
Element holder: 1 events 0.019 total 0.019 average (context/eic
msecs msecs matching)
Element imagedata: 5 events 0.104 total 0.021 average (context/eic
msecs msecs matching)
Element 5 events 0.107 total 0.021 average (context/eic
imageobject: msecs msecs matching)
Element itemizedlist: 109 4.052 total 0.037 average (context/eic
events msecs msecs matching)
Element legalnotice: 1 events 0.020 total 0.020 average (context/eic
msecs msecs matching)
Element listitem: 129 6.534 total 0.051 average (context/eic
events msecs msecs matching)
Element 5 events 0.109 total 0.022 average (context/eic
mediaobject: msecs msecs matching)
Element objectinfo: 5 events 0.107 total 0.021 average (context/eic
msecs msecs matching)
Element orderedlist: 39 events 1.442 total 0.037 average (context/eic
msecs msecs matching)
Element para: 98 events 7.232 total 0.074 average (context/eic
msecs msecs matching)
Element releaseinfo: 1 events 0.021 total 0.021 average (context/eic
msecs msecs matching)

1070 User's Guide

Element section: 225 6.975 total 0.031 average (context/eic
events msecs msecs matching)
Element subtitle: 1 events 0.021 total 0.021 average (context/eic
msecs msecs matching)
Element title: 104 3.995 total 0.038 average (context/eic
events msecs msecs matching)
Element year: 1 events 0.019 total 0.019 average (context/eic
msecs msecs matching)
Element #TOTAL#: 1304 42.795 total 0.033 average (context/eic
events msecs msecs matching)

———————————————————— (condition/att matching)

————————————————————
Element _font: 108 98.476 total 0.912 average (condition/att
events msecs msecs matching)
Element _gtlink: 15 events 0.527 total 0.035 average (condition/att
msecs msecs matching)
Element _sfe: 54 events 1.065 total 0.020 average (condition/att
BeforeOrAfterText: msecs msecs matching)
Element abstract: 5 events 0.094 total 0.019 average (condition/att
msecs msecs matching)
Element article: 1 events 0.574 total 0.574 average (condition/att
msecs msecs matching)
Element articleinfo: 1 events 0.018 total 0.018 average (condition/att
msecs msecs matching)
Element atidmd: 15 events 0.286 total 0.019 average (condition/att
Bookmark: msecs msecs matching)
Element atidmd: 1 events 0.019 total 0.019 average (condition/att
DocumentMetaData: msecs msecs matching)
Element atidmd: 1 events 0.019 total 0.019 average (condition/att
Outline: msecs msecs matching)
Element atidmd: 14 events 0.270 total 0.019 average (condition/att
Title: msecs msecs matching)
Element 1 events 0.017 total 0.017 average (condition/att
authorgroup: msecs msecs matching)
Element bmrk__bot_ 14 events 7.143 total 0.510 average (condition/att
of_div*: msecs msecs matching)
Element bmrk__top_ 14 events 6.233 total 0.445 average (condition/att
of_div*: msecs msecs matching)

Debugging Stylesheets 1071

Element bmrk__ 14 events 6.319 total 0.451 average (condition/att
within_div_title*: msecs msecs matching)
Element copyright: 1 events 0.027 total 0.027 average (condition/att
msecs msecs matching)
Element corpauthor: 1 events 0.057 total 0.057 average (condition/att
msecs msecs matching)
Element emphasis: 21 events 4.362 total 0.208 average (condition/att
msecs msecs matching)
Element figure: 5 events 0.087 total 0.017 average (condition/att
msecs msecs matching)
Element holder: 1 events 0.027 total 0.027 average (condition/att
msecs msecs matching)
Element imagedata: 10 events 0.191 total 0.019 average (condition/att
msecs msecs matching)
Element 5 events 0.095 total 0.019 average (condition/att
imageobject: msecs msecs matching)
Element itemizedlist: 16 events 0.306 total 0.019 average (condition/att
msecs msecs matching)
Element legalnotice: 1 events 0.078 total 0.078 average (condition/att
msecs msecs matching)
Element listitem: 40 events 7.990 total 0.200 average (condition/att
msecs msecs matching)
Element 5 events 0.101 total 0.020 average (condition/att
mediaobject: msecs msecs matching)
Element objectinfo: 5 events 0.094 total 0.019 average (condition/att
msecs msecs matching)
Element orderedlist: 3 events 0.056 total 0.019 average (condition/att
msecs msecs matching)
Element para: 98 events 1.723 total 0.018 average (condition/att
msecs msecs matching)
Element releaseinfo: 1 events 0.018 total 0.018 average (condition/att
msecs msecs matching)
Element section: 14 events 27.997 total 2.000 average (condition/att
msecs msecs matching)
Element subtitle: 1 events 0.047 total 0.047 average (condition/att
msecs msecs matching)
Element title: 104 73.016 total 0.702 average (condition/att
events msecs msecs matching)

1072 User's Guide

Element year: 1 events 0.017 total 0.017 average (condition/att
msecs msecs matching)
Element #TOTAL#: 591 237.353 total 0.402 average (condition/att
events msecs msecs matching)

———————————————————— (gentext processing)

————————————————————
Element /_font: 54 events 1.050 total 0.019 average (gentext
msecs msecs processing)
Element /_gtlink: 15 events 0.322 total 0.021 average (gentext
msecs msecs processing)
Element /_sfe: 54 events 2.347 total 0.043 average (gentext
BeforeOrAfterText: msecs msecs processing)
Element /abstract: 5 events 0.111 total 0.022 average (gentext
msecs msecs processing)
Element /article: 1 events 0.082 total 0.082 average (gentext
msecs msecs processing)
Element /articleinfo: 1 events 0.021 total 0.021 average (gentext
msecs msecs processing)
Element /atidmd: 15 events 0.789 total 0.053 average (gentext
Bookmark: msecs msecs processing)
Element /atidmd: 1 events 0.051 total 0.051 average (gentext
DocumentMetaData: msecs msecs processing)
Element /atidmd: 1 events 0.051 total 0.051 average (gentext
Outline: msecs msecs processing)
Element /atidmd: 14 events 0.739 total 0.053 average (gentext
Title: msecs msecs processing)
Element 1 events 0.021 total 0.021 average (gentext
/authorgroup: msecs msecs processing)
Element /bmrk__ 14 events 0.347 total 0.025 average (gentext
bot_of_div*: msecs msecs processing)
Element /bmrk__ 14 events 0.378 total 0.027 average (gentext
top_of_div*: msecs msecs processing)
Element /bmrk__ 14 events 0.362 total 0.026 average (gentext
within_div_title*: msecs msecs processing)
Element /copyright: 1 events 0.021 total 0.021 average (gentext
msecs msecs processing)
Element /corpauthor: 1 events 0.021 total 0.021 average (gentext
msecs msecs processing)

Debugging Stylesheets 1073

Element /emphasis: 21 events 0.468 total 0.022 average (gentext
msecs msecs processing)
Element /figure: 5 events 0.102 total 0.020 average (gentext
msecs msecs processing)
Element /holder: 1 events 0.020 total 0.020 average (gentext
msecs msecs processing)
Element 5 events 0.111 total 0.022 average (gentext
/imageobject: msecs msecs processing)
Element 16 events 0.358 total 0.022 average (gentext
/itemizedlist: msecs msecs processing)
Element /legalnotice: 1 events 0.021 total 0.021 average (gentext
msecs msecs processing)
Element /listitem: 40 events 0.894 total 0.022 average (gentext
msecs msecs processing)
Element 5 events 0.111 total 0.022 average (gentext
/mediaobject: msecs msecs processing)
Element /objectinfo: 5 events 0.110 total 0.022 average (gentext
msecs msecs processing)
Element /orderedlist: 3 events 0.067 total 0.022 average (gentext
msecs msecs processing)
Element /para: 98 events 2.013 total 0.021 average (gentext
msecs msecs processing)
Element /releaseinfo: 1 events 0.021 total 0.021 average (gentext
msecs msecs processing)
Element /section: 14 events 2.017 total 0.144 average (gentext
msecs msecs processing)
Element /subtitle: 1 events 0.022 total 0.022 average (gentext
msecs msecs processing)
Element /title: 20 events 0.438 total 0.022 average (gentext
msecs msecs processing)
Element /year: 1 events 0.020 total 0.020 average (gentext
msecs msecs processing)
Element _font: 54 events 1.274 total 0.024 average (gentext
msecs msecs processing)
Element _gtlink: 15 events 0.361 total 0.024 average (gentext
msecs msecs processing)
Element _sfe: 54 events 2.506 total 0.046 average (gentext
BeforeOrAfterText: msecs msecs processing)
Element abstract: 5 events 0.140 total 0.028 average (gentext

1074 User's Guide

 msecs msecs processing)
Element article: 1 events 1.393 total 1.393 average (gentext
msecs msecs processing)
Element articleinfo: 1 events 0.026 total 0.026 average (gentext
msecs msecs processing)
Element atidmd: 15 events 0.844 total 0.056 average (gentext
Bookmark: msecs msecs processing)
Element atidmd: 1 events 0.056 total 0.056 average (gentext
DocumentMetaData: msecs msecs processing)
Element atidmd: 1 events 0.054 total 0.054 average (gentext
Outline: msecs msecs processing)
Element atidmd: 14 events 0.785 total 0.056 average (gentext
Title: msecs msecs processing)
Element 1 events 0.026 total 0.026 average (gentext
authorgroup: msecs msecs processing)
Element bmrk__bot_ 14 events 0.999 total 0.071 average (gentext
of_div*: msecs msecs processing)
Element bmrk__top_ 14 events 0.782 total 0.056 average (gentext
of_div*: msecs msecs processing)
Element bmrk__ 14 events 0.618 total 0.044 average (gentext
within_div_title*: msecs msecs processing)
Element copyright: 1 events 0.146 total 0.146 average (gentext
msecs msecs processing)
Element corpauthor: 1 events 0.026 total 0.026 average (gentext
msecs msecs processing)
Element emphasis: 21 events 0.566 total 0.027 average (gentext
msecs msecs processing)
Element figure: 5 events 0.132 total 0.026 average (gentext
msecs msecs processing)
Element holder: 1 events 0.136 total 0.136 average (gentext
msecs msecs processing)
Element imagedata: 10 events 0.211 total 0.021 average (gentext
msecs msecs processing)
Element 5 events 0.136 total 0.027 average (gentext
imageobject: msecs msecs processing)
Element itemizedlist: 16 events 0.434 total 0.027 average (gentext
msecs msecs processing)
Element legalnotice: 1 events 0.026 total 0.026 average (gentext
msecs msecs processing)

Debugging Stylesheets 1075

Element listitem: 40 events 137.023 3.426 average (gentext
total msecs msecs processing)
Element 5 events 0.134 total 0.027 average (gentext
mediaobject: msecs msecs processing)
Element objectinfo: 5 events 0.135 total 0.027 average (gentext
msecs msecs processing)
Element orderedlist: 3 events 0.080 total 0.027 average (gentext
msecs msecs processing)
Element para: 98 events 2.527 total 0.026 average (gentext
msecs msecs processing)
Element releaseinfo: 1 events 0.026 total 0.026 average (gentext
msecs msecs processing)
Element section: 14 events 2.487 total 0.178 average (gentext
msecs msecs processing)
Element subtitle: 1 events 0.091 total 0.091 average (gentext
msecs msecs processing)
Element title: 20 events 63.836 total 3.192 average (gentext
msecs msecs processing)
Element year: 1 events 0.025 total 0.025 average (gentext
msecs msecs processing)
Element #TOTAL#: 896 231.544 0.258 average (gentext
events total msecs msecs processing)

============== End timing data for operation: computing generated text

================

============= Start timing data for operation: header/footer processing

===============
———————————————————— (context/eic matching)
————————————————————

Element _sfe: 16 events 0.374 total 0.023 average (context/eic

Gentext: msecs msecs matching)
Element _sfe: 16 events 0.353 total 0.022 average (context/eic
HeaderOrFooter: msecs msecs matching)
Element colspec: 48 events 0.929 total 0.019 average (context/eic
msecs msecs matching)
Element entry: 48 events 5.698 total 0.119 average (context/eic
msecs msecs matching)

1076 User's Guide

Element 16 events 1.845 total 0.115 average (context/eic
informaltable: msecs msecs matching)
Element row: 16 events 0.315 total 0.020 average (context/eic
msecs msecs matching)
Element tbody: 16 events 0.309 total 0.019 average (context/eic
msecs msecs matching)
Element tgroup: 16 events 0.311 total 0.019 average (context/eic
msecs msecs matching)
Element #TOTAL#: 192 10.134 total 0.053 average (context/eic
events msecs msecs matching)

———————————————————— (condition/att matching)

————————————————————

Element _sfe: 16 events 0.322 total 0.020 average (condition/att

Gentext: msecs msecs matching)
Element _sfe: 16 events 0.313 total 0.020 average (condition/att
HeaderOrFooter: msecs msecs matching)
Element colspec: 48 events 0.820 total 0.017 average (condition/att
msecs msecs matching)
Element entry: 48 events 0.821 total 0.017 average (condition/att
msecs msecs matching)
Element 16 events 0.311 total 0.019 average (condition/att
informaltable: msecs msecs matching)
Element row: 16 events 0.274 total 0.017 average (condition/att
msecs msecs matching)
Element tbody: 16 events 0.279 total 0.017 average (condition/att
msecs msecs matching)
Element tgroup: 16 events 0.283 total 0.018 average (condition/att
msecs msecs matching)
Element #TOTAL#: 192 3.423 total 0.018 average (condition/att
events msecs msecs matching)

———————————————————— (gentext processing)

————————————————————

Debugging Stylesheets 1077

Element /_sfe: 16 events 0.929 total 0.058 average (gentext
Gentext: msecs msecs processing)
Element /_sfe: 16 events 1.005 total 0.063 average (gentext
HeaderOrFooter: msecs msecs processing)
Element /entry: 48 events 0.985 total 0.021 average (gentext
msecs msecs processing)
Element 16 events 0.355 total 0.022 average (gentext
/informaltable: msecs msecs processing)
Element /row: 16 events 0.326 total 0.020 average (gentext
msecs msecs processing)
Element /tbody: 16 events 0.324 total 0.020 average (gentext
msecs msecs processing)
Element /tgroup: 16 events 0.324 total 0.020 average (gentext
msecs msecs processing)
Element _sfe: 16 events 1.011 total 0.063 average (gentext
Gentext: msecs msecs processing)
Element _sfe: 16 events 1.004 total 0.063 average (gentext
HeaderOrFooter: msecs msecs processing)
Element colspec: 48 events 0.895 total 0.019 average (gentext
msecs msecs processing)
Element entry: 48 events 1.203 total 0.025 average (gentext
msecs msecs processing)
Element 16 events 0.444 total 0.028 average (gentext
informaltable: msecs msecs processing)
Element row: 16 events 0.402 total 0.025 average (gentext
msecs msecs processing)
Element tbody: 16 events 0.403 total 0.025 average (gentext
msecs msecs processing)
Element tgroup: 16 events 0.397 total 0.025 average (gentext
msecs msecs processing)
Element #TOTAL#: 336 10.007 total 0.030 average (gentext
events msecs msecs processing)

XPath Performance
Although the use of XPath expressions in Arbortext Styler provides almost
unlimited flexibility in terms of processing options, a stylesheet writer must take
care when including them in order to avoid potential performance problems.
Generally, if the use of XPath causes problems, it’s because it is easy to write

1078 User's Guide

expressions that require a lot of processing and matching work before they are
resolved, or because the XPath engine is somewhat slower to process elements
than, for example, the Arbortext Command Language (ACL). In particular,
though, XPath expressions of the following types cause the most anomalies in
terms of performance:
• preceding:: or following:: expressions
This can mean that large parts of the document must be traversed for
matching. If in turn the document is large this will require even more
processing time. Avoid expressions of this
If you are working with the PTC APP engine, using a predicate in the
expression will limit the need to traverse the whole document. For example,
count(preceding::para) will be slow, but preceding::para[1]
will not.
All uses of preceding:: and following:: are slow when working with
the FOSI engine.
Alternative methods of arriving at the same effect should also be explored, for
example using the Insert ▶ Element Content menu item in the Generated Text
Editor. Quite often, the use of edited source also promotes efficiency of
processing.
• Expressions or sub-expressions that start with //
Using expressions of this type means that the whole document must be
traversed for matching. If the document is large this will require substantial
processing time.
If at all possible, change such expressions to use only single slashes. For
example, the expression /*/abc will be considerably more efficient than
//abc, especially when it is effected in sizeable documents. Note, however,
that while this expression is more effective during processing, it requires more
knowledge when developing the stylesheet since the developer must know the
level at which the abc occurs in order to place the expression accordingly.
Again, as an alternative, using the gentext menu options Insert ▶ Element
Content or Insert ▶ Attribute Content instead of an XPath expression based on
the // function will usually improve processing time.
• position() or last() expressions that test position
Expressions of this nature cause processing issues when used in XPath tests
for conditions, or in generated text.
Some alternatives methods of testing position via XPath in these situations are
listed below:
○ Instead of position(), use count(preceding-sibling::*)+1

Debugging Stylesheets 1079

 ○ To test whether an element is the last child of its parent, i.e. to test
position()=last(), use count(following-sibling::*)=0
○ To test whether an element is the first child of its parent use
count(preceding-sibling::*)=0

1080 User's Guide

 34
General Reference Information
Reference Information ........................................................................................... 1082
Keyboard Navigation in the Arbortext Styler Window ................................................ 1082
Differences in Output Support ................................................................................ 1084
FOSI Output Limitations with XPath in Generated Text ..............................................1110
Glossary ................................................................................................................1111

This section provides some general reference information that will assist you
when you are working with Arbortext Styler and stylesheets.

1081
Reference Information
Additional information described here may assist you in managing your
stylesheets.
• Keyboard Navigation in the Arbortext Styler Window on page 1082
• Differences in Output Support on page 1084

Keyboard Navigation in the Arbortext

Styler Window
This topic describes how to navigate in Arbortext Styler using keyboard shortcuts.

Arbortext Styler Window Navigation

Keyboard Shortcuts for Arbortext Styler Window

To Shortcut
Cycle through the open windows, including Arbortext Styler, ALT+F6
Arbortext Editor, and the Generated Text Editor
Move downwards through top, center and bottom panes F6
Move upwards through top, center and bottom panes SHIFT+F6
Cycle through the fields in the top or bottom pane, or in any TAB
dialog
Cycle forwards through list views or property categories, CTRL+TAB
whichever has cursor focus
Cycle backwards through list views or property categories, CTRL+SHIFT
whichever has cursor focus +TAB
Navigate backwards ALT+LEFT
ARROW
Navigate forwards ALT+RIGHT
ARROW
Activate the Elements list CTRL+1
Activate the Property Sets list CTRL+2
Activate the Page Sets list CTRL+3
Activate the Page Types list CTRL+4
Activate the Page Regions list CTRL+5
Activate the Generated Contents list CTRL+6
Activate the Tables of Contents list CTRL+7
Activate the Custom Tables list CTRL+8
Activate the Cross References list CTRL+9

1082 User's Guide

Keyboard Shortcuts for Arbortext Styler Window (continued)
To Shortcut
Activate the Sizes list CTRL+0
Invoke the Edit menu in the Arbortext Styler window ALT+E
Invoke the File menu in the Arbortext Styler window ALT+F
Invoke the Help menu in the Arbortext Styler window ALT+H

Invoke the Insert menu in the Arbortext Styler window ALTt+I

Invoke the Options menu in the Arbortext Styler window ALT+O
Invoke the Preview menu in the Arbortext Styler window ALT+P
Invoke the Tools menu in the Arbortext Styler window ALT+T
Invoke the View menu in the Arbortext Styler window ALT+V

The following table describes the keyboard controls for navigating within the list
views in the Arbortext Styler window.

Keyboard Shortcuts for List View window

To Shortcut
Select all objects in the list CTRL+A
Select the last object in the list END
Select the first object in the list HOME
(Elements list only) Expand the selected element, displaying all RIGHT
contexts and conditions ARROW
(Elements list only) Collapse the selected element, hiding all LEFT ARROW
contexts and conditions

Keyboard Shortcuts for Opening, Creating, and Saving Stylesheets

To Shortcut
Open a new stylesheet. CTRL+N
Open the Open Stylesheet dialog box, from which you can CTRL+O
select an existing stylesheet.
Save the stylesheet. CTRL+S

Keyboard Shortcuts for Editing Stylesheets

Cut the selected text, and save it to the clipboard. CTRL+X

Copy the selected text to the clipboard. CTRL+C
Paste the contents of the clipboard to the cursor location. CTRL+V

General Reference Information 1083

Keyboard Shortcuts for Editing Stylesheets (continued)
Delete the selected text. DELETE
Undo CTRL+Z
Redo CTRL+Y
Invoke the Modules dialog box, from which you can create and CTRL+M
manage the modules in a modular stylesheet.

Keyboard Shortcuts for Arbortext Styler Functions

(Elements list) Open the New Context dialog box, in which you F10
can create a new context.
(Elements list) Open the New Condition dialog box, in which F11
you can create a new condition.
(All lists) Rename the selected object F2
(All lists) Open the Find Where Used dialog box, in which you CTRL+F
can create a search for all the instances of a particular object in
your stylesheet
(All lists) Open the Stylesheet Properties dialog box with the CTRL+L
Language tab active, to access the language properties of the
stylesheet

Keyboard Shortcuts for Previewing Stylesheets

Display the document in Arbortext Editor using the current CTRL+E

stylesheet settings.
Display the document in the Print Preview window using the CTRL+P
current stylesheet settings.
Display the document as an HTML file in a browser using the CTRL+H
current stylesheet settings.

Differences in Output Support

The following differences in output occur within the features of Arbortext Styler,
when documents are published to the different available formats.
It should be noted that the list of limitations described here for RTF output refers
only when creating export styling via Arbortext Styler formatting properties. If
you create a map template that uses Word style names a limitation may not apply -
note that if a difference is caused by a limitation of Microsoft Word you may still
not be able to achieve the required effect.

1084 User's Guide

Arbortext Editor Output
Area in UI Limitation
Text • Text given super and subscript font properties in Arbortext
category Styler only appear as such in Arbortext Editor if the Tag
Display option in Arbortext Editor is set to none.
• Elements mapped to Hidden in Arbortext Styler are still
displayed in Arbortext Editor if the Hidden Content option for
Edit View is selected on the View tab of the Tools ▶ Preferences
dialog box.
• A value set in the Offset field will have no effect on content
consisting of an inline graphic.
Indent • Negative indents are not displayed.
category • Indents set from the right margin are not displayed.
• Elements given an Alignment setting of Justified will only
appear justified in Arbortext Editor if the Full Justification
option for Edit View is selected on the View tab of the Tools ▶
Preferences dialog box.
Spacing • Variations in line spacing are not displayed.
category

General Reference Information 1085

Area in UI Limitation
Generated • Change bars are not supported - see the Insert ▶ Begin Change
text Bar and Insert ▶ End Change Bar options in the Generated Text
category Editor
• Settings made in the Insert Leaders, Rule or Space dialog box
are not used - see the Insert ▶ Leaders, Rule and Space menu
option in the Generated Text Editor
Side by Side • Side by side layout is not supported in Arbortext Editor view.
category

Print/PDF Output via FOSI

Area in UI Limitation
Text • If font properties are not specifically set for the font used in a
category header or footer, headers and footers use system default font
properties.
It is suggested that you apply font properties to the
_sfe:HeaderOrFooter element if the system defaults do
not meet your requirements
• A value set in the Offset field will have no effect on content
consisting of an inline graphic.
Indent • Non-left (e.g., centered, right, and preformatted) alignment for
category numbered elements will not work properly unless the
alignment is also specified within the same condition and/or
output-specific property that specifies the numbering details.
In the same situation, the Align at (tab to) details are ignored,
and the number is separated from the text by an em-space.
Generated • If a numbered object is centered or right aligned, any Align at
text and Follow with settings in the numbering details dialog are
category ignored. The number is automatically followed by an em-
space.
• Generated text configured for a property set will be resolved to
the contexts/conditions that reference the property set when the
stylesheet is exported.
Side by side • If Placement is Right, the value of Horizontal offset is
category ignored when determining the left edge of the right aligned
element. The FOSI engine uses the left indent and first line
indent settings on the Indent category instead.
• When Horizontal gap is greater than zero, the position of the

1086 User's Guide

Area in UI Limitation
following content is determined by adding the values of both
Horizontal gap and the indent settings to the adjacent edge of
the aligned element.
• Values specified in em are not permitted in the Horizontal
offset, Width, and Horizontal gap fields. If such a size is used,
FOSI will treat 1em as 1pc.
PDF tags This is disabled for a stylesheet set to generate PDF via the FOSI
category engine. You must use the PTC APP engine to generate tagged PDF
output or alternate text for graphics/links.
Elements • Unpredictable results may occur when a context is processed
list via FOSI, if its position in the document is defined via an
XPath predicate that specifies an explicit level in the document
hierarchy. To avoid this situation, use the more general
parent and ancestor position options.
Page Sets • In the Page types category, when the Double sided option is
list selected, a setting of Same as other pages in the Blank pages
field will output the page type specified for even pages.
• Unequal column widths are not supported.
Page • The main content flow region must be the same width for all
Regions list pages.
• The main content flow region may only be rotated by 90
degrees.
• Graphics for a region background may not be extracted via
XPath.
• Region borders will not be output.
• An Underlaid regions avoid this region setting will be ignored.
• A Clip region at page edge setting will be ignored.
•
Independent horizontal and vertical scaling of graphics is not
supported.
Table of • With FOSI outputs, XPath expressions specifying navigation
Contents list that starts from a node in generated text will give unpredictable
results (see above). If you define TOC conditions that use
XPath tests, any title contexts where the title is generated (i.e.
is a UFE) will not appear in the table of contents.
Combined • Combined fonts are not supported in print output generated via
fonts list the FOSI engine
Graphics The Shrink graphics to fit option is not supported. You must
publish via the PTC APP engine to use this feature.

General Reference Information 1087

Area in UI Limitation
Tables Rotated content in table cells is always formatted on one line. You
may see very tall cells if their content is rotated 90° or 180°.
Publish via the PTC APP engine if you need your content to break
across lines.
Footnotes • When multiple footnotes are encountered with the same text on
a page, FOSI will create new footnotes for each use.
PTC APP will create a single footnote entry for that text and all
uses will have the same footnote number.
• When footnotes are used within a table header and the table
spans two or more pages, FOSI will create a single footnote
entry on the first page containing the table. All instances of the
header refer to this single footnote.
PTC APP will create a new footnote entry for each instance of
the header. The footnote will appear with a new number on
each page.

All FOSI Outputs (Arbortext Editor and Print/PDF)

Area in UI Limitation
Generated • The resolution of XPath expressions in generated text (see the
text Insert Element Content dialog box, for example) is
category unpredictable if the given start point for the expression is an
element in generated text. To avoid this, ensure that the
navigation starts from an element in the document itself.
• The Start At feature for numbering does not apply for elements
that occur in generated text, for example UFEs used for
generated titles, when the Start At value is not fixed and is not
specified by an attribute on the numbered element itself. For
example, you cannot use the number from an attribute of an
ancestor.
Elements • FOSI edited source for contexts and conditions will contain
list resolved property settings from output properties in any
referenced property sets.
• Changes to property set output properties are not reflected in
existing FOSI edited source of elements and contexts that
reference the changed property set.

1088 User's Guide

Area in UI Limitation
Property • FOSI property set edited source does not include output
Sets list properties.
Generated • Scoped page numbering using the Final Page Number option in
Contents list the Generated Text Editor may not format correctly in FOSI
print output based on double sided page output, where there
can be blank pages at the end of a division.

Print/PDF Output via XSL-FO

Note
The FOSI and XSL-FO print engines are on sustained support and do not
receive enhancements or maintenance fixes. PTC APP is the recommended
engine for print/PDF output.

Area in UI Limitation
Text • Shading activated for a block element via the Shading field
category will apply background color to the whole block. With the FOSI
and PTC APP print engines shading applies only to individual
lines of text in the block.
Elements that are shaded can only be split across page
boundaries in XSL-FO output when
deepcontentsplitting is active.
Breaks • If an element is set to start a new page set, and the Page
category number field is set to Initial, the first page will always be a
recto (odd) page regardless of the settings in the Start new
field. This may result in a blank page at the end of the previous
section.
In FOSI and PTC APP output, the type of first page output will
always follow the value of the Start new field, even if the page
number is set to Initial.
• If an element is set to start a new page set, and its style is set to
Definition List, you will see composition pipeline errors as
shown below when you attempt to publish the document via
the XSL-FO engine, and the element in question will likely
show the terms overlapping the definitions in output.
No content area defined for formatting object fo:block, output may not be properly formatted

or
Expecting 'fo:page-sequence' but found 'fo:block' which is not a valid child of 'fo:root'

General Reference Information 1089

Area in UI Limitation
To overcome this, either do not start a new page set on a
definition list element or use either the FOSI or the PTC APP
engine for print/PDF output.
• Run-in styling is not supported.
Generated • Generated text configured for a property set will be resolved to
text the contexts/conditions that reference the property set when the
category stylesheet is exported.
Side by side • If Placement is Right, the value of Horizontal offset is
category ignored when determining the left edge of the right aligned
element. The XSL-FO engine uses the left indent and first line
indent settings on the Indent category instead.
• When Horizontal gap is greater than zero, the position of the
following content is determined by adding the values of both
Horizontal gap and the indent settings to the adjacent edge of
the aligned element.
• Values specified in em are not permitted in the Horizontal
offset, Width, and Horizontal gap fields. If such a size is used,
XSL-FO will treat 1em as 1pc.
PDF tags This is disabled for a stylesheet set to generate PDF via XSL-FO.
category You must use the PTC APP engine to generate tagged PDF output
or alternate text for graphics/links.
Tables of • PDF bookmarks in PDFs generated using the XSL-FO engine
Contents list will always consist of the number followed by the title
contents, irrespective of any other content that may be
associated with the title when it is displayed in a table of
contents. All formatting details associated with the context in
the TOC are ignored when using the XSL-FO engine. See
description of PDF bookmarks in Tables of Contents List on
page 774 for further information.
The FOSI engine incorporates formatting information
associated with the context in the TOC when generating PDF
bookmarks.
Page Sets • In the Page types category, when the Double sided option is
list selected, a setting of Same as other pages in the Blank pages
field will output the page type specified for even pages.
• Unequal column widths are not supported.
Page • The main content flow region must be the same width for all
Regions list pages.
• The main content flow region may only be rotated by 90

1090 User's Guide

Area in UI Limitation
degrees.
• Graphics for a region background may not be extracted via
XPath.
• Region borders will not be output.
• An Underlaid regions avoid this region setting will be ignored.
• A Clip region at page edge setting will be ignored.
• Independent horizontal and vertical scaling of graphics is not
supported.
Custom • Styling for the element used as an anonymous cell in a custom
Tables list table is ignored. One of the following methods could be used
instead:
1. Putting the styling on an element within the cell that wraps
all the content (if such exists)
2. Specifying explicitly in the custom table model all the
elements that can be cells
Graphics • The Shrink graphics to fit option is not supported. You must
publish via the PTC APP engine to use this feature.
• Default dpi differences between Windows and Unix mean that
graphics may appear cropped in XSL-FO output generated via
a Solaris or Linux PE server. To get results equivalent to that
produced in a Windows environment, set
defaultscreendpi=96 on the Unix machine.
Tables Rotated content in table cells is always formatted on one line. You
may see very tall cells if their content is rotated 90° or 180°.
Publish via the PTC APP engine if you need your content to break
across lines.

General Reference Information 1091

Print/PDF Output via PTC APP
Area in UI Limitation
Text • Dotted underlines, and other styles of underline, are not
category identical between FOSI and PTC APP
Indent • The following indent property settings are not supported in
category PTC APP:
○ First line:
◆ relative to left margin (displayed same as relative to
current left indent)
◆ relative to parent first line indent (displayed same as
relative to current left indent)
• When Block elements with indents relative to the margin are
used within table cells, the margin is treated as the cell
boundary. Cell padding is not used.
Spacing • Settings made in the Minimum field for the Allow space to vary
category options are ignored - space will be stretched between the
Preferred and Maximum values
• PTC APP and FOSI have different ways of applying line
spacing. This can result in different amounts of vertical space
between lines in cases where blocks using different font sizes
are adjacent to each other.
Breaks • The on same page option of the Keep scope field in the
category Keeps dialog box (accessed via the Print/PDF Keeps button) is
not supported. If the setting is made for a multi-column page,
keeps will be applied on a column-by-column basis. The
content pieces to be kept together must therefore exist in the
same column if they are to appear on the same page.
• If Word breaking is set to Do not break, and a word is too
large for a table cell, PTC APP will hyphenate (at a valid
location if there is one, but at an invalid location if need be).
This differs to the processing for FOSI output, which will
overrun the cell and emit an error message.
If Word breaking is set to Hyphenate but there are no valid
hyphenation points, PTC APP will still hyphenate if a word is
too big for a cell.
• A run-in configuration must start with an element styled with a
With following or With both run-in setting.
Generated • Advanced parameter settings for an index (see the Insert ▶
text Index menu option in the Generated Text Editor) are ignored

1092 User's Guide

Area in UI Limitation
category
Side by side • If a non-zero value is set for Horizontal gap, PTC APP will use
category either the value of the field or the gap that results from indent
settings, whichever is the larger.
• Values specified in em are not permitted in the Horizontal
offset, Width, and Horizontal gap fields. If such a size is used,
PTC APP will treat 1em as the current font size.
Elements • Display of unstyled elements in a different tag color (see the
list Options ▶ Highlight Unstyled Elements menu option) is only
available with a preview action in PTC APP.
• Unpredictable results may occur when a context is processed
via PTC APP, if its position in the document is defined via an
XPath predicate that specifies an explicit level in the document
hierarchy. To avoid this situation, use the more general
parent and ancestor position options.
• You may only edit the source of individual contexts in PTC
APP - the option to edit the source of an element is not
supported
Page Sets • PTC APP displays a page with a pink background color if no
list page set has been specified for the page, or if there's an error
processing the page set data. An error message will explain the
problem.
Page • PTC APP supports these graphic types for an underlay in a
Regions list page region:
○ BMP
○ EPS
○ GIF
○ JPG
○ PDF
○ PNG
○ TIFF

General Reference Information 1093

Area in UI Limitation
Tables • PTC APP supports the orient attribute on OASIS table
wrappers. This allows a table to be presented in landscape
mode on a page that has portrait content, or vice versa.
FOSI and XSL-FO engines do not support the orient attribute.
To present landscape tables with these engines use controls in
the Breaks category, but note that all the content on the body of
the page will be in landscape format, not just the table. Headers
and footers on the page will still be presented in portrait view.
• The dotted and dashed rules that can be added to a table row
broken by deep content splitting are not supported.
• Formatting of tables will throw an error if any columns in the
table have a width that is less than the sum of the left and right
cell margins applied to the table.
• PTC APP will ignore a row height PI if it would cause text to
overflow the row. The FOSI engine will overset the text in this
case.
Graphics • PDF graphics are supported in PTC APP’s PDF and PDF
Preview output, but not in its print output.
• Transparency in some graphic formats is not supported. For
example, a .gif file that defines magenta as the transparent
color will display magenta areas when the document is
published in PTC APP.
• The following are not supported when processing graphics in
PNG format:
○ GIF alpha channels
○ GIF custom pixel aspect ratios
• CGM segment entity is not supported.
• Alternate text is not supported for page region graphics.
Footnotes • If two footnotes with identical content occur on the same page,
PTC APP will create a single footnote entry for that text and all
uses will have the same footnote number.
FOSI will create new footnotes for each use.
In FOSI and XSL-FO outputs, footnotes are only classed as
duplicates and merged if both their marker and content are
identical.
• When footnotes are used within a table header and the table
spans two or more pages, PTC APP will create a new footnote

1094 User's Guide

Area in UI Limitation
entry for each instance of the header. The footnote will appear
with a new number on each page.
FOSI will create a single footnote entry on the first page
containing the table. All instances of the header refer to this
single footnote.
• Relative XPath expressions in generated text evaluated in the
footnote area are not supported in print/PDF output generated
by the PTC APP engine.
The XPath expression must start navigation from the root of
the document.
General • The size of spaces between words in fully justified text will
differ in PTC APP output as it uses different hyphenation and
justification algorithms to FOSI.
• The size of spaces between words in non justified text may
differ in PTC APP output. In PTC APP output, the size of the
space will always be 0.25em. In FOSI output, the size of the
space is determined by data in the font.
• The default end-of-sentence space will differ in PTC APP
output. In FOSI output, space is approximately 0.42em
whereas in PTC APP output the space will be 0.25em in size, i.
e. PTC APP’s normal space width.
• PTC APP does not support formatting of equations created by
PTC Arbortext’s equation editor.
• It is not possible to edit the source of header or footer objects.
• PTC APP supports the underlay method for draft
watermark, which is also the default method for FOSI. PTC
APP does not allow you to choose the overlay method in
application.xml as you can with FOSI.
• If a cross reference is missing its target attribute, it will still
appear as an active link in PTC APP PDF output. It will not
lead anywhere when clicked.

General Reference Information 1095

Area in UI Limitation
Arbortext • The following processing instructions will not be reflected in
Editor output generated via the PTC APP engine:
features
○ _eos-space (End-of-Sentence Space)
○ _nopagebreak (No Page Break Region)
○ _nocolumnbreak (No Column Break Region)
○ _texmac (TeX Macro)
○ _texmacpair (TeX Macro Pair)
• Custom touchup instructions defined in the Touchup (FOSI
only) dialog box or with the _touchup PI have no effect in
output generated by the PTC APP engine.

1096 User's Guide

All Print Outputs
Area in UI Limitation
General • PTC Arbortext does not, and cannot, guarantee page fidelity
between PDF, print, and RTF output. There are too many
variables between publishing formats, applications that display
those formats, and versions of the applications which are used
as the viewers to be able to ensure identical output in all
formats.

General Reference Information 1097

All XSL Outputs
Area in UI Limitation
Generated • The following styles of list and title numbering are not
text supported in all XSL outputs (including RTF) - numbering
category assigned these styles will be displayed in the decimal style:
○ circled decimal
○ cjk-earthly-branch
○ cjk-heavenly-stem
○ hangul
○ hangul-consonant
• A limitation of the XSLT processor means that numbers greater
than 9 are displayed incorrectly in the simplified-chinese-
informal language.
Instead of the correct counting algorithm, these numbers are
made up of consecutive single digits. For example, where 10
should be displayed as 十, the processor uses 1 followed by 0
to make up the number, i.e. 一〇. 11 should be shown as 十一
(10+1), where it is actually made up of 1 followed by 1, i.e. 一
一.
• Graphics in generated text generally will not be found in
directories specified via %B in the graphics path.
• Generated text associated with structural table elements is
ignored for XSL outputs.
For example, generated text will not appear if it is configured
directly for the entry context. You must insert a non-table
element within the entry context and configure the generated
text for that context, for example p in entry.
• Generated text configured for a property set will be resolved to
the contexts/conditions that reference the property set when the
stylesheet is exported.

1098 User's Guide

All HTML Outputs
Area in UI Limitation
Text • Bugs in certain browsers mean that font characteristics font-
category style and font-weight are not always properly inherited into
tables from parent elements.
Note that this limitation will affect numbered titles and list
items too, when these are formatted as tables. Using the same
solution as suggested for tables themselves will provide the
desired output.
• Customized underline and strikethrough styles are not
supported in HTML output and will be treated as single rule in
output of these types. See the Limitations of output support for
underlining and strikethrough table in Text Underlining and
Strikethrough on page 646 for further details.
• HTML outputs do not support scoring color - the score color
will always match the font color.
• HTML outputs do not support the application of scoring to
words only - scoring will always run over spaces between
words.
• The double-underline property set has some limitations
for HTML outputs. Because this property set is implemented in
HTML using border properties, you should not use it on table-
related (or custom table-related) elements. Instead, if you want
text within tables to be double-underlined, you should put this
property set on an element surrounding the text within the table
cells. Also, if you use the double-underline property set
on a block element, it will underline the block, not all the text
in the block. The typical use of the double-underline
property set for HTML output is to put it on an inline element.
• Narrow rules (single rules less tan 1px/0.8pt wide or double
rules less than 3px/2pt wide) may not display in certain
browsers.
Indent • The following indent property settings are not fully supported
category

General Reference Information 1099

Area in UI Limitation
by HTML browsers:
○ First line:
◆ relative to left margin (displayed same as relative to
current left indent)
◆ relative to parent first line indent (displayed same as
relative to current left indent)
○ Right:
◆ relative to current left indent (displayed with a 0 point
right indent)
Spacing • Some combinations of indentation and spacing properties for
category list items result in paragraph shapes that cannot be reflected in
HTML. This also applies to numbered titles and table of
contents entries.
• Space before and after settings are handled differently than for
Arbortext Editor and Print/PDF.
• Precedence settings for Spacing before and Spacing after are
ignored - space will be accumulated and the largest amount
allocated
Generated • Change bars are not supported - see the Insert ▶ Begin Change
text Bar and Insert ▶ End Change Bar options in the Generated Text
category Editor
• Advanced parameter settings for an index (see the Insert ▶
Index menu option in the Generated Text Editor) are ignored
• If the stylesheet property Format list items as tables is not
selected, list numbering is implemented in the HTML list by
setting the list style in an attribute of the generated HTML.
Support for this method of declaring the list style varies by
browser. Numbered styles will be limited to arabic decimal,
roman (upper and lower), alpha (upper and lower), the bulleted
styles are decided by the browser, label and suffix settings will
be ignored, as will any punctuation added to the format.
• Generated text in list item numbering will not display in list
items not set to be formatted as tables. Use the stylesheet
property Format list items as tables if necessary.
• If you have set the Follow number and suffix with option to a
value of Tab when numbering a list item, this will be output as
a space if the Format list items as tables stylesheet property is
not selected.

1100 User's Guide

Area in UI Limitation
• If you have set the Follow number and suffix with option to a
value of Tab when numbering a title, this will be output as a
space if the Format titles as tables stylesheet property is not
selected.
• List item labels, numbers (or bullets) and suffixes may not be
visible in HTML output if the Format list items as tables
stylesheet property is selected. These items are treated together
as a single list item marker, which is placed in a column of the
table used to format the list item. If the width of that column is
not sufficient to display the whole list item marker, one of two
things will happen:
1. If there is a break point (e.g. a space) in the string ,
browsers will insert a line break so that the content appears
on two lines

General Reference Information 1101

Area in UI Limitation
2. If there is no break point, browsers will only display the
amount of content that fits in the column. The list item will
appear as if some text is cut off or missing. This is a
limitation of HTML and browsers.
To avoid this situation, ensure that the Tab to setting in the
numbering dialog box, which defines the width of the table
cell, is large enough to accommodate the whole list item
marker.
• If the Format list items as tables stylesheet property is selected,
the indent for the body text for all lines of the list item is
determined by the Tab to amount in the numbering dialog box.
Any value set in the Indent following lines field is ignored.
Non-first lines in a list item will be aligned with the text of the
first line, not the number and label.
There are certain exceptions to this limitation, where the Indent
following lines setting will be obeyed:

○ When there is no numbering

○ When the Keep number at beginning of line option is not
checked in the numbering dialog
○ When the Alignment field is set to Left and tabbing is not
used
• If you have set the Follow number and suffix with option to a
value of Tab when numbering an element that is styled as
something other than List Item or Title, the tab will be output
as a space.
• For certain Asian numbering styles, browsers that do not
support the word-break: keep-all CSS property (such
as Firefox) allow line breaks to occur within the number or
between the number and its following punctuation.
• Graphics inserted via generated text (see the Insert ▶ Graphic
menu option in the Generated Text Editor) must be presented in
a format acceptable for web viewing when they are referenced.
The processing process will not carry out a conversion to web-
friendly format.
• Settings made in the Insert Leaders, Rule or Space dialog box
are not used - see the Insert ▶ Leaders, Rule and Space menu
option in the Generated Text Editor
Block border • Some Arbortext Styler border styles are not supported in

1102 User's Guide

Area in UI Limitation
category HTML. These mapping to HTML border styles apply:
Styler style HTML style
Single Solid
Double Double
Dot Dotted
Dash Dashed
Long Dash Dashed
Dot Dash Dashed
Dot Dot Dash Dotted
Jagged Solid
Jagged Double Double
Curvy Solid
Curvy Double Double
Side by side • Side by side settings are only supported for an element that has
category a Structure type of Block. Arbortext Styler attempts to enforce
this by disabling the Side by side controls if the element being
styled appears to be inline.
It can be difficult to confirm the structure type when property
sets apply for the element, as more than one can apply in a
given instance. It may be the case that side by side formatting
is applied to an inline element. When working with HTML
outputs, this can lead to unexpected results. You can try and
mitigate this:
○ Avoid setting side by side properties directly on the
element that is expected to be inline.
○ Use context and conditions to avoid setting side by side
properties in Property Sets when the element would also be
inline (either by Property Set or by direct assignment).
• If a non-zero value is set for Horizontal gap, HTML outputs
will use either the value of the field or the gap that results from
indent settings, whichever is the larger.
• Values specified in em are not permitted in the Horizontal
offset, Width, and Horizontal gap fields. If such a size is used,
HTML outputs will treat 1em as 1pc.
• When End previous alignment is Yes, this will end all previous
alignments, not just the immediately preceding one.
• Some browsers ignore a value of Yes for End previous
alignment. Setting End all contained alignments to Yes will

General Reference Information 1103

Area in UI Limitation
usually work in such cases.
General • In tables, alignment of cell content to a defined character is not
effective in HTML outputs. Browsers are not required to
support it under the HTML specification, and they do not.

EPUB Output
Area in UI Limitation
Tables of When generating TOCs with the Use for chunked HTML outputs
Contents list (EPUB, HTML Help, and Web) option, only titles at levels 1–3 in the
document hierarchy will be included.
Indexes list Indexes are not supported in EPUB output.
Side by side Side by side formatting does not work reliably for EPUB output.
category
General Arbortext’s EPUB output conforms to the EPUB Standard Version
2. Different e-reader applications have varying levels of support
for this standard and you may see differences between output
viewed in Calibre e-reader during publishing and your selected
reader. Ensure that you have tested output in your various required
readers to confirm the appearance is satisfactory. If there are
unexpected anomalies, use the View EPUB option in the Publish to
EPUB dialog box to confirm the appearance is correct in the
Calibre e-reader.

1104 User's Guide

HTML File Output
Area in UI Limitation
Indexes list • Indexes are not supported in HTML File output.
Indent • When generating HTML File output from Arbortext Styler
category with the stylesheet property Format titles as table selected, an
alignment setting other than Left (i.e. Center or Right) for a
numbered or bulleted item will only be reflected in a Mozilla-
based browser (e.g. Firefox) if the alignment is set in the
context's properties (Base (All Outputs) properties or HTML File
output properties). The setting will not be reflected in such a
browser if it is set in a condition or via a property set. This
restriction is a result of browser limitations.

HTML Help Output

Area in UI Limitation
Indexes list A single index is supported in HTML Help output. This index will
include all index terms from all index definition objects with the
Use for chunked HTML output (EPUB, HTML Help, and Web) option
checked.
Generated • Language parameters for an index are not supported- see the
text Insert ▶ Index option in the Generated Text Editor
category

Web Output
Area in UI Limitation
Indexes list A single index is supported in Web output. This index will include
all index terms from all index definition objects with the Use for
chunked HTML output (EPUB, HTML Help, and Web) option
checked.

Chunked HTML Outputs (except EPUB)

Area in UI Limitation
Indexes list Scoping for indexes is ignored.

General Reference Information 1105

RTF Output
Area in UI Limitation
Text • The Shading property is not supported for inline elements.
category • Because of limitations in MS Word, the curvy underline styles
will be mapped to the jagged style in RTF output
• The Words Only setting for strikethrough is not supported
• Strikethrough color settings are not supported - strikethrough
will be displayed in the current font color.
• The Offset measure option for super- and subscript fonts is not
supported. This is a limitation of MS Word.
Spacing • Line spacing variations are not supported - spacing will always
category be set to single line
• Precedence settings for Spacing before and Spacing after are
ignored - space will be accumulated and the largest amount
allocated
Breaks • Widow and orphan control via the Print/PDF Keeps button and
category associated Keeps dialog box are not supported
• Priority settings for keeps are ignored.
• Keeps can only be applied within the on same page scope
• In the Start new field, a setting of Column is treated as Page.
• When electing start a new page, no blank pages will occur
when it appears one should be forced. For example, if the
current page is page 1 and an element starts a new odd page, a
new page numbered 3 starts, showing odd header/footers. No
page 2 will be emitted.
• Setting a number of columns for a new page is not supported
when the page is created via the Start new: Page option
Changing the number of columns can only be done at Page Set
level, which corresponds to a section in MS Word.
• The Landscape page body for duration of element option is not
supported
Generated Settings made on the Generated text category are ignored if you are
text working with RTF styles.
category • Settings made in the Insert Leaders, Rule or Space dialog box
are not used - see the Insert ▶ Leaders, Rule and Space menu
option in the Generated Text Editor
• Change bars are not supported - see the Insert ▶ Begin Change
Bar and Insert ▶ End Change Bar options in the Generated Text

1106 User's Guide

Area in UI Limitation
Editor
• It is recommended that you set up indexing using Word styles -
settings made in the Generated text category (see the Insert ▶
Index option ) are not supported

See Creating a Index with Nesting Element Model Index Terms

on page 382 for further limitations when creating an index for
RTF output.
• The Start At option for numbering (see the numbering dialog
boxes accessed via the Edit button next to the Bullets and
Numbers field) is only supported if you are not using Word
styles. Exporting to RTF using Word styles can only generated
hard coded numbers, not those calculated dynamically.
• The Custom counter option for numbering (see the numbering
dialog boxes accessed via the Edit button next to the Bullets
and Numbers field) is only supported if you are not using Word
styles. Exporting to RTF using Word styles can only generated
hard coded numbers, not those calculated dynamically.
• Page numbers and footnote numbers in RTF only support the
“cjk-earthly-branch” or “cjk-heavenly-stem” numbering styles.
Any of the other non-Latin styles in these contexts will be
displayed in the decimal style in RTF output.
Note that alphabetic and roman numeral page and footnote
numbers are permitted
• Settings made in the Repeat title or continuation text field are
ignored
• Graphics inserted via generated text (see the Insert ▶ Graphic
menu option in the Generated Text Editor) must be presented in
a format acceptable for web viewing when they are referenced.
The processing process will not carry out a conversion to web-
friendly format.
• The Specified Horizontal Space option in the Format ▶ Print/
PDF menu in the Generated Text Editor is not supported. Any
value will appear as a single space.
• Generated text configured for a property set will be resolved to
the contexts/conditions that reference the property set when the
stylesheet is exported.
Side by side • Side by side layout is not supported in RTF output.
category
Page Sets Columns category

General Reference Information 1107

Area in UI Limitation
list • The Balance columns option is not supported. This is a
limitation of Microsoft Word.
Page numbers category

• Division numbers inserted into a page set via the Insert ▶

Division Reference option in the Generated Text Editor are only
partially supported. A division number will be inserted by
selecting this option but it cannot be updated/restarted
dynamically as the divisions change within a single page set.
Page Page regions will not be included in RTF output unless they can be
Regions list identified as headers or footers. They need to match certain
criteria:
Header region:
• Same left and right margins as the page body
• Does not overlap the page body
• Top aligned
Footer region:
• Same left and right margins as the page body
• Does not overlap the page body
• Bottom aligned
Generated In general, extra work is required when setting up generated
Contents list content objects to ensure that they can be updated dynamically in
RTF output. Use Word field codes and refer to Word
documentation for full details on how this can be achieved.
• The Insert ▶ Final Page Number option in the Generated Text
Editor is not supported.
• Division numbers inserted via the Insert ▶ Division Reference
option in the Generated Text Editor are only partially
supported. A division number will be inserted by selecting this
option but it cannot be updated/restarted dynamically as the
divisions change within a single page set.
• When electing to insert the content of an element via the Insert
▶ Element Content menu option in the Generated Text Editor,
the position options in the Insert Element Content dialog box
are only partially supported:
○ Specific occurrence within document: supported
○ First started on page: not supported since RTF cannot
process position information that is expected to be updated

1108 User's Guide

Area in UI Limitation
dynamically
○ Last started on page: not supported, as above
Indexes list • index-sort-as is not supported in RTF output. This is a
limitation of MS Word.
• index-see-also is only supported for the index term. You
must manually enter the text See Also, or equivalent, as
content of the index term to ensure it is output correctly. This is
a limitation of MS Word.
Combined • Combined fonts are not supported in RTF output.
fonts list
Footnotes • Footnote numbers in RTF only support the “cjk-earthly-
branch” or “cjk-heavenly-stem” numbering styles. Any of the
other non-Latin styles in these contexts will be displayed in the
decimal style in RTF output.
• Separator rule settings in the .style file (as well as spacing
above the footnote) are ignored. The footnote separator rule is
emitted by Word.
• If you have set footnote numbering to restart at a division, this
will only work properly if:
The division starts a new page set
and
There are no elements that also start a page set within the
element on which footnote numbering is set to restart
This is a limitation of Microsoft Word.
Graphics • Scaling settings for a graphic will only have an effect if the
graphic is embedded. See the RTF tab on page 1048 of the
Stylesheet Properties dialog box.
• The Shrink graphics to fit option is not supported.
• Default dpi differences between Windows and Unix mean that
embedded graphics may appear cropped in RTF output
generated via a Solaris or Linux PE server. To get results
equivalent to that produced in a Windows environment, set
defaultscreendpi=96 on the Unix machine.

General Reference Information 1109

Area in UI Limitation
Tables • Nested tables are not supported in RTF output. This is a
limitation of Microsoft Word. If a nested table appears in a
document, it will be omitted when the document is published to
RTF output.
General • Word 97, and Excel 97, and earlier versions, are not supported
• Index formatting specified in the Arbortext Styler UI (see the
Tools ▶ Format Index menu option) will not be reflected in
indexes in RTF output. Refer to Microsoft Word’s online help
for the ways in which index formatting can be defined.

All Outputs
Area in UI Limitation
Text • Strikethrough and overlining (defined via the overline
category property set) cannot be displayed concurrently for the same
element/context, although they can both be set. See the
Limitations of output support for underlining and strikethrough
table in Text Underlining and Strikethrough on page 646 for
further details.
Note
Pre-5.4 stylesheets are not affected by the change that
causes this anomaly.
• Color and height settings for strikethrough and overlining are
shared and may produce unexpected results when both are set
for an element/context. See the Limitations of output support
for underlining and strikethrough table in Text Underlining and
Strikethrough on page 646 for further details.
Generated • XPath expressions used to specify an element (see the By XPath
Contents list fields in the Insert Element Content and Insert Attribute Content
dialog boxes, or the Insert XPath String menu option) must start
from the beginning of the document. The expression must start
with the / character.

FOSI Output Limitations with XPath in

Generated Text
Relative XPath expressions cannot be evaluated for elements in generated text
when generating FOSI outputs. Please ensure that you use expressions of the
following types:

1110 User's Guide

• Expressions that start from an absolute position
• Expressions that don't navigate away from the current element, for example
contains(@outputclass, 'draft')
Expressions such as ancestor::para will produce no results when working
with FOSI outputs and starting from an element in generated text.

Glossary
Glossary of terms for Arbortext Styler:

General Reference Information 1111

 Glossary

Block
A basic element structure that is preceded and followed by a line
break.

break
Identifies location for new column or new page in a stylesheet

child module
A module that is referenced by another module in the module
hierarchy

chunk
A piece of HTML data that is produced when a source XML
document is split into fragments when published to EPUB,
HTML Help, or Web output. An Arbortext Styler stylesheet
permits you to define the element(s) in the document that should
form chunk boundaries, and the document will break within the
scope of these selected elements on output.

combined
A user defined font that contains mappings between various
font system fonts and certain characters (or character blocks) from
the Unicode specification to enable the display of non Latin text

condition
An element context that includes a test or set of tests. You can
set formatting that will only apply to an element when a defined
condition matches for its context.
context
The specific location of an element relative to surrounding
elements within the overall document structure.
Context is referred to as selector in CSS. The corresponding
XSL term is pattern.

derivation
The process of obtaining a formatting property’s value by
evaluating the properties of an element's parents and ancestors.

derive
Usually used in the context of formatting property values. An
element inherits the value of a property defined for a different
element, for example the element's parent or an ancestor.

1113
DITA
Darwin Information Typing Architecture. An OASIS standard
that defines an architecture for developing topic-oriented,
information-typed content that can be reused and single-sourced
in a variety of ways. It is also an architecture for creating new
information types and describing new information domains
based on existing types and domains. The standard provides a
set of DTDs and XML Schemas for base topic types, such as
concept, task or reference, and for map documents that are used
to collect topic references.

divisions
Document structure elements, such as chapter, section, topic or
subtopic.

endnote
One of a set of notes that are collected within a specific scope
element, for example a chapter. Endnotes appear at the end of
the specified endnote scope element, in the order they occurred
in the document.

endnote body
The text of an endnote.

endnote
The set of all endnotes collected for a specified endnote scope
collection element. The place in which the endnotes are output at the end
of the endnote scope element is referred to as the endnote
collection area.

endnote mark
The number, symbol, or other marker that identifies an endnote
in the endnote collection area. It is usually the same as the
associated reference mark, though the two may be styled
differently.

endnote
The number, symbol, or other marker that identifies the
reference reference location of an endnote.
mark

endnote scope
The element throughout which a set of endnotes is collected.
Endnote numbering is reset at the beginning of a specified
endnote scope. The collected endnotes are output somewhere
within the endnote scope element, usually at the end of the
element.

1114 User's Guide

footnote
A floating note associated with a reference location and
reference mark in text. Footnotes appear in the footnote area at
the bottom of the column or page on which the associated
reference mark appears.

footnote body
The text of a footnote.

footnote mark
The number, symbol, or other marker that identifies a footnote.
It is usually the same as the associated reference mark, though
the two may be styled differently.

footnote
The number, symbol, or other marker that identifies the
reference reference location of a footnote.
mark

formatting
A single configurable formatting characteristic, such as font size
property or line spacing.

FOSI
A Formatting Output Specification Instance (FOSI) is a
stylesheet stylesheet standard defined in MIL-PRF-28001 and MIL-
HDBK-28001 for output of SGML or XML instances.

generalization
The DITA process where a specialized information type or
domain can be associated with its ancestor information type or
domain.

generated
A definition that specifies a piece of content. The definition can
content be referenced from any number of page regions to apply the
same content to those regions.

generated text
Predefined text that is automatically output by the stylesheet for
your document type when the document is published. Generated
text can consist of list counters, section numbering, tables of
contents, and indexes.

ID equivalent
The attribute that is a target for cross references, footnote
attribute references, and endnote references. This attribute can be defined
in two ways. First, it can be defined as an ID attribute in the
document model. Second, it can be defined as an ID in the
.dcf file associated with the document model. In this case, you
use the idAttribute attribute on the Options element in
the .dcf file to define the ID equivalent attribute.

Glossary 1115
Inline
A basic element structure that does not contain a line break
between it and the preceding and following element

keeps
Conditions for controlling and disallowing the breaking of
elements over column or page boundaries.

leaf module
A stylesheet at the bottom of the module hierarchy that does not
reference any other modules.

link
Links are elements that reference destinations in documents and
on the Web. Link elements are defined in a document type's
.dcf file.

modularized
A stylesheet that is made up of multiple modules.
stylesheet

module
The contents of a single stylesheet, not including merged
definitions from other modules.

module
The set of modules that are collectively represented by a
hierarchy modularized stylesheet. The hierarchy starts with a single root
module that can reference any number of other modules.
Modules in the hierarchy can reference other modules down to
the leaf module level. Any mergeable definitions in modules
lower in the hierarchy are overridden by identically named
definitions higher in the hierarchy.

mergeable
A set of formatting specifications, identified by a name, that can
definition be overridden by a definition of the same name in a module
higher in a module hierarchy. The following stylesheet
components are mergeable definitions:
• Element
• Property set
• Page set
• Header and Footer
• Table of contents
• Cross reference
• Custom table

1116 User's Guide

 • Size
• Combined font

orphan
In typography, the situation where the first line of a paragraph
begins at the bottom of a page, with the rest of the paragraph
appearing at the top of the following page.
In a FOSI, the number of lines to keep together at the bottom of
a column.

page region
An area on a page that can have content and properties such as
background color, position, size, and rotation applied.

page type
A collection of page regions that can be referenced by page sets
to provide page layout.

parent
A module that references another module in the module
module hierarchy.

preformatted
Asis formatting that respects line breaks and spaces in original
source.
property
A specified font, indent, spacing, breaks, or generated text
setting.

property set
A predefined or user-defined collection of formatting properties
that can be referenced anywhere formatting properties are
assigned. Property sets correspond to FOSI charsubsets, and are
closely related to XSL attribute-sets.

publishing
The process of transforming a source document to another
format using the rules specified in a stylesheet.

reference
The attribute that references an ID equivalent attribute. You may
attribute use IDREF, IDREFS, or CDATA attributes as a reference
attribute. This applies to cross references, footnote references,
and endnote references.

resolved
An intermediate XML document produced from a DITA Map
document containing all of the content referenced in the map. The resolved
document can be used for operations such as spell checking,
find/replace, and stylesheet development.

Glossary 1117
resolving
The process of obtaining and displaying formatting properties
for the selected object or objects (one or more contexts,
conditions, or property sets). This involves:
• displaying any property values that have been applied to the
objects
• indicating whether the properties are explicitly set or
obtained from a property set, condition, or ancestor.

root module
A single stylesheet at the top of the module hierarchy that
references all of the other modules.

SFE
See Styler Formatting Element

Size
When used with the initial capital, represents a size definition
that can be referenced anywhere a measurement is required.
Also known as Named Size or Size object.

source
language The language in which generated text is authored in a document.

specialization
The DITA process for creating new information types and
describing new information domains based on existing types and
domains.

style
An element's style determines its initial formatting properties, as
well as how it affects and is affected by other elements. For
example, if you map the section element to the Division
style, it affects how an element mapped to the Title style is
formatted when it appears inside a section element.

Styler
An element created automatically by Arbortext Styler to provide
Formatting initial style properties for structures such as tables of contents
Element and indexes when they are defined in generated text. These
elements are prefixed with _sfe:.

stylesheet
A collection of style settings that governs the appearance of a
document. Generic types of stylesheets used in Arbortext Editor
include application, document, local, current editor, and current
print.

1118 User's Guide

target
A language into which generated text can be translated.
language

translation
The body of generated text that has been configured for an
unit element or context and can be translated as one item. Each
translation unit in a stylesheet will form a trans-unit entry
in an XLIFF file exported for translation.

UFE
See User Formatting Element

User
An element created by the user specifically for assigning
Formatting formatting properties to elements defined in generated text.
Element These elements are prefixed with _ufe:.

widow
In typography, the situation where the last line or word of a
paragraph appears at the top of a page, with the first part of the
paragraph appearing at the bottom of the previous page.
In a FOSI, the number of lines to keep at the top of a column.

XPath
The XML Path Language standard developed by the World
Wide Web Consortium for addressing parts of an XML
document.

XSL
A stylesheet that transforms XML documents into HTML,
stylesheet XHTML, or XML. It is helpful to add a suffix to XSL to
indicate the stylesheet's expected output. For example, XSL-
HTML indicates a stylesheet that generates HTML.

Glossary 1119
 Index

.3f file PDF configuration file, 87-88, 90,

associate PTC APP template with 94-96
stylesheet, 55 compatibility, 87-88, 90, 94-95
guidelines for templates associated compression level, 87-88, 90, 94-
with stylesheets, 55 95
crop marks, 87-88, 90, 94-95
initial view, 87-88, 90, 94-95
A PDF version, 87-88, 90, 94-95
accessibility web-optimized PDF output, 87-
alternate text support for graphics, 88, 90, 94-95
172 PDF forms in PDF output, 752
generate accessible HTML output, APP Source Editor, 897
155 menus, 897
generate accessible PDF output, 138 applicable page set, 804
Add Document Language Mapping Arabic
dialog box, 948 features to enable Arabic text, 634
Add HTML Attribute dialog box, 979 numbering styles, 638
Add JavaScript Library dialog box, Arbortext Editor
918 preview documents with stylesheet,
Add Module dialog box, 918 53
Add Namespace Declaration dialog Arbortext Import/Export
box, 919 batch publishing, 694
Add New Elements dialog box, 920 create Export stylesheet, 657
Add PDF Attribute dialog box, 979 limitations when publishing to RTF,
Add Target Language Mapping dialog 696
box, 921 overview, 656
Add Translation Note dialog box, 1055 publish figures, 670
alignment publish footnotes and endnotes, 692
preformatted (xml:space = publish headers and footers, 689
“preserve”), 795 publish lists, 687
side by side, 825 publish RTF with/without Word
side by side formatting, 204 style names, 658
APP publish scoped table of contents, 692
custom JavaScript functions in print/ publish table and figure captions,
PDF output, 749 673-674, 677, 681
publish tables, 672

1121
 publish Word fields, instructions, PDF tags category, 831
and switches, 663 Property sets category, 820
publish XML attributes to Word RTF category, 838
styles, 667 Side by side category, 825
publish XML files, 656 Spacing category, 800
troubleshooting, 695 Text category, 787
log files, error return codes, and Footnote category, 821
event log errors, 695 Generated Contents list, 774
Arbortext Styler Generated text category, 818
concepts overview, 20 Graphic category, 843
DITA styling overview, 620, 622- HTML Functions list, 781
623 HTML tag category, 834
overview, 20 Indent category, 795
versions, 24 Indexes list, 777
Arbortext Styler window, 766 Format category, 861
Block border category, 823 General category, 861
Breaks category, 804 menus, 870, 872, 875, 880, 885,
Breaks category - HTML chunking, 887, 891-892, 894
814 Outputs to Edit field, 787
Breaks category - Keeps, 812 PAD tags category, 831
columns in list views, 781 Page Regions list, 774
Combined Fonts list, 780 Borders category, 858
Comment tab, 785 Graphic category, 856
Cross References list, 778 Other category, 859
Custom Tables list, 777 Position category, 853
Background Color category, 869 Text category, 855
Cells category, 863 Page Sets list, 772
Elements category, 862 Columns category, 848
Format category, 866 x columns, 850
Header Cells category, 864 Other category, 852
Description tab, 784 Page Numbers category, 851
Elements list, 769 Page Size category, 844
Block border category, 823 Page Types category, 847
Breaks category, 804 Page Types list, 772
Breaks category - HTML Property sets category, 820
chunking, 814 Property Sets list, 771
Breaks category - Keeps, 812 Block border category, 823
Footnote category, 821 Breaks category, 804
Generated text category, 818 Breaks category - HTML
Graphic category, 843 chunking, 814
HTML tag category, 834 Breaks category - Keeps, 812
Indent category, 795 Footnote category, 821

1122 User's Guide

 Generated text category, 818 hanging punctuation, 644
Graphic category, 843 right to left layout direction, 652
HTML tag category, 834 Block border category, 823
Indent category, 795 block border properties, 823
PDF tags category, 831 bookmarks
Property sets category, 820 creating PDF bookmarks in
RTF category, 838 Arbortext Styler, 774
Side by side category, 825 borders
Spacing category, 800 adding border rules to block
Text category, 787 elements, 202
PTC ALD Functions list, 781 block elements, 823
RTF category, 838 Borders category, 858
Side by side category, 825 breaks
Sizes list, 778 applicable page set, 804
Spacing category, 800 hyphenation language, 804
Tables of Contents list, 774 run-in titles, 804
Text category, 787 structure type, 804
toolbars, 894 word breaks, 804
Attribute Modifier dialog box, 921 Breaks category, 804
attribute tests Keeps, 812
conditions, 300 Breaks category - HTML chunking,
attributes 814
for HTML tags, 979 Bullet dialog box, 923
for PDF tags, 979 bullets
insert attribute value in generated add bullets to list items, 479
text, 468 change default characters, 479
use attribute value as footnote change font, 479
reference mark output specific, 479
Inline Model, 439-441, 444, 447
Reference Model, 439-441, 444,
C
447
cells
generating custom table cells via
B XPath, 411
background color reorder columns in custom tables,
background color for custom tables, 415
417 Cells category, 863
Background Color category, 869 change tracking
balanced columns, 186 change bars based on an attribute
barcodes value, 524
generating, 599 change bars based on an element,
block 524

Index 1123
 change location of change bars, 524 content tests, 300
change tracking markup in XSL- creating, 300
based publishing, 524 cutting, copying, and pasting, 327
display change bars in document, deleting, 300
524 deleting tests, 300
modify appearance of change bars, editing, 300
524 example of creating, 303
Chinese if, else if and else conditions, 306
features to enable Chinese text, 634 if, else if and else conditions in
chunk boundary, 814 exported stylesheets, 317
CJK nested conditions, 309
numbering styles, 638 nested conditions in exported
color stylesheets, 317
background color for custom tables, overview, 298
417 processing order during publishing,
column breaks 248
repeating titles, 522 processing order in Arbortext Styler,
columns 249, 252-253
balancing, 186 start of HTML chunk tests, 300
justifying, 189 using XPath, 318
reorder columns in custom tables, XPath tests, 300
415 Configure Columns dialog box, 926
setting in a page set, 186 content
Columns category, 848 hiding element content, 236
x columns, 850 content tests
combined fonts, 635 conditions, 300
Combined Fonts list, 780 contexts
Comment tab, 785 applying property sets to, 258
comments changing page orientation, 598
creating for an object, 785 creating, 283
composition cutting, copying, and pasting, 325
overview of preview and publishing, deleting, 283
52 editing, 283
compound numbering example of creating, 291
pages, 345, 347-348 overview, 280
conditions priority of, 282
applying property sets to, 258 processing order during publishing,
attribute tests, 300 248
changing page orientation, 598 processing order in Arbortext Styler,
changing page size, 320 249, 252-253
conditions based on the result of a using XPath, 288
script, 746 Convert Stylesheet dialog box, 934

1124 User's Guide

copy styling HTML from different
conditions, 327 document types, 165
contexts, 325 Custom Content dialog box, 936
cross references, 332 custom tables
custom tables, 331 background color, 417
elements, 324 create a custom table object, 405
overview, 324 cutting, copying, and pasting, 331
page sets, 329 generating cells via XPath, 411
properties, 333 generating header rows via XPath,
property sets, 328 411
tables of contents, 330 reordering columns, 415
Copy to Module dialog box, 935 SFEs to support custom table cells
Cross Reference Details dialog box, generated via XPath, 411
935 style a non table element as a
cross references custom table, 405
auto generate cross reference text, styling, 405
551 styling overview, 404
creating a cross reference format Custom Tables list, 777
object, 551 Background Color category, 869
cutting, copying, and pasting, 332 Cells category, 863
format based on attribute value, 551 Elements category, 862
format based on target element, 551 Format category, 866
modifying default formatting, 563 Header Cells category, 864
output specific, 551 Customize Table of Contents dialog
overview, 550 box, 937
styling an element as a cross cut
reference, 551 conditions, 327
suppress punctuation in references to contexts, 325
numbered element, 495 cross references, 332
to a title that contains footnotes, 563 custom tables, 331
to an alternative title element, 551 elements, 324
to elements without a title, 551 overview, 324
user defined cross reference text, page sets, 329
551 properties, 333
Cross References list, 778 property sets, 328
CSS tables of contents, 330
CSS files in HTML output, 159 Cut Properties dialog box, 939
CSS rules based on property sets,
159
D
custom styling with a custom CSS
file, 159 debug stylesheet

Index 1125
 common stylesheet problems, 1064- Division Details, 941
1065, 1067-1068 Division Title Number, 942
output diagnostic information, 1064- Duplicate Translation Unit IDs in
1065, 1067-1068 Module, 949
functional areas, 1064-1065, Edit Attribute Test, 921
1067-1068 Edit Condition, 925
how to, 1064-1065, 1067-1068 Edit Content Test, 927
information types, 1064-1065, Edit Context, 929
1067-1068 Edit Document Language Mapping,
overview, 1064-1065, 1067-1068 948
sample output of set debug Edit Generated Cell, 977
command, 1064-1065, 1067-1068 Edit Generated Header Cell, 977
XPath performance, 1078 Edit Graphic XPath, 949
declared elements, 264, 266, 269 Edit HTML Attribute, 979
adding to stylesheet, 271 Edit Module, 950
Definition List Details dialog box, 939 Edit PDF Attribute, 979
delete Edit Translation Note, 1055
properties, 333 Edit Uses List, 950
Delete Properties dialog box, 941 Edit XPath Override for Current
Description tab, 784 Level, 951
dialog boxes Edit XPath Test, 1061
Add Document Language Mapping, Export CSS, 954
948 Export FOSI Stylesheet, 954
Add HTML Attribute, 979 Export Generated Text for
Add JavaScript Library, 918 Translation, 955
Add Module, 918 Export PTC APP Template, 953
Add Namespace Declaration, 919 Export XSL-EPUB Stylesheet, 956
Add New Elements, 920 Export XSL-FO Stylesheet, 957
Add PDF Attribute, 979 Export XSL-HTML File Stylesheet,
Add Target Language Mapping, 921 958
Add Translation Note, 1055 Export XSL-HTML Help Stylesheet,
Attribute Modifier, 921 959
Bullet, 923 Export XSL-Web Stylesheet, 960
Configure Columns, 926 Export-XSL-FO RTF Stylesheet,
Convert Stylesheet, 934 958
Copy to Module, 935 Field, 960
Cross Reference Details, 935 Final Page Number, 961
Custom Content, 936 Find Explicit Properties, 962
Customize Table of Contents, 937 Find Where Used, 964
Cut Properties, 939 Footnote Number, 966
Definition List Details, 939 Footnotes, 968
Delete Properties, 941 Formal Block Title Number, 971

1126 User's Guide

 Graphic Details, 978 New User Formatting Element, 1017
HTML/CSS Defects List, 982 New XPath Test, 1061
Import Generated Text Translation, No Stylesheet Found, 1017
983 Number Details, 1017
Incomplete Document Types for Numbering Start and Restart, 1023
Stylesheet, 985 Open Stylesheet, 1024
Index Details, 985 Page Number Start At, 1027
Index Term (Attribute Model) Paragraph Styles for Nested Lists,
Details, 986 1025
Index Term (Element Model) Paste Properties, 1025
Details, 987 Save As Merged Stylesheet, 1026
Index Term (Nesting Element Save Stylesheet As, 1026
Model) Details, 989 Start At, 1027
Insert Attribute Content, 990 Start of HTML Chunk Test, 1030
Insert Attribute Content (Headers Stylesheet Properties, 1031
and Footers), 993 General, 1032
Insert Cross Reference, 994 HTML Chunk, 1037
Insert Division Reference, 942 HTML File, 1033
Insert Element Content, 995 Language, 1040
Insert Element Content (Headers and Print/PDF, 1042
Footers), 998 PTC ALD Formatting, 1044
Insert Index, 1000 RTF, 1048
Insert Leaders, Rule, or Space, 1001 Table, 1047
Insert Metadata, 1002 Tables of Contents Condition, 1049
Insert Symbol, 1003 Tables of Contents Details, 1050
Insert Table of Contents, 1004 Tables of Contents Format, 1050
Insert XPath String, 1004 Tables of Contents Format Details,
Link Details, 1005 1052
Link Target Details, 1006 Translation Defects Window, 1054
List Item Number, 1007 Translation has not Changed, 983
Modify Division Reference, 942 Translation is Already Current, 984
Modules, 1012 Translation is Identical to the
Move to Module, 1014 Source, 984
Namespace Declarations, 1014 Unused Definitions, 1056
New Attribute Test, 921 Use Exported FOSI for, 1056
New Condition, 925 Use Stylesheet For, 1058
New Content Test, 927 Validate Page Sets, 1059
New Context, 929 XPath Predicate, 1060
New Custom Counter, 1015 DITA
New Generated Cell, 977 default stylesheets, 620, 622-623
New Generated Header Cell, 977 DITA support in distributed
New Module, 1016 stylesheets, 620, 622-623

Index 1127
 fallback generalization, 630 Edit menu, 870, 872, 875, 880, 885,
footnotes, 434 887, 891-892, 894
indexes, 382 Edit menu in APP Source Editor, 897
specialized elements, 630 Edit menu in Generated Text Editor,
styling overview, 620, 622-623 903
unstyled elements, 630 Edit menu in Source Editor, 899
working with the resolved document Edit Module dialog box, 950
for styling, 623 Edit PDF Attribute dialog box, 979
Division Details dialog box, 941 Edit Translation Note dialog box, 1055
Division Title Number dialog box, 942 Edit Uses List dialog box, 950
divisions Edit XPath Override for Current Level
generate titles for divisions without dialog box, 951
title elements, 483 Edit XPath Test dialog box, 1061
including division reference in edited source
headers and footers, 343 regenerate when updating a
labeling, 483 stylesheet, 49
non Latin numbering, 638 editing source, 703, 714
numbering, 483 APP root template, 712
compound numbering, 483 APP Source Editor, 897
divisions without title elements, common XSL source, 711
483 compare edited source and XPath,
page x of y numbering, 483 731
specify division levels, 43 contexts, 706
Duplicate Translation Unit IDs in custom JavaScript functions, 749
Module dialog box, 949 delete source edits, 731
elements, 706
elements with numbered conditions
E
or contexts, 726
eBook examples, 723
publishing content for eBooks, 153 FOSI resource description, 710
Edit Attribute Test dialog box, 921 identify items with edited source,
Edit Condition dialog box, 925 700
Edit Content Test dialog box, 927 introduce complex or custom code,
Edit Context dialog box, 929 727, 729
Edit Document Language Mapping adding custom XSL code, 727,
dialog box, 948 729
Edit Generated Cell dialog box, 977 locating missing references, 725
Edit Generated Header Cell dialog box, page set, 709
977 PDF forms in PDF output, 752
Edit Graphic XPath dialog box, 949 property set, 709
Edit HTML Attribute dialog box, 979 source containing references, 725
Source Editor, 899

1128 User's Guide

 tips for FOSI, 722 User Formatting Elements, 264, 266,
tips for XSL, 722 269
XSL root template, 712 XPath test for conditions, 1061
elements Elements category, 862
adding generated text, 465 Elements list, 769
adding to stylesheet, 271 selecting elements, 769
and document types, 278 Elements Not in Document Type
applying property sets to, 258 Window, 952
associate element with page set, 200 Elements toolbar, 894
attribute test for conditions, 921 endnotes
block elements inline model (same element for
adding border rules, 202 reference mark and content), 449
borders, 823 overview, 448
configuring a graphic element, 278 reference model (different elements
content test for conditions, 927 for reference mark and content),
creating, 271 454
cutting, copying, and pasting, 324 EPUB
declared, 264, 266, 269 create chunked output, 148
hiding element content, 236 publishing EPUB output, 153
in free-form XML documents, 264, export
266, 269 export stylesheet as FOSI, 176
insert element content in generated export stylesheet as PTC APP
text, 468 template, 176
keeping together, 274 export stylesheet as XSL, 176
namespaced, 264, 266, 269 Export CSS dialog box, 954
overview, 264, 266, 269 Export FOSI Stylesheet dialog box,
PDF graphic properties, 843 954
postspace, 239 Export Generated Text for Translation
prespace, 239 dialog box, 955
SFEs, See Styler Formatting Export PTC APP Template dialog box,
Elements 953
spacing, 800 Export XSL-EPUB Stylesheet dialog
specialized elements in DITA, 630 box, 956
start of HTML chunk test for Export XSL-FO RTF Stylesheet dialog
conditions, 1030 box, 958
Styler Formatting Elements, 264, Export XSL-FO Stylesheet dialog box,
266, 269 957
UFEs, See User Formatting Export XSL-HTML File Stylesheet
Elements dialog box, 958
undeclared, 264, 266, 269 Export XSL-HTML Help Stylesheet
unstyled, 36 dialog box, 959

Index 1129
Export XSL-Web Stylesheet dialog overview, 338
box, 960 Footnote category, 821
Footnote Number dialog box, 966
footnotes
F
DITA model, 434
fallback generalization, 630 footnote contexts in Elements list,
Field dialog box, 960 422
figures format reference mark, 439-441,
labeling, 491 444, 447
output specific, 491 attribute value as marker, 439-
numbering, 491 441, 444, 447
output specific, 491 numbered footnotes and footnotes
File menu, 870, 872, 875, 880, 885, with reference marks from
887, 891-892, 894 attribute value, 439-441, 444,
File menu in APP Source Editor, 897 447
File menu in Generated Text Editor, scoped footnote numbering, 439-
903 441, 444, 447
File menu in Source Editor, 899 hybrid model, 434
Final Page Number dialog box, 961 inline model (same element for
Find Explicit Properties dialog box, reference mark and content), 425
962 non Latin numbering, 638
Find Explicit Properties Results overview, 422
window, 963 properties, 821
Find menu in Source Editor, 899 reference marker based on callout
Find Where Used, 766 attribute, 434
Find Where Used dialog box, 964 reference model (different elements
Find Where Used Results Window, for reference mark and content),
965 431
font suppress punctuation in footnote
combined fonts, 635 reference, 495
multiple fonts in a single block, 635 Footnotes dialog box, 968
footers Formal Block Title Number dialog
add content, 341 box, 971
adding to a page set, 198 formal blocks
create, 338 labeling, 491
include compound page number, output specific, 491
345, 347-348 non Latin numbering, 638
include division reference, 343 numbering, 491
to titles that contains footnotes, output specific, 491
343 Format category, 861, 866
include page number, 345, 347-348 Format menu in Generated Text Editor,
include x of y page numbering, 345, 903
347-348

1130 User's Guide

FOSI list item numbering, 474
converting to stylesheet, 28 output specific, 474
exporting stylesheets as, 176 markup, 509
limitations of FOSI conversion, 28 overview, 464
free version of Arbortext Styler properties, 818
limitations, 25 repeating titles, 522
migrating stylesheets to the full rules, 507
version, 25 set attribute value in generated text
overview, 24 to value of a different attribute, 468
free-form XML elements, 264, 266, space fills, 507
269 symbols, 513
tables, 514
translation, 528
G
ACL for importing XLIFF files,
General category, 861 545
generalization, 630 document language analysis, 529
Generated Contents list, 774 export generated text for
generated text translation, 537
adding to elements, 465 import translations, 541
bullet manage translation units, 532,
change font, 479 535-536
bullets set source and target languages,
change default characters, 479 529
change bars translation statistics, 544
based on an attribute value, 524 XLIFF files, 538
based on an element, 524 translation units, 532, 535-536
change location, 524 add note for translator, 532, 535-
change tracking markup in XSL- 536
based publishing, 524 turn translations on and off, 532,
display change bars, 524 535-536
modify appearance, 524 UFEs, 517
embed output of script in generated use XPath expression to generate
text, 746 content, 518
Generated Text Editor, 903 use XPath to generate non-standard
graphics, 511 numbering, 506
insert attribute value in generated User Formatting Elements, 517
text, 468 Generated text category, 818
insert element content in generated Generated Text Editor, 903
text, 468 menus, 903
leaders, 507 genfos
list item bullets, 479 save stylesheet with .genfos file, 46
output specific, 479 genfos file, 46

Index 1131
Graphic category, 843, 856 chunked HTML output, 148
Graphic Details dialog box, 978 creating online TOC for chunked
graphics HTML output in Arbortext Styler,
alternate text support, 172 774
configuring a graphic element, 278 CSS files in HTML output, 159
configuring to output barcodes and custom JavaScript functions in
QR codes, 599 HTML output, 749
in generated text, 511 define chunk boundaries, 148
intelligent graphics, 568 define chunk filenames, 148
PDF graphics, 570 generate accessible HTML output,
graphics sets 155
stylesheet support, 568 generate XHTML output, 153
HTML tags, 834
JavaScript libraries in HTML
H
output, 749
Header Cells category, 864 pass metadata to chunked output,
headers 148
add content, 341 persistent file name, 814
adding to a page set, 198 preview documents with stylesheet,
create, 338 53
include compound page number, styling HTML from different
345, 347-348 document types, 165
include division reference, 343 HTML Functions list, 781
to titles that contain footnotes, HTML Help
343 create chunked output, 148
include page number, 345, 347-348 HTML tag category, 834
include x of y page numbering, 345, HTML tags
347-348 attributes, 979
overview, 338 HTML/CSS Defects List, 982
Hebrew HTML5
features to enable Hebrew text, 634 generate HTML5 output, 153
numbering styles, 638 hyphenation, 216, 219
Help menu, 870, 872, 875, 880, 885, languages supported in Styler, 216,
887, 891-892, 894 219
Help menu in APP Source Editor, 897 hyphenation language, 804
Help menu in Source Editor, 899
HTML
alternate text support from graphics, I
172 Import Generated Text Translation
attributes for semantic HTML dialog box, 983
output, 979 Incomplete Document Types for
chunk boundary, 814 Stylesheet dialog box, 985
indent

1132 User's Guide

 properties, 795 General category, 861
Indent category, 795 Insert Attribute Content dialog box,
indents 990
hanging punctuation, 644 Insert Attribute Content dialog box
index (Headers and Footers), 993
alternative sorting, 386 Insert Cross Reference dialog box, 994
attribute model, 381 Insert Division Reference dialog box,
configure multiple indexes for a 942
document, 388 Insert Element Content (Headers and
context matching of elements in Footers) dialog box, 998
index terms, 395 Insert Element Content dialog box, 995
DITA model, 382 Insert Index dialog box, 1000
element model, 379 Insert Leaders, Rule, or Space dialog
from multiple index elements, 379 box, 1001
from single index term element with Insert menu, 870, 872, 875, 880, 885,
attribute, 381 887, 891-892, 894
from single nested index term Insert menu in Generated Text Editor,
element, 382 903
generate a sorted inline list, 396 Insert menu in Source Editor, 899
include elements not styled as index Insert Metadata dialog box, 1002
terms, 393 Insert Symbol dialog box, 1003
insert index terms into multiple Insert Table of Contents dialog box,
indexes, 393 1004
modify index appearance, 390 Insert XPath String dialog box, 1004
modify index parameters, 392 intelligent graphics
nesting element model, 382 graphics sets, 568
non Latin numbering, 638 stylesheet support, 568
overview, 378
see, 384
J
see also, 384
Index Details dialog box, 985 Japanese
Index Term (Attribute Model) Details features to enable Japanese text, 634
dialog box, 986 JavaScript
Index Term (Element Model) Details associate JavaScript libraries with a
dialog box, 987 stylesheet, 749
Index Term (Nesting Element Model) custom JavaScript functions, 749
Details dialog box, 989 justified columns, 189
indexes
scope, 861 K
styling, 861
Indexes list, 777 keeps, 812
Format category, 861 keeping elements together, 274
run in titles, 274

Index 1133
 widow and orphan control, 274 List Unused Definitions, 766
keyboard navigation, 1082 lists
Korean bullets, 479
features to enable Korean text, 634 change default characters, 479
change font, 479
output specific, 479
L
non Latin numbering, 638
labeling numbering, 474
divisions, 483 output specific, 474
divisions without title elements,
483
figures, 491 M
formal blocks, 491 margins
output specific, 491 hanging punctuation, 644
tables, 491 setting in a page set, 185
landscape mode markup
formatting tables in, 598 in generated text, 509
language menus
language settings for a stylesheet, 32 Arbortext Styler, 870, 872, 875, 880,
non-Latin languages 885, 887, 891-892, 894
combined fonts, 635 Edit, 870, 872, 875, 880, 885,
hanging punctuation, 644 887, 891-892, 894
non-Latin numbering styles, 638 File, 870, 872, 875, 880, 885, 887,
right to left layout direction, 652 891-892, 894
strikethrough styles, 646 Help, 870, 872, 875, 880, 885,
underline styles, 646 887, 891-892, 894
overview of support for non Latin Insert, 870, 872, 875, 880, 885,
languages, 634 887, 891-892, 894
leaders Options, 870, 872, 875, 880, 885,
in generated text, 507 887, 891-892, 894
limitations of output support, 1084 Preview, 870, 872, 875, 880, 885,
Link Details dialog box, 1005 887, 891-892, 894
Link Target Details dialog box, 1006 Tools, 870, 872, 875, 880, 885,
links 887, 891-892, 894
basic link formatting, 551 View, 870, 872, 875, 880, 885,
create simple internal link, 551 887, 891-892, 894
overview, 550 Styler menu in Arbortext Editor,
SFEs to support dynamic linking 870, 872, 875, 880, 885, 887, 891-
_sfe:ExternalLink, 565-566 892, 894
_sfe:InternalLink, 565-566 metadata
SFEs to support linking, 565-566 custom XMP metadata in PDF
List Item Number dialog box, 1007 output, 169

1134 User's Guide

 pass metadata to chunked output, New Attribute Test dialog box, 921
148 New Condition dialog box, 925
pass metadata to PDF output, 169 New Content Test dialog box, 927
Modify Division Reference dialog box, New Context dialog box, 929
942 New Custom Counter dialog box, 1015
modules New Generated Cell dialog box, 977
adding new definitions, 593 New Generated Header Cell dialog
creating a new stylesheet using box, 977
existing modules, 585 New Module dialog box, 1016
creating from existing stylesheet, New User Formatting Element dialog
584 box, 1017
modifying definitions in a module, New XPath Test dialog box, 1061
591 No Stylesheet Found dialog box, 1017
overriding stylesheet definitions, Number Details dialog box, 1017
588 numbering
overview, 582 advanced numbering, 495
Modules dialog box, 1012 Arabic numbering styles, 638
Modules toolbar, 894 CJK numbering styles, 638
Move to Module dialog box, 1014 compound page numbers, 345, 347-
348
divisions, 483
N
compound numbering, 483
Namespace Declarations dialog box, divisions without title elements,
1014 483
namespaced elements, 264, 266, 269 page x of y numbering, 483
adding to stylesheet, 271 figures, 491
new formal blocks, 491
condition, 300 output specific, 491
context, 283 Hebrew numbering styles, 638
create new stylesheet, 30 list items, 474
cross reference format object, 551 output specific, 474
custom table object, 405 number non-numbered elements,
definition in module, 593 506
element, 271 number titles consecutively based on
header or footer, 338 attribute, 495
module numbered titles or captions for
from existing stylesheet, 584 figures, 495
property set, 256 numbering sequences based on
stylesheet element type, 495
using existing modules, 585 page numbers, 199
table of contents, 352 page numbers in headers and
table of contents format object, 355 footers, 345, 347-348

Index 1135
 place number after title, 495 P
start numbering at 0, 495
page breaks
start numbering based on attribute
repeating titles, 522
value, 495
page extent
suppress punctuation in references to
setting for a page set, 184
numbered element, 495
page layout, See page sets
tables, 491
hanging punctuation, 644
Thai numbering styles, 638
right to left layout direction, 652
use XPath to generate non-standard
page layouts
numbering, 506
side by side formatting, 204
x of y page numbers in headers and
Page Number Start At dialog box,
footers, 345, 347-348
1027
Numbering Start and Restart dialog
page numbers
box, 1023
defining in a page set, 199
include page numbers in headers and
O footers, 345, 347-348
Page Numbers category, 851
open
page orientation
open existing stylesheet, 30
setting for a page set, 182
Open Stylesheet dialog box, 1024
using conditions to change, 598
Options menu, 870, 872, 875, 880,
using contexts to change, 598
885, 887, 891-892, 894
page regions
orphans, 812
avoid settings, 859
controlling with keeps, 274
background color, 859
Other category, 852
borders, 858
Other category (page regions), 859
clip to page edge, 859
output
creating for a page set, 190
chunked HTML output, 148
creating with a helper, 192
create sets of output formats to style,
graphic content, 856
950
position, 853
generate HTML5 output, 153
rotation, 853
generate XHTML output, 153
size, 853
generate XHTML5 output, 153
text content, 855
styling HTML from different
Page Regions list, 774
document types, 165
Borders category, 858
output support
Graphic category, 856
limitations, 1084
Other category, 859
Outputs to edit
Position category, 853
sets of output formats, 235
Text category, 855
Outputs to Edit field, 787
page sets
applying to an element, 200
change bars, 852

1136 User's Guide

 columns, 186, 848, 850 paragraphs
creating, 182 run-in styling, 215
cutting, copying, and pasting, 329 paste
footers, 198 conditions, 327
headers, 198 contexts, 325
margins, 185, 844 cross references, 332
nested page sets, 180 custom tables, 331
number of pages, 184 elements, 324
overview, 180 overview, 324
page extent multiples, 852 page sets, 329
page numbers, 199, 851 properties, 333
page regions, 190 property sets, 328
add page region helper, 192 tables of contents, 330
page size, 844 Paste Properties dialog box, 1025
page types, 847 PDF
print engine support for features, alternate text support from graphics,
180 172
set page orientation, 182 attributes for tagged PDF output,
set page size, 182 979
validating, 200 creating PDF bookmarks with
Page Sets list, 772 Arbortext Styler, 774
Columns category, 848 custom metadata in PDF output, 169
x columns, 850 generate accessible PDF output, 138
Other category, 852 pass metadata to PDF output, 169
Page Numbers category, 851 PDF configuration file
Page Size category, 844 APP, 87-88, 90, 94-96
Page Types category, 847 PDF forms in PDF output, 752
page size PDF tags, 831
setting for a page set, 182 preview documents with stylesheet,
using conditions to change, 320 53
Page Size category, 844 set PTC APP as default print engine
Page Types category, 847 for stylesheet, 55
Page Types list, 772 PDF graphic properties, 843
pages PDF tags
compound numbering, 345, 347-348 attributes, 979
include x of y page numbers in PDF tags category, 831
headers and footers, 345, 347-348 performance
non Latin numbering, 638 save genfos file to improve
numbering, 199 document startup time, 46
spacing, 800 persistent file name, 814
Paragraph Styles for Nested Lists Position category, 853
dialog box, 1025 postspace

Index 1137
 applying to elements, 239 deleting, 333
precedence level of, 239 deriving properties from ancestors,
precedence 223
specifying for prespace and deriving property values, 223
postspace, 239 footnotes, 821
prespace generated text, 818
applying to elements, 239 HTML tags, 834
precedence level of, 239 hyphenation language, 804
preview indent, 795
overview of preview and publishing, initial, 243
52 keeps, 812
preview documents with stylesheet, modifying, 233
53 multi-output properties, 235
preview with PTC APP, 55 orphans, 812
Preview menu, 870, 872, 875, 880, output-specific properties, 234
885, 887, 891-892, 894 overview, 222
print PDF graphics, 843
preview documents with stylesheet, PDF tags, 831
53 persistent file name, 814
print with PTC APP, 55 processing order of properties in
set PTC APP as default print engine Arbortext Styler, 249, 252-253
for stylesheet, 55 property derivation chain, 223
print engine property sets, 820
APP resolving property values, 227
PDF configuration file, 87-88, 90, RTF, 838
94-95 run-in titles, 804
print/PDF side by side, 825
keeps, 812 spacing, 800
orphans, 812 structure type, 804
widows, 812 text, 787
processing order widows, 812
during publishing, 248 word breaks, 804
in Arbortext Styler, 249, 252-253 property sets
properties applying to contexts or conditions,
applicable page set, 804 258
block border, 823 applying to property sets, 258
chunk boundary, 814 block elements
color changes when properties set, borders, 823
244 creating, 256
compare explicit and derived values, cutting, copying, and pasting, 328
229 deleting, 256
cutting, copying, and pasting, 333 editing, 256

1138 User's Guide

 example of creating, 261 publish RTF with/without Word
overview, 256 style names, 658
PDF graphic properties, 843 publish scoped table of contents in
processing order in Arbortext Styler, RTF files, 692
249, 252-253 publish table and figure captions in
renaming, 256 RTF, 673-674, 677, 681
working with, 256 mapping a context to a single
Property sets category, 820 paragraph style, 673-674, 677,
Property Sets list, 771 681
property values mixing paragraph and character
determining from processing order styles with a SEQ field, 673-674,
of contexts during publishing, 248 677, 681
PTC Advanced Print Publisher using generated text for labeling a
access from Arbortext Styler, 55 SEQ field for numbering, 673-
installation with Arbortext Styler, 55 674, 677, 681
print features available, 61 publish tables in RTF files, 672
PTC ALD Functions list, 781 publish Word fields, instructions,
PTC APP, See PTC Advanced Print and switches in RTF, 663
Publisher publish XML attributes to Word
associate PTC APP template with styles in RTF, 667
stylesheet, 55 publish XML files to RTF with
guidelines for templates associated Arbortext Import/Export, 656
with stylesheets, 55 publishing
overview of autogenerated PTC APP generate HTML5 output, 153
source, 714 generate XHTML output, 153
set as default print engine for generate XHTML5 output, 153
stylesheet, 55 styling HTML from different
PTC APP templates document types, 165
exporting stylesheets as, 176
publish
Q
batch publishing of RTF files, 694
create Export stylesheet, 657 QR codes
EPUB output, 153 generating, 599
limitations of publishing to RTF,
696
R
publish figures in RTF, 670
publish footnotes and endnotes in resolved document, 623
RTF files, 692 RTF
publish headers and footers in RTF batch publishing, 694
files, 689 create Export stylesheet, 657
publish lists in RTF files, 687 keeps, 812
limitations of publishing to RTF,
696

Index 1139
 orphans, 812 S
overview of Arbortext Import/
Save As Merged Stylesheet dialog box,
Export, 656
1026
preview documents with stylesheet,
Save Stylesheet As dialog box, 1026
53
scripts
properties, 838
accessing from Arbortext Styler, 746
publish figures, 670
create conditions based on the result
publish footnotes and endnotes, 692
of a script, 746
publish headers and footers, 689
embed output of script in generated
publish lists, 687
text, 746
publish scoped table of contents, 692
_sfe:ExternalLink, 565-566
publish table and figure captions,
_sfe:GeneratedCell, 411
673-674, 677, 681
_sfe:GeneratedHeaderCell, 411
mapping a context to a single
_sfe:GeneratedHeaderRow, 411
paragraph style, 673-674, 677,
_sfe:InternalLink, 565-566
681
SFEs, See Styler Formatting Elements
mixing paragraph and character
_sfe:ExternalLink, 565-566
styles with a SEQ field, 673-674,
_sfe:InternalLink, 565-566
677, 681
SFEs to support custom table cells
using generated text for labeling a
generated via XPath, 411
SEQ field for numbering, 673-
SFEs to support linking, 565-566
674, 677, 681
Side by side category, 825
publish tables, 672
Sizes list, 778
publish with/without Word style
source
names, 658
editing stylesheet source, 703
publish Word fields, instructions,
viewing stylesheet source, 701
and switches, 663
Source Editor, 899
publish XML attributes to Word
menus, 899
styles, 667
space
publish XML files to RTF, 656
applying to elements, 239
troubleshooting Import and Export
space fills
issues, 695
insert in generated text, 507
log files, error return codes, and
spacing
event log errors, 695
elements, 800
widows, 812
pages, 800
RTF category, 838
text, 800
rules
Spacing category, 800
in generated text, 507
spacing properties, 800
run-in styling, 215
specialized elements, 630
run-in titles, 804
Standard toolbar, 894
Start At dialog box, 1027

1140 User's Guide

Start of HTML Chunk Test dialog box, Print/PDF tab, 1042
1030 RTF tab, 1048
start of HTML chunk tests Tables tab, 1047
conditions, 300 stylesheet source
strikethrough editing, 703
customize, 646 viewing, 701
structure type, 804 stylesheets
.style file, 46 adding new definitions to modules,
Style Helper, 43 593
Styler Formatting Elements, 264, 266, creating modules from, 584
269 creating using existing modules, 585
styles exporting, 176
applying, 37 modifying definitions in modules,
Hidden, 236 591
overview, 35 overriding stylesheet definitions
Style Helper, 43 with modules, 588
stylesheet overview of preview and publishing,
associate PTC APP template with 52
stylesheet, 55 previewing, 53
create basic hierarchy, 43 symbols
create new stylesheet, 30 in generated text, 513
export as FOSI, 176
export as PTC APP template, 176
T
export as XSL, 176
language setting, 32 Table menu in Generated Text Editor,
migrate stylesheet from previous 903
release, 47 Table of Contents Format Details
open existing stylesheet, 30 dialog box, 1052
regenerate edited source when Table of Contents Format dialog box,
updating, 49 1050
save, 46 tables
save as, 46 formatting in landscape mode, 598
save with .genfos file, 46 in generated text, 514
single stylesheet for multiple labeling, 491
document types, 30 output specific, 491
validate, 44 numbering, 491
Stylesheet Properties dialog box, 1031 output specific, 491
ALD Formatting tab, 1044 tables of contents
General tab, 1032 attribute test for conditions, 921
HTML Chunk tab, 1037 conditions, 360
HTML File tab, 1033 content
Language, 1040

Index 1141
 change a title's numbering for its generate accessible HTML output,
TOC entry, 360 155
change a title's punctuation for its generate accessible PDF output, 138
TOC entry, 360 pink tags, 36
control TOC entries based on template
attribute, 360 .3f files in Arbortext Styler, 55
control TOC entries based on associate PTC APP template with
content, 360 stylesheet, 55
control TOC entries with XPath, guidelines for PTC APP templates
360 associated with stylesheets, 55
include a title that contains tests
footnotes, 360 creating for conditions
include additional generated text attribute test, 921
in TOC entry, 360 content test, 927
include generated titles, 360 start of HTML chunk test, 1030
content test for conditions, 927 XPath test, 1061
creating a table of contents format editing for conditions
object, 355 attribute test, 921
creating online TOC for chunked content test, 927
HTML output in Arbortext Styler, start of HTML chunk test, 1030
774 XPath test, 1061
customizing, 937 text
customizing the content, 360 alignment, 795
cutting, copying, and pasting, 330 effects, 787
formatting, 1050 hide, 787
modify a table of contents format, indent, 795
357 non-Latin languages
non standard formatting, 370 combined fonts, 635
numbering to left of entry, 370 hanging punctuation, 644
overview, 352 non-Latin numbering styles, 638
start of HTML chunk test for right to left layout direction, 652
conditions, 1030 strikethrough styles, 646
styling an element to generate a underline styles, 646
table of contents, 357 offset, 787
XPath test for conditions, 1061 shading, 787
Tables of Contents Condition dialog size, 787
box, 1049 spacing, 800
Tables of Contents Details dialog box, style, 787
1050 super/subscript, 787
Tables of Contents list, 774 Text category, 787
tags Text category (page regions), 855
text properties, 787

1142 User's Guide

Thai U
features to enable Thai text, 634
UFEs, See User Formatting Elements
numbering styles, 638
in generated text, 517
titles
undeclared elements, 264, 266, 269
advanced titles, 495
adding to stylesheet, 271
place number after title, 495
underlining
place title after figure, 495
customize, 646
repeating titles, 522
unstyled elements, 36
run in titles, 274
DITA, 630
run-in styling, 215
Unused Definitions dialog box, 1056
toolbars, 894
update
Tools menu, 870, 872, 875, 880, 885,
update stylesheet from previous
887, 891-892, 894
release, 47
Tools menu in Generated Text Editor,
Use Exported FOSI for dialog box,
903
1056
Tools menu in Source Editor, 899
Use Stylesheet For dialog box, 1058
translation User Formatting Elements, 264, 266,
language settings, 32 269
translate generated text, 528 adding to stylesheet, 271
document language analysis, 529 in generated text, 517
export generated text, 537
import translations, 541
manage translation units, 532, V
535-536 validate
set source and target languages, page sets, 200
529 stylesheet, 44
translation statistics, 544 Validate Page Sets dialog box, 1059
XLIFF files, 538 View menu, 870, 872, 875, 880, 885,
XLIFF files 887, 891-892, 894
use ACL to import, 545 View menu in Source Editor, 899
Translation Defects Window, 1054
Translation has not Changed dialog
box, 983 W
Translation is Already Current dialog Web
box, 984 create chunked output, 148
Translation is Identical to the Source widows, 812
dialog box, 984 controlling with keeps, 274
Translations menu in Generated Text Window menu in Source Editor, 899
Editor, 903 word breaks, 804

X
XHTML

Index 1143
 generate XHTML output, 153
styling XHTML from different
document types, 165
XHTML5
generate XHTML5 output, 153
XMP
custom XMP metadata in PDF
output, 169
XPath
generating custom table cells via
XPath, 411
generating custom table header rows
via XPath, 411
insert element node set in generated
text, 518
insert element/attribute content in
generated text, 518
number non-numbered elements,
506
tips to improve XPath performance,
1078
use XPath to generate non-standard
numbering, 506
XPath expressions in generated text,
518
XPath Predicate dialog box, 1060
XPath tests
conditions, 300
.xsl file, 46
XSL stylesheets
exporting stylesheets as, 176

1144 User's Guide