White papers

Removing XML whitespace in structured FrameMaker documents

Structured FrameMaker does not ignore whitespace when it reads in XML files. Any whitespace that is used to make an XML file more readable results in excess spaces in paragraphs and table cells. These spaces create unsightly gaps in text and are time consuming to remove.

This paper describes an XSL transform that removes excess whitespace from XML documents. The paper also describes how you can add the transform to a FrameMaker structured application so that FrameMaker removes the whitespace automatically.

Read in HTML or download the PDF file PDF file (155 KB, 12 pages)

divider

Configuring fonts in FOP and the DITA Open Toolkit

By default, the DITA Open Toolkit only recognizes a few fonts. If you want to use others, you have to configure both the FOP and the DITA OT to use them. Configuring the FOP for new fonts is described on the Apache web pages for FOP, but those instructions do not address all the issues for FOP with the DITA OT.

This white paper supplements the Apache instructions for configuring FOP and provides additional information for integration of FOP with the DITA Open Toolkit.

Read in HTML or download the PDF file PDF file (200 KB, 8 pages)

divider

Creating PDF files from DITA content

There are several ways to create PDF output from DITA content, and each method has its own trade-offs for ease of use, automation, sophistication of layout, and costs. How do you decide which one is best for you?

This white paper evaluates and explains the PDF-producing capabilities of several tools and technologies that support DITA, including XSL-FO, FrameMaker, Arbortext, MadCap Flare, XMetaL, and more.

Read in HTML or download the PDF file PDF file (540 KB, 22 pages)

divider

Hacking the DITA Open Toolkit

This white paper focuses on the changes you can make to HTML output generated from the DITA Open Toolkit (OT). These modifications include changes to cascading stylesheets (CSS), headers and footers, and more advanced customizations. The paper also illustrates how you can create content-specific elements through DITA specialization.

Read in HTML, or download the PDF file PDF file (435 KB, 19 pages).

divider

FrameMaker 8 and DITA

FrameMaker 8 provides support for creating, editing, and publishing DITA 1.0 content. You can use FrameMaker to author and publish DITA content as high-quality print and PDF output, or you can create content elsewhere and use FrameMaker strictly for publishing print and PDF output. This document describes FrameMaker’s DITA support and provides guidance on how you might best integrate DITA and FrameMaker.

Download the PDF file PDF file (5 MB, 55 pages).

divider

Handling XSL:FO’s memory issue with large page counts

Formatting Object (FO) processors (FOP in particular) often fail with memory errors when processing very large documents for PDF output. This document shows a general structural solution for FO documents that preventst this error and how the solution can be applied to the Darwin Information Typing Architecture (DITA) Open Toolkit.

Read in HTML, or download the PDF file PDF file (211 KB, 10 pages).

divider

Friend or foe? Web 2.0 in technical communication

The rise of Web 2.0 technology provides a platform for user-generated content. Publishing is no longer restricted to a few technical writers — any user can now contribute information. But the information coming from users tends to be highly specific. The two types of information can coexist and improve the overall user experience. User-generated content also offers an opportunity for technical writers to participate as “curators” — by evaluating and organizing the information provided by end users.

This white paper includes Flash movies.

Read in HTML, or download the PDF file PDF file (400 KB, 14 pages).

divider

Structured authoring and XML

Structured authoring and XML represent a significant paradigm shift in content creation. Implementing structured authoring with XML allows organizations to enforce content organization requirements. The addition of hierarchy and metadata to content improves reuse and content management. These benefits, however, must be weighed against the effort required to implement a structured authoring approach. The business case is compelling for larger writing organizations; they will be the first to adopt structured authoring. Over time, improvements in available tools will reduce the cost of implementing structured authoring and make it affordable for smaller organizations.

Read in HTML, or download the PDF file PDF file (318 KB, 22 pages).

divider

Managing implementation of structured authoring

Moving a desktop publishing-based workgroup into structured authoring requires authors to master new concepts, such as hierarchical content organization, information chunking with elements, and metadata labeling with attributes. In addition to these technical challenges, the implementation itself presents significant difficulties. This paper describes Scriptorium Publishing’s methodology for implementing structured authoring environments. This document is intended primarily as a roadmap for our clients, but it could be used as a starting point for any implementation.

This white paper assumes basic familiarity with XML and structured authoring. For more information about these concepts, refer to the Structured Authoring and XML white paper.

Read in HTML, or download the PDF file PDF file (150 KB, 10 pages).

divider

Assessing DITA as a foundation for XML implementation

The Darwin Information Typing Architecture (DITA) is being positioned as the solution for XML-based technical content. Is DITA right for you?

This white paper describes the potential business advantages of DITA, provides a high-level overview of DITA’s most important features, and then discusses how you can decide whether to develop a DITA-based XML implementation.

Read in HTML, or download the PDF file PDF file (400 KB, 11 pages).

divider

Integrating XML and FrameMaker

FrameMaker provides solid support for XML-based authoring workflows. Its PDF and print output capabilities are stellar. Because FrameMaker combines authoring and publishing in a single application, configuring XML support can be quite challenging.

Read in HTML, or download the PDF file PDF file (280 KB, 19 pages).