Clarify the usage of the documentLoader option
authorMarkus Lanthaler <>
Tue, 03 Sep 2013 17:43:20 +0200
changeset 1955 836bd7f8ab6f
parent 1954 2dc1b06f333b
child 1956 1d8c40b91cfa
Clarify the usage of the documentLoader option

--- a/spec/latest/json-ld-api/index.html	Sat Aug 31 17:26:23 2013 -0700
+++ b/spec/latest/json-ld-api/index.html	Tue Sep 03 17:43:20 2013 +0200
@@ -216,6 +216,8 @@
       to retrieve remote contexts and remote documents</li>
     <li>Allow contexts to be passed into the API directly. Previously only context documents, i.e.,
       objects having a <code>@context</code> member were allowed.</li>
+    <li>Clarify the usage of the
+      <code class="idlMemberName"><a href="#widl-JsonLdOptions-documentLoader">documentLoader</a></code> option.</li>
   <p>Before this specification exits Candidate Recommendation, two or more
@@ -3859,6 +3861,17 @@
       <code class="idlMemberName"><a href="#widl-JsonLdError-code">code</a></code>
       and processing is stopped.</p>
+    <p>If the <code class="idlMemberName"><a href="#widl-JsonLdOptions-documentLoader">documentLoader</a></code>
+      option is specified, a conformant <tref>JSON-LD Processor</tref> MUST use it to dereference remote documents
+      and contexts. The <code class="idlMemberName"><a href="#widl-RemoteDocument-documentUrl">documentUrl</a></code>
+      in the returned <code class="idlMemberName"><a href="#idl-def-RemoteDocument">RemoteDocument</a></code>
+      is used as <tref>base IRI</tref> and the
+      <code class="idlMemberName"><a href="#widl-RemoteDocument-contextUrl">contextUrl</a></code>
+      is used instead of looking at the HTTP Link Header directly. For the sake of simplicity, none of the algorithms
+      in this document mention this directly. <tref title="JSON-LD API Implementation">JSON-LD API Implementations</tref>
+      are not required to implement the
+      <code class="idlMemberName"><a href="#widl-JsonLdOptions-documentLoader">documentLoader</a></code> option.</p>
     <dl title="[Constructor] interface JsonLdProcessor" class="idl">
       <dt>Promise compact()</dt>