Skip to main content

XTM Cloud 25.2

Opening Custom preview in XTM Workbench

Project Managers and Linguists can use the Custom preview to display an in-context preview of a file whose extension is NOT supported by XTM Workbench Visual mode (for details, see Visual mode in XTM Workbench), but is supported by XTM Cloud (for details, see File formats supported in XTM Cloud). To use the Custom preview feature, they must open it, for the relevant file, in XTM Workbench. To do so, follow the procedure below.

Important

Certain prerequisites must be met so that Project Managers and Linguists can use the Custom preview feature in their XTM Cloud instance. For details, see the Prerequisites section in Custom preview in XTM Workbench.

Procedure. To open Custom preview for a file:

  1. In XTM Workbench, select In-context preview from the top menu bar.

  2. In the dropdown menu, select Open Custom preview.

    Result: the Open Custom preview option is replaced by the Close Custom preview, in the In-context preview menu. XTM Cloud now sends REST API requests to obtain the source and target file HTML previews. You see an additional docked panel at the top of the XTM Workbench screen. It informs you about the custom preview generation progress.

  3. If:

    • the HTML preview files have been returned and validated successfully, in the new docked panel, you now see the Custom preview of the source and target text.

      • The generated Custom preview is static. This means an active target segment is not highlighted, in the Custom preview. Also, if you make a change to a target segment, it will NOT be reflected in the Custom preview. To update the preview, close the current Custom preview (Closing the Custom preview in XTM Workbench) and then open it again to generate a new Custom preview.

      • If required, you can open the Custom preview in a separate browser tab. For details, see Opening a secondary window containing a Custom preview.

    • an error occurred during HTML preview generation, an error message is displayed, in the new custom preview docked panel. In this case, in the Custom preview docked panel, select the rotate_solid_brand_refreshed.svg Reload button. An error can occur for one of these reasons:

      • XTM Cloud could not generate the target file.

      • The external service responds to the source or target HTML preview generation request with an error.

      • Request timeout (after 5 minutes).

      • The files returned by the endpoint have not been validated as HTML format.

Important

The Custom preview files are not stored by XTM International, in any form. So, when you close the Custom preview, they can no longer be accessed. When you open the Custom preview again, for the relevant source file, the new preview files are generated.

In this section: