Tridion Docs Preview

Tridion Docs Preview

By Trados Solutions

Free

Description

This app enables users working in the Online Editor (through Trados Team, Accelerate or Enterprise) to visualize an in-context preview of the Tridion Docs XML (DITA) files.

The app uses Tridion Docs API – ExternalPreview, which requires the site’s out-of-the-box module, External Preview (bin folder of ISHCM web site).

Technical details

1.0.3.0 - Trados Enterprise, Trados Team, Trados Accelerate

Changelog:

Latest release - Tridion Docs Preview App

Checksum:

Release date: 2025-02-28

1.0.1.0 - Trados Accelerate, Trados Team, Trados Enterprise

Changelog:

First Release

Checksum:

Release date: 2025-02-27

Support website: https://www.gateway.sdl.com

Support e-mail:

Shared products:

Trados Enterprise, Trados Team, Trados Accelerate

1.0.3.0

Latest release - Tridion Docs Preview App

Trados Accelerate, Trados Team, Trados Enterprise

1.0.1.0

First Release

Tridion Docs Preview


Table of Contents

  1. Introduction
  2. Key Features
  3. Installation
  4. Updates
  5. Technical Requirements
  6. Using the App
  7. References

Introduction

The Tridion Docs Preview App enables users working in the Online Editor (via Trados Team, Accelerate, or Enterprise) to visualize an in-context preview (HTML) of Tridion Docs XML (DITA) files.

This app leverages the Tridion Docs API – ExternalPreview, which requires the External Preview module in the Tridion Docs system. See prerequisites for details.


Key Features

  • In-context preview of Tridion Docs DITA files
  • Integration with Trados Online Editor
  • Compatibility with Tridion Docs API – ExternalPreview

Installation

Prerequisites

To install the Tridion Docs Preview App, ensure the following:

  1. The External Preview module is enabled on Tridion Docs
    Enable External Preview Module

  2. The Tridion Docs External Preview API URL must be public to allow the app to connect.

  3. The API URL should not require authentication and must be enabled for the Guest user.
    Enable ISHExternalPreview

New Installation

Option 1: Install via RWS AppStore

  1. Visit RWS AppStore
  2. Search for "Tridion Docs Preview"
  3. Sign in to your Trados account
  4. Click Install

Option 2: Install via Trados Account

  1. Login to Trados
  2. Click on Account Settings
  3. Navigate to RWS AppStore
  4. Locate Tridion Docs Preview under Apps
  5. Click Install

Installation Screen

Once installed, enter the Tridion Docs External Preview API URL (example: https://mytridionsite.rws.com/ISHCM/API/ExternalPreview) and click Complete. Installation Screen


Updates

If an update is available, a notification will be sent via email or displayed in Trados notifications. To check if any update to app is available, follow the steps below:

  1. Login to Trados
  2. Click on Account Settings icon on the top right corner

Installation Screen

  1. • Choose “RWS AppStore”.

Installation Screen

  1. Under Installed Apps, it will show either Up to Date or Update Available.
  2. If an update is available, click on the app and select Update.

Installation Screen


Technical Requirements

File Type Configuration

Once installed, the Tridion Docs Preview Extension is automatically added in the file type configuration.

To verify:

  1. Navigate to Resources

Installation Screen

  1. Select File Type Configurations
  2. Open the XML 2: OASIS DITA 1.3 Compliant file type

Installation Screen

  1. Expand Preview Settings

Installation Screen

  1. Ensure that Tridion Docs Preview Extension is enabled

Installation Screen


Using the App

Create Project

  1. Login to Trados at eu.cloud.trados.com
  2. Go to Projects
  3. Click New Project
  4. Enter the required details:
    • Project Name: [Your Project Name]
    • Description (Optional): [Description]
    • Location: Select from list
    • Project Template: Select from list
    • Source Language
    • Target Languages
    • Due Date
    • File Type Configuration
  5. Upload DITA (XML) files (e.g., SampleDITAFile.xml)
  6. Click Create

Alternatively, you can create a translation job directly in Tridion Docs Environment and access it via Trados.


Preview

Once a project reaches the translation stage, users can enable preview in the Online Editor.

  1. Open the project in Trados Online Editor
  2. Click View > Preview

Installation Screen

  1. By default, "Preview Off" is selected. Change it to your preferred preview mode.

Installation Screen

  1. Ensure Tridion Docs Preview App is selected under Preview Type
  2. The Preview Section will load within the same window

Installation Screen

  1. If any text is modified in the bilingual editor, click the Refresh Icon above the preview to update it.

Installation Screen


Checkout other plugins from this developer: