78
This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication CROSSING THE DIVIDE Jang F.M. Graat Advanced Techniques for Conversion to Structured FrameMaker

Advanced techniques for conversion to structured FrameMaker

Embed Size (px)

DESCRIPTION

Having well-formatted content available in FrameMaker enables you to automatically convert that content to structured FrameMaker (and then possibly moving it into XML). Automating the entire process is possible using a combination of preprocessing (with FrameMaker's built-in ExtendScript), smart conversion tables and post-processing (using FrameSLT, a low-cost plug-in for FrameMaker and some more ExtendScript). This tutorial outlines some of the tricks and tips that will get you started.

Citation preview

Page 1: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

CROSSING THE DIVIDE

Jang F.M. Graat

Advanced Techniques for Conversionto Structured FrameMaker

Page 2: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

WHO’S TALKING ?

Jang F.M. Graat

Studied Applied Physics, Psychology, Philosophy

Worked 25+ Years in Tech Comms Industry

Self-educated Professional

Automating FrameMaker

ExtendScript, XSLT, DITA

Page 3: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

A. About Conversion

B. Pre-Processing

C. Conversion Tables

D. Post-Processing

E. When All Else Fails...

AGENDA

Page 4: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

ABOUT CONVERSION

A-0

Page 5: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

UNSTRUCTURED ?

A-1

Page 6: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

FORMAT TAGS

A-2

Page 7: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

CONTENT + FORMATS

A-3

Page 8: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

BUILD CONVERSION TABLE

A-4

Page 9: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

STRUCTURE DOCUMENT

A-5

Page 10: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

PRE-PROCESSING

Avoiding Conversion Crashes

Optimizing Format Tags

Improving the Structure

Handling Text Insets

Preparations for Batch-Processing

B-0

Page 11: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

FRAMEMAKER CRASHES

B-1

Page 12: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

WHAT WENT WRONG ?

B-1a

Page 13: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

“MIF-WASH”

Save Document to MIF

Open MIF Document

Save as FM Document

Removes Various Illegal Characters

B-1b

Page 14: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

AVAILABLE IN SAMPLES

B-1c

Page 15: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

ACTIVATE IN MAKER.INI

B-1d

Page 16: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

ANCHORED TEXT FRAMES

B-2

Page 17: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

CONVERSION TABLE

B-2a

Page 18: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

AFRAME AS GRAPHIC

B-2b

Page 19: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

MOVE INTO FLOW

Identify Applicable Anchored Frames

Find Paragraph that Contains the Anchor

Move Content into New Paragraphs

Apply Formats to New Paragraphs

Remove Anchored Frame

B-2c

Page 20: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

AFTER SCRIPT

B-2d

Page 21: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

ADAPT NOTE FORMATS

B-2e

Page 22: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

RESULTING STRUCTURE

B-2f

Page 23: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

NOTE ICONS

B-3

Info note

Tools note

Page 24: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

CHANGE TO FORMATS

Identify Anchored Frames with Icons

Find Paragraph that Contains the Anchor

Add Empty Paragraph Before

Apply Note Format to Empty Paragraph

Remove Anchored Frame with Icon

B-3a

Page 25: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

AFTER SCRIPT

B-3b

Page 26: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

ICONS ON REF PAGES

B-3c

Page 27: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

FORMAT NOTE PARA’S

B-3d

Page 28: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

AFTER REFORMATTING

B-3e

Page 29: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

ADD CONVERSION RULES

B-3f

Page 30: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

RESULTING STRUCTURE

B-3g

Page 31: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

TEXT INSETS

B-4

Page 32: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

CONVERSION TABLE

B-4a

Page 33: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

CONVERSION RESULT

B-4b

Page 34: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

INVALID STRUCTURE

B-4c

Page 35: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

PRE-PROCESS TEXT INSETS

Text Insets are Probably Reuse Items

Structure Inset Files Separately

Do not Include in Converted Files

Define Placeholder Element

Pass Inset File Pointer to Post-Processing

B-4d

Page 36: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

PRE-PROCESSED INSETS

B-4e

Page 37: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

CONVERSION TABLE

B-4f

Page 38: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

CONVERSION RESULT

B-4g

Page 39: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

VALID STRUCTURE

B-4h

Page 40: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

BATCH-PROCESSING

Input Directory

Move FM Files

Generated Files

Backup Files

Recovery Files

Specific Conversions

Select Conversion Tables

B-5

Page 41: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

PREPARING THE BATCH

B-5a

TOCchapter 1chapter 2chapter 3chapter 4Index

book

input temp

output

TOCchapter 1chapter 2chapter 3chapter 4Index

book

Page 42: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

CONVERSION TABLES

Catching All Formats

Structured Conversion Tables

Modular Conversion Tables

Handling User Variables

C-0

Page 43: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

CATCH ALL FORMATS

Use Multiple Files as Input

Generate Conversion Table > Update Existing

Use Wildcards

% Matches 0 or more Characters

Accept Upper/Lowercase, Spaces in Format Tags

Add Catchall Format Rules

Define Recognizable Catchall Elements

C-1

Page 44: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

STRUCTURED TABLES

Empty Structured Conversion Table

Let FrameMaker Add Rules

Drag Rows in the Desired Order

Use Structure Tools to Manipulate Table

C-2

Page 45: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

MODULAR TABLES

FM Does not Require One Table

Pull Tables in via Text Insets

Combine Modules into Complete Documents

Reuse Higher-Level Modules

C-3

Page 46: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

EXAMPLE: MERGING STYLES

House style 1

House style 1I

House style III

H1, H2, ...Bold, ItalicsImages

Title1, Title2EmphasisFigure

Head1, ...b, i, u, ...Images

} titlepara figurestrongemphasistable

}topicconceptreferenceproceduresectionsubsection

