beffroi-tools/docs/interfaces/midra-layout-exchange.md

19 KiB
Raw Blame History

Midra Layout geometry exchange

The Export menu writes SVG v2, draw.io v1, geometry JSON v1, geometry CSV v1, DXF, HTML/CSS v1, PPTX, Figma FIG and Illustrator AI (the latter via a local VectorCraft CLI). Project JSON is version 10 and is the full-fidelity save format. These exchanges preserve layer visible-box geometry, not sources, crop settings, zoom, pivots, Midra links, locks, visibility, camera or selection. Pictures illustrate current cropping; importing a picture does not reconstruct its crop or source settings.

Ready-to-open two-layer templates are published under docs/templates/midra-layout/ for Full HD (1920 × 1080) and UHD 4K (3840 × 2160), in the six text exchange formats. The 4K geometry is an exact 2× scale of the Full HD layout. Regenerate them with:

cargo run --locked -p midra-layout --example check_geometry_exchange -- templates docs/templates/midra-layout

Application and format matrix

Workflow Exchange format Import/export Background Placeholder pictures
Inkscape, Illustrator, Affinity Designer, Figma, web vector tools SVG Yes Embedded PNG Embedded PNG
diagrams.net / draw.io draw.io XML Yes Embedded PNG Embedded PNG
Scripts, automation and future adapters Geometry JSON Yes Embedded PNG Embedded PNG
Excel, LibreOffice Calc and data tools Geometry CSV Yes Geometry row No
AutoCAD, LibreCAD and QCAD DXF Yes Rectangle entity No
Browsers and web layout tools HTML/CSS Yes Embedded PNG Embedded PNG
PowerPoint, LibreOffice Impress, DeckCraft PPTX Yes; slide picker on import Embedded PNG Embedded PNG
Figma, FigCraft Native FIG Yes; page/frame picker on import Embedded PNG Embedded PNG
Illustrator, VectorCraft Native AI via VectorCraft CLI Yes; artboard picker on import Embedded PNG Embedded PNG

PSD, VSDX and ODG remain future adapters rather than implied support. PDF is a useful final visual but does not retain a reliable editable-rectangle contract for import, so it is not presented as a round-trip format.

Scope, coordinates and artwork

All formats offer Current layer (exactly one selected), Selected layers, Specific layer (including hidden), All layers and Visible layers only. Stable IDs are layer-N; order is document stacking order, independent of selection order. All chosen layers are exported visibly, even if hidden in the editor. No layers, unknown/duplicate IDs, invalid project geometry or dimensions rounding below one pixel reject export. X/Y are top-left output pixels, relative to the whole output screen, including for single-layer exports. X, Y, width and height round independently to nearest integer; halves round away from zero. Negative positions are retained. No stroke expansion is necessary: exported boxes have no outline.

Export layers… is one window: choose a format, artwork options and layer scope. All codecs share project validation and shape preparation; the byte-oriented interchange registry supplies formats, extensions and capabilities to the UI. Importing files uses the same mapping review as pasted text. Multi-page files require a page/frame/slide choice; changing it resets mappings. File parsing and conversion run on workers so the viewport remains responsive. Files are written only after encoding succeeds; existing destinations require replacement approval.

Options are shared for the current session, default off; they do not modify the project/settings schema:

  • Include background layer adds a first, full-screen shape with ID midra-background, explicitly marked as background. SVG, draw.io, JSON, HTML, PPTX, FIG and AI embed all visible references composited in project order over a dark backdrop using each image's fit/stretch/native-size, offset and opacity; otherwise they embed a plain dark backdrop. This is a baked visual reference, not an editable copy of reference settings. Image raster dimensions are proportional to the screen, capped at 1920 pixels on the longest side; the exported shape still has the exact screen dimensions. CSV and DXF carry only the background rectangle.
  • Include placeholder pictures uses embedded PNG source-grid patterns instead of flat layer fills. The pattern reflects native input cropping and advanced cropping, fitted into each visible box. Each raster is capped at 512 pixels on its longest side. No live source image is available/captured by this exporter. The images contain no external URLs and need no network access. Imported picture layers are still geometry-only. Without this option, the layers are rectangles. CSV and DXF disable this option because they cannot embed self-contained raster pictures in the supported profile.

