RDF/JS: SHACL-UI specification

Draft Community Group Report,

More details about this document
This version:
https://github.io/rdfjs/shacl-ui/
Issue Tracking:
GitHub
Editor:
Thomas Bergwinkl

Abstract

This specification introduces an ontology that extends SHACL to define shape-driven UI components and layouts.

Status of this document

1. Introduction

This section is non-normative

The objective is to enhance the SHACL ontology to cater specifically to the UI use cases for application development and data exploration. It covers viewing, editing and filtering RDF data. Interfaces for reusable UI components should be established. To achieve this, we aim for implementations to rely on the SHACL ontology and the UI extension, enabling them to select UI components and generate layouts. The foundation for this will be the existing DASH ontology. The defined interfaces will enable seamless communication between implementations and UI components, enabling efficient viewing, editing or filtering of RDF data. Whenever feasible, we will utilize other RDF/JS specifications.

Conformance

Document conventions

Conformance requirements are expressed with a combination of descriptive assertions and RFC 2119 terminology. The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in the normative parts of this document are to be interpreted as described in RFC 2119. However, for readability, these words do not appear in all uppercase letters in this specification.

All of the text of this specification is normative except sections explicitly marked as non-normative, examples, and notes. [RFC2119]

Examples in this specification are introduced with the words “for example” or are set apart from the normative text with class="example", like this:

This is an example of an informative example.

Informative notes begin with the word “Note” and are set apart from the normative text with class="note", like this:

Note, this is an informative note.

References

Normative References

[RFC2119]
S. Bradner. Key words for use in RFCs to Indicate Requirement Levels. March 1997. Best Current Practice. URL: https://datatracker.ietf.org/doc/html/rfc2119