Glossary update

[rousso]

Currently, the glossary is generated by transforming a XMI file to produce HTML output. The objective of this task is to update the glossary to utilize OWL and SHACL RDF files produced from the Conceptual Model. The new Glossary will provide a more accurate and feature-rich representation of the semantic data specification and is to be integrated in the current ePO documentation.

Proposed Features

• Direct RDF Parsing:
  • The system parses the RDF files of the Semantic Data Specification, such as SHACL and OWL artefacts, to generate AsciiDoc to be displayed in the documentation site.
• Metadata:
  • Display or link metadata such as version information and change history generated by a Diffing tool (Task 6).
• For a class:
  • Display broader/narrower concepts.
  • Display disjoint/equivalent classes.
  • Display relationships (both object and datatype).
  • Display inherited relationships from broader concepts (using inference or CONSTRUCT query over the RDF.
  • Display deprecation status and notes.
• For a property:
  • Display expected values and cardinality.
  • Display which classes use it.
• Filtering and Search:
  • Allow users to filter concepts by sub-module, status, or other criteria.
  • Allow users to search a concept by name.
• Multilingual Support:
  • Display labels and definitions in multiple languages when available.
• Cross-referencing:
  • Provide links to related concepts.
  • Provide links to the source OWL and SHACL documents
  • Show usage examples or instance data if available.

Implementation

• The system should be designed to accommodate new features without requiring changes to the transformation script.
• The system should be designed to be extended with new queries, for example references of a concept in external RML rules.
• The glossary should employ a user-friendly language accessible to a broad audience, drawing inspiration from widely used glossaries, for example schema
• The design should be responsive to ensure usability across various devices and screen sizes.

The implementer is expected to:

• Provide a Glossary System Design Document: Detailing the technical architecture, data processing workflows, and key features of the updated glossary system. The objective of document is to agree, adjust and ratify the key glossary features and the AsciiDoc generation strategy.
• Provide a glossary application prototype: A prototype of the web-based glossary demonstrating the key features and data presentation.
• Develop a web-based glossary application: A fully functional, web-based glossary that aligns with the capabilities outlined in the prototype.
• Write the glossary-related documentation: for deploying and maintaining the glossary system and guidelines on how to link glossary elements to other documentation in Antora.

Important

The following pre-existing issues must to also be resolved in this context: model2owl#220, model2owl#199, model2owl#201