Working with Storage Format

This page will give you directions on how to configure a TMS in order to work with the Confluence storage format.

The storage format export is considered legacy functionality. If you're just setting up a translation workflow for your content, we recommend to use the XLIFF format option.

Export vs. Import Files

Export and import files have exactly the same structure, and only differ in the metadata that is being set on the top-level translation element.

Exported files are named as follows:

CODE

<space-key>_<version-name>_<variant-name>_<targetLanguage>_<yyMMdd-HHmm>.zip

The contained XML file follows the same naming scheme, except for the file extension:

CODE

<space-key>_<version-name>_<variant-name>_<targetLanguage>_<yyMMdd-HHmm>.xml

XML Schema

The schema of the XML file is very simple:

CODE

+- translation (+ attributes)
   +- page (+ attributes)
      +- title
      +- content
         +- [Confluence Storage Format]

Translation Element

The translation element represents a translation of one or more pages in the specific language.

Attributes:

Name	Description	Required
`spaceKey`	The space key of the content.
`originalLanguage`	The original language of the content in Confluence.
`targetLanguage`	The requested language of the translation.
`versionId`	The id of the translated version. If the currently published versions exported or if the version management is not enabled in the current space, the value will be "current".
`variantId`	The id of the translated variant. If all pages are exported, the value will be "all".
`exportTimestamp`	The time of the export.

Page Element

The page elements represents a page to be translated.

Attributes:

Name	Description	Required
pageId	The Confluence page ID.
version	The version of the page.

Title Element

The title contains the title of the page in the specific language as <![CDATA[Title]>.

The Content Element

The content is provided in the Confluence storage format as anyType. In order to make the storage format work in the translation management system, links that contain CDATA as body need to be transformed to a separate representation to improve the handling in the translation systems.

CODE

<ac:link>
    <ri:page ri:content-title="Page Title" />
    <ac:plain-text-link-body>
        <![CDATA[Link to another Confluence Page]]>
    </ac:plain-text-link-body>
</ac:link>

will be exported as

CODE

<ac:link>
    <ri:page ri:content-title="Page Title" />
    <ac:plain-text-link-body>
        <span class="sv-cdata-translate">Link to another Confluence Page</span>
    </ac:plain-text-link-body>
</ac:link>