Edit online

Fluenta DITA Translation Add-on (Discontinued)

The Fluenta DITA Translation add-on lets you manage the Fluenta translation workflow for DITA projects directly from Oxygen.

Important:

The Fluenta DITA Translation add-on has been discontinued and will receive no further updates. Development has ended following changes to the Fluenta licensing model. This final release preserves support for the last open-source Fluenta version available before those licensing changes.

Existing installations will continue to function, but no bug fixes, compatibility updates, or new features will be provided.

Compatibility:
This add-on is compatible with the following products:
  • Oxygen XML Editor
  • Oxygen XML Author
Edit online

Introduction

Fluenta is a tool designed to simplify the translation of DITA projects. It parses a DITA map, resolves the references to all topics and subtopics, and prepares a unified XLIFF file that you can send to your Language Service Provider. The Fluenta DITA Translation add-on allows you to manage the Fluenta translation workflow directly from within Oxygen.

Edit online

Quick Installation

You can drag the following Install button and drop it into the main editor in Oxygen to quickly initiate the installation process:

Install

Edit online

Manual Installation

To manually install the add-on, follow this procedure:
  1. Go to Help > Install new add-ons to open an add-on selection dialog box. Enter or paste https://www.oxygenxml.com/InstData/Addons/default/updateSite.xml in the Show add-ons from field or select it from the drop-down menu.
    Note:
    If you have issues connecting to the default update site, you can download the add-on package, unzip it, then use the Browse for local files action in the Install new add-ons dialog box to locate the downloaded addon.xml file.
  2. Select the Fluenta Dita Translation add-on and click Next.
  3. Read the end-user license agreement, then select I accept all terms of the end-user license agreement and select Install.
  4. Restart the Oxygen application.

Result: A Translate (Fluenta) submenu is now available in the contextual menu of the Project View and DITA Maps Manager.

Edit online

Translation Workflow

A typical translation workflow based on Fluenta has the following steps:
  1. Create a Fluenta project. A project contains metadata associated with a DITA map (for example, the languages that the project is translated into). This is a one-time action.
  2. At various milestones (for example, when a new version is released), you generate XLIFF files for each language you translate to.
  3. You send the XLIFF file to the translation service provider.
    Tip:
    Alternatively, you can translate the XLIFF file directly in Oxygen using the AI Translator add-on, which automates the translation process using AI models. For more information, see AI Translator Add-on.
  4. Once the XLIFF returns from translation, you import the XLIFF file. A translated version of your map and topics will be generated at the selected location from the XLIFF file.
Restriction:
DITA 2.x resources (maps, topics) are not supported.
Edit online

Creating a Fluenta Project

The first step in the workflow is to create a Fluenta project:
  1. Open the main DITA map in the DITA Maps Manager.
  2. Right-click the map and select Translate (Fluenta) > Create project.
    Note:
    This action is visible only if there is no project detected for the open DITA map.

  3. In the resulting dialog box, you need to provide a name for the project and the languages that the project will be translated into.

Result: A translation memory with the same name as the project will automatically be created. Also, only one project can be created for a DITA map file. Once created, you will be able to edit it to change certain information.

Edit online

Generating XLIFF Files

To prepare the project for translation, generate an XLIFF file for each target language as follows:
  1. Open the main DITA map in the DITA Maps Manager.
  2. Right-click the map and select Translate (Fluenta) > Generate XLIFF.
    Note:
    This action is visible only if there is a Fluenta project associated with the current DITA map and the XLIFF files will be generated for this project.

  3. In the resulting dialog box, select the Output folder for the XLIFF file(s) and the Target language(s) for translation.

  4. Configure the other XLIFF generation options as desired:
    • DITAVAL file - Allows users to include a DITAVAL file. This file controls content conditionality, enabling exclusion of specific sections in the generated XLIFF files for translation. This option is useful in some use cases, such as when you do not want certain content translated into specific languages to reduce translation costs.
    • XLIFF version - Choose the appropriate XLIFF version from this drop-down menu to ensure compatibility with your translation systems.
    • Reuse ICE matches - Compares the current content with the content available the last time an XLIFF file was generated and reuses all existing translations.
    • Use translation memory - Uses the translation memory associated with the project to recover translations for the segments not yet translated.
    • Ignore translatable SVG files - Excludes the SVG files that contain translatable text from the generated XLIFF file.
    • Segment by paragraphs - Enables paragraph segmentation instead of the default sentence segmentation for more accurate and contextually appropriate segmentation.
  5. Click Generate when finished.

