Control File

instruction.xml Example

Below you will find the content of an uncommented instruction.xml file.

You can download a commented instruction.xml file here.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<instruction source="CMS Name" xmlns="http://www.across.net" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.across.net instructions.xsd">
  <files>
    <file name="File1.xml" workflow="Translation and correction" />
    <file name="SubFolder1\File2.xml" workflow="Translation and correction" />
  </files>
  <project name="Project Name" deadline="2121-08-13 23:00 +02:00" projectsettings="Default" >
    <projectmanager name="project.manager.one" />
    <projectmanager name="project.manager.two" />
    <attribute name="Subjects">
      <value>Marketing</value>
    </attribute>
    <attribute name="Relations">
      <value>Relation A</value>
      <value>Relation B</value>
    </attribute>
    <attachment path="attachment1.docx" />
    <attachment path="SubFolder2\attachment2.docx" />
    <loopfile path="loopMe.txt" />
  </project>
  <source>
    <language>
      <languageDef>
        <ISO>
          <language>en-US</language>
        </ISO>
      </languageDef>
    </language>
  </source>
  <target>
    <language>
      <languageDef>
        <ISO>
          <language>de-DE</language>
        </ISO>
      </languageDef>
    </language>
    <language>
      <languageDef>
        <ISO>
          <language>fr-FR</language>
        </ISO>
      </languageDef>
    </language>
  </target>
  <meta />
</instruction>

Sections and Settings

Below you will find information on all the sections and settings in the control file.

Mandatory items are marked with an asterisk (*).

<instruction>*

The root node of the instruction file.

source*

Name of the creating CMS. The name is used to check for compatibility.

Element	Attribute	XPath
instruction		/instruction
instruction	source	/instruction/@source

<file>*

Entry for a translation file. At least one file must be specified. Multiple files can be specified.

name*

File name and relative path within the package. The name must be different for all specified files.

workflow

Name of the Across workflow. Only the first value specified will be used for all files. Currently, this value is supported via XPath extraction.

Element	Attribute	XPath
file		/instruction/files/file
	name	/instruction/files/file/@name
	workflow	/instruction/files/file/@workflow

<project>*

Entry for a project.

name*

Name of the project.

deadline

Due date of the project. The supported date format is: yyyy-MM-dd HH:mm zzz

The value must be in the future and must contain timezone information. If the value is omitted, a default offset of 14 days is used.

projectsettings

Name of the project settings template in the TMS. The name needs to be spelled as it is in Across, but the comparison is case insensitive. Currently, this value is supported via XPath extraction.

Element	Attribute	XPath
project		/instruction/project
	name	/instruction/project/@name
	deadline	/instruction/project/@deadline
	projectsettings	/instruction/project/@projectsettings

<attachment>

Entry for a project attachment. Multiple attachments can be specified.

path*

File name and relative path within the package. The name must be different for all specified attachments.

Element	Attribute	XPath
attachment		/instruction/project/attachment
attachment	path	/instruction/project/attachment/@path

<attribute>

Entry for additional project attributes. Multiple attributes can be specified.

name*

Name of the attribute. The name needs to be spelled as it is in Across.

Element	Attribute	XPath
attribute		/instruction/project/attribute
attribute	name	/instruction/project/attribute/@name

<value>*

Entry for attribute values. At least one value must be specified within the context of the containing attribute. Multiple values can be specified. Currently, this value is supported via XPath extraction.

Element	XPath
value	/instruction/project/attribute[@name='Attribute name']/value

<loopfile>

Entry for a file that will be contained in the output package unchanged. This setting can be used if the CMS needs specific files in the package to also be present in output packages. Multiple files can be specified.

path*

File name and relative path within the package. The name must be different for all specified files.

Element	Attribute	XPath
loopfile		/instruction/project/loopfile
loopfile	path	/instruction/project/loopfile/@path

<projectdescription>

Contains the text of the project description.

Element	XPath
projectdescription	/instruction/project/projectdescription

<project manager>

Specifies an additional project manager in the TMS.

name*

Name of the project manager in the TMS. Supports both login name and display name in the TMS. Currently, this value is supported via XPath extraction.

Element	Attribute	XPath
project manager		/instruction/project/projectmanager
project manager	name	/instruction/project/projectmanager/@name

<source>*

Contains the specification of the source language for all documents.

Element	XPath
source	/instruction/source

<target>*

Contains the specification of the target languages for all documents.

Element	XPath
target	/instruction/target

<language>*

Contains the definition of a language.

Element	XPath
language	/instruction/source/language /instruction/target/language

<languageDef>*

Contains the definition of a language.

Element	XPath
languageDef	/instruction/source/language/languageDef /instruction/target/language/languageDef

<ISO>*

Contains the definition of an ISO language.

Element	XPath
ISO	/instruction/source/language/languageDef/ISO /instruction/target/language/languageDef/ISO

<language>*

Contains the ISO language code for a language.

Element	XPath
language	/instruction/source/language/languageDef/ISO/language /instruction/target/language/languageDef/ISO/language