Package com.inductiveautomation.ignition.common.i18n.translation.io
package com.inductiveautomation.ignition.common.i18n.translation.io
Import and export of
TranslationPackage to and from on-disk
archive formats.
Entry points
The two public types are enums, one per direction, each constant pairing a format with the strategy that serializes or parses it:TranslationExporter—ZIP,XLSX. CallTranslationExporter.ZIP.write(pkg, out).TranslationImporter—ZIP,XLSX,LEGACY. CallTranslationImporter.XLSX.read(path).
The format is always selected explicitly by the caller; nothing is inferred from a file's
contents. The enums also expose descriptionKey() and extensions() so UI layers
can build file choosers — this package holds no UI types itself.
Formats
- Zip (modern, read+write): a
manifest.jsonlisting the contained files, one<language-tag>.jsonper locale, and anotes.jsonof per-key editorial notes. The manifest is the source of truth on import; the notes file is listed there like any other entry and recognized by name. - Excel (modern, read+write): one workbook with a leading
notesworksheet followed by one worksheet per locale. - Legacy (read only): the older loose
.properties/.xmlfiles, which the caller bundles into a zip before reading. Carries no notes.
A version is written into every modern export (manifest.json for zip, a custom
workbook property for Excel) but is not enforced on import: because users edit these
files with external tools, only structural guarantees are relied upon.
Internals
Each format's logic lives in a package-privateTranslationWriter /
TranslationReader implementation; TranslationIo holds the shared on-disk names, the
encoding version, and helpers (zip-as-filesystem, human-readable key/locale ordering) that keep
the writer and reader of a format in agreement.-
Enum ClassesClassDescriptionThe supported translation export formats.The supported translation import formats.