XML Attribute Scanner

Overview. XML Attribute Scanner allows the user to localize XML files with localizable data residing in attributes (and attributes only).

The most important settings are the following:

  • File; the XML file to localize.
  • Attributes (Attributes tab); definition of which attributes are localized and customization of context.
  • Validation (Validation tab); localizable XML file can be checked for well-formedness before scanning.

Availability

This plug-in is available in Multilizer Enterprise. To get an evaluation for other Multilizer versions, contact sales(at)multilizer.com.


Tabs

Output

Output directory. Specifies the directory where the localized files will be created. This is the directory where Multilizer creates the localized output files and subdirectories. You can control the name of the localized files and directories by setting Type and Coding.

Output file name

Type. Specifies how Multilizer names localized files are named and and where they are placed. Possible options are:

Subdirectory Create localized files in subdirectories named by language and locale.
Bundle name Append the language and locale information to the output file name.
File extension Replace the original file extension with language and locale information.

Coding. Selects file name initial coding style. Possible values are:

ISO ISO standard coding style.
.NET Microsoft .Net coding style.
Windows Windows coding style.

Language delimiter

Specifies the language delimiter for naming the localized file version when Bundle name type is used. This delimiter separates the output file name from language and locale information. The default value is the underscore character (_).

Encodings

Native language. Specifies the native language that is used in the target. Set this to match the language in the original file. If the original file contains two or more languages, set the language to the one that is most widely used.

Default language. Specifies the default language. It is the language that is used in the build process, if there is no translation given in the the build language. The translation search order is following: first the build languages, then the default language.

Native encoding. Specifies the native encoding that is used for reading the original XML file.

Encoding list. Contains the encodings to be used in the localized files. To change the value right click the line and select a new value.

Attributes

Attributes are used for the following purposes:

Localizable attributes

The user needs to specify which attributes are contain to be localizable text. By default no such attributes are defined; thus the user should add them in order to find any localizable data.

Multiple attribute names can be separated by commas.

Note that a localizable attribute cannot be used as a part of the context.

Smart context

Note! Changes in configuration of the features discussed below will chnage the context in Multilizer project. In the middle of a localization project this can lead in loss of translations.

By default, the context is formed from the name of the localizable attribute with a running number. Consider the following XML file.


 
 
 

If attribute value is defined to contain localizable text, the resulting Multilizer project will contain the following rows:

Context Localizable text
value[0] My first row
value[1] My second row
value[2] My third row

Note that here the context depends only on the location of the attribute: the text in the first value attribute has context value[0], the text in the second value attribute has context value[1], and so forth. Therefore, the context could change when the XML file is modified. Consequently, it could be advisable to use other attributes to obtain a stable context. For instance, if attribute id is defined used to form a context, the resulting Multilizer project will contain the following rows:

Context Localizable text
id[1st].value[0] My first row
id[2nd].value[0] My second row
id[3rd].value[0] My third row

If attribute id is unique, the context is stable as long as the id value is not changed.

Optionally, context can be further enhanced by including the pertinent element (node) name in it. This is useful when the localizable XML file contains elements with different names but identically named localizable attributes. Check Use element names as a part of the context to enable this feature.

If both element name and attribute id are defined used to form a context, the resulting Multilizer project will contain the following rows:

Context Localizable text
element[row].id[1st].value[0] My first row
element[row].id[2nd].value[0] My second row
element[row].id[3rd].value[0] My third row

More discussion on context in XML files can be found in the XML Scanner documentation.

Validation

Specifies if the XML file should be checked for well-formedness before scanning.