Skip to content
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

Jump to bottom

Updating the vocab diagram #1387

Merged
merged 1 commit into from
Dec 26, 2023
Merged

Updating the vocab diagram #1387

Show file tree
Hide file tree
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
50 changes: 13 additions & 37 deletions vocab/credentials/v2/template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,6 @@
</script>
<script class="remove">
var respecConfig = {
localBiblio: {
"VC-DATA-MODEL": {
title: "Verifiable Credentials Data Model v2.0",
href: "https://www.w3.org/TR/vc-data-model-2.0/",
authors: [
"Manu Sporny", "Grant Noble", "Dave Longley",
"Daniel C. Burnett", "Brent Zundel", "Kyle Den Hartog",
"Orie Steel", "Michael B. Jones", "Gabe Cohen"
],
publisher: "W3C"
}
},
specStatus: "base",
shortName: "2018/credentials/",
thisVersion: "https://www.w3.org/2018/credentials/",
Expand Down Expand Up @@ -162,17 +150,6 @@ <h2>Specification of terms</h2>
In some cases, a local explanation is necessary to complement, or to replace, the definition found in an external specification. For instance, this is so when the term is needed to provide a consistent structure to the RDFS vocabulary, such as when the term defines a common supertype for class instances that are used as objects of specific properties, or when <a href="https://www.w3.org/TR/rdf12-concepts/#section-rdf-graph">RDF Graphs</a> are involved. For such cases, the extra definition is included in the current document (and the `rdfs:comment` property is used to include them in the RDFS representations).
</p>
<figure id="vocabulary-diagram" style="text-align:center">
<!--
Original diagram is in https://drive.google.com/file/d/1-kg7AzhahSzIwiIHeh5ANGJB_JK-kugs/view?usp=drive_link
using the draw.io (diagrams.net plugin for google).
The diagram is exported into SVG, and then the following editorial changes should be done (using any text editor):
- The "width" and "height" attributes in the top level <svg> element must be removed (to make the diagram rescale if
viewed directly)
- add the aria-details="#vocabulary-diagram-alt" attribute to the top level svg element

The exported SVG can also be viewed and edited inkscape. (The reason draw.io is used, instead of using
exclusively inkscape, is because the connecting line feature of inkscape is buggy.)
-->
<div data-include="vocabulary.svg" data-include-replace="true" data-oninclude="massageSVGLinks"></div>
<figcaption>Overview diagram of the vocabulary (without the deprecated items).<br />
A separate, stand-alone <a href="vocabulary.svg" target="_blank">SVG version</a> of the diagram, as well as a <a href="#vocabulary-diagram-alt">textual description</a>,
Expand Down Expand Up @@ -270,32 +247,31 @@ <h2>Diagram description</h2>
</p>
<p>
In the middle of the diagram there is a column of labeled boxes, all styled as Property.
The labels, from top to bottom, are: "credentialSchema",
"credentialStatus", "credentialSubject", "issuer", "evidence",
"refreshService", "renderMethod", "confidenceMethod", "termsOfUse", "validFrom",
The labels, from top to bottom, are: "credentialSchema", "credentialStatus", "credentialSubject",
"issuer", "evidence", "refreshService", "renderMethod", "confidenceMethod", "termsOfUse", "validFrom",
"validUntil", and "holder".
On the left side of this column, there are four labeled ellipses, styled as Class.
On the left side of this column, there are five labeled ellipses, styled as Class.
These are, from top to bottom, "VerifiableCredential", "JsonSchemaCredential",
"VerifiableCredentialGraph", and "VerifiablePresentation".
"EnvelopedVerifiableCredential", "VerifiableCredentialGraph", and "VerifiablePresentation".
There is also a small, unlabeled circle, which serves as an intersection point for connector
lines, with two pointing in, and three pointing out.
lines, with two pointing in, and four pointing out.
</p>
<p>
The "VerifiableCredential" ellipse is connected to the "credentialSchema", "credentialStatus",
"credentialSubject", "issuer", "relatedResource", "evidence", "refreshService", "renderMethod",
and "confidenceMethod" boxes, through connecting lines styled as Domain Of.
It is also connected to the crossing point circle with a similar connecting line,
styled as Domain Of.
The "VerifiablePresentation" ellipse is connected to the crossing point circle, as well as the "holder"
and "verifiableCredential" boxes, with a similar connecting line, styled as Domain Of.
The "VerifiablePresentation" ellipse is connected to the crossing point circle, as well as the "holder" and
"verifiableCredential" boxes, with a similar connecting line styled as Domain Of.
The crossing point circle is connected to the "termsOfUse", "validFrom", and "validUntil" boxes with a
connecting line styled as Domain Of.
The "verifiableCredential" box is connected to the "VerifiableCredentialGraph" ellipse with a connecting
line styled as Range.
The "JsonSchemaCredential" ellipse is connected to the "VerifiableCredential" ellipse with a
connecting line styled as Superclass.
Finally, the "VerifiableCredentialGraph" ellipse is connected to the "VerifiableCredential"
ellipse with a connector line styled as Contains.
and "EnvelopedVerifiableCredential" ellipses with connector lines styled as Contains.
</p>
<p>
On the right side of the column, there is another column of ellipses, styled as "Class", and labeled as "CredentialSchema",
Expand All @@ -307,14 +283,14 @@ <h2>Diagram description</h2>
<p>
The "CredentialSchema" ellipse is connected to one more ellipse, on the far right
side of the diagram, styled as Class and labeled as "JsonSchema", with a connecting line
styled as Superclass. This "JsonSchema" ellipse is also connected to a Property box
labeled as "jsonSchema", through a connector line styled as Domain Of. This "jsonSchema"
box is connected to a Datatype shape labeled as "rdf:JSON", with a connecting line
styled as Range.
styled as Superclass.
This "JsonSchema" ellipse is also connected to a Property box labeled as "jsonSchema",
through a connector line styled as Domain Of, and to a Datatype shape
labeled as "rdf:JSON", through a connecting line styled as Range.
</p>
<p>
Finally, on the lower far right side of the diagram, there is a separate Property box labeled as
"digestSRI", connected to a Datatype shape labeled as "sristring", with a connecting line
"digestSRI", connected to a Datatype shape labeled as "sriString", with a connecting line
styled as Range.
</p>
</details>
Expand Down
Loading