Customizing a FrameMaker Structured Application You can do it!

Transcription

1 Customizing a FrameMaker Structured Application You can do it! STC Summit Chicago, IL 22 May Scott Prentice, Leximation, Inc.

2 Introduction Scott Prentice, President of Leximation, Inc. Specializing in FrameMaker plugin development as well as structured FrameMaker conversions, consulting, and development. FrameMaker user/developer since Developed DITA FMx, a FrameMaker plugin for efficient DITA authoring and publishing. Developer of custom Help systems and creative/functional web applications.

3 Before we start... I ll be working with a DITA structured application. These concepts apply to all apps, don t get caught up in DITA. I ll be using DITA-FMx apps and processing tools. This is just for convenience, it is not required. Live demo with real content...

4 Structured application? Structured application applies formatting to XML files opened in FrameMaker Similar in concept to CSS / HTML.. but more Applies formatting based on context Can perform transformation of structure

5 But why? FrameMaker is both an XML authoring and publishing tool Front-loads the PDF publishing effort Want well-formatted PDFs? Conceptually similar to XSL-FO development (but far easier)

6 Structapp components DTD - Document Type Definition EDD - Element Definition Document Template Read/write rules XSLT import and/or export stylesheets Import/export FDK client

7 Relationship of components DTD - defines the model EDD - created from the DTD, references styles in template Template - defines the styles and page layout, contains a copy of the EDD Read/write rules - defines special element properties as read from or written to XML on disk XSLT import and/or export stylesheets - optionally perform transformation on import or export

8 Create a new app? Creating complex app can be a bit of work Create EDD from DTD Modify EDD to apply context rules Import EDD into template You can create an app from a DTD and CSS Open DTD as EDD Import CSS into EDD

9 Customize existing app? If possible, it s best to start from an existing app First, clone the structured application files Next, create a new structured application definition Then, start with template modifications: Modify paragraph or character styles and formats Update the page layout headers/footers (master pages) Update the reference pages as needed

10 <DEMO - Clone apps> Show location of app files Copy main app folder to new name Rename app name in each EDD and import into templates Update app name and rename paths in stub files Add stubs to structapp file Read structapp file

11 <DEMO - Modify template> Open DITA map in FrameMaker + DITA-FMx Generate book from map View generated book.. locate items that require change Modify in generated file Open Book template and import formats from modified file Regenerate book and see changes change main title font change side-head space add colored box to title change chapnum color/font

12 Need structural changes? If you want to modify the structure: New elements or attributes General rule changes Special context rules You ll need to modify the EDD Then import the EDD into the template (don t forget!)

13 <DEMO - EDD changes> Show general structure of EDD and element definitions Locate element to change, determine modification type Update EDD and import into test document Repeat until satisfied Import EDD into template Set color of shortdesc based on parent topic type task Then add support for concept concept Then add a level rule to add a SingleLine under shortdesc at first topic Regenerate book and see changes

14 Other types of processing? Read/write rules allow definition of special element properties when reading or writing to disk Import/export XSLT for serious modifications to the structure or content Import/export FDK client (plugin) can perform any other automated processing needed

15 It s worth the effort! Fine tuning a structured application can take time Leverages existing FrameMaker template skills Start simple and learn as you go Puts you in control of your PDF layout and formatting

16 Resources / questions Structured Application Developer s Guide is your friend Structured FrameMaker Forum Questions? Scott Prentice <scott AT leximation.com> Leximation, Inc. -