[UI] Add property roles section #651
Open
+136
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TallTed
reviewed
Nov 17, 2025
|
|
||
| <p> | ||
| This section introduces Property Roles for annotating SHACL property shapes along with several core property roles defined in the SHUI namespace. | ||
| Property Roles is defined in the SHUI namespace and defines the class <code>shui:PropertyRole</code> and the property <code>shui:propertyRole</code>. |
Member
There was a problem hiding this comment.
Suggested change
| Property Roles is defined in the SHUI namespace and defines the class <code>shui:PropertyRole</code> and the property <code>shui:propertyRole</code>. | |
| Property Roles are defined in the SHUI namespace and define the class <code>shui:PropertyRole</code> and the property <code>shui:propertyRole</code>. |
TallTed
reviewed
Nov 17, 2025
|
|
||
| <p> | ||
| Property roles can be annotated on property shapes by using the <code></code>shui:propertyRole</code> predicate and linking directly to a property role instance. | ||
| SHACL renderers may use this direct annotation to drive how specific user-interface elements are displayed. |
Member
There was a problem hiding this comment.
Suggested change
| SHACL renderers may use this direct annotation to drive how specific user-interface elements are displayed. | |
| SHACL renderers may use such direct annotations to drive the way specific user-interface elements are displayed. |
TallTed
reviewed
Nov 17, 2025
|
|
||
| <p> | ||
| It is possible but not recommended to assign the same property role to multiple property shapes that apply to the same focus node using the direct role annotation form. | ||
| When this occurs, the resulting behavior is undefined. |
Member
There was a problem hiding this comment.
Suggested change
| When this occurs, the resulting behavior is undefined. | |
| When this is done, the resulting behavior is undefined. |
bergos
requested changes
Nov 17, 2025
| <h2>Property Roles</h2> | ||
|
|
||
| <p> | ||
| RDF resources commonly use properties to specify labels and descriptions, which user-interface engines depend on to render structured content. |
Contributor
There was a problem hiding this comment.
Suggested change
| RDF resources commonly use properties to specify labels and descriptions, which user-interface engines depend on to render structured content. | |
| RDF resources commonly use properties to specify labels and descriptions, and other information needed for rendering, which user-interface engines depend on to render structured content. |
Contributor
There was a problem hiding this comment.
I have icons and images in mind, but I wanted to keep the text generic in case we find other use cases.
Member
There was a problem hiding this comment.
Small tweak to @bergos' tweak.
Suggested change
| RDF resources commonly use properties to specify labels and descriptions, which user-interface engines depend on to render structured content. | |
| RDF resources commonly use properties to specify labels, descriptions, and other information needed for rendering, which user-interface engines depend on to render structured content. |
| <p> | ||
| RDF resources commonly use properties to specify labels and descriptions, which user-interface engines depend on to render structured content. | ||
| However, the vocabularies defining these properties vary across domains and communities. To ensure consistent interpretation, property shapes can | ||
| be annotated with explicit roles for elements such as labels and descriptions. |
Contributor
There was a problem hiding this comment.
Suggested change
| be annotated with explicit roles for elements such as labels and descriptions. | |
| be annotated with explicit roles for elements such as labels and descriptions, and additional rendering properties. |
Member
There was a problem hiding this comment.
Suggested change
| be annotated with explicit roles for elements such as labels and descriptions. | |
| be annotated with explicit roles for elements such as labels, descriptions, and other rendering properties. |
| </p> | ||
| </aside> | ||
|
|
||
| <h3>Qualified Role Annotation</h3> |
Contributor
There was a problem hiding this comment.
Should we add a note that RDF 1.2 reification is recommended, and the section will be revisited later?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the Property Roles section to the UI document. It builds on the foundations established in the DASH Property Roles and Resource Summaries document and introduces a new qualified role annotation modeling pattern that enables assigning multiple roles of the same type with support for preference ordering.
This initial PR introduces only one built-in property role:
shui:LabelRole. It does not yet include the constraints or processing logic implied by this role as the task force still needs to decide whether roles should inherit constraints or processing behaviour. Additional label-related logic (such as defining label properties as subproperties ofrdfs:labelhas been deferred to the upcoming label resolution section, which will be added in a separate PR.Other property roles from the DASH Property Roles document will also be added later in separate PRs.
Closes #538