Skip to content

Commit c9a37c6

Browse files
nicholascarnicholascar
committed
SHACL Specifications section; use of "specification", not "document", throughout
1 parent adb648c commit c9a37c6

File tree

1 file changed

+69
-37
lines changed

1 file changed

+69
-37
lines changed

‎shacl12-profiling/index.html

Lines changed: 69 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<script class="remove">
88

99
function prepareSyntaxRules() {
10-
document.querySelectorAll("[data-syntax-rule]").forEach(element => {
10+
specification.querySelectorAll("[data-syntax-rule]").forEach(element => {
1111
let ruleId = element.getAttribute("data-syntax-rule");
1212
let tr = document.createElement("tr");
1313
tr.classList.add("syntax-rule-tr");
@@ -420,10 +420,10 @@
420420
<body>
421421
<section id="abstract">
422422
<p>
423-
This document defines extensions of the SHACL Shapes Constraint Language created to allow for profiling.
423+
This specification defines elements of the SHACL Shapes Constraint Language created to allow for profiles of SHACL and profiling with SHACL.
424424
</p>
425425
<p>
426-
SHACL is a language for validating RDF graphs against a set of conditions, so this document's scope is limited to profiling of RDF graph models, including SHACL-defined models.
426+
SHACL is a language for validating RDF graphs against a set of conditions, so this document's scope is limited to profiling of RDF graphs, including graphs containing SHACL Shapes.
427427
</p>
428428

429429
<p style="text-indent: 100px;">
@@ -436,6 +436,44 @@
436436

437437
<section id="sotd"></section>
438438

439+
<section class="introductory">
440+
<h2>SHACL Specifications</h2>
441+
<p>
442+
This specification is part of the SHACL 1.2 family of specifications. See the SHACL 1.2 Overview for a more detailed introduction to all of them.
443+
</p>
444+
<p>
445+
The specifications are as follows:
446+
</p>
447+
<dl>
448+
<dt><a href="https://w3c.github.io/data-shapes/shacl12-overview/">SHACL 1.2 Overview</a></dt>
449+
<dd>overviews the set of SHACL specifications</dd>
450+
<dt><a href="https://w3c.github.io/data-shapes/shacl12-core/">SHACL 1.2 Core</a></dt>
451+
<dd>defines the Core of SHACL</dd>
452+
<dt><a href="https://w3c.github.io/data-shapes/shacl12-sparql/">SHACL 1.2 SPARQL Extensions</a></dt>
453+
<dd>defines SPARQL-related extensions of the SHACL</dd>
454+
<dt><a href="https://w3c.github.io/data-shapes/shacl12-node-expr/">SHACL 1.2 Node Expressions</a></dt>
455+
<dd>defines graph expressions used to determine focus nodes in SHACL</dd>
456+
<dt><a href="https://w3c.github.io/data-shapes/shacl12-inf-rules/">SHACL 1.2 Inference Rules</a></dt>
457+
<dd>defines SHACL's methods of rule-based inference</dd>
458+
<dt><a href="https://w3c.github.io/data-shapes/shacl12-ui/">SHACL 1.2 UI</a></dt>
459+
<dd>defines SHACL's use for User Interface generation</dd>
460+
<dt><a href="https://w3c.github.io/data-shapes/shacl12-compact-syntax/">SHACL 1.2 Compact Syntax</a></dt>
461+
<dd>defines an RDF syntax for expressing SHACL concepts</dd>
462+
<dt>SHACL 1.2 Profiling (this specification)</dt>
463+
<dd>defines the use of SHACL for profiling data, including SHACL data</dd>
464+
</dl>
465+
</section>
466+
467+
<section class="introductory">
468+
<h2>Document Outline</h2>
469+
<p>
470+
The introduction provides background concepts of profiling and states this specification's scope.
471+
</p>
472+
<p>
473+
Sections 2 & 3 cover the two main elements within the stated scope.
474+
</p>
475+
</section>
476+
439477
<section id="introduction">
440478
<h2>Introduction</h2>
441479
<section id="what-is">
@@ -469,43 +507,32 @@ <h3>What is profiling?</h3>
469507
<em>A data specification that constrains, extends, combines, or provides guidance or explanation about the use of other data specifications.</em>
470508
</p>
471509
<p>
472-
If a shapes graph is taken to be a "data specification" (and it can sensibly be), then, in addition to data valid according to a shapes graph being a profile of the data graph validated, the shapes graph itself is a profile of the data model used for the data graph.
510+
If a shapes graph is taken to be a "data specification" and it can sensibly be then, in addition to data valid according to a shapes graph being a profile of the data graph validated, the shapes graph itself is a profile of the data model used for the data graph.
473511
</p>
474512
</section>
475513
<section id="scope">
476514
<h3>Scope</h3>
477515
<p>
478-
With the above section's concepts in mind, this document defines the following:
516+
With the above section's concepts in mind, this specification defines the following:
479517
</p>
480518
<ol>
481519
<li>profiles of SHACL</li>
482-
<li>how to make profiles with SHACL</li>
520+
<li>profiling with SHACL</li>
483521
</ol>
484522
</section>
485-
<p>SHACL Profiling is the act of creating
486-
a <a href="https://www.w3.org/TR/dx-prof/#dfn-profile">profile</a>
487-
of an <a href="https://www.w3.org/TR/shacl/#dfn-rdf-graph">RDF graph</a>
488-
using SHACL...
489-
490523
<section id="terminology">
491524
<h3>Terminology</h3>
492-
493525
<p>
494-
Terminology used throughout this document is consistent with several sources:
526+
Terminology used throughout this specification is taken from several sources:
495527
</p>
496-
<ol>
497-
<li>the main SHACL [[shacl]] specification
498-
<ul>
499-
<li>which references terms from RDF [[rdf11-concepts]]</li>
500-
<li>technical terns for SHACL</li>
501-
</ul>
502-
</li>
503-
<li>the Profiles Vocabulary [[dx-prof]], a W3C Dataset Exchange Working Group Note
504-
<ul><li>which defines general terms to do with profiling including the terms "profiling" / "profile"</li></ul>
505-
</li>
506-
</ol>
528+
<dl>
529+
<dt><a href="https://w3c.github.io/data-shapes/shacl12-core/">SHACL 1.2 Core</a> specification</dt>
530+
<dd>technical terms for SHACL and RDF, the latter from [[rdf12-concepts]]</dd>
531+
<dt>Profiles Vocabulary [[dx-prof]]</dt>
532+
<dd>defines general terms to do with profiling including the terms "profiling" &amp; "profile"</dd>
533+
</dl>
507534
<p>
508-
The SHACL terms include
535+
The SHACL &amp; RDF terms include:
509536
<dfn data-lt="bindings">
510537
<a href="https://www.w3.org/TR/shacl/#dfn-binding">binding</a>
511538
</dfn>
@@ -658,7 +685,7 @@ <h3>Terminology</h3>
658685
.
659686
</p>
660687
<p>
661-
The general profiling terms include
688+
The general profiling terms include:
662689
<dfn data-lt="specification|specifications">
663690
<a href="https://www.w3.org/TR/dx-prof/#dfn-specification">specification</a>
664691
</dfn>
@@ -676,7 +703,7 @@ <h3>Terminology</h3>
676703
<section id="conventions">
677704
<h3>Document Conventions</h3>
678705
<p>
679-
Within this document, the following namespace prefix definitions are used:
706+
Within this specification, the following namespace prefix definitions are used:
680707
</p>
681708
<table class="term-table">
682709
<tr>
@@ -693,7 +720,7 @@ <h3>Document Conventions</h3>
693720
</tr>
694721
<tr>
695722
<td><code>sh:</code></td>
696-
<td><code><a href="http://www.w3.org/ns/shacl">http://www.w3.org/ns/shacl#</a></code></td>
723+
<td><code>http://www.w3.org/ns/shacl#</code></td>
697724
</tr>
698725
<tr>
699726
<td><code>xsd:</code></td>
@@ -706,7 +733,7 @@ <h3>Document Conventions</h3>
706733
</table>
707734

708735
<p>
709-
Within this document, the following JSON-LD context is used:
736+
Within this specification, the following JSON-LD context is used:
710737
</p>
711738
<pre class="jsonld">{
712739
"@context": {
@@ -723,11 +750,11 @@ <h3>Document Conventions</h3>
723750
References to the SHACL vocabulary, e.g., via <code>owl:imports</code> should include the <code>#</code>.
724751
</p>
725752
<p>
726-
Throughout the document, color-coded boxes containing RDF graphs in Turtle and JSON-LD will appear.
753+
Throughout the specification, color-coded boxes containing RDF graphs in Turtle and JSON-LD will appear.
727754
The color and title of a box indicate whether it is a Shapes graph, a Data graph, or something else.
728-
The Turtle document fragments use the prefix bindings given above.
729-
The JSON-LD document fragments use the context given above.
730-
Only the Turtle documents will have parts highlighted.
755+
The Turtle specification fragments use the prefix bindings given above.
756+
The JSON-LD specification fragments use the context given above.
757+
Only the Turtle specifications will have parts highlighted.
731758
</p>
732759

733760
<div class="shapes-graph">
@@ -799,13 +826,18 @@ <h3>Document Conventions</h3>
799826
</section>
800827
</section>
801828

802-
<section id="section">
803-
<h2>Section</h2>
829+
<section id="profiles-of-shacl">
830+
<h2>Profiles of SHACL</h2>
831+
<p>Content.</p>
832+
</section>
833+
834+
<section id="profiling-with-shacl">
835+
<h2>Profiling with SHACL</h2>
804836
<p>Content.</p>
805837
</section>
806838

807839
<section id="syntax-rules" class="appendix">
808-
<h2>Summary of Syntax Rules from this Document</h2>
840+
<h2>Summary of Syntax Rules from this Specification</h2>
809841
</section>
810842

811843
<section id="security">
@@ -820,7 +852,7 @@ <h2>Privacy Considerations</h2>
820852

821853
<section id="ack" class="appendix informative">
822854
<h2>Acknowledgements</h2>
823-
<p>Many people contributed to this document, including members of the RDF Data Shapes Working Group.</p>
855+
<p>Many people contributed to this specification, including members of the RDF Data Shapes Working Group.</p>
824856
</section>
825857

826858
<section id="internationalization">

0 commit comments

Comments
 (0)