Result: An XLIFF file will be generated in the output folder for each selected language.

Edit online

Translating XLIFF Using Oxygen AI Translator

After generating the XLIFF file, you can translate it directly in Oxygen using the AI Translator add-on. To access the action to translate XLIFF with the AI Translator, right-click on a DITA map in the Project View or DITA Maps Manager and select Translate (Fluenta) > Translate XLIFF using Oxygen AI Translator. This action is visible only if there is a Fluenta project associated with the selected DITA map. This add-on automates the translation process with AI models and provides advanced translation management features. For more information, see AI Translator Add-on.

Edit online

Importing XLIFF

Once you receive a translated XLIFF file, generate the translated version of your project:
  1. Open the main DITA map in the DITA Maps Manager.
  2. Right-click the map and select Translate (Fluenta) > Import XLIFF.
    Note:
    This action is visible only if there is a Fluenta project associated with the current DITA map and the XLIFF file will be imported for this project.

  3. In the resulting dialog box, browse for the XLIFF file and set the options according to your needs:

    • Accept unapproved translations - Uses translations that are not marked as approved in the XLIFF file being imported.
    • Update "{MemoryName}" translation memory - Stores the imported translations in the project translations memory.
    • Ignore inline tag errors - If enabled, the application checks for mismatches in inline tags (such as <ph>, <bpt>, <ept>) between the source and target. This helps prevent formatting or structural issues in the translated content.
  4. Click Import when finished.
Result: A translated version of the project content will be created in the indicated output folder.
CAUTION:
If your images are not in SVG format, you will have to copy them to the newly generated project.
Edit online

Editing a Fluenta Project

Sometimes after creating a project, certain information needs to be edited. The steps are similar to those for creating a new project:
  1. Open the main DITA map in the DITA Maps Manager.
  2. Right-click the map and select Translate (Fluenta) > Edit project "{ProjectName}".
    Note:
    This action is visible only if there is a Fluenta project associated with the current DITA map and this project will be edited.

  3. In the resulting dialog box, you need to replace the project information you want updated and click OK when finished.

Edit online

Managing Translation Memories

A translation memory is a database that stores sentences, paragraphs, or segments of text that have previously been translated. The original language (sometimes referred to as the "source") and its translation (also referred to as the "target") are both included in each entry or segment in the translation memory.
  1. Open the main DITA map in the DITA Maps Manager.
  2. Invoke the contextual menu and select Fluenta > Manage translation memories.

  3. In the resulting dialog box, you will see a table with all the translation memories defined in Fluenta.

  4. In this dialog box, you can perform the following operations:

    • Create - This action will open a dialog box for creating a new translation memory.

    • Edit - This action will open a dialog box for editing the selected translation memory from the translation memories table.

    • Delete - Deletes the selected translation memory. If a translation memory is associated with a project, it cannot be deleted.

    • Import TMX - Populates the content of the translation memory with content from a specified import file.
      Note:
      One or more files can be imported into a translation memory.

    • Export TMX - Exports the selected translation memory to TMX format to view its content and use at a latter time.

Edit online

Preferences

Various options can be configured in the preferences page, both at the global level and at the project level.
  1. Open the main DITA map in the DITA Maps Manager or select it from the Project View.
  2. Right-click the map and select Translate (Fluenta) > Preferences.

    Result: In the resulting dialog box, you will see the Fluenta DITA Translation Add-on preferences page:

    Figure 1. Fluenta DITA Translation Add-on Preferences Page
  3. Configure options as needed. You can set the folders where projects and translation memories will be saved. Both absolute paths and paths that contain editor variables can be used. Also, you can set some target languages ​​that will be pre-filled when a Fluenta project is created.
  4. Click OK or Apply when finished.
Edit online

Working with Remote Files

Context

While Fluenta is designed to work with local DITA files, you can still process remote DITA maps by first downloading the map and its referenced topics locally. Once all necessary files are on your computer, Fluenta can parse the map and generate the XLIFF file as usual.

How to Prepare a Remote DITA Map for Fluenta

To use a remote DITA map with Fluenta, follow these steps to export the content locally:

  1. Open the remote DITA map file in the DITA Maps Manager.

  2. From the main menu, select DITA Maps > Export DITA Map.

  3. In the resulting dialog box, specify the folder where the DITA map and its referenced topics should be exported locally. You can also choose to export the content as a ZIP archive.

  4. Open the newly exported local DITA map in the DITA Maps Manager and create a Fluenta project using this local version.