C-3a

Page 47: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

USER VARIABLES

C-4

Page 48: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

ADD TO CONVERSION

C-4a

Page 49: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

CONVERTED VARIABLES

C-4b

Page 50: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

DEFINE BOOK ATTRIBUTES

C-4c

Page 51: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

PREFIX VAR ELEMENT

C-4d

Page 52: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

POST-PROCESSING

Importing EDD + Formats

Optimizing the Structure

Relinking Cross-References

Converting Conditional Text

D-0

Page 53: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

STRUCTURE > FORMATS

DTD

CSS

+

=

Doc

CSS

Doc

} EDD +

=

DocDoc

EDD

Template

Doc

Template

D-1

Page 54: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

EDD SETS FORMAT TAGS

D-1a

Page 55: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

FORMATS IN TEMPLATE

D-1b

Page 56: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

EDD PREFIX RULES

D-1c

Page 57: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

EDD CHANGE HISTORY

D-1d

Page 58: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

EDD VERSION TRACKING

D-1e

Page 59: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

EDD INFO AVAILABLE

D-1f

Page 60: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

OPTIMIZING STRUCTURE

Inconsistent Formatting in Legacy Documents

Structural Reordering of Elements

Replacing Fixed-Text Elements

Inserting new Elements

Re-linking Text Insets

D-2

Page 61: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

XSLT IN FRAMEMAKER

West Street Consulting

XPath Expressions

Element Actions

Attribute Actions

Scripting Options

$ 100 =

D-2a

Page 62: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

FRAMESLT NODE WIZARD

D-2b

Page 63: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

NODE WIZARD SCRIPTS

D-2c

Page 64: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

INSERTING ELEMENTS

D-2d

Page 65: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

RETAGGING ELEMENTS

D-2e

Page 66: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

CROSS-REFERENCES

Ensure Targets have Unique ID Attribute

Move Cross-Ref Marker IDs to Proper Targets

Re-insert Cross-References

FM Only Allows Inserting Resolved Cross-Refs

D-3

Page 67: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

CONDITIONAL CONTENT

Unstructured FM uses TextRange Properties

Not Removed or Handled by Conversion

Hide Conditional Content to find Markers

Wrap Markers into <phrase> Elements

Use FrameSLT to Correct the Structure

Define Filters Based on Attributes and Xpath

D-4

Page 68: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

WHEN ALL ELSE FAILS...

E-0

Page 69: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

EVEN MS WORD IS XML

zip word

E-1

Page 70: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

DOCX IN MS WORD

E-2

Page 71: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

CONTENT IN XXXXML

E-3

Page 72: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

FINDING THE CONTENT

E-4

Page 73: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

XSLT

E-5

Page 74: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

THE BAIT

E-6

Page 75: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

THE CATCH

E-7

Page 76: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

MORE INFOWrite Less, Say More (Minimalism)

TA3 - Wednesday 11:15 - room 12A

Changing the Engine Without Stopping the Car

TA5 - Wednesday -15:00 - room 12A

Website : www.jang.nl

Automating FrameMaker blogs

Twitter : @4everJang ( blog post announcements )

Page 77: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

Page 78: Advanced techniques for conversion to structured FrameMaker

This presentation was created by Jang F.M. Graat and delivered at the tcworld 2012 conferences. © 2012 JANG Communication

THANK YOU