DITA
  

This content was developed by Bob Doyle and is being hosted here to make it more accessible to the user assistance community.


DITA Communities


DITA and Help    Up to the top of the page

We use Help Authoring Tools (HAT) to provide Help for DITA Users.

We used Madcap Flare 2.5 to produce WebHelp files for DITA Users support (www.ditausers.org/help/).

We used Adobe RoboHelp 6 to convert the DITA Language Specification files to a Help interface with excellent full-text search (www.ditausers.org/oasis/).

And we have used DITA to create Help files.

We created a tri-pane DITA Infocenter using Eclipse Help that includes the DITA Language Specification, Architectural Specification, and OT User Guide in one searchable interface with TOC, Index, and Search. The DITA Infocenter is widely used as the go-to reference for DITA specs.

DITA Infocenter

But how good is DITA as a HAT?

At this time, for web help the DITA Open Toolkit is limited to Microsoft HTML Help. And HTML Help is limited to Internet Explorer.

DITA OT can output JavaHelp and Eclipse Help. But JavaHelp appears to be in decline.

Since DITA Users is entirely web-based, we want Help files that can play on the web, and on all browsers, not just IE. So MS HTML Help is not good enough. Moreover, we cannot generate MS HTML Help with our web-based DITA Open Toolkit, since we are running on a Linux Apache server.

WebHelp versions from Adobe RoboHelp and Madcap Flare are playable in all browsers, as are many other HAT tools.

Here's a comparison of some leading Help Authoring Tools with the current DITA Help capabilities. See Char James-Tanny's HAT Matrix for many more.

Help format Adobe RoboHelp Madcap Flare DITA OT
MS HTML Help yes yes yes
WebHelp yes yes no
JavaHelp no no yes
Eclipse Help no no yes
FlashHelp yes no no

Help authoring tools have always been topic-oriented. Their topics have generally been like DITA tasks, the steps needed to solve some problem. So DITA should be a fine authoring tool for Help. The OASIS DITA Technical Committee authorized a subcommittee to study DITA and Help, under the leadership of Tony Self and Stan Doherty.

References:


DITA Mailing Lists    Up to the top of the page


DITA Publications    Up to the top of the page

Books

Introduction to DITA, by Jennifer Linton and Kylene Bruski (Comtech Services), 2006).
Introduction to DITA, by JoAnn Hackos, Arbortext, 2007.
DITA Pocket Guide, by SiberLogic, 2006.
DITA Open Toolkit User Guide 1.3.1 (PDF),
HTML Frameset version
by Anna van Raaphorst and Richard H. (Dick) Johnson,
VR Communications, 2006.
Developing Quality Technological Information: A Handbook for Writers and Editors (2nd Edition) , by Gretchen Hargis, Michelle Carey, Ann Kilty Hernandez, Polly Hughes, Deirdre Longo, Shannon Rouiller, Elizabeth Wilde (IBM Press, Information Management Series, 2004).
Information Development: Managing Your Documentation Projects, Portfolio, and People, by JoAnn Hackos (Wiley, 2006).
XML and Framemaker, by Kay Ethier (Apress, 2004).

Articles

Articles at IBM developerWorks

Online Tutorials and Workshops


DITA Websites    Up to the top of the page


DITA Infocenter    Up to the top of the page

We have combined our old specification pages for the DITA Language and Architectural Specifications, and the DITA Open Toolkit User Guide.

They are now published on their own new website as DITA Infocenter, which is a demonstration of Eclipse online help.

DITA Infocenter

Up to the top of the page