Skip to main content

Rigi Documentation

XCode XLIFF 1.2 parser

Key features:

  • Auto-encoding. The XCode XLIF parser supports UTF-8 encoding with or without BOM. The generated target files will have the same encoding as the source file.

  • Specify keys within objects that are to be used as string IDs (keyPatterns).

  • Specify an exclusive list of keys that must be translated (selectKeys).

  • Specify a list of keys that must be ignored (skipKeys).

  • Specify a list of texts that must be ignored (skipSource).

  • Specify the field that represents the locale (selectLocale).

Parser settings:

  • Use Unix newlines (unixNewline).

    When set, the parser will generate a Unix newline (\n). Otherwise, it will generate a Windows newline (\r\n).

  • Generate bi-lingual XLIFF (generatebilingualxliff).

    Default: true.

    This setting is used in very specific cases. When deselected, the parser generates a monolingual XLF file containing only the source texts.

  • Use 'file\@original' in the stringID (includefileoriginal) / Filename only (filenameonly).

    If the includefileoriginal option is selected, the content of the file>@original attribute will be included in the stringID. If you would like to use the file name rather than the file path, select filenameOnly.

  • Write XML entities (flattenXml).

    When set, this setting writes characters as entities:

    • '<' as '&lt;'.

    • '>' as '&gt;'.

    • '&' as '&amp;'.

  • Write tags u, i, b (writetagUIB).

    Default: false.

    Writes u, i, and b as tags. This setting overrides the Write XML entities setting.

  • Non-breaking space (WriteNBSP).

    Default: false.

    Write a non-breaking space as a character. This setting overrides the Write XML entities setting.

  • Trim spaces (trim).

    Default: true.

    When set, this setting removes spaces at the beginning and end of strings during reading and writing.

  • Untranslated (write-status-untranslated) / Translated (write-status-translated ) / Reviewed (write-status-reviewed) / Validated (write-status-validated).

    Default: translated.

    Specifies the state value that will be written in the generated trans-unit > target elements. If you leave these settings empty, the following default states will be written in the generated file:

    • Untranslated → needs-translation.

    • Translated → needs-review-translation.

    • Reviewed → signed-off.

    • Validated → final.

    write-status-translated-reviewed (deprecated since version 2.12)

    Until version 2.11, it was impossible to write different state values for Translated or Reviewed strings separately. The same single setting (write-status-translated-reviewed) specified which value should be written. If it was empty, the default value (needs-review-translation) was written. This setting is no longer in use.

    Warning

    If the legacy setting write-status-translated-reviewed is not empty, the write-status-translated and write-status-reviewed settings are ignored, and the value from write-status-translated-reviewed is used instead.

  • Pseudo (write-status-pseudo).

    Specifies the state value that will be written in the trans-unit > target elements in the Rigi tokenized files. If you leave this setting empty, the following default state will be written: final.

  • Write language only (langOnly).

    Default: false.

    Writes the language code without the locale. For example, if this setting is selected, it will write only 'de' instead 'de-DE' language code. By default, this setting is deselected.

For other parser settings, see the Generic parser settings article.

In this section: