Skip to content

Commit 4a20f81

Browse files
authored
Merge pull request #455 from json-ld/data-cite-in-dfn
Use data-cite in definitions that are reflections of external definitions
2 parents 0d509df + 838ae40 commit 4a20f81

File tree

4 files changed

+112
-93
lines changed

4 files changed

+112
-93
lines changed

spec/latest/common/terms.html

Lines changed: 47 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ <h1>General Terminology</h1>
1515
unless specifically defined (see
1616
<a data-cite="JSON-LD#sets-and-lists" class="externalDFN">Sets and Lists</a> in
1717
the JSON-LD specification [[JSON-LD]]).</dd>
18-
<dt><dfn data-lt="JSON objects">JSON object</dfn></dt><dd>
18+
<dt><dfn data-cite="ecmascript-6.0#sec-terms-and-definitions-object" data-lt="JSON objects">JSON object</dfn></dt><dd>
1919
In the JSON serialization, an object structure is represented as a pair of curly brackets surrounding zero or
2020
more key-value pairs. A key is a <a>string</a>. A single colon comes after
2121
each key, separating the key from the value. A single comma separates a value
2222
from a following key. In JSON-LD the keys in an object MUST be unique.
2323
In the <em>abstract representation</em> a <a>JSON object</a> is equivalent to a
2424
<a data-cite="WebIDL#dfn-dictionary" class="externalDFN"><dfn data-lt="dictionaries">dictionary</dfn></a> (see [[WebIDL]]).</dd>
25-
<dt><dfn>null</dfn></dt><dd>
25+
<dt><dfn data-cite="ecmascript-6.0#sec-null-value">null</dfn></dt><dd>
2626
The use of the <a>null</a> value within JSON-LD is used to
2727
ignore or reset values. A key-value pair in the <code>@context</code> where
2828
the value, or the <code>@id</code> of the value, is <a>null</a>
@@ -32,44 +32,44 @@ <h1>General Terminology</h1>
3232
<code>@value</code>, <code>@list</code>, or <code>@set</code> is set to
3333
<a>null</a> in expanded form, then the entire <a>JSON
3434
object</a> is ignored.</dd>
35-
<dt><dfn data-lt="numbers|JSON number|JSON numbers">number</dfn></dt><dd>
35+
<dt><dfn data-cite="ecmascript-6.0#sec-number-object" data-lt="numbers|JSON number|JSON numbers">number</dfn></dt><dd>
3636
In the JSON serialization, a number is similar to that used in most programming languages, except
3737
that the octal and hexadecimal formats are not used and that leading
3838
zeros are not allowed.
3939
In the <em>abstract representation</em>, a <a>number</a> is equivalent to either
40-
a <a data-cote="WebIDL#idl-long" class="externalDFN">long</a>
41-
or <a data-cite="WebIDL#idl-double" class="externalDFN">double</a>, depending
40+
a <dfn data-cite="WebIDL#idl-long">long</dfn>
41+
or <dfn data-cite="WebIDL#idl-double">double</dfn>, depending
4242
on if the number has a non-zero fractional part (see [[WebIDL]]).</dd>
4343
<dt><dfn>scalar</dfn></dt><dd>
4444
A scalar is either a JSON <a>string</a>, <a>number</a>, <a>true</a>,
4545
or <a>false</a>.</dd>
46-
<dt><dfn data-lt="strings">string</dfn></dt><dd>
46+
<dt><dfn data-cite="ecmascript-6.0#sec-string-object" data-lt="strings">string</dfn></dt><dd>
4747
A string is a sequence of zero or more Unicode (UTF-8) characters,
4848
wrapped in double quotes, using backslash escapes (if necessary). A
4949
character is represented as a single character string.</dd>
5050
<dt><dfn>true</dfn> and <dfn>false</dfn></dt><dd>
5151
Values that are used to express one of two possible
52-
<a data-cite="WebIDL#idl-boolean" class="externalDFN">boolean</a> states.</dd>
52+
<dfn data-cite="WebIDL#idl-boolean">boolean</dfn> states.</dd>
5353
</dl>
5454