The background is detected and ignored by default on import and cannot be mapped as a content layer. A legitimate full-screen layer is kept as a layer. Every placeholder is one importable layer, not an image plus duplicate rectangle.

Optional native document codecs and licensing builds

The default vendor_formats Cargo feature uses the published, pinned deckcraft-pptx 0.6.1 and figcraft-format 0.5.1 crates with their document/geometry types. Their licenses are MIT OR Apache-2.0; vendor file formats do not imply a proprietary implementation license. No upstream app UI, font bundle, media engine or online service is embedded. VectorCraft's AI readers are unpublished and pull in rendering, font and PDF stacks, so AI uses a separate optional executable rather than embedding that stack. Upstream licenses still apply to separately distributed tools; Midra does not bundle VectorCraft.

# Normal build: native PPTX/FIG codecs and the optional AI converter interface.
cargo build --locked --release -p midra-layout
# Excludes vendor codecs, their optional dependency trees and the AI interface.
cargo build --locked --release -p midra-layout --no-default-features --features no_proprietary

no_proprietary takes precedence in code and UI if combined with other features. Cargo features are additive: the --no-default-features part is required to remove the dependencies themselves. An --all-features build disables the adapters but still compiles optional dependencies. CI tests both configurations; production coverage uses defaults so native-codec code remains included in the denominator. This is a format/dependency policy switch, not a legal certification.

PPTX

Standard OOXML ZIP, one slide matching the screen; 96 screen pixels per inch, or 0.75 points per pixel (9525 EMU/px). Native shapes/pictures preserve editable names and boxes. The background is named midra-background, a reserved marker excluded from mapping. PNGs are embedded as media; no source URLs are used. PPTX/FIG export asks to rename a content layer with that reserved name so it cannot silently become an ignored background on reimport. Stable Midra device/source IDs are not represented in the native file.

Import lists each readable slide independently. Shapes and pictures use their explicit transforms, recursively composing group coordinate transforms. Rotation and flips produce axis-aligned enclosing boxes. Hidden, zero-sized, unpositioned and unsupported opaque/connector objects are omitted with a count in the review. Masters, inherited placeholders, text content, animations, media playback and source/crop semantics are not imported. The note reports slide dimensions and the fixed unit convention; importing never silently resizes the Midra output.

Figma FIG

FigCraft writes a native .fig ZIP containing the Kiwi-encoded canvas and embedded image assets. Export creates a Midra Layout frame with screen dimensions and rectangle children (image fills when requested). Coordinates are Figma pixels. The background uses the same reserved midra-background name. The upstream codec is best effort; warnings on export are errors rather than silent losses.

Import offers top-level frames/components as separate canvases, relative to their own origin, and pages with loose objects. Visible leaf objects are mapped by their transformed enclosing boxes; nested containers are traversed without duplicating their bounding rectangle. Hidden children and zero-sized objects are omitted. Upstream approximation warnings appear in the mapping review. Constraints, components, auto-layout rules, text and styling do not become Midra parameters. Native round-trip tests verify geometry/artwork with the pinned upstream codec; they do not constitute validation against every Figma service version.

Illustrator AI

Uses VectorCraft CLI, discovered through MIDRA_VECTORCRAFT_CLI, beside the Midra executable, in its bin/ subdirectory, then on PATH. Conversion runs locally in safe mode in a temporary directory, with a 60-second timeout and 16 MiB result limit. Nothing is installed automatically. The CLI reads AI and converts to SVG for the shared geometry importer, or writes PDF-compatible AI from Midra SVG. Import enumerates up to 64 artboards and presents each separately in the same canvas selector. Converter import warnings are shown in the mapping review; export warnings reject the result instead of silently losing content. SVG's rectangle/path/image restrictions still apply; this is layer-box exchange, not arbitrary illustration reconstruction.

Manual native-file generation and round-trip diagnostics (no device access):

cargo run --locked -p midra-layout --example check_geometry_exchange -- native /tmp/midra-native pptx fig
MIDRA_VECTORCRAFT_CLI=/path/to/vectorcraft-cli cargo run --locked -p midra-layout --example check_geometry_exchange -- native /tmp/midra-ai ai

