Add titles to all examples in the API spec
authorMarkus Lanthaler <mark_lanthaler@gmx.net>
Tue, 15 Jan 2013 15:06:25 +0100
changeset 1127 415e3f95a83a
parent 1126 814558958f7b
child 1128 72e8a1aae425
Add titles to all examples in the API spec
spec/latest/json-ld-api/index.html
--- a/spec/latest/json-ld-api/index.html	Tue Jan 15 10:56:59 2013 +0100
+++ b/spec/latest/json-ld-api/index.html	Tue Jan 15 15:06:25 2013 +0100
@@ -221,7 +221,8 @@
     note that the following input uses only <tref>term</tref>s and is fairly
     compact:</p>
 
-  <pre class="example" data-transform="updateExample">
+  <pre class="example" data-transform="updateExample"
+       title="Sample JSON-LD document">
   <!--
   {
     "@context": {
@@ -241,7 +242,8 @@
   <p>The next input example uses one <tref>URL</tref> to express a property, but leaves
     the rest of the information untouched.</p>
 
-  <pre class="example" data-transform="updateExample">
+  <pre class="example" data-transform="updateExample"
+       title="Sample JSON-LD document using a URL instead of a term to express a property">
   <!--
   {
     "@context": {
@@ -267,7 +269,8 @@
     <a href="#expansion-algorithm">Expansion algorithm</a> against the examples provided
     above results in the following output:</p>
 
-  <pre class="example" data-transform="updateExample">
+  <pre class="example" data-transform="updateExample"
+       title="Expanded sample document">
   <!--
   [
     {
@@ -305,7 +308,8 @@
 
   <p>For example, assume the following expanded JSON-LD input document:</p>
 
-  <pre class="example" data-transform="updateExample">
+  <pre class="example" data-transform="updateExample"
+       title="Expanded sample document">
   <!--
   [
     {
@@ -323,7 +327,8 @@
 
   <p>Additionally, assume the following developer-supplied JSON-LD <tref>context</tref>:</p>
 
-  <pre class="example" data-transform="updateExample">
+  <pre class="example" data-transform="updateExample"
+       title="JSON-LD context">
   <!--
   {
     "@context": {
@@ -341,7 +346,8 @@
     supplied above against the JSON-LD input document provided above would result in the
     following output:</p>
 
-  <pre class="example" data-transform="updateExample">
+  <pre class="example" data-transform="updateExample"
+       title="Compacted sample document">
   <!--
   {
     "@context": {
@@ -383,7 +389,8 @@
 
   <p>For example, assume the following JSON-LD input document:</p>
 
-  <pre class="example" data-transform="updateExample">
+  <pre class="example" data-transform="updateExample"
+       title="Sample JSON-LD document">
   <!--
   {
     "@context": {
@@ -412,7 +419,8 @@
     with a context set to <tref>null</tref> to prevent compaction returns
     the following document:</p>
 
-  <pre class="example" data-transform="updateExample">
+  <pre class="example" data-transform="updateExample"
+       title="Flattened sample document in expanded form">
   <!--
   [
     {
@@ -453,7 +461,8 @@
     passing a context. Using the same context as the input document, the flattened
     and compacted document looks as follows:</p>
 
-  <pre class="example" data-transform="updateExample">
+  <pre class="example" data-transform="updateExample"
+       title="Flattened and compacted sample document">
   <!--
   {
     "@context": {
@@ -499,7 +508,8 @@
 
   <p>For example, assume the following RDF input serialized in Turtle [[TURTLE-TR]]:</p>
 
-  <pre class="example" data-transform="updateExample">
+  <pre class="example" data-transform="updateExample"
+       title="Sample Turtle document">
   <!--
   <http://me.markus-lanthaler.com/> <http://xmlns.com/foaf/0.1/name> "Markus Lanthaler" .
   <http://me.markus-lanthaler.com/> <http://xmlns.com/foaf/0.1/homepage> <http://www.markus-lanthaler.com/> .
@@ -509,7 +519,8 @@
   <p>Using the <a href="#convert-from-rdf-algorithm">Convert from RDF Algorithm</a> a
     developer could transform this document into expanded JSON-LD:</p>
 
-  <pre class="example" data-transform="updateExample">
+  <pre class="example" data-transform="updateExample"
+       title="Sample Turtle document converted to JSON-LD">
   <!--
   [
     {
@@ -2299,7 +2310,8 @@
         digits (<code>0-9</code>) with an optional leading minus sign; leading zeroes are prohibited.
         To convert the number in JavaScript, implementers can use the following snippet of code:</p>
 
-      <pre class="example" data-transform="updateExample">
+      <pre class="example" data-transform="updateExample"
+           title="Sample integer serialization implementation in JavaScript">
       <!--
       (value).toFixed(0).toString()
       -->
@@ -2321,7 +2333,8 @@
 
       <p>To convert the number in JavaScript, implementers can use the following snippet of code:</p>
 
-      <pre class="example" data-transform="updateExample">
+      <pre class="example" data-transform="updateExample"
+           title="Sample floating point number serialization implementation in JavaScript">
       <!--
       (value).toExponential(15).replace(/(\d)0*e\+?/,'$1E')
       -->