Skip to content

issue-723/724: Further cosmetic edits related to dirLangString #756

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.

Sign up for GitHub

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
HolgerKnublauch wants to merge 1 commit into
base: gh-pages
Choose a base branch
from
Open

issue-723/724: Further cosmetic edits related to dirLangString #756

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions shacl12-core/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -882,7 +882,7 @@ <h2>Shapes and Constraints</h2>
</div>
<div class="diagram-class-properties-section">
<div><a href="#deactivated">sh:deactivated</a> : xsd:boolean</div>
<div><a href="#message">sh:message</a> : text</div>
<div><a href="#message">sh:message</a> : xsd:string, rdf:dirLangString/langString or rdf:HTML</div>

@TallTed TallTed Feb 4, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
<div><a href="#message">sh:message</a> : xsd:string, rdf:dirLangString/langString or rdf:HTML</div>
<div><a href="#message">sh:message</a> : xsd:string, rdf:dirLangString, rdf:langString, or rdf:HTML</div>

@HolgerKnublauch HolgerKnublauch Feb 4, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I did that intentionally because otherwise it was too wide for the box. That's exactly the problem here, and why I went with "text" earlier.

@TallTed TallTed Feb 4, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

too wide for the box depends on the active viewport, the available viewport, the user-set base font size, and other factors. Just let it flow to a second (or third, or more) line.

@TallTed TallTed Feb 4, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Here's what I'm now seeing in the PR preview, which is displaying in dark mode for unknown reasons --

Screen Shot 2026-02-04 at 01 12 12 PM

Note that the sh:Shape has a sh:message that wraps, even with your /.

If exact presentation matters, the diagram should be an immutable image ... but even then, various user- or device-based settings, preferences, etc., may change what the user actually sees.

Better we be precise with our language, naming, etc., and figure out presentation challenges later — optimally with decisions that optimize presentation throughout our document(s).

@HolgerKnublauch HolgerKnublauch Feb 4, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Here is how it looks for me
image
and you see the sh:description barely fits in the property shape box, and that was after I have added a few pixels.

Yes, all this is very fragile and perhaps of questionable value because it's just a small subset of features anyway. There are various unresolved/proposed additions related to bringing in different tools but they are appear stalled. Unless someone has sufficient time to truly fix this diagram, I would tend to just discard it completely.

<div><a href="#severity">sh:severity</a> : sh:Severity</div>
</div>
</div>
Expand All @@ -896,26 +896,26 @@ <h2>Shapes and Constraints</h2>
<div class="diagram-class-properties">
<div class="diagram-class-properties-start">
<div><b><a href="#constraints">Constraint parameters</a></b>, for example:</div>
<div><a href="#ClosedConstraintComponent">sh:closed</a> : xsd:boolean or sh:ByTypes</div>
<div><a href="#ClosedConstraintComponent">sh:closed</a> : [true, false, sh:ByTypes]</div>
<div><a href="#OrConstraintComponent">sh:or</a>, <a href="#AndConstraintComponent">sh:and</a>, <a href="#XoneConstraintComponent">sh:xone</a> : rdf:List</div>
<div><a href="#NotConstraintComponent">sh:not</a> : sh:Shape</div>
<div><a href="#PropertyConstraintComponent">sh:property</a> : sh:PropertyShape</div>
</div>
</div>
</div>
<div class="diagram-class" style="float: left; width: 480px;">
<div class="diagram-class" style="float: left; width: 490px;">
<div class="diagram-class-name"><a href="#property-shapes">sh:PropertyShape</a></div>
<div class="diagram-class-properties">
<div class="diagram-class-properties-start">
<div><b><a href="#constraints">Constraint parameters</a></b>, for example:</div>
<div><a href="#MinCountConstraintComponent">sh:minCount</a>, <a href="#MaxCountConstraintComponent">sh:maxCount</a> : xsd:integer</div>
<div><a href="#MinLengthConstraintComponent">sh:minLength</a>, <a href="#MaxLengthConstraintComponent">sh:maxLength</a> : xsd:integer</div>
<div><a href="#ClassConstraintComponent">sh:class</a>, <a href="#DatatypeConstraintComponent">sh:datatype</a> : rdfs:Resource or rdf:List of rdfs:Resources</div>
<div><a href="#ClassConstraintComponent">sh:class</a>, <a href="#DatatypeConstraintComponent">sh:datatype</a> : rdfs:Resource or list of rdfs:Resource</div>
<div><a href="#NodeConstraintComponent">sh:node</a> : sh:NodeShape</div>
</div>
<div class="diagram-class-properties-section">
<div><a href="#name">sh:name</a> : xsd:string or rdf:dirLangString or rdf:langString</div>
<div><a href="#description">sh:description</a> : text</div>
<div><a href="#name">sh:name</a> : xsd:string or rdf:dirLangString/langString</div>
<div><a href="#description">sh:description</a> : xsd:string, rdf:dirLangString/langString or rdf:HTML</div>

@TallTed TallTed Feb 4, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
<div><a href="#description">sh:description</a> : xsd:string, rdf:dirLangString/langString or rdf:HTML</div>
<div><a href="#description">sh:description</a> : xsd:string, rdf:dirLangString, rdf:langString, or rdf:HTML</div>

@HolgerKnublauch HolgerKnublauch Feb 4, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Maybe we should just delete the "UML" diagram altogether and move it to some other overview document.

<div><a href="#syntax-rule-path-defaultValue">sh:defaultValue</a> : any</div>
<div><a href="#syntax-rule-path-defaultValue">sh:values</a> : any</div>
<div><a href="#group">sh:group</a> : sh:PropertyGroup</div>
Expand Down Expand Up @@ -2775,7 +2775,7 @@ <h4>sh:datatype</h4>
</aside>
<p>
The following example illustrates the list-based syntax, meaning that all values of
<code>rdfs:label</code> must be either <code>xsd:string</code> or <code>rdf:langString</code>.
<code>rdfs:label</code> must be either <code>xsd:string</code>, <code>rdf:langString</code> or <code>rdf:dirLangString</code>.
</p>
<aside class="example" title="Shape with a list of IRIs as sh:datatype property constraint">
<div class="shapes-graph">
Expand All @@ -2788,7 +2788,7 @@ <h4>sh:datatype</h4>
ex:TextExampleShape-label
a sh:PropertyShape ;
sh:path rdfs:label ;
sh:datatype ( xsd:string rdf:langString ) ;
sh:datatype ( xsd:string rdf:langString rdf:dirLangString ) ;
.
</div>
</div>
Expand Down