-
Notifications
You must be signed in to change notification settings - Fork 37
Add Plantuml variant (re #166) #471
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
base: gh-pages
Are you sure you want to change the base?
Conversation
Co-authored-by: Yousouf Taghzouti <[email protected]>
Co-authored-by: Yousouf Taghzouti <[email protected]>
|
@YoucTagh Thanks for your close reading!!!!
|
|
As I noted in #166 —
Also, note that Accessibility review will demand textual description of each diagram, usable with screen readers and other assistive technologies. So it's in our best interest to avoid overly complex diagrams, even if they're easily produced. |
- sh:path : predicate or list or blank node and link to #property-paths - add ellipsis as per TallTed - rdf:List -> "list" because SHACL doesn't require the rdf:List type - add sh:nodeKind, sh:ignoredProperties
|
@TallTed @YoucTagh I added a few more changes, can you please recheck?
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you, the content is good for me. I won't merge it; maybe we can figure out how to make the links work.
|
@YoucTagh the links work now: https://raw.githack.com/VladimirAlexiev/data-shapes/refs/heads/issue-166-plantuml/shacl12-core/index.html#constraints-section. @TallTed I can't yet add an accessibility description ( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Much improved. There's always more, but this is a big step forward.
|
@VladimirAlexiev Can we merge this PR? |
|
@YoucTagh yes, but the end of index.html should be like this (related to #486) <script type="text/javascript">
// Load and inline SVG diagrams for clickable links
// 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> |
|
@VladimirAlexiev, ok, thank you. Once #487 is merged, we will update index.html and then merge it. |
…r. Move sh:path to top of PropertyShape
|
@YoucTagh I've added a few of the new features: core-components-list (3 fields), sh:targetWhere, sh:codeIdentifier: (note: I put back the link to PropertyGroup and it shows ok on I tried this variant with extra links to NodeShape but I think the diagram gets too busy, so I omitted them (they are listed as fields) |
|
Same concern as #483 (comment) |

Reopens #166: by using better technology (PlantUML) we can improve the diagram a lot more easily, and make new diagrams.
IMHO the PlantUML code is more readable than the textual diagram,
and it produces real arrows (doesn't depend on the
Class-Diagram-Arrows.pngkluge)NodeShape->PropertyShapePropertyGroupsh:ordertoPropertyShapeandPropertyGroupThese are minor fixes, but the point is that with PlantUML we can maintain more easily, add more diagrams (eg Node Expressions), and make more kinds of diagrams.
See SVG diagram rendered at plantuml server
skinparam topurl https://raw.githack.com/w3c/data-shapes/master/shacl12-core/index.htmlin the.pumlfile but we should try to leave it out and see whether the links use as base the HTML URL (good) or the SVG URL (bad)plantumlinstallation<color:blue>and<u>). Note the whole node is clickable and goes to the class definitionIf you agree, I can:
<img>tagClass-Diagram-Arrows.pngPlease check all links for accuracy!