DITA Project Configuration

DITA Introduction

The Darwin Information Typing Architecture (DITA) is an XML-based architecture for authoring, producing, and delivering topic-oriented, information-typed content that can be reused and single-sourced in a variety of ways. DITA is a standard that is applicable to any kind of publication or information that might be presented to readers, including interactive training and educational materials, standards, reports, business documents, trade books, travel and nature guides, and more.

Because DITA topics are conforming XML documents, they can be readily viewed, edited, and validated using standard XML tools, although realizing the full potential of DITA requires using DITA-aware tools.

• See: https://www.oxygenxml.com/dita/1.3/specs/archSpec/base/introduction-to-dita.html

DITA uses certain file extensions for topics, maps, and conditional processing profiles. Files that contain DITA content SHOULD use the following file extensions:

• DITA topics
  • .dita (preferred)

• DITA maps
  • .ditamap

For the purpose of Localyzer on-boarding, the source locale and target locales make up sibling directories under one DITA root. The file structure and files under each locale directory are the same, with .dita and/or .ditamap translated under each target directory.

Illustrative DITA Sample, "Spectrum"

An illustrative simple example is used to guide the on-boarding. Actual DITA repositories will follow most of the same on-boarding.

1. In the repository, the directory under which the locale directories are located is dita/Spectrum 2. Under dita/Spectrum, the source locale is en for United States English 3. Under dita/Spectrum/en is the full directory structure for the DITA files. Path to actual .dita and .ditamap can be deep. 4. Translation will be located under dita/Spectrum/fr-FR for France French 5. Pseudo-localization will be located under dita/Spectrum/eo for Esperanto

Create a DITA Transform System File

Copy the transform from https://github.com/Lingoport/CommandCenterConfig branch main into your own repository and change the configuration file, 'dita_properties.sh' to point to the directory to start from, here dita/Spectrum

• DITA_DIR="dita/Spectrum"

As Administrator, go to Settings, and add a Transform directory, using the following:

• <your repository with the configured dita_properties.sh
• <your branch>

It should look close to the following:

Resource File Configuration

Configure the project with the source locale, target locales, pseudo-locale if necessary and use customer resource file format for the .dita and .ditmap:

Note: Make sure to use the file location pattern with the right '-' (dash) or '_' (underscore) depending on the directory naming convention. Here, the targets are 'fr-FR' and 'de-DE', hence the '-' in the l-c-v file name pattern, for both All locales

Run the project.

Now add the transform configured above.

Run the project again and verify the configuration.

The rest of the DITA configuration is the same as for any other projects.