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

PlantUML class diagram builders are needed for diagrams that represent XSD profiles #176

Open
tviegut opened this issue Oct 24, 2024 · 3 comments
Assignees
Labels
cimtool-builders-website-updates-required Requires that the CIMTool Builders repo and website be updated. documentation Improvements or additions to documentation enhancement New feature or request

Comments

@tviegut
Copy link
Contributor

tviegut commented Oct 24, 2024

In the 2.2.0 release the puml-l2r.xsl and puml-t2b.xsl builders were introduced to support class diagrams representing RDFS profiles. Comparable to these builders we need class diagrams that represent the profiles that correspond to XSDs. As a part of this task the following should be performed:

  • Rename puml-l2r.xsl to `puml-rdfs-l2r.xsl'
  • Rename puml-t2b.xsl to `puml-rdfs-t2b.xsl'
  • Create a new `puml-xsd-l2r.xsl' (for left-to-right oriented XSD class diagrams)
  • Create a new puml-xsd-t2b.xsl (for top-to-bottom oriented XSD class diagrams)

Special note that thought needs to be put into how to represent both XSD choices (i.e. UML unions) and XOR as part of the implementation of the XSD diagram builders.

@tviegut tviegut added documentation Improvements or additions to documentation enhancement New feature or request cimtool-builders-website-updates-required Requires that the CIMTool Builders repo and website be updated. labels Oct 24, 2024
@tviegut tviegut self-assigned this Oct 24, 2024
@tviegut tviegut moved this to Backlog in CIMTool 2.3.0 Oct 24, 2024
@tviegut tviegut moved this from Backlog to Ready in CIMTool 2.3.0 Oct 24, 2024
@tviegut tviegut moved this from Ready to In progress in CIMTool 2.3.0 Oct 24, 2024
@tviegut tviegut changed the title PlantUML class diagram builders are needed for diagrams the represent XSDs. PlantUML class diagram builders are needed for diagrams that represent XSD profiles Oct 24, 2024
tviegut added a commit that referenced this issue Oct 24, 2024
tviegut added a commit that referenced this issue Oct 24, 2024
tviegut added a commit that referenced this issue Oct 24, 2024
tviegut added a commit that referenced this issue Oct 24, 2024
@Sveino
Copy link

Sveino commented Oct 25, 2024

We should also make it ready to support RDF - the instance data. CIMTool do today support validation of the CIM XML. I am not sure that CIMTool targeted is to support full install data support, but for doing DevOps or rather SchemaOps we would need to have test data in RDF that we can test the creation of the Schema / Profile against. In this we need to be able to visualise (and most like develop) the test data. The development could be done in LinkML but the visualisation would be very useful to include in CIMTool. Fist stage would just be to make it ready. We should investigate the repo: https://github.com/VladimirAlexiev/rdf2rml

@tviegut
Copy link
Contributor Author

tviegut commented Oct 30, 2024

We should also make it ready to support RDF - the instance data. CIMTool do today support validation of the CIM XML. I am not sure that CIMTool targeted is to support full install data support, but for doing DevOps or rather SchemaOps we would need to have test data in RDF that we can test the creation of the Schema / Profile against. In this we need to be able to visualise (and most like develop) the test data. The development could be done in LinkML but the visualisation would be very useful to include in CIMTool. Fist stage would just be to make it ready. We should investigate the repo: https://github.com/VladimirAlexiev/rdf2rml

@Sveino : This is a great suggestion and makes sense for the use cases you highlight above. I just took a peek at the link you provided to Vladimir's site. That's excellent and looks like it could be the very thing we could integrate to render those diagrams. Thanks for the heads up on that as I had not seen that previously. On a side note, I had experimented just a little bit at what existing options for PlantUML for rendering the JSON-LD instance data. I did a really simplistic conversion (not necessarily accurate but usable for my purposes to render something). Below was a sample of JSON data. We'll have to take a look down the road and put our collective heads together to see what may seem best.

image

@tviegut tviegut moved this from In progress to In review in CIMTool 2.3.0 Oct 30, 2024
@tviegut tviegut moved this from In review to In progress in CIMTool 2.3.0 Oct 30, 2024
@Sveino
Copy link

Sveino commented Oct 30, 2024

Maybe this issue is resolving #183

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cimtool-builders-website-updates-required Requires that the CIMTool Builders repo and website be updated. documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: In progress
Development

No branches or pull requests

2 participants