Fwd: [DDI-CDI] News on the generated DDI-CDI documentation and UCMIS-M2T/UCMIS
Wendy Thomas
--Hi all,
There is an updated version available at https://ddi-cdi.github.io/m2t-ng/DDI-CDI_1-0/field-level-documentation/ .
The changes include:
- A detailed page (under “About/UCMIS”) describing how simple UCMIS classes and data types are generated for syntax representations/encodings. This page is intended for the technical audience. The page allows comparison between all encodings. See: https://ddi-cdi.github.io/m2t-ng/DDI-CDI_1-0/field-level-documentation/about/ucmis/mapping.html .
- Improved printing
- Improved deep linking to sections of a class or data type page
Cheers,
Achim
On 12.08.25 21:38, Joachim Wackerow wrote:
Hi all,
Here are some news on the tool UCMIS-M2T which generates the documentation for DDI-CDI and on the UML Class Diagram Interoperable Subset (UCMIS).
I finalized some major work on the tool. It includes following changes in the generated documentation:
- Mobile-friendly field-level documentation for DDI-CDI. It supports now both regular displays and small displays (you can now view the documentation at the bus stop, sorry you can't escape DDI-CDI :) ). Panorama view is recommended for small screens.
- Two interactive diagrams for the explorative approach of the model: the class inheritance tree of the whole model (realized by hierarchical edge bundling) and the model with the associations of all classes (realized by a node-link tree). The diagrams are integrated in the field-level documentation. Both diagrams are created with the Vega visualization grammar. Try it out to get familiar with them.
- Additional encodings are provided: JSON Schema, SHACL, and ShEx. Pierre-Antoine Champin created these together with Deidre. Deidre can provide more details on the status of the encodings SHACL and ShEx. The encodings are integrated in the generated documentation for each class and data type.
- The class diagrams can now be displayed as an overlay in full-screen mode. Pan and zoom functionality are then available for diagram exploration, also export as PNG and SVG.
- The sections of a class or data type page can be deep linked and the related dropdown opens. Example: https://ddi-cdi.github.io/m2t-ng/DDI-CDI_1-0/field-level-documentation/DDICDILibrary/Classes/Agents/Agent.html#encodings .
- Some known minor issues are fixed.
- The tool can now be used for any UML model that conforms to the UML Class Model Interoperable Subset (UCMIS). The generated documentation for an example model, LIB, is available. Some documentation work is planned for finalizing UCMIS itself.
- Standalone production (batch) without the need of interactive steps in Eclipse/Acceleo. A related Git repository is available with documentation (Readme file and PDF documentation)
I'm sure there are still some issues. It is a challenge to use multiple software frameworks together (web front end packages not always like each other :) ).
The tool generates the documentation and encodings on the basis of an UML model that conforms to UCMIS. The Eclipse Acceleo implementation of the OMG standard MOF Model to Text is used to generate reStructuredText code for the Python documentation generator Sphinx. The Sphinx Book Theme with the underlying Sphinx PyData Theme are used (the Book Theme is provided by the Executable Books Project which works on solutions for the Jupyter ecosystem, the PyData Theme is from the PyData community). The Javascript libraries DataTables (interactive HTML tables), Vega Visualization Grammar, Panzoom, and canvg are integrated for further functionality. Some of these frameworks are using the generic Javascript library jQuery and the CSS framework Bootstrap.
A new version of the documentation form of DDI-CDI (new in form but not in content) raises the question how this and other new things can be provided to the user community independently from a new specification version.
Please explore this DDI-CDI site. I'm interested to hear your comments.
Cheers,
Achim--
DDI-CDI (Cross Domain Integration), https://ddialliance.org/Specification/DDI-CDI/
Email list archive at: https://groups.google.com/forum/#!forum/ddi-cdi
---
You received this message because you are subscribed to the Google Groups "DDI-CDI" group.
To unsubscribe from this group and stop receiving emails from it, send an email to ddi-cdi+u...@googlegroups.com.
To view this discussion visit https://groups.google.com/d/msgid/ddi-cdi/ef2f19b9-297c-404d-9f32-0bef5edd8a2a%40posteo.de.
DDI-CDI (Cross Domain Integration), https://ddialliance.org/Specification/DDI-CDI/
Email list archive at: https://groups.google.com/forum/#!forum/ddi-cdi
---
You received this message because you are subscribed to the Google Groups "DDI-CDI" group.
To unsubscribe from this group and stop receiving emails from it, send an email to ddi-cdi+u...@googlegroups.com.
To view this discussion visit https://groups.google.com/d/msgid/ddi-cdi/dda21819-88a5-4252-8f72-8cd7add4eb21%40posteo.de.