ClickHelp User Manual

XLIFF Import Specifics

When importing the XLIFF files into ClickHelp, you need to keep in mind several particularities of the process mentioned below.

Supported File Formats and Upload Specifics

You can simultaneously upload one or more .zip and .xlf files in any combination. The other formats are not supported.
When importing a .zip archive, ClickHelp will only take .xlf files from it. Files with other extensions are ignored. The system processes the .xlf files located in the root folder of the archive as well as from the subfolders.
You can import .xlf files of different translation documents — topics from different projects, home pages, variables, etc. — all translated into different languages.
You can only import files that originated from ClickHelp. See technical details below.

ClickHelp-specific XLIFF attributes

Here's what the content of an .xlf file looks like:

Example of a valid ClickHelp XLIFF file

<?xml version="1.0" encoding="utf-8"?>
<xliff xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" x-object-type="Article" x-persistent-id="31c7bcf0-14b2-444d-b0ba-00e1f436a03f" version="1.2" xmlns="urn:oasis:names:tc:xliff:document:1.2">
  <file source-language="en-US" target-language="de-DE" original="Body" d2p1:inputEncoding="utf-8" datatype="html" xmlns:d2p1="okp">
    <body>
      <trans-unit id="tu1" restype="x-paragraph">
        <source xml:lang="en-US">Welcome to your new documentation project! You are now just a few steps away from launching an online documentation portal for your clients.</source>
        <seg-source>
          <mrk mid="0" mtype="seg">Welcome to your new documentation project!</mrk>
          <mrk mid="1" mtype="seg"> You are now just a few steps away from launching an online documentation portal for your clients.</mrk>
        </seg-source>
        <target xml:lang="de-DE">
          <mrk mid="0" mtype="seg">Welcome to your new documentation project!</mrk>
          <mrk mid="1" mtype="seg"> You are now just a few steps away from launching an online documentation portal for your clients.</mrk>
        </target>
      </trans-unit>
      <trans-unit id="tu2" restype="x-paragraph">
        <source xml:lang="en-US">This help topic will serve as a quick introduction to basic ClickHelp functionality. It will also help you discover the main features of the WYSIWYG topic editor - your main tool for content creation. In this document, you will find useful documentation links, as well as examples of some elements you can use in your own content. <ph id="1">&lt;br/&gt;</ph></source>
        <seg-source>
          <mrk mid="0" mtype="seg">This help topic will serve as a quick introduction to basic ClickHelp functionality.</mrk>
          <mrk mid="1" mtype="seg"> It will also help you discover the main features of the WYSIWYG topic editor - your main tool for content creation.</mrk>
          <mrk mid="2" mtype="seg"> In this document, you will find useful documentation links, as well as examples of some elements you can use in your own content. <ph id="1">&lt;br/&gt;</ph></mrk>
        </seg-source>
        <target xml:lang="de-DE">
          <mrk mid="0" mtype="seg">This help topic will serve as a quick introduction to basic ClickHelp functionality.</mrk>
          <mrk mid="1" mtype="seg"> It will also help you discover the main features of the WYSIWYG topic editor - your main tool for content creation.</mrk>
          <mrk mid="2" mtype="seg"> In this document, you will find useful documentation links, as well as examples of some elements you can use in your own content. <ph id="1">&lt;br/&gt;</ph></mrk>
        </target>
      </trans-unit>
    </body>
  </file>
  <file source-language="en-US" target-language="de-DE" original="Meta" d2p1:inputEncoding="utf-8" datatype="x-application/json" xmlns:d2p1="okp">
    <body>
      <trans-unit id="sg1_sf1_tu1" resname="Article_Title_1">
        <source xml:lang="en-US">Quick Reference</source>
        <seg-source>
          <mrk mid="0" mtype="seg">Quick Reference</mrk>
        </seg-source>
        <target xml:lang="de-DE">
          <mrk mid="0" mtype="seg">Quick Reference</mrk>
        </target>
      </trans-unit>
      <trans-unit id="sg1_sf2_tu1" resname="Article_ExternalID_1">
        <source xml:lang="en-US">quick-reference</source>
        <seg-source>
          <mrk mid="0" mtype="seg">quick-reference</mrk>
        </seg-source>
        <target xml:lang="de-DE">
          <mrk mid="0" mtype="seg">quick-reference</mrk>
        </target>
      </trans-unit>
    </body>
  </file>
</xliff>

For the proper backtracking during import, ClickHelp needs the following metadata specified in the file:

x-object-type and x-persistent-id attributes for the <xliff> tag.
target-language attribute for the <file> tags.

In some cases, the target-language value can point to a language that doesn't exist in the portal. For example, this can happen when you transfer a translation from one portal to another. To avoid conflict during the import, create a project in the language you want to import so that the system can add the corresponding language to the portal beforehand.

If you need to import an XLIFF file that originated not from ClickHelp, contact us at support@clickhelp.com — we'll evaluate the file and see what kind of help we can offer in the scope of the Technical Support or a paid import service.

Translation Documents Import Reference Translation