These generate plain and illustrated documents, with backgrounds, and verify the imported layer boxes. Existing diagnostic files are not overwritten. VectorCraft 0.24.1 native AI round trips were checked for both variants. DeckCraft 0.8.0 rendered the exported PPTX independently of the pinned 0.6.1 codec; the resulting Full HD image was visually inspected.

SVG v2

Example: midra-layout-svg-v2.example.svg. UTF-8 SVG; SVG namespace and optional XLink namespace. Root attributes:

  • data-midra-layout-geometry="2"
  • width, height: output screen dimensions in pixels
  • viewBox="0 0 W H"

Each layer is a <rect> (plain) or <image> (placeholder), with id="layer-N", data-midra-role="layer", x, y, width, height. A <title> carries its name for external viewers; Midra import does not rename destinations. Images use xlink:href="data:image/png;base64,..." and preserveAspectRatio="none". The optional background is an <image> with data-midra-role="background" and full-page bounds. No visible text geometry, transforms, clipping or CSS is needed.

The importer supports v1 and v2 and explicitly rejects other marked versions. VectorCraft-derived SVG may omit the root version and retain data-midra-role on wrapping groups. The importer inherits these role markers and their stable IDs; marked image layers remain importable and backgrounds remain excluded. Explicit unsupported root versions are still refused. Legacy Project::to_svg/to_svg_ids continue producing v1 rectangle-only SVG; the GUI uses v2. Old applications cannot import v2 placeholder images; use JSON or a plain rectangle-only export where required. Editors should retain role markers. If they remove them, ordinary image import remains intentionally limited to a first full-page background. Midra never fetches image URLs during import.

draw.io v1

Example: midra-layout-drawio-v1.example.drawio. UTF-8 uncompressed <mxfile compressed="false"> with one <diagram> containing an <mxGraphModel data-midra-layout-geometry="1">. pageWidth, pageHeight, pageScale="1", and page="1" establish the output canvas; diagram units are pixels. Root cells 0 and 1 provide the required graph root and default layer.

Each exported shape is an <mxCell vertex="1" parent="1"> with stable id, escaped plain-text value (layer name), and data-midra-role="layer" or "background". Its single <mxGeometry as="geometry"> stores pixel X/Y/width/ height. Styles disable outlines and rounding. Pictures use shape=image, imageAspect=0, and draw.io's image=data:image/png,BASE64 style syntax (without ;base64, which would split the style). Background label text is empty.

Import accepts raw/once-percent-encoded mxGraphModel clipboard XML, single-page mxfile XML, and native compressed diagram text: Base64 → raw DEFLATE → percent decode → mxGraphModel. Native re-saving may remove the model's Midra version attribute; role attributes and stable IDs survive in the tested version. The reserved midra-background ID also identifies the exported background. Unknown marked draw.io exchange versions are rejected. Multiple pages are refused with an instruction to export one page, rather than silently importing the wrong page. Groups, edges, rotation, flips, relative/alternate bounds and nonrectangular shapes remain unsupported; ordinary unrotated image cells now import their box.

Geometry JSON v1

UTF-8 JSON with root fields format: "beffroi.midra-geometry", version: 1, units: "px", canvas: {width,height} and layers. Each layer has id, name, role, x, y, width and height; image_png_base64 is optional. Roles are layer or background. Unknown fields, versions and units are rejected. IDs must be unique and at most 255 characters; names are limited to 1024 characters without controls. This JSON is the preferred small machine interface. It is not the version-10 project save file and does not contain sources, crop or device links.

Geometry CSV v1

RFC 4180 CSV with CRLF records and this fixed header:

midra_geometry_version,canvas_width,canvas_height,id,name,role,x,y,width,height

Every row repeats version 1 and the same canvas so a selected row remains self-describing. Names use normal CSV quoting. Roles and geometry have the same meaning as JSON. Empty files, mismatched canvases, extra/missing fields and non-integer geometry are rejected. CSV carries background geometry but no image data or placeholder pictures.

DXF profile

