Issue #486 ValidationReport UML

shacl12-core/images/Makefile

@@ -0,0 +1,4 @@
+all: ValidationReport-UML.svg
+
+%.svg: %.puml
+	plantuml -Tsvg $^

shacl12-core/images/ValidationReport-UML.puml

@@ -0,0 +1,23 @@
+@startuml
+hide circles
+hide empty members
+skinparam pathHoverColor red ' on cover, highlight blue links as red
+
+class "<color:blue><u>sh:ValidationReport" as ValidationReport [[#results-validation-report]] {
+  [[#conforms sh:conforms]] : xsd:boolean
+  [[#shapesGraphWellFormed sh:shapesGraphWellFormed]] : xsd:boolean
+}
+
+class "<color:blue><u>sh:ValidationResult" as ValidationResult [[#results-validation-result]] {
+  [[#results-focus-node sh:focusNode]] : any
+  [[#results-path sh:resultPath]] : [[#property-paths SHACL prop path]]
+  [[#results-value sh:value]] : any
+  [[#results-source-shape sh:sourceShape]] : [[#shapes sh:Shape]]
+  [[#results-source-constraint-component sh:sourceConstraintComponent]] : [[#dfn-constraint-component sh:ConstraintComponent]]
+  [[#results-message sh:resultMessage]] : xsd:string or rdf:langString
+  [[#results-severity sh:resultSeverity]] : [[#severity sh:Severity]]
+}
+
+ValidationReport --> ValidationResult : [[#result sh:result]] * 
+ValidationResult -> ValidationResult : [[#results-detail sh:detail]] * 
+@enduml

shacl12-core/index.html

@@ -2,6 +2,7 @@
 		<title>SHACL 1.2 Core</title>
 		<meta charset="utf-8">
 		<script src="https://www.w3.org/Tools/respec/respec-w3c" class="remove" defer=""></script>
+		<meta name="color-scheme" content="light dark">
 		<script class="remove">
 
 			function prepareSyntaxRules() {
@@ -2920,8 +2921,9 @@ <h3>Validation Report</h3>
 				<p>
 					The <dfn data-lt="validation report|report">validation report</dfn> is the result of the <a>validation</a> process that reports the <a>conformance</a> and the set of all <dfn data-lt="validation result|result">validation results</dfn>.
 					The validation report is described with the SHACL <dfn>Validation Report Vocabulary</dfn> as defined in this section.
-					This vocabulary defines the RDF properties to represent structural information that may provide guidance on how to identify or fix violations in the data graph.
+					This vocabulary defines the RDF classes and properties to represent structural information that may provide guidance on how to identify or fix violations in the data graph:
 				</p>
+				<div id="ValidationReport-UML.svg"></div>
 				<p><!-- ISSUE-181 -->
 					SHACL-compliant processors MUST be capable of returning a validation report with all required <a>validation results</a>
 					described in this specification.
@@ -7976,11 +7978,24 @@ <h2>Changes between SHACL 1.0 Core and SHACL 1.2 Core</h2>
 
 	<script type="text/javascript">
 
-		tooltip = "Targets are not the only way to initiate validation, SHACL also allows specific nodes to be validated against specific shapes.";
-		var t = document.getElementsByClassName("target-can-be-skipped");
-		for (var i = 0; i < t.length; i++) {
-			t[i].title = tooltip;
-		}
+		// tooltip = "Targets are not the only way to initiate validation, SHACL also allows specific nodes to be validated against specific shapes.";
+		// var t = document.getElementsByClassName("target-can-be-skipped");
+		// for (var i = 0; i < t.length; i++) {
+		// 	t[i].title = tooltip;
+		// }
+
+    // Load and inline SVG diagrams
+    // TODO: add <svg desc> for accessibility
+    function svgInline(svg) {
+      fetch('images/'+svg)
+        .then(response => response.text())
+        .then(svgText => {
+          const container = document.getElementById(svg);
+          container.innerHTML = svgText;
+        })};
+
+    // svgInline('SHACL-UML.svg');
+    svgInline('ValidationReport-UML.svg');
 
 	</script>
 

shacl12-vocabularies/shacl-shacl.ttl

@@ -23,11 +23,11 @@ shsh:
 shsh:ListShape
 	a sh:NodeShape ;
 	rdfs:label "List shape"@en ;
-	rdfs:comment "A shape describing well-formed RDF lists. Currently does not check for non-recursion. This could be expressed using SHACL-SPARQL."@en ;
+	rdfs:comment "A shape describing well-formed RDF lists. Currently does not check for non-recursion (this could be expressed using SHACL-SPARQL)."@en ;
 	rdfs:seeAlso <https://www.w3.org/TR/shacl/#syntax-rule-SHACL-list> ;
 	sh:property [
 		sh:path [ sh:zeroOrMorePath rdf:rest ] ;
-		rdfs:comment "Each list member (including this node) must be have the shape shsh:ListNodeShape."@en ;
+		rdfs:comment "Each list member (including this node) must have the shape shsh:ListNodeShape."@en ;
 		sh:hasValue rdf:nil ;
 		sh:node shsh:ListNodeShape ;
 	] .