Skip to content

Commit ab4319a

Browse files
committed
Rename JSON-LD Implementation to Processor and Processor to API Implementation
See #237 (comment) This addresses #237. /cc @msporny @dlongley @gkellogg @niklasl @sandhawke
1 parent 11ea074 commit ab4319a

File tree

1 file changed

+34
-28
lines changed

1 file changed

+34
-28
lines changed

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

Lines changed: 34 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,8 @@ <h1>Introduction</h1>
173173
<ul>
174174
<li>Developers that want an overview of the JSON-LD API.</li>
175175
<li>Web authors and developers that want a very detailed view of how
176-
a JSON-LD Implementation or a JSON-LD Processor's API operates.</li>
176+
a <tref>JSON-LD Processor</tref> or a <tref>JSON-LD API Implementation</tref>
177+
operates.</li>
177178
<li>Software developers that want to implement the algorithms to transform
178179
JSON-LD documents.</li>
179180
</ul>
@@ -558,33 +559,37 @@ <h1>Conformance</h1>
558559
in [[!RFC2119]].</p>
559560

560561
<p>There are three classes of products that can claim conformance to this
561-
specification: <tref title="JSON-LD Implementation">JSON-LD Implementations</tref>
562-
and <tref title="JSON-LD Processor">JSON-LD Processors</tref>.</p>
562+
specification: <tref title="JSON-LD Processor">JSON-LD Processors</tref>
563+
and <tref title="JSON-LD API Implementation">JSON-LD API Implementations</tref>.</p>
563564

564-
<p>A conforming <tdef>JSON-LD Implementation</tdef> is a system which can perform the
565+
<p>A conforming <tdef>JSON-LD Processor</tdef> is a system which can perform the
565566
<a href="#expansion-algorithm">Expansion</a>, <a href="#compaction-algorithm">Compaction</a>,
566567
and <a href="#flattening-algorithm">Flattening</a> operations defined in this specification.</p>
567568

