-
Notifications
You must be signed in to change notification settings - Fork 41
#645: [UI] added terminology #658
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
bergos
wants to merge
4
commits into
gh-pages
Choose a base branch
from
issue-645-ui-terms
base: gh-pages
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
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
edmondchuc
reviewed
Nov 25, 2025
Comment on lines
+429
to
+454
| A <dfn data-lt="shacl Renderer">SHACL Renderer</dfn> is a piece of software that processes SHACL | ||
| <a>shapes</a> and data to dynamically generate a form. A UI that represents the data is generated from one | ||
| or more <a>node UI components</a>. The SHACL renderer may add additional UI elements, such as a submit | ||
| button to save changes, a button to toggle between edit and view mode, selectors for <a>focus node</a> and | ||
| <a>node shape</a>, or messages from the <a>validation report</a>. | ||
|
|
||
| Further functionality the SHACL renderer may provide: | ||
| <ul> | ||
| <li>State management for the mode (edit/view) and changes</li> | ||
| <li>Managing widgets and widget selection logic</li> | ||
| <li>The target selection logic</li> | ||
| <li>Communication with the persistence layer</li> | ||
| </ul> | ||
|
|
||
| The inputs: | ||
| <ul> | ||
| <li><a>Focus node</a> IRI (optional, some implementations may provide a logic or UI to determine the root | ||
| node)</li> | ||
| <li><a>Node shape</a> IRI (optional, some implementations may provide a logic or UI to determine a | ||
| matching shape)</li> | ||
| <li><a>Data graph</a></li> | ||
| <li><a>Shapes graph</a></li> | ||
| </ul> | ||
|
|
||
| If both the focus node and node shape are provided, the SHACL renderer operates in manual mode. Otherwise, | ||
| when logic is applied to determine one or both values, it operates in automatic mode. |
Contributor
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.
Suggested change
| A <dfn data-lt="shacl Renderer">SHACL Renderer</dfn> is a piece of software that processes SHACL | |
| <a>shapes</a> and data to dynamically generate a form. A UI that represents the data is generated from one | |
| or more <a>node UI components</a>. The SHACL renderer may add additional UI elements, such as a submit | |
| button to save changes, a button to toggle between edit and view mode, selectors for <a>focus node</a> and | |
| <a>node shape</a>, or messages from the <a>validation report</a>. | |
| Further functionality the SHACL renderer may provide: | |
| <ul> | |
| <li>State management for the mode (edit/view) and changes</li> | |
| <li>Managing widgets and widget selection logic</li> | |
| <li>The target selection logic</li> | |
| <li>Communication with the persistence layer</li> | |
| </ul> | |
| The inputs: | |
| <ul> | |
| <li><a>Focus node</a> IRI (optional, some implementations may provide a logic or UI to determine the root | |
| node)</li> | |
| <li><a>Node shape</a> IRI (optional, some implementations may provide a logic or UI to determine a | |
| matching shape)</li> | |
| <li><a>Data graph</a></li> | |
| <li><a>Shapes graph</a></li> | |
| </ul> | |
| If both the focus node and node shape are provided, the SHACL renderer operates in manual mode. Otherwise, | |
| when logic is applied to determine one or both values, it operates in automatic mode. | |
| A <dfn data-lt="shacl Renderer">SHACL Renderer</dfn> is software that processes SHACL | |
| <a>shapes</a> and data and dynamically generates a user-interface using one | |
| or more <a>node UI components</a>. Implementations may add supplementary UI elements, such as a submit | |
| button to save changes, controls to toggle between edit and view modes, selectors for <a>focus node</a> and | |
| <a>node shape</a>, or visualizations of <a>validation report</a> messages. | |
| They may also provide: | |
| <ul> | |
| <li>State management for editing, viewing, and tracking data changes</li> | |
| <li>Widget management, including widget selection strategies</li> | |
| <li>Logic for determining the initial focus node (target) and the best suited node shape</li> | |
| <li>A communication protocol for interacting with a persistence service</li> | |
| </ul> | |
| A SHACL Renderer operates on a <a>data graph</a> and a <a>shapes graph</a>, and may also take a | |
| <a>focus node</a> and a <a>node shape</a>. When all four inputs are provided, the renderer | |
| operates in <strong>manual mode</strong>. When the focus node or node shape is not provided, | |
| the renderer may operate in <strong>automatic mode</strong>, in which case the application determines | |
| appropriate values for the missing inputs. |
Note: I've removed the use of form in the opening sentence since technically SHACL Renderers can produce non-form related user-interfaces.
Co-authored-by: Edmond Chuc <[email protected]>
Co-authored-by: Edmond Chuc <[email protected]>
Co-authored-by: Edmond Chuc <[email protected]>
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.
Adds a terminology section to the UI specification.
Closes #645