org.doctales.terminology

The plugin org.doctales.terminology is made for developing terminology databases with DITA.

DITA is well suited to model relationships between things and therefore is also very suitable for terminology management. The plugin org.doctales.terminology consists of several things:

  • A new DITA topic type called termentry, that represents a single term
  • An <oXygen/> XML framework that contains stylesheets and author actions for the <termentry> topic.
  • A terminology checker, that detects deprecated terms in a DITA file and offers recommended synonyms to the author.
  • A TBX-Basic converter to convert the DITA terminology to TBX-Basic for delivering it to a language service provider (LSP).
  • A TBX-Min converter to convert the DITA terminology to TBX-Min for delivering it to a language service provider (LSP).
  • A termbrowser, that is based on the plugin com.oxygenxml.webhelp that is shipped with the <oXygen/> XML editor.

Installation

Install org.doctales.terminology via the dita command:

dita -install https://github.com/doctales/org.doctales.terminology/archive/master.zip

Optional: Install the <oXygen/> XML framework

  1. Open the menu item Options > Preferences.
  2. Open Document Type Association > Location.
  3. In the Additional frameworks directories section: Add the org.doctales.terminology directory, e.g. ${homeDir}/workspace/dita-ot/plugins/org.doctales.terminology.

Termentry Topic

The plugin ships a new topic type called <termentry>. The <termentry> topic represents a single term. It is slightly similar to a <glossentry> topic but is designed to not only hold allowed terms, acronyms and abbreviations but also deprecated ones in multiple languages. Further on, the <termentry> element can have multiple <termVariant> elements to represent synonyms in different languages.

<oXygen/> XML Framework

The plugin ships an Oxygen XML framework that has CSS/LESS stylesheets to visualize the termentries and also has context sensitive menus and actions to make terminology authoring easy.

Figure 1. Termentry Topic in Oxygen XML

Transformation Types

The plugin ships some transformation types, which transform your terminology base to something that can be used with other tools.

  • termchecker - Transform the terminology to Schematron to perform automatical terminology checks.
  • webhelp-termbrowser - Transform the terminology to a termbrowser using the <oXygen/> XML webhelp transtype.
  • tbx-basic - Transform the terminology to TBX-Basic to send it to your language service provider.
  • tbx-min - Transform the terminology to TBX-Min to send it to your language service provider.

termchecker

The termchecker transformation type generates a Schematron file of the terminology map. This file contains rules that detect deprecated terms in a text and offers Schematron quick fixes to replace deprecated terms with allowed ones.

Parameters

args.language
Language of the termchecker rules to be generated.

Usage

dita -i terminology.ditamap -f termchecker -Dargs.language=de-DE -o termchecker

tbx-basic

The tbx-basic transformation type transforms your terminology to a single TBX-Basic file. A TBX-Min file is a bilingual XML-based file for exchanging terminology with your language service provider.

Parameters

none

Usage

dita -i terminology.ditamap -f tbx-basic -o tbx-basic

tbx-min

The tbx-min transformation type transforms your terminology to a single TBX-Min file. A TBX-Min file is a bilingual XML-based file for exchanging terminology with your language service provider.

Parameters

  • args.source.language: The source language of your terminology
  • args.target.language: The target language of your terminology

Usage

dita -i terminology.ditamap -f tbx-min -Dargs.source.language="en" -Dargs.target.language="de" -o tbx-min

Termbrowser

org.doctales.terminology includes XSLT templates, JavaScript libraries and CSS for rendering a termbrowser. You need the plugin com.oxygenxml.webhelp with a CLI license for publishing a termbrowser from CLI or you need to call the transformation scenario directly from <oXygen/> XML.

Parameters

  • args.hdf: Path to the ~/org.doctales.terminology/hdf/hdf.xml file

Usage

dita -i terminology.ditamap -f webhelp -Dargs.hdf=../hdf/hdf.xml