5555
<p>Furthermore, the following terminology is used throughout this document:</p>
5656

5757
<dl class="termlist">
58-
<dt><dfn data-lt="absolute IRIs">absolute IRI</dfn></dt><dd>
59-
An <a data-cite="rfc3987#section-1.3">absolute IRI</a>> is defined in [[!RFC3987]] containing a <em>scheme</em> along with a <em>path</em> and
58+
<dt><dfn data-cite="rfc3987#section-1.3" data-lt="absolute IRIs">absolute IRI</dfn></dt><dd>
59+
An <a>absolute IRI</a> is defined in [[!RFC3987]] containing a <em>scheme</em> along with a <em>path</em> and
6060
optional <em>query</em> and fragment segments.</dd>
6161
<dt><dfn data-lt="base IRIs">base IRI</dfn></dt><dd>
6262
The <a>base IRI</a> is an <a>absolute IRI</a> established in the <a>context</a>,
6363
or is based on the <a>JSON-LD document</a> location. The <a>base IRI</a> is used to turn
6464
<a>relative IRIs</a> into <a>absolute IRIs</a>.</dd>
65-
<dt><dfn data-lt="blank nodes">blank node</dfn></dt><dd>
65+
<dt><dfn data-cite="rdf11-concepts#dfn-blank-node" data-lt="blank nodes">blank node</dfn></dt><dd>
6666
A <a>node</a> in a <a>graph</a> that is neither an
6767
<a>IRI</a>, nor a <a>JSON-LD value</a>, nor a <a>list</a>.
6868
A <a>node</a> does not contain a de-referenceable
6969
identifier because it is either ephemeral in nature or does not contain information that needs to be
7070
linked to from outside of the linked data graph. A blank node is assigned an identifier starting with
7171
the prefix <code>_:</code>.</dd>
72-
<dt><dfn data-lt="blank node identifiers">blank node identifier</dfn></dt><dd>
72+
<dt><dfn data-cite="rdf11-concepts#dfn-blank-node-identifier" data-lt="blank node identifiers">blank node identifier</dfn></dt><dd>
7373
A blank node identifier is a string that can be used as an identifier for a
7474
<a>blank node</a> within the scope of a JSON-LD document. Blank node identifiers
7575
begin with <code>_:</code>.</dd>
@@ -80,10 +80,10 @@ <h1>General Terminology</h1>
8080
<dt><dfn data-lt="contexts">context</dfn></dt><dd>
8181
A a set of rules for interpreting a <a>JSON-LD document</a> as specified in
8282
<cite><a data-cite="JSON-LD#the-context">The Context</a> of the [[JSON-LD]] specification.</dd>
83-
<dt><dfn>datatype IRI</dfn></dt><dd>
84-
A <a data-cite="rdf11-concepts#dfn-datatype-iri" class="externalDFN">datatype IRI</a>
83+
<dt><dfn data-cite="rdf11-concepts#dfn-datatype-iri">datatype IRI</dfn></dt><dd>
84+
A <a>datatype IRI</a>
8585
as specified by [[RDF11-CONCEPTS]].</dd>
86-
<dt><dfn>default graph</dfn></dt><dd>
86+
<dt><dfn data-cite="rdf11-concepts#dfn-default-graph">default graph</dfn></dt><dd>
8787
The default graph is the only graph in a JSON-LD document which has no <a>graph name</a>.
8888
When executing an algorithm, the graph where data should be placed
8989
if a <a>named graph</a> is not specified.</dd>
@@ -108,7 +108,7 @@ <h1>General Terminology</h1>
108108
A frame object is a a <a>dictionary</a> element withing a <a>frame</a>
109109
which represents a specific portion of the <a>frame</a> matching either a
110110
<a>node object</a> or a <a>value object</a> in the input.</dd>
111-
<dt><dfn data-lt="graph names">graph name</dfn></dt><dd>
111+
<dt><dfn data-cite="rdf11-concepts#dfn-graph-name" data-lt="graph names">graph name</dfn></dt><dd>
112112
The <a>IRI</a> identifying a <a>named graph</a>.</dd>
113113
<dt class="changed"><dfn data-lt="id maps">id map</dfn></dt><dd class="changed">
114114
An <a>id map</a> is a <a>JSON object</a> value of a <a>term</a> defined with
@@ -131,8 +131,8 @@ <h1>General Terminology</h1>
131131
<a>set object</a>, or
132132
an <a>array</a> of zero or more of the above possibilities.
133133
</dd>
134-
<dt><dfn data-lt="IRIs|Internationalized Resource Identifier"><abbr title="Internationalized Resource Identifier">IRI</abbr></dfn></dt><dd>
135-
An <a data-cite="rfc3987">Internationalized Resource Identifier</a> as described in [[!RFC3987]].</dd>
134+
<dt><dfn data-cite="rfc3987#section-1.3" data-lt="IRIs|Internationalized Resource Identifier"><abbr title="Internationalized Resource Identifier">IRI</abbr></dfn></dt><dd>
135+
An Internationalized Resource Identifier as described in [[!RFC3987]].</dd>
136136
<dt><dfn data-lt="JSON-LD documents">JSON-LD document</dfn></dt><dd>
137137
A <a>JSON-LD document</a> is a serialization of a collection of
138138
<a>graphs</a> and comprises exactly one
@@ -152,14 +152,14 @@ <h1>General Terminology</h1>
152152
<a>string</a>, or
153153
an <a>array</a> of zero or more of the above possibilities.
154154
</dd>
155-
<dt><dfn data-lt="language-tagged strings">language-tagged string</dfn></dt><dd>
155+
<dt><dfn data-cite="rdf11-concepts#dfn-language-tagged-string" data-lt="language-tagged strings">language-tagged string</dfn></dt><dd>
156156
A <a>language-tagged string</a> consists of a string and a non-empty language
157-
tag as defined by [[!BCP47]]. The language tag MUST be well-formed according to
157+
tag as defined by [[!BCP47]]. The <dfn data-cite="rdf11-concepts#dfn-language-tag">language tag</dfn> MUST be well-formed according to
158158
<a data-cite="bcp47#section-2.2.9">section 2.2.9 Classes of Conformance</a>
159159
of [[!BCP47]], and is normalized to lowercase.</dd>
160160
<dt><dfn>Linked Data</dfn></dt><dd>
161161
A set of documents, each containing a representation of a <a>linked data graph</a>.</dd>
162-
<dt><dfn data-lt="graph|graphs">linked data graph</dfn></dt><dd>
162+
<dt><dfn data-cite="rdf11-concepts#dfn-rdf-graph" data-lt="graph|graphs">linked data graph</dfn></dt><dd>
163163
A labeled directed graph, i.e., a set of <a>nodes</a>
164164
connected by <a>edges</a>,
165165
as specified in the <a data-cite="JSON-LD#data-model">Data Model</a>
@@ -169,7 +169,9 @@ <h1>General Terminology</h1>
169169
as defined in [[!RDF-CONCEPTS]].</dd>
170170
<dt><dfn data-lt="lists">list</dfn></dt><dd>
171171
A <a>list</a> is an ordered sequence of <a>IRIs</a>,
172-
<a>blank nodes</a>, and <a>JSON-LD values</a>.</dd>
172+
<a>blank nodes</a>, and <a>JSON-LD values</a>.
173+
See <dfn data-cite="rdf-schema#ch_collectionvocab" data-lt="collection">RDF collection</dfn>
174+
in [[RDF-SCHEMA]].</dd>
173175
<dt><dfn data-lt="list objects">list object</dfn></dt><dd>
174176
A <a>list object</a> is a <a>JSON object</a> that has an <code>@list</code>
175177
member.</dd>
@@ -178,13 +180,13 @@ <h1>General Terminology</h1>
178180
<dt><dfn data-lt="local contexts">local context</dfn></dt><dd>
179181
A <a>context</a> that is specified within a <a>JSON object</a>,
180182
specified via the <code>@context</code> <a>keyword</a>.</dd>
181-
<dt><dfn data-lt="named graphs">named graph</dfn></dt><dd>
183+
<dt><dfn data-cite="rdf11-concepts#dfn-named-graph" data-lt="named graphs">named graph</dfn></dt><dd>
182184
A <a>linked data graph</a> that is identified by an <a>IRI</a> or <a>blank node</a>
183185
<dt><dfn data-lt="nested properties">nested property</dfn></dt><dd>
184186
A <a>nested property</a> is a <a>property</a> which is contained within an object referenced by
185187
a semantically meaningless <em>nesting property</em>.
186188
</dd>
187-
<dt><dfn data-lt="nodes">node</dfn></dt><dd>
189+
<dt><dfn data-cite="rdf11-concepts#dfn-node" data-lt="nodes">node</dfn></dt><dd>
188190
Every <a>node</a> is an <a>IRI</a>, a <a>blank node</a>,
189191
a <a>JSON-LD value</a>, or a <a>list</a>.
190192
A piece of information that is represented in a <a>linked data graph</a>.</dd>
@@ -203,50 +205,35 @@ <h1>General Terminology</h1>
203205
<dt><dfn data-lt="node references">node reference</dfn></dt><dd>
204206
A <a>node object</a> used to reference a node having only the
205207
<code>@id</code> key.</dd>
206-
<dt><dfn data-lt="objects">object</dfn></dt><dd>
207-
A <a>node</a> in a <a>linked data graph</a> with at least one incoming edge.</dd>
208-
<dt><dfn data-lt="prefixes">prefix</dfn></dt><dd>
208+
<dt><dfn data-cite="rdf11-concepts#dfn-object" data-lt="objects">object</dfn></dt><dd>
209+
A <a>node</a> in a <a>linked data graph</a> with at least one incoming edge.
210+
See <dfn data-cite="rdf11-concepts#dfn-object">RDF object</dfn>in [[RDF11-CONCEPTS]].</dd>
211+
<dt><dfn data-lt="prefixes">prefix</dfn></dt><dd>
209212
A <a>prefix</a> is a <a>term</a> that expands to a vocabulary <a>base IRI</a>. It
210213
is typically used along with a <em>suffix</em> to form a <a>compact IRI</a> to create an IRI
211214
within a vocabulary.</dd>
212215
<dt><dfn data-lt="properties">property</dfn></dt><dd>
213-
The <a>IRI</a> label of an edge in a <a>linked data graph</a>.</dd>
214-
<dt><dfn data-lt="quads">quad</dfn></dt><dd>
216+
The <a>IRI</a> label of an edge in a <a>linked data graph</a>.
217+
See <dfn data-cite="rdf11-concepts#dfn-predicate" data-lt="predicate|predicates|RDF predicates">RDF predicate</dfn> in [[RDF11-CONCEPTS]].</dd>
218+
<dt><dfn data-lt="quads">quad</dfn></dt><dd>
215219
A piece of information that contains four items; a <a>subject</a>, a <a>property</a>,
216220
an <a>object</a>, and a <a>graph name</a>.</dd>
217-
<dt><dfn>RDF collection</dfn></dt><dd>
218-
A <a data-cite="rdf-schema#ch_collectionvocab" class="externalDFN">collection</a>
219-
as specified by [[RDF-SCHEMA]].</dd>
220-
<dt><dfn>RDF dataset</dfn></dt><dd>
221-
A <a data-cite="rdf11-concepts#dfn-rdf-dataset" class="externalDFN">dataset</a>
222-
as specified by [[RDF11-CONCEPTS]] representing a collection of
221+
<dt><dfn data-cite="rdf11-concepts#dfn-rdf-dataset" data-lt="dataset">RDF dataset</dfn></dt><dd>
222+
A <a>dataset</a> as specified by [[RDF11-CONCEPTS]] representing a collection of
223223
<a data-cite="rdf11-concepts#dfn-rdf-graph">RDF graphs</a>.</dd>
224-
<dt><dfn data-lt="RDF literals">RDF literal</dfn></dt><dd>
225-
A <a data-cite="rdf11-concepts#dfn-literal" class="externalDFN">literal</a>
226-
as specified by [[RDF11-CONCEPTS]].</dd>
227-
<dt><dfn>RDF object</dfn></dt><dd>
228-
An <a data-cite="rdf11-concepts#dfn-object" class="externalDFN">object</a>
229-
as specified by [[RDF11-CONCEPTS]].</dd>
230-
<dt><dfn data-lt="predicate|predicates|RDF predicates">RDF predicate</dfn></dt><dd>
231-
A <a data-cite="rdf11-concepts#dfn-predicate" class="externalDFN">predicate</a>
232-
as specified by [[RDF11-CONCEPTS]].</dd>
233-
<dt><dfn>RDF resource</dfn></dt><dd>
234-
A <a data-cite="rdf11-concepts#dfn-resource" class="externalDFN">resource</a>
235-
as specified by [[RDF11-CONCEPTS]].</dd>
236-
<dt><dfn>RDF subject</dfn></dt><dd>
237-
A <a data-cite="rdf11-concepts#dfn-subject" class="externalDFN">subject</a>
238-
as specified by [[RDF11-CONCEPTS]].</dd>
239-
<dt><dfn data-lt="triple|triples|RDF triples">RDF triple</dfn></dt><dd>
240-
A <a data-cite="rdf11-concepts#dfn-rdf-triple" class="externalDFN">triple</a>
241-
as specified by [[RDF11-CONCEPTS]].</dd>
224+
<dt><dfn data-cite="rdf11-concepts#dfn-resource" data-lt="resource">RDF resource</dfn></dt><dd>
225+
A <a>resource</a> as specified by [[RDF11-CONCEPTS]].</dd>
226+
<dt><dfn data-cite="rdf11-concepts#dfn-rdf-triple" data-lt="triple|triples|RDF triples">RDF triple</dfn></dt><dd>
227+
A <a>triple</a> as specified by [[RDF11-CONCEPTS]].</dd>
242228
<dt><dfn data-lt="relative IRIs">relative IRI</dfn></dt><dd>
243229
A relative IRI is an <a>IRI</a> that is relative to some other <a>absolute IRI</a>.</dd>
244230
<dt><dfn>set object</dfn></dt><dd>
245231
A <a>set object</a> is a <a>JSON object</a> that has an <code>@set</code>
246232
member.</dd>
247-
<dt><dfn data-lt="subjects">subject</dfn></dt><dd>
248-
A <a>node</a> in a <a>linked data graph</a> with at least one outgoing edge, related to an <a>object</a> node through a <a>property</a>.</dd>
249-
<dt><dfn data-lt="terms">term</dfn></dt><dd>
233+
<dt><dfn data-cite="rdf11-concepts#dfn-subject" data-lt="subjects">subject</dfn></dt><dd>
234+
A <a>node</a> in a <a>linked data graph</a> with at least one outgoing edge, related to an <a>object</a> node through a <a>property</a>.
235+
See <dfn data-cite="rdf11-concepts#dfn-subject">RDF subject</dfn> in [[RDF11-CONCEPTS]].</dd>
236+
<dt><dfn data-lt="terms">term</dfn></dt><dd>
250237
A <a>term</a> is a short word defined in a <a>context</a> that MAY be expanded to an <a>IRI</a>
251238
</dd>
252239
<dt><dfn data-lt="term definitions">term definition</dfn></dt><dd>
@@ -262,10 +249,10 @@ <h1>General Terminology</h1>
262249
value MUST be a <a>node object</a>, or <a>array</a> of node objects.
263250
If the value contains a property expanding to <code>@type</code>, it's values
264251
are merged with the map value when expanding.</dd>
265-
<dt><dfn>typed literal</dfn></dt><dd>
252+
<dt><dfn data-cite="rdf11-concepts#dfn-typed-literal">typed literal</dfn></dt><dd>
266253
A <a>typed literal</a> is a <a>literal</a> with an associated <a>IRI</a>
267-
which indicates the literal's datatype. See <a
268-
data-cite="rdf11-concepts#dfn-typed-literal">languaged-tagged literal</a> in [[!RDF-CONCEPTS]].</dd>
254+
which indicates the literal's datatype.
255+
See <dfn data-cite="rdf11-concepts#dfn-literal" data-lt="RDF literals">RDF literal</dfn> in [[!RDF-CONCEPTS]].</dd>
269256
<dt><dfn data-lt="typed values">typed value</dfn></dt><dd>
270257
A <a>typed value</a> consists of a value, which is a <a>string</a>, and a type,
271258
which is an <a>IRI</a>.</dd>
@@ -335,9 +322,9 @@ <h1>Algorithm Terms</h1>
335322
as a stack with elements from the previous <a>processor state</a>
336323
copied into a new <a>processor state</a> when entering a new
337324
<a>JSON object</a>.</dd>
338-
<dt><dfn data-lt="promises">promise</dfn></dt><dd>
325+
<dt><dfn data-cite="ecmascript-6.0#sec-promise-objects" data-lt="promises">promise</dfn></dt><dd>
339326
A <em>promise</em> is an object that represents the eventual result of a single asynchronous operation.
340-
<a data-cite="ecmascript-6.0#sec-promise-objects">Promises</a> are defined in [[ECMASCRIPT-6.0]].</dd>
327+
Promises are defined in [[ECMASCRIPT-6.0]].</dd>
341328
<dt><dfn>require all flag</dfn></dt><dd>
342329
A flag specifying that all properties present in the <a>input frame</a>
343330
MUST either have a default value or be present in the <a>JSON-LD

