Skip to content

Commit 1920037

Browse files
committed
Refactor context section to be easier to read.
1 parent 52562ec commit 1920037

File tree

1 file changed

+35
-37
lines changed

1 file changed

+35
-37
lines changed

index.html

Lines changed: 35 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1249,27 +1249,18 @@ <h3>Contexts</h3>
12491249
<p>
12501250
When two software systems need to exchange data, they need to use terminology
12511251
that both systems understand. As an analogy, consider how two people
1252-
communicate. Both people must use the same language and the words they use must
1253-
mean the same thing to each other. This might be referred to as
1254-
<em>the context of a conversation</em>.
1255-
</p>
1256-
<p>
1257-
[=Verifiable credentials=] and [=verifiable presentations=] have many
1258-
properties and values that are identified by [=URLs=] [[URL]]. However,
1259-
those [=URLs=] can be long and not very human-friendly. In such cases,
1260-
short-form human-friendly aliases can be more helpful. This specification uses
1261-
the `@context` [=property=] to map such short-form aliases to the
1262-
[=URLs=] required by specific [=verifiable credentials=] and [=verifiable
1263-
presentations=].
1264-
</p>
1265-
<p class="note">
1266-
In JSON-LD, the `@context` [=property=] can also be used to
1267-
communicate other details, such as datatype information, language information,
1268-
transformation rules, and so on, which are beyond the needs of this
1269-
specification, but might be useful in the future or to related work. For more
1270-
information, see
1271-
<a href="https://www.w3.org/TR/json-ld11/#the-context">Section 3.1: The Context</a>
1272-
of the [[[JSON-LD11]]] [[JSON-LD11]] specification.
1252+
communicate effectively by using the same language where the words they use,
1253+
such as "name" and "website", mean the same thing to each individual. This is
1254+
sometimes referred to as <em>the context of a conversation</em>. This
1255+
specification uses a similar concept to achieve similar results for software
1256+
systems by establishing a context in which to communicate.
1257+
</p>
1258+
<p>
1259+
Software systems that process [=verifiable credentials=] and [=verifiable
1260+
presentations=] identify terminology by using [=URLs=] [[URL]] for each term.
1261+
However, those [=URLs=] can be long and not very human-friendly and short-form,
1262+
human-friendly aliases can be more helpful. This specification uses the
1263+
`@context` [=property=] to map such short-form aliases to the [=URLs=].
12731264
</p>
12741265
<p>
12751266
[=Verifiable credentials=] and [=verifiable presentations=] MUST include a
@@ -1279,11 +1270,10 @@ <h3>Contexts</h3>
12791270
<dl>
12801271
<dt><dfn class="export">@context</dfn></dt>
12811272
<dd>
1282-
The value of the `@context` [=property=] MUST be an ordered set
1273+
The value of the `@context` [=property=] MUST be an [=ordered set=]
12831274
where the first item is a [=URL=] with the value
1284-
`https://www.w3.org/ns/credentials/v2`. For reference, a copy of
1285-
the base context is provided in Appendix <a href="#base-context"></a>.
1286-
Subsequent items in the array MUST be composed of any combination of
1275+
`https://www.w3.org/ns/credentials/v2`.
1276+
Subsequent items in the [=ordered set=] MUST be composed of any combination of
12871277
[=URLs=] and/or objects where each is processable as a
12881278
<a data-cite="JSON-LD11#the-context">JSON-LD Context</a>.
12891279
</dd>
@@ -1312,27 +1302,35 @@ <h3>Contexts</h3>
13121302
<p>
13131303
The example above uses the base context [=URL=]
13141304
(`https://www.w3.org/ns/credentials/v2`) to establish that the
1315-
conversation is about a [=verifiable credential=]. The second [=URL=]
1316-
(`https://www.w3.org/ns/credentials/examples/v2`) establishes that
1317-
the conversation is about examples.
1305+
data exchange is about a [=verifiable credential=].
13181306
</p>
13191307

1320-
<p class="note">
1321-
This document uses the example context [=URL=]
1322-
(`https://www.w3.org/ns/credentials/examples/v2`) for the purpose
1323-
of demonstrating examples. Implementations are expected to not use this
1324-
[=URL=] for any other purpose, such as in pilot or production systems.
1308+
<p>
1309+
The second [=URL=] (`https://www.w3.org/ns/credentials/examples/v2`) is used for
1310+
the purpose of demonstrating examples. Implementations are expected to not use
1311+
this [=URL=] for any other purpose, such as in pilot or production systems.
13251312
</p>
13261313

13271314
<p>
1328-
The data available at `https://www.w3.org/ns/credentials/v2` is a
1329-
static document that is never updated and SHOULD be downloaded and cached. The
1330-
associated human-readable vocabulary document for the Verifiable Credentials
1331-
Data Model is available at
1315+
The data available at `https://www.w3.org/ns/credentials/v2` is a static
1316+
document that is never updated and SHOULD be downloaded and cached. For
1317+
reference, a copy of the base context is provided in Appendix
1318+
[[[#base-context]]]. The associated human-readable vocabulary document for
1319+
the Verifiable Credentials Data Model is available at
13321320
<a href="https://www.w3.org/2018/credentials/">https://www.w3.org/2018/credentials/</a>.
13331321
This concept is further expanded on in Section <a href="#extensibility"></a>.
13341322
</p>
13351323

1324+
<p class="note" title="See JSON-LD for more information about @context.">
1325+
In JSON-LD, the `@context` [=property=] can also be used to
1326+
communicate other details, such as datatype information, language information,
1327+
transformation rules, and so on, which are beyond the needs of this
1328+
specification, but might be useful in the future or to related work. For more
1329+
information, see
1330+
<a href="https://www.w3.org/TR/json-ld11/#the-context">Section 3.1: The Context</a>
1331+
of the [[[JSON-LD11]]] [[JSON-LD11]] specification.
1332+
</p>
1333+
13361334
</section>
13371335

13381336
<section>

0 commit comments

Comments
 (0)