Skip to content

#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.

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

#645: [UI] added terminology #658

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
13ea66c
#645: [UI] added terminology
bergos Nov 17, 2025
a9cff85
Update shacl12-ui/index.html
bergos Nov 25, 2025
da7bd39
Update shacl12-ui/index.html
bergos Nov 25, 2025
bd7bd09
Update shacl12-ui/index.html
bergos Nov 25, 2025
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
66 changes: 66 additions & 0 deletions shacl12-ui/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,6 +387,72 @@ <h3>Terminology</h3>
</dfn>
.
</p>
<div class="def">
<div class="term-def-header">Language Resolution</div>
<div>
<dfn data-lt="language resolution">Language Resolution</dfn> is the process of determining and ordering the
values associated with a given subject-predicate pair, prioritizing the preferred or most relevant language
value for display.
</div>
</div>
<div class="def">
<div class="term-def-header">Label Resolution</div>
<div>
<dfn data-lt="label resolution">Label Resolution</dfn> is the process of selecting the most appropriate
display label for an RDF resource, or generating a fallback value when no suitable value exists. It
applies to both value nodes and properties identified by <code>sh:path</code>, the latter of which is commonly used to label form elements.

The process includes <a>language resolution</a> and considers labeling-related annotations from the
<a>shapes graph</a>, <a>data graph</a>, application environment, and user preferences, to determine the best label for UI presentation.
</div>
</div>
<div class="def">
<div class="term-def-header">Property UI Component</div>
<div>
A <dfn data-lt="property ui component">Property UI Component</dfn> is a combination of <a>constraints</a>
across multiple <a>property shapes</a> that share the same <a>property path</a>, <a>focus node</a>, and
<a>value nodes</a>. It represents a single field (e.g., a text input, a dropdown) in a form.
</div>
</div>
<div class="def">
<div class="term-def-header">Node UI Component</div>
<div>
A <dfn data-lt="node ui component">Node UI Component</dfn> is generated from a single <a>focus node</a>,
typically containing one or more <a>property UI components</a>. It is often derived from one or more
<a>node shapes</a> that apply to the <a>focus node</a>.
</div>
</div>
<div class="def">
<div class="term-def-header">SHACL Renderer</div>
<div>
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.
Comment on lines +428 to +453
Copy link
Contributor

@edmondchuc edmondchuc Nov 25, 2025

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.

</div>
</div>
</section>

<section id="conventions">
Expand Down