568-
<p>A conforming <tdef>JSON-LD Processor</tdef> is a conforming <tref>JSON-LD Implementation</tref>
569-
that exposes the Application Programming Interface (API) defined in this specification.
570-
It MUST implement the <code>json-ld-1.0</code> processing mode (for further details, see the
569+
<p>A conforming <tdef>JSON-LD API Implementation</tdef> is a conforming <tref>JSON-LD Processor</tref>
570+
that exposes the <a href="#the-application-programming-interface">Application Programming Interface (API)</a>
571+
defined in this specification. It MUST implement the <code>json-ld-1.0</code>
572+
processing mode (for further details, see the
571573
<code class="idlMemberName"><a href="#widl-JsonLdOptions-processingMode">processingMode</a></code>
572574
option of <a>JsonLdOptions</a>).</p>
573575

574-
<p>JSON-LD Implementations or Processors MUST NOT attempt to correct malformed
575-
<tref title="IRI">IRIs</tref> or language tags; however, they MAY issue validation
576-
warnings. IRIs are not modified other than converted between
577-
<tref title="relative IRI">relative</tref> and
576+
<p><tref title="JSON-LD Processor">JSON-LD Processors</tref> and
577+
<tref title="JSON-LD API Implementation">API Implementations</tref> MUST NOT
578+
attempt to correct malformed <tref title="IRI">IRIs</tref> or language tags;
579+
however, they MAY issue validation warnings. IRIs are not modified other
580+
than converted between <tref title="relative IRI">relative</tref> and
578581
<tref title="absolute IRI">absolute IRIs</tref>.</p>
579582

580583
<p>A conforming <tdef>JSON-LD-RDF Converter</tdef> is a system that can perform
581584
<a href="#convert-to-rdf-algorithm">Conversion to RDF</a> and
582585
<a href="#convert-from-rdf-algorithm">Conversion from RDF</a>.</p>
583586

584-
<p>The algorithms in this specification are generally written with more concern for clarity than
585-
efficiency. Thus, JSON-LD Implementations and Processors may implement the algorithms
586-
given in this specification in any way desired, so long as the end result is indistinguishable
587-
from the result that would be obtained by the specification's algorithms.</p>
587+
<p>The algorithms in this specification are generally written with more concern for clarity
588+
than efficiency. Thus, <tref title="JSON-LD Processor">JSON-LD Processors</tref>
589+
and <tref title="JSON-LD API Implementation">API Implementations</tref> may
590+
implement the algorithms given in this specification in any way desired,
591+
so long as the end result is indistinguishable from the result that would
592+
be obtained by the specification's algorithms.</p>
588593

589594
<p class="note">Implementers can partially check their level of conformance to
590595
this specification by successfully passing the test cases of the JSON-LD test
@@ -3671,8 +3676,9 @@ <h2>Data Round Tripping</h2>
36713676
backslash-escape the forward slash character. For example, the value
36723677
<code>http://example.com/</code> would be serialized as <code>http:\/\/example.com\/</code>.
36733678
This is problematic as other JSON parsers might not understand those escaping characters.
3674-
There is no need to backslash-escape forward slashes in JSON-LD. To aid interoperability
3675-
between JSON-LD processors, a JSON-LD serializer MUST NOT backslash-escape forward slashes.</p>
3679+
There is no need to backslash-escape forward slashes in JSON-LD. To aid
3680+
interoperability between JSON-LD processors, forward slashes MUST NOT be
3681+
backslash-escaped.</p>
36763682
</section> <!-- end of Data Round Tripping -->
36773683
</section>
36783684

@@ -3682,19 +3688,19 @@ <h2>The Application Programming Interface</h2>
36823688

36833689
<p>This API provides a clean mechanism that enables developers to convert
36843690
JSON-LD data into a variety of output formats that are often easier to
3685-
work with. A conformant JSON-LD Processor MUST implement the entirety of the
3686-
following API.</p>
3691+
work with. A conformant <tref>JSON-LD API Implementation</tref> MUST
3692+
implement the entirety of the following API.</p>
36873693

36883694
<section>
36893695
<h3>JsonLdProcessor</h3>
36903696

3691-
<p>The JSON-LD Processor interface is the high-level programming structure
3697+
<p>The <a>JsonLdProcessor</a> interface is the high-level programming structure
36923698
that developers use to access the JSON-LD transformation methods.</p>
36933699

36943700
<p>It is important to highlight that conformant
3695-
<tref title="JSON-LD Processor">JSON-LD processors</tref> MUST NOT modify
3696-
the input parameters. If an error is detected, the <i>callback</i> is
3697-
invoked passing a <a>JsonLdError</a> with the corresponding error
3701+
<tref title="JSON-LD API Implementation">JSON-LD API Implementations</tref>
3702+
MUST NOT modify the input parameters. If an error is detected, the <i>callback</i>
3703+
is invoked passing a <a>JsonLdError</a> with the corresponding error
36983704
<code class="idlMemberName"><a href="#widl-JsonLdError-code">code</a></code>
36993705
and processing is stopped.</li></p>
37003706

@@ -3866,9 +3872,9 @@ <h3>JsonLdProcessor</h3>
38663872
<section>
38673873
<h3>Callbacks</h3>
38683874

3869-
<p>JSON-LD processors utilize callbacks in order to exchange information in
3870-
an asynchronous manner with applications. This section details the
3871-
parameters of those callbacks.</p>
3875+
<p><tref title="JSON-LD API Implementation">JSON-LD API Implementations</tref>
3876+
utilize callbacks in order to exchange information in an asynchronous manner
3877+
with applications. This section details the parameters of those callbacks.</p>
38723878

38733879
<section>
38743880
<h3>JsonLdCallback</h3>
@@ -3964,9 +3970,9 @@ <h3>JsonLdOptions</h3>
39643970
<dt>object or DOMString expandContext = null</dt>
39653971
<dd>A context that is used to initialize the active context when expanding a document.</dd>
39663972
<dt>DOMString processingMode = "json-ld-1.0"</dt>
3967-
<dd>If set to <code>json-ld-1.0</code>, the JSON-LD Processor MUST produce
3973+
<dd>If set to <code>json-ld-1.0</code>, the JSON-LD processor MUST produce
39683974
exactly the same results as the algorithms defined in this specification.
3969-
If set to another value, the JSON-LD Processor is allowed to extend
3975+
If set to another value, the JSON-LD processor is allowed to extend
39703976
or modify the algorithms defined in this specification to enable
39713977
application-specific optimizations. The definition of such
39723978
optimizations is beyond the scope of this specification and thus

0 commit comments

Comments
 (0)