docs(roadmap): propose an MTIP export as an optional layout augment to a SysML v1 migration - #529
Merged
Merged
Conversation
…o a SysML v1 migration Co-Authored-By: jason.han <hanhuijun@gmail.com>
Contributor
Author
|
I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".
|
HuiJun
marked this pull request as ready for review
September 22, 2026 14:31
…ent join Co-Authored-By: jason.han <hanhuijun@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What and why
A Cameo/MagicDraw
.mdzipmigrated throughsysml -convert sysmlcarries which elements each diagram shows (#524 writes them asviewusages) but not where the diagram draws them — the tool keeps diagram geometry outside the XMI. Open-MBEE's MTIP plugin (mtip-cameo) reads that geometry through the tool's API and writes it into its HUDS XML (per-diagram bounds, connector breakpoints, colors, fonts, images, keyed by element id).This adds a fourth item under Proposed in
docs/project/roadmap.md: read an MTIP export as an optional augment (-layout <mtip-export.xml>), not as a second input format. The.mdzip/.xmistays the one source of structure and behavior; the HUDS file contributes presentation only, joined to the migrated views by element id and written as the landedDiagramLayoutmetadata (metadata Layout about …,metadata Route about …,@Canvas) in the view usage's body — standard metadata, not a sidecar. The item states what is refused or reported (unmatched ids, skipped diagrams, malformed records, an export from a different project; colors/fonts/images thatDiagramLayouthas no attribute for), that output without-layoutis byte-identical to today's, that fixtures come from MTIP's own test exports plus a hand-written pair, and that the gate is an MTIP export of a model whose.mdzipis also available — none exists yet, so the item is not started. The "What remains open" Proposed bullet is threaded accordingly.Roadmap-only; no code, no changelog fragment (as with earlier roadmap-only edits).
How it was verified
python3 scripts/check-doc-links.py— 0 broken linkspython3 scripts/check-doc-ids.py— no internal work-item labelspython3 -m mkdocs build --strict— passesChecklist
make testandmake lintpass locally (docs-only change; the documentation gates above are the relevant ones)changes/unreleased/<slug>.<section>.md, not as an edit toCHANGELOG.md(n/a — roadmap-only edits carry none)make docs-countsrun if a gate count moved (no count moved)F4,K5) in the body, docs, or changelog