Skip to content

SHACL Profiling Document #335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 10 commits into
base: gh-pages
Choose a base branch
from

Conversation

YoucTagh
Copy link
Contributor

@YoucTagh YoucTagh commented Mar 24, 2025

This is the intended document that will introduce and point to the SHACL Profiling document

Closes #334

@YoucTagh YoucTagh added the Profiles For SHACL 1.2 Profiles spec label Mar 24, 2025
Copy link
Member

@TallTed TallTed left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor, for clarity

YoucTagh and others added 2 commits April 14, 2025 10:34
@YoucTagh YoucTagh requested review from TallTed and nicholascar April 14, 2025 08:43
</tr>
</table>
<p>
Throughout the document, color-coded boxes containing RDF graphs in Turtle will appear. These fragments of Turtle documents use the prefix
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that W3C document accessibility standards advise against color coding when that is the only means of communicating some information (such as these Turtle document fragments, formal definitions, and syntax rules). Among other concerns are that these may all appear to be the same gray, to readers lacking color vision. We should look to other specifications from the past few years, to see examples that may be adapted to our use.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have updated this doc to use the same colour coding conventions as the Core doc. This doesn't directly address this issue - colour is still used - but it does put "Shapes Graph" and "Data Graph" in the top left of all the coloured boxes, e.g. https://w3c.github.io/data-shapes/shacl12-core/#example-1. The grey boxes do not say "Syntax Rules".

Since this document now matches the Core doc, I suggest we proceed like this for now - all doc matching - and then we update them all with just the following:

"Throughout the document, color-coded boxes containing RDF graphs in Turtle and JSON-LD will appear."

goes to

"Throughout the document, color-coded boxes containing RDF graphs in Turtle and JSON-LD will appear. The color of the box as well as a title indicate whether they are a Shapes graph, a Data graph or something else."

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add a terminal comma, i.e., Shapes graph, a Data graph or something -> Shapes graph, a Data graph, or something.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Profiles For SHACL 1.2 Profiles spec
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create the SHACL Profiling Document
4 participants