Update API spec intro as suggested by @davidlehn
authorMarkus Lanthaler <mark_lanthaler@gmx.net>
Wed, 27 Mar 2013 13:19:41 +0100
changeset 1483 5e373674a84f
parent 1482 a081bb1f9860
child 1484 526614506a86
Update API spec intro as suggested by @davidlehn

... also link to API calls in the feature descriptions.

See http://lists.w3.org/Archives/Public/public-linked-json/2013Feb/0005.html

This addresses #218.
spec/latest/json-ld-api/index.html
--- a/spec/latest/json-ld-api/index.html	Wed Mar 27 12:50:46 2013 +0100
+++ b/spec/latest/json-ld-api/index.html	Wed Mar 27 13:19:41 2013 +0100
@@ -175,13 +175,14 @@
   <h1>Introduction</h1>
 
   <p>This document is a detailed specification for an Application Programming
-    Interface for the JSON-LD Syntax. The document is primarily intended for
+    Interface for the JSON-LD syntax. The document is primarily intended for
     the following audiences:</p>
 
   <ul>
+    <li>Developers that want an overview of the JSON-LD API.</li>
     <li>Web authors and developers that want a very detailed view of how
-      a JSON-LD processor and the API operates.</li>
-    <li>Software developers that want to implement processors and APIs for
+      a JSON-LD Implementation or a JSON-LD Processor's API operates.</li>
+    <li>Software developers that want to implement the algorithms to transform
       JSON-LD documents.</li>
   </ul>
 
@@ -288,8 +289,9 @@
       <tref>expanded form</tref>. <tref>Expanded form</tref> is the most verbose
       and regular way of expressing of values in JSON-LD; all contextual
       information from the document is instead stored locally with each value.
-      Running the <a href="#expansion-algorithm">Expansion algorithm</a> against
-      the examples provided above results in the following output:</p>
+      Running the <a href="#expansion-algorithm">Expansion algorithm</a>
+      (<code class="idlMemberName"><a href="#widl-JsonLdProcessor-expand-void-object-object---DOMString-input-JsonLdCallback-callback-JsonLdOptions-options">expand</a></code>
+      operation) against the examples provided above results in the following output:</p>
 
     <pre class="example" data-transform="updateExample"
          title="Expanded sample document">
@@ -375,9 +377,10 @@
     -->
     </pre>
 
-    <p>Running the <a href="#compaction-algorithm">Compaction Algorithm</a> given
-      the context supplied above against the JSON-LD input document provided above
-      would result in the following output:</p>
+    <p>Running the <a href="#compaction-algorithm">Compaction Algorithm</a>
+      (<code class="idlMemberName"><a href="#widl-JsonLdProcessor-compact-void-object-object---DOMString-input-object-DOMString-context-JsonLdCallback-callback-JsonLdOptions-options">compact</a></code>
+      operation) given the context supplied above against the JSON-LD input
+      document provided above would result in the following output:</p>
 
     <pre class="example" data-transform="updateExample"
          title="Compacted sample document">
@@ -442,8 +445,9 @@
     </pre>
 
     <p>Running the <a href="#flattening-algorithm">Flattening algorithm</a>
-      with a context set to <tref>null</tref> to prevent compaction returns
-      the following document:</p>
+      (<code class="idlMemberName"><a href="#widl-JsonLdProcessor-flatten-void-object-object---DOMString-input-object-DOMString-context-JsonLdCallback-callback-JsonLdOptions-options">flatten</a></code>
+      operation) with a context set to <tref>null</tref> to prevent compaction
+      returns the following document:</p>
 
     <pre class="example" data-transform="updateExample"
          title="Flattened sample document in expanded form">