Skip to content

stefan-jung/org.jung.terminology

Repository files navigation

org.jung.terminology

DITA-OT 4.1.2 DITA-OT 4.0.2 DITA-OT 3.7.4 license CI

org.jung.terminology is a plugin for the DITA-OT for creating a DITA-based terminology database.

  • Create and change terms easily using specialized DITA topics (DTD/RNG). The new DITA <termentry> topic represents a single term. Terms are linked together to a terminology database using the <termmap> map.
  • Author terms easily using an <oXygen/> XML framework with author mode stylesheets, that simplify the editing of <termentry> and <termmap> topics.
  • Navigate through the terminology database with a classic or responsive terminology browser (DEMO) based on the <oXygen/> webhelp transformation.
  • Check DITA or XLIFF files with a Schematron based terminology checker.
  • Export the terminology to TBX-Basic or TBX-Min for your Language Service Provider (LSP).

Installation

Prerequisites

  • DITA-OT 2.3.x or higher
  • The termbrowser needs the OOPS Consultancy XMLTask library on classpath. If this library is missing, you can provide it by installing the DITA-OT utility plugin org.jung.xmltask.
  • <oXygen/> XML 18 or higher (optional)
  • To use the Relax NG topics and maps, you need to install the dita-relaxng-defaults plugin.
    dita --install https://github.com/oxygenxml/dita-relaxng-defaults/archive/master.zip

Install the plugin

Install the plugin with the dita command.

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

Install the <oXygen/> XML Framework

  1. In <oXygen/> open the menu Options > Preferences.
  2. In the preferences, open Document Type Association > Locations.
  3. Add the frameworks directory of the plugin in the DITA-OT as an additional framework directory, e.g. /home/user/workspace/DITA/dita-ot/plugins/org.doctales.terminology/frameworks.

Using the Plugin

Please refer to the documentation.

Licenses

TBX-Core

TBX-Core is a TBX dialect and licensed under the CC BY 4.0 license.

The TBXcoreStructV03.rng is maintained in the GitHub repository github.com/LTAC-Global/TBX_Core_RNG. The grammar file(s) represent TBX core as described in ISO 30042.

Contribution

People who contribute to org.doctales.terminology: