Document:
Best Practice for Managing Acronyms and Abbreviations in DITA

Draft (A preliminary unapproved sketch, outline, or version.)

Details

Submitted By Dr. JoAnn Hackos on 2008-10-04 12:36 am UTC

Publication Type

None at this time.

Group / Folder

DITA Translation SC / Working documents

Modified by

Not modified.

Copy

This document is not a copy.

Technical Contact

None at this time.

Download Count

560

Download Agreement

None at this time.

Description

Abbreviated forms such as acronyms are used frequently in technical documentation. Abbreviated forms need to be expanded to their full form the first time that they appear in a document to ensure that the reader understands what the abbreviated form refers to. In electronic published documents such as an online help system, the expansion of abbreviated forms can also be made available in the form of a hyperlink or 'tool tip' mechanism. In addition, it should be possible to automatically insert the expansion of abbreviated forms from the source file into glossary entries for the publication. This best practice describes how to encapsulate abbreviations and their full forms in DITA documents to realize these objectives.