Understanding the localization model options

Standard mode - Sequential model

The sequential model is enabled by default. Its configuration section begins with the line:

<manager class="com.ixiasoft.cms.controller.localization.sequential.SequentialLocalizationManagerService"

It includes the following options to configure:

substantialChange
full.context
context.document.type
include.default.images
in.context.exact.matches
translatable.attributes
include.cross.references.in.kit
import.translations.skip.review
translation.autotranslation.fulltranslation.status
translated.state.type
retranslated.state

These options are explained in the Localization model options section below.

Standard mode - Concurrent model

The concurrent model can be enabled instead of the sequential model. Its configuration section begins with the line

<manager class="com.ixiasoft.cms.controller.localization.concurrentLocalization.ConcurrentLocalizationManagerService"

It includes the following options to configure:

full.context
bundle.creation.xliffFormat
context.document.type
include.default.images
translation.autotranslation.acceptPartialTranslation
translation.autotranslation.fulltranslation.status
translation.autotranslation.ignorableElement.xpath
translation.autotranslation.ignorableText.regex
translation.autotranslation.ignorableSpace

These options are explained in the Localization model options section below.

DRM mode - Standard model

The sequential model is the only model available in DRM. Its configuration section begins with the line:

<manager class="com.ixiasoft.cms.controller.localization.sequential.SequentialLocalizationManagerServiceWithContainer"

It has the following options to configure.

substantialChange
full.context
context.document.type
include.default.images
in.context.exact.matches
translatable.attributes
import.translations.skip.review
translation.autotranslation.fulltranslation.status
translated.state.type
retranslated.state

These options are explained in the Localization model options section below.

Localization model options


Option	Description
`bundle.creation.xliffFormat`	Specifies the format of the files in the localization kits; Valid values are: `true`: XLIFF (default) `false`: DITA
`context.document.type`	Specifies how to output the context documents, such as originals.zip and lasttranslation.zip. The value must match one of the output types defined for your deployment. Enter the output type name as it appears in the outputtypes.xml file (for example, Dita2xhtml or Dita2Pdf). If you do not want these context documents, leave this field empty.
`full.context`	Specifies whether to package in the localization kit only the files that require translation (`false`) or to package all the files, even if they do not need to be translated (`true`). Packaging all the files provides a context for the content to be translated. For example, consider a map that contains five topics, but only two topics have been updated. When `full.context=true`, the five topics are included in the localization kit to provide context for the files that need to be translated. When `full.context=false`, only the two topics that were updated will be packaged in the localization kit. Default value is `true`.
`import.translations.skip.review`	Specifies if an object bypasses the status "review" (or the equivalent in your deployment) when it is re-imported into the Content Store after localization. Valid values are: `False`: Puts the status to "review". This is the default value. `True`: Skips the status "review" and puts it in the status defined by the `translation.autotranslation.fulltranslation.status` option or to the next status in the workflow if the option is not set.
`in.context.exact.matches`	Specifies whether to perform auto-translation when preparing the localization kit. If `in.context.exact.matches` is set to `true`, auto-translation is enabled. The sequential localization manager checks the previous version of the language object and will auto-translate elements that were previously translated and haven't changed. If `in.context.exact.matches` is set to `false`, auto-translation is disabled. The sequential localization manager does not perform auto-translation and sends the content in the original language. Default value is `false`.
`include.cross.references.in.kit`	Specifies whether or not to include in the localization kit topics that are the target of cross-references but which are not in the map. This option is disabled by default and the assumed value is `true`.
`include.default.images`	Specifies whether images should be provided as part of the localization kit for context. Note that these images are not provided in a format that can be used for localization; they are provided for context only. Default value is `true`.
`retranslated.state`	Specifies the state that the topics will be in after they are retranslated from source (with the Localization > Retranslate from source command). This must be a valid state in your deployment.
`substantialChange`	Currently not supported for the sequential localization method. Leave the field as is.
`translatable.attributes`	Specifies which attribute values to translate. Typically attribute values are not translated but those whose value is exposed to users can be. By default, the `@alt` and `@navtitle` attributes are translated. Add others to the list as needed.
`translated.state.type`	Specifies the type of state of the object when it is re-imported into the Content Store after localization. Valid values are: `review`: Re-imported objects are set with the `review` state which corresponds to the status of "Localization:review" (or the equivalent in your deployment). This is the default value. `end`: Re-imported objects are set with the `end` state which corresponds to the status of "Localization:done" (or the equivalent in your deployment).
`translation.autotranslation. acceptPartialTranslation`	Specifies whether the system accepts documents that were partially translated during auto-translation. Valid values are: `true`: Partially translated documents are accepted and saved in the Content Store after the auto-translation process. They will be included in the localization kit sent for translation. `false`: Only fully translated documents are accepted and saved in the Content Store. In this case, the original source document is sent in the localization kit and the partial auto-translations are ignored. Default value is `true`.
`translation.autotranslation. fulltranslation.status`	Specifies the status for documents that were fully translated by the auto-translation process. For example: `Localization:machine translated` Note: This status must be a valid status configured in your workflow. If you specify a status that is not in your workflow, this option will be ignored. There is no default value for this option. If you don't specify it, the documents will be put in the standard workflow status (for example, `Localization:review`)
`translation.autotranslation. ignorableElement.xpath`	Specifies the elements that should be ignored during auto-translation. For example, the following code indicates that if an element has a child `draft-comment`, `data`, or `comment` element, then changes in these child elements will be ignored during auto-translation. `child::draft-comment \| child::data \| child::comment()<` Enter a valid XPath expression. There is no default value for this option. If you don't specify it, no element will be ignored.
`translation.autotranslation. ignorableSpace`	Specifies whether spaces should be ignored during auto-translation. Valid values are: `true`: Spaces are ignored. `false`: Spaces are not ignored. For example, if a previous version of a topic and a current version are identical but one has an extra space, then it will not be auto-translated. Default value is `true`.
`translation.autotranslation. ignorableText.regex`	Specifies the text inside elements that should be ignored during auto-translation. For example, the following code indicates that the following characters (— " ' - _ \) will be ignored when comparing documents during auto-translation: `[\—\"\'\-\_\\]+` Enter a valid regular expression (regex). There is no default value for this option. If you don't specify it, no character will be ignored.