Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Output structured data #61

Open
nkh opened this issue Mar 1, 2023 · 2 comments
Open

Output structured data #61

nkh opened this issue Mar 1, 2023 · 2 comments

Comments

@nkh
Copy link

nkh commented Mar 1, 2023

Hi, I'm the author of https://github.com/nkh/P5-App-Asciio

A contributor ( THE contributor ;) ) uses Diagon and has been bugging me to try it, nice work, I was looking for something to replace PlantUml.

Then it hit me that we work on different parts of the documentation space which I would describe as:

.----------.               .------------.            .-----------------.
| raw data |-->transform-->| input data |-->Diagon-->| ASCII rendering |----.
'----------'               '------------'            '-----------------'    |
                    .-------------------------------------------------------'
                    |
                    v                                .---------------.
                 Asciio--------------------->Goat--->| SVG rendering |
                                                     '---------------'

The problem here is that the ASCII rendering from Diagon is just a block of codes and Asciio can only manipulate it as a block.

If Diagon was capable to output structured data describing what objects are placed were, then that input could be transformed in Asciio elements that can be manipulated before they are output as ASCII or passed to Goat/svgbob, ... to generate SVG.

So I'm seeing Diagon as some sort of Graphviz .

If you already have the layout information, could you generated a structured output?

@ArthurSonzogni
Copy link
Owner

Hi!

Sorry for the delay here. I did not see the question.


Diagon is a collection of "translator". Currently, it contains:

  • Math
  • Sequence
  • Tree
  • Table
  • Grammar
  • Frame
  • GraphDAG
  • GraphPlanar
  • Flowchart

Are you talking of a particular one? Maybe GraphDAG or GraphPlanar?

From there, I am not sure what kind of structured data we could output. The node position and the edges paths?

@nkh
Copy link
Author

nkh commented May 2, 2023

Hi, I was thinking about any these:

Sequence Diagram
GraphPlanar
GraphDAG
Flowchart

output in JSON or YAML would be good.

node/edges with UUID, start positions, size, text, ...

If possible the relationship between the nodes should be given, IE: if an edge is connected to a node. Asciio is interactive so when a node is moved, the edges are resized to keep the relationship.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants