Skip to content

Commit b108b04

Browse files
ihermanmsporny
iherman
authored and
msporny
committed
Added changes to the vocabulary
1 parent 30699a8 commit b108b04

File tree

4 files changed

+990
-5
lines changed

4 files changed

+990
-5
lines changed

‎vocab/template.html

+109
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,16 @@ <h2>Specification of terms</h2>
157157
document (and the `rdfs:comment` property is used to include them in the RDFS
158158
representations).
159159
</p>
160+
<figure id="vocabulary-diagram" style="text-align:center">
161+
<div data-include="vocabulary.svg" data-include-replace="true" data-oninclude="massageSVGLinks"></div>
162+
<figcaption>Overview diagram of the vocabulary (without the`xsd`
163+
datatypes). The terms prefixed by <code>cred:</code> or <code>sec:</code> are not defined in this vocabulary;
164+
they have only been added to the diagram for the sake of clarity.<br />
165+
A separate, stand-alone <a href="vocabulary.svg" target="_blank">SVG version</a> of the diagram, as well as a <a
166+
href="#vocabulary-diagram-alt">textual description</a>,
167+
are also available.
168+
</figcaption>
169+
</figure>
160170
</section>
161171
<section>
162172
<h2>Namespaces</h2>
@@ -216,5 +226,104 @@ <h2>Deprecated individuals</h2>
216226
</section>
217227
</section>
218228

229+
<section class="appendix" id="vocabulary-diagram-alt">
230+
<h2>Diagram description</h2>
231+
<details>
232+
<summary>Overview diagram of the vocabulary (without the `xsd` datatypes). The terms prefixed by <code>cred:</code> or
233+
<code>sec:</code> are not defined in this vocabulary; they have only been added to the diagram for the sake of clarity.</summary>
234+
<p>
235+
The diagram uses boxes, ellipses, and connecting lines with different "styles"
236+
(border color, end marker, line type) to differentiate their semantic meaning:
237+
"Property", "Class", and "Datatype" are identified by the shape of the
238+
graph node (e.g., an ellipse signifies a "Class"); "Superclass", "Domain Of", or "Range" relationships
239+
are identified by the style of the connecting line.
240+
These style names are used in the explanation text that follows, below.
241+
</p>
242+
<p>
243+
The diagram is roughly divided into three sections — left, middle, and right.
244+
To make this description easier to understand, these sections will be respectively referred to
245+
as the "Classes", "Properties", and "Values" sections.
246+
Shapes in the three sections are connected by lines of different styles.
247+
</p>
248+
<section>
249+
<h3>Classes Section</h3>
250+
251+
<p>
252+
The section contains three ellipses, labeled as "cred:CredentialStatus",
253+
"BitstringStatusListEntry", and "BitstringStatusList". It also contains
254+
a box, styled as "Property" and labeled as "cred:credentialStatus".
255+
</p>
256+
257+
<p>
258+
The "cred:CredentialStatus" ellipse, is connected to the ellipse,
259+
labeled as "cred:CredentialStatus", with a line styled "Range".
260+
The ellipse labeled as "BitstringStatusListEntry" is connected to the
261+
ellipse, labeled as "cred:CredentialStatus", with a line styled as
262+
"Superclass".
263+
</p>
264+
265+
<p>
266+
The ellipses labeled as "BitstringStatusListEntry" and "BitstringStatusList" are
267+
also connected to a number of boxes, all styled as "Property", with lines styled as
268+
"Domain Of"; see the "Properties" section below for further details.
269+
</p>
270+
</section>
271+
<section>
272+
<h3>Properties Section</h3>
273+
274+
<p>
275+
The section contains a number of boxes, each styles as "Property". The labels of
276+
these boxes are "statusListIndex", "statusListCredential", "statusPurpose",
277+
"statusMessage", "ttl", "statusReference", "statusSize", and "encodedList".
278+
There is also a small, unlabeled circle, which serves as an intersection point for connector
279+
lines.
280+
</p>
281+
282+
<p>
283+
The ellipse labeled as "BitstringStatusListEntry", described in the previous section, is
284+
connected to the "statusListIndex", and "statusListCredential" boxes with lines styled as "Domain Of".
285+
The ellipse labeled as "BitstringStatusList", also described in the previous section,
286+
is connected to the "statusMessage", "ttl", "statusReference", "statusSize",
287+
and "encodedList" boxes, also with lines styled as "Domain Of".
288+
</p>
289+
290+
<p>
291+
Both the ellipses labeled as "BitstringStatusListEntry" and "BitstringStatusList" are connected to the
292+
intersection point with a line styled as "Domain Of", and the intersection point is connected to the
293+
box labeled as "statusPurpose with a line styled as "Domain Of".
294+
</p>
295+
</section>
296+
<section>
297+
<h3>Values Section</h3>
298+
299+
<p>
300+
The section contains and ellipse, labeled as "BitstringStatusListCredential", which is connected to
301+
another ellipse, labeled as "cred:VerifiableCredential", with a line styled as "Superclass".
302+
The box labeled as "statusListCredential", described in the previous section, is connected to the ellipse,
303+
labeled as "BitstringStatusListCredential", with a line styled as "Range".
304+
</p>
305+
306+
<p>
307+
Another ellipse, labeled as "BistringStatusMessage", is connected to two boxes with lines styled
308+
as "Domain Of". The boxes are styled as "Property" and are labeled with "status" and "message".
309+
The box labeled as "statusMessage", described in the previous section, is connected to the ellipse,
310+
labeled as "BistringStatusMessage", with a line styled as "Range".
311+
</p>
312+
313+
<p>
314+
The box labeled as "statusSize", described in the previous section, is connected to a box, styled
315+
as "Datatype", and labeled as "xsd:positiveInteger", with a line styled as "Range".
316+
</p>
317+
318+
<p>
319+
The box labeled as "encodedList", described in the previous section, is connected to a box, styled
320+
as "Datatype", and labeled as "sec:multibase", with a line styled as "Range".
321+
</p>
322+
</section>
323+
</details>
324+
</section>
325+
326+
327+
219328
</body>
220329
</html>

0 commit comments

Comments
 (0)