Adobe FRAMEMAKER - User Manual

WHITEPAPER
Using the Open Toolkit plug-in
for FrameMaker
With the Darwin Information Typing Architecture (DITA) emerging as the de facto stan-
dard for creating topic-based content, Adobe® FrameMaker® 9 provides extensive support
for authoring DITA content. In addition, you can use the DITA Open Toolkit with
FrameMaker to obtain deliverable outputs. This document describes how to use the DITA
Open Toolkit with FrameMaker 9.
You are expected to know how to use DITA in FrameMaker. For information on installing
DITA Open Toolkit, see “Appendix 1: Installing the DITA Open Toolkit
” on page 9, and
“Appendix 2: Installing the Open Toolkit plug-in for FrameMaker
” on page 13.
Overview of DITA Open Toolkit
DITA Open Toolkit is a set of software tools, originally developed by IBM®, for publishing
DITA to various formats, including HTML, Microsoft HTML Help (.CHM) and Java™
Help. If your content conforms to the DITA structure, you can use the DITA Open Toolkit
to generate a wide variety of outputs.
The DITA Open Toolkit—an Open Source tool chain for multichannel publishing
DITA Open Toolkit is available for free distribution on the Organization for the Advance-
ment of Structured Information Standards (OASIS) website at http://www.oasis-open.org/
committees/tc_home.php?wg_abbrev=dita. OASIS maintains the DITA specification.
Working with the Open Toolkit plug-in for FrameMaker
The Open Toolkit plug-in for FrameMaker lets you manage publishing through the
FrameMaker user interface. The plug-in provides a DITA menu for publishing multiple
outputs through the DITA Open Toolkit, using the default options or your customized
builds.
HTML
Compiled Help
Java Help
XML conforming to
DITA Structure
DITA Open
ToolKit
XML
TABLE OF CONTENTS
1 Over view of DITA Open Toolk it
1 Working with the Open Toolkit plug-in for
FrameMaker
3 Advanced features
9 Appendix 1: Installing the DITA Open Toolkit
13 Appendix 2: Installing the Open Toolkit plug-
in for FrameMaker
14 Next steps
14 Resources

Summary

Working with the Open Toolkit Plug-in for FrameMaker

Current File Method for Output Generation

Selected Target Method for Output Generation

Advanced Features and Customization

Modifying the DITA Initialization File (ditafm.ini)

Appendix 1: Installing the DITA Open Toolkit

Prerequisites for DITA Open Toolkit

Requires Java Development Kit, Apache Ant, JavaHelp, SAXON, and Microsoft HTML Help.

Installing the Java Development Kit (JDK)

Download and install the JDK from Oracle's website, following the provided steps.

Installing Apache Ant

Download and install Apache Ant from its website and extract the archive to the C:\ folder.

Installing the DITA Open Toolkit

Download and extract the DITA Open Toolkit .zip archive to the C:\ folder.

Setting and Verifying Environment Variables

Configuring Windows Environment Variables

Set environment variables in Windows XP to ensure applications work together correctly.

Setting ANT_HOME and ANT_OPTS

Set ANT_HOME to Apache Ant location and ANT_OPTS for sufficient memory.

Setting Classpath Variables

Include Open Toolkit dost.jar, SAXON.jar, and xml-resolver-1.2.jar in the Classpath.

Setting JAVA_HOME and JHHome

Set JAVA_HOME to JDK path and JHHome to JavaHelp path.

Setting the Path Variable

Add the Apache Ant bin folder path to the System Path variable.

Verifying DITA Open Toolkit Installation

Appendix 2: Installing the Open Toolkit Plug-in for FrameMaker

Installation Overview for FrameMaker Plug-in

Extracting and Placing Archive Files

Adding Plug-in Entry in maker.ini

Add the ditaOpenToolkit entry to the APIClients section of maker.ini.

Adobe FRAMEMAKER Specifications

General

Developer	Adobe Systems
Initial Release	1986
License	Proprietary
Scripting Languages	ExtendScript, FrameScript
Latest Version	Adobe FrameMaker 2023
Operating System	Windows, macOS
Type	Technical communication
Primary Use	Technical documentation
File Formats Supported (Import)	XML, RTF, HTML
File Formats Supported (Export)	PDF, HTML, XML, EPUB
File Formats Supported	PDF, EPUB, HTML, XML, RTF, TXT
Key Features	Structured authoring