spec/latest/json-ld-api/index.html

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -437,7 +437,7 @@ <h2>Compaction</h2>
437437
<h2>Flattening</h2>
438438

439439
<p>While expansion ensures that a document is in a uniform structure,
440-
flattening goes a step further to ensure that the shape of the data
440+
<dfn data-lt="flattened">flattening</dfn> goes a step further to ensure that the shape of the data
441441
is deterministic. In expanded documents, the properties of a single
442442
<a>node</a> may be spread across a number of different
443443
<a>JSON objects</a>. By flattening a
@@ -2753,7 +2753,7 @@ <h3>Overview</h3>
27532753
which collects all properties of a <a>node</a> in a single
27542754
<a>JSON object</a>. In the next step, the <em>node map</em> is
27552755
converted to a JSON-LD document in
2756-
<a href="../json-ld/#flattened-document-form" class="externalDFN">flattened document form</a>.
2756+
<a href="../json-ld/#flattened-document-form">flattened document form</a>.
27572757
Finally, if a <a>context</a> has been passed, the flattened document
27582758
is compacted using the <a href="#compaction-algorithm">Compaction algorithm</a>
27592759
before being returned.</p>
@@ -3673,8 +3673,7 @@ <h3>Algorithm</h3>
36733673
<li>Otherwise, if <em>value</em> is a
36743674
<a>language-tagged string</a>
36753675
add a member <code>@language</code> to <em>result</em> and set its value to the
3676-
<a data-cite="rdf11-concepts#dfn-language-tag" class="externalDFN">language tag</a>
3677-
of <em>value</em>.</li>
3676+
<a>language tag</a> of <em>value</em>.</li>
36783677
<li>Otherwise, set <em>type</em> to the
36793678
<a>datatype IRI</a>
36803679
of <em>value</em>, unless it equals <code>xsd:string</code> which is ignored.</li>

0 commit comments

Comments
 (0)