Interconnection views: allow a layout direction and ranking by metadata in Mermaid output

Aperta
#2,233 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
go

Direzione di ricerca

The issue names the Mermaid output path for interconnection views (-render-form mermaid), which always writes flowchart LR, and the DOT rankdir setting. Before coding, ask the maintainers whether direction should be a CLI flag or read from view metadata, since the issue offers both. Done means a view can set the layout direction and order sibling parts by a named metadata attribute, with the output matching the reporter's test model.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement

When rendering an interconnection view with -render-form mermaid, OpenSysML 0.12.1 always writes flowchart LR, so nested parts are laid out left to right. We model a layered platform architecture where each layer is a part, and the convention for our diagrams is that layer 1 sits at the top and the last layer at the bottom. At the moment there is no way to get that from a declared view.

Two features would let us generate these diagrams directly from the model:

A layout direction for a view. For example, a render option such as -render-direction TB|LR|BT|RL, or a view-level setting read from metadata, which sets the Mermaid flowchart direction for interconnection views (and DOT rankdir for the DOT form).
Ranking by a metadata attribute. An option that orders sibling parts by the value of a named metadata attribute (for us, a layer position), so that the order on the page follows the model and not the declaration order. In Mermaid this can be done with invisible links between consecutive ranks, which we have tested with Pele 1.13.0, the Mermaid renderer Obsidian uses: it keeps the order top to bottom.
Environment: OpenSysML 0.12.1 (commit b2f0e9b), macOS, rendering for Obsidian (Mermaid) and D2.

We are happy to provide a small test model that shows the case.

Lingua principale
Go
Stelle
59
Fork
20
Merge medio
10h 23m
PR unite (30g)
897

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Open-MBEE/OpenSysML

Tutte le issue di Open-MBEE/OpenSysML

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.