Skip to main content

DITA XML

Information about how Transifex handles the DITA XML (.dita) file format.

P
Written by Product Team
Updated over 2 months ago

File Extension(s)

.dita

i18n type(s)

DITA


The DITA XML file format is widely used for structured, topic-based authoring of technical content. Each .dita file typically represents a standalone topic, such as a concept, task, or reference, and follows the DITA specification defined by OASIS.

Transifex extracts translatable content from common DITA elements, including:

  • <title> – Topic and section titles

  • <p> – Paragraphs of body text

  • <li>, <dt>, <dd> – List and definition items

  • Inline elements such as <ph>, <b>, <i>, and others used for formatting or phrase-level markup

When a .dita file is uploaded, Transifex automatically detects and exposes for translation:

  • Text inside block-level elements like <section>, <note>, and <body>

  • Content within table cells (<entry>)

  • Inline and structural text elements

  • Select attribute values such as:

    • alt (e.g., in <image>)

    • title, label, placeholder

    • href in links (<xref>, <link>), and src in media references

To protect certain strings, such as code samples, cross-references, or file paths, from being translated, you can use Smart tags in Transifex to "lock" those segments. Locked content is visible but not editable by translators, helping prevent accidental changes to technical elements.


Managing DITA XML translation files

Uploading a DITA XML translation file, the respecting parser will extract and match the content found in the file with the respecting content of the source DITA XML file, following the specific content order found on the source DITA XML file. Any differences in the structure of the elements between the two files will not allow uploading of the translation file.

When uploading a DITA XML translation file, the parser will go through each element identified and match translations to the source strings following the same order in the respecting source file. Please ensure the structure and content are relayed in the same order between source and translation files. Any difference will map the translations to different source strings.


Parser behavior

The following table outlines what occurs to strings when using the API, CLI, or UI to manipulate translation files depending on download mode.


πŸ’‘Tip

Looking for more help? Get support from our Transifex Community Forum!

Find answers or post to get help from Transifex Support and our Community.

Did this answer your question?