UTF-8 ASCII DXF declares AC1021 (AutoCAD 2007), unitless $INSUNITS=0, and whole-pixel $LIMMIN/$LIMMAX canvas bounds (with matching initial extents). Every stable ID has a layer-table entry and every shape is one closed, four-vertex LWPOLYLINE; its DXF layer name is the stable Midra layer ID. Because CAD Y increases upward, export writes cad_y = canvas_height - screen_y and import reverses that conversion. The midra-background entity is ignored as background. DXF cannot embed the supported self-contained placeholder artwork; human names are comments and may be discarded by CAD re-saving. Import requires explicit extents and axis-aligned closed rectangles rather than guessing scale, units or page origin.

HTML/CSS v1

The XHTML-compatible document is a directly viewable page. Root data-midra-layout-geometry="1" marks the version; #midra-canvas stores data-width/data-height. Each <div> or <img> stores authoritative data-midra-role, data-name, data-x, data-y, data-width and data-height; inline CSS renders the same box. Images use self-contained PNG data URLs. Import reads the data attributes, not computed CSS, scripts or browser layout. The file contains no script or external resource.

Limits, import and round trips

Import files and clipboard text, and generated exports, are capped at 16 MiB (to allow self-contained images). Decompression is bounded: at most 48 MiB of percent-encoded text and 16 MiB decoded XML. Up to 256 layer boxes plus one background are allowed. No imported image is decoded or downloaded by the geometry importer. Export reference decoding retains the existing 8192-pixel per-side/256 MiB decoder bounds. Oversized exports fail before writing a file.

Use Import → Geometry file…, or paste supported text, then review and map shapes to editor layers. Destination count need not match current selection. Import with size and position enabled restores the rounded geometry in one Undo step. Output screen resolution is not imported. Mapped names, sources and Midra links stay with the destination layers. File replacement retains the existing explicit overwrite confirmation and atomic-write path.

SVG files rendered by draw.io Desktop are also accepted. The importer recognizes the data-cell-id wrapper groups retained by draw.io, reads the first rectangle, image or symbol use in each cell, and ignores generated HTML labels, raster text fallbacks, symbols and the draw.io help link. The standard SVG 1.1 public DOCTYPE emitted by draw.io is accepted without fetching external content; XML parsing is limited to 200,000 nodes. The reserved midra-background cell remains an ignored background.

Draw.io's SVG export normally crops the canvas to the diagram content, adds one pixel to its bounds and rebases cell coordinates. Those rebased coordinates are the only positions present in that SVG. Include Midra Layout's background layer before exporting through draw.io when the full output-screen origin must survive the round trip.

Tests cover each format/artwork combination, all twelve published templates, full-screen layers vs backgrounds, negative/fractional coordinates, repeat round trips, compressed clipboard/files, embedded references, invalid IDs/versions and no-overwrite file handling. A manual native-editor check is available:

cargo run --locked -p midra-layout --example check_geometry_exchange -- generate /tmp/midra-exchange-check
drawio -x --size page -o /tmp/midra-exchange-check/render.png /tmp/midra-exchange-check/illustrated.drawio
drawio -x -o /tmp/midra-exchange-check/resaved.xml /tmp/midra-exchange-check/illustrated.drawio
drawio -x -f svg -o /tmp/midra-exchange-check/drawio-rendered.svg /tmp/midra-exchange-check/illustrated.drawio
cargo run --locked -p midra-layout --example check_geometry_exchange -- verify /tmp/midra-exchange-check/resaved.xml
cargo run --locked -p midra-layout --example check_geometry_exchange -- verify /tmp/midra-exchange-check/drawio-rendered.svg

On 2026-11-14, installed draw.io Desktop 31.7.0 (/usr/bin/drawio, not Flatpak) rendered the illustrated diagram correctly, and its re-saved XML returned both layer boxes unchanged. Its SVG export, including <symbol>/<use> image cells and HTML/raster label fallbacks, also returned both layer boxes unchanged when the background preserved the page. Generated plain/illustrated SVG and draw.io files passed geometry verification. Native output artifacts remain in /tmp, not Git.

Protocol references: draw.io diagram format and desktop CLI, SVG 2, CSV RFC 4180, and Autodesk's DXF group-code reference.

Multiple references are flattened into the same single background image in artwork-capable exports; no format version changes. Reimport reconstructs that background as a geometry/artwork item, not the editable reference collection. Use project JSON v10 to preserve independent images and visibility.