Browse documentation
DocsFormat guide

IDML

Extract Adobe InDesign stories and formatting markers into the shared localization model.

01

Parse stories

IDML parsing materializes story text and can project inline formatting into Lokit's common tag representation. An async unit iterator is also available under lokit.parse.async_.

idml.py
import lokit
document = lokit.parse.idml(    "brochure.idml",    source_locale="en-US",    target_locale="fr-FR",    include_tags=True,)
02

Write back into the package

An IDML output needs the original package. Use either the export helper or regeneration API; both make the source package explicit.

export_idml.py
document.export.idml("brochure.fr.idml", source_idml="brochure.idml")document.regen.idml("brochure.idml", "brochure.fr.idml")
03

Availability

IDML has materialized and async parsing, canonical writing, and regeneration. It does not expose a synchronous StreamingStructure parser.