Ensured all examples in the Syntax spec have titles
authorFrançois Daoust <francois@joshfire.com>
Wed, 14 Nov 2012 14:17:56 +0100
changeset 961 ff92cb209707
parent 960 6f71d3b78b32
child 962 2ee56198945d
Ensured all examples in the Syntax spec have titles

(cherry picked from commit 02dce3ff12f7bc4d2a8912e15c2cf6a1d6aee9ca)
(cherry picked from commit b632dcf9e3ad8451689f012dd966fe5d8076e377)
(cherry picked from commit 80c3343d55e0bc22e56c4c1465615c0144fa85c6)

This closes #163.
spec/latest/json-ld-syntax/index.html
--- a/spec/latest/json-ld-syntax/index.html	Tue Nov 13 22:41:30 2012 +0100
+++ b/spec/latest/json-ld-syntax/index.html	Wed Nov 14 14:17:56 2012 +0100
@@ -505,7 +505,7 @@
 </p>
 
 <pre class="example" data-transform="updateExample"
-     title="Sample JSON object">
+     title="Sample JSON document">
 <!--
 {
   "name": "Manu Sporny",
@@ -519,7 +519,7 @@
 to reference the context and transform it into a JSON-LD document:</p>
 
 <pre class="example" data-transform="updateExample"
-     title="Adding context reference to JSON document">
+     title="Referencing a JSON-LD context">
 <!--
 {
   ****"@context": "http://json-ld.org/contexts/person.jsonld",****
@@ -992,7 +992,7 @@
 
 <p>The value of a <code>@type</code> key may also be a <tref>term</tref> defined in the <tref>active context</tref>:</p>
 <pre class="example" data-transform="updateExample"
-     title="Using a term as the value of an @type key">
+     title="Using a term to specify the type">
 <!--
 {
   "@context": "http://json-ld.org/contexts/person.jsonld",
@@ -1017,7 +1017,7 @@
   <tref>term</tref> definition:</p>
 
 <pre class="example" data-transform="updateExample"
-     title="String Internationalization">
+     title="Setting the default language of a JSON-LD document">
 <!--
 {
   ****"@context":
@@ -1038,7 +1038,7 @@
 <p>It is possible to override the default language by using an <tref>expanded value</tref>:</p>
 
 <pre class="example" data-transform="updateExample"
-     title="Expanded value with language">
+     title="Overriding default language using an expanded value">
 <!--
 {
   "@context": {
@@ -1059,7 +1059,7 @@
 <code>null</code> when expressing the <tref>expanded value</tref>:</p>
 
 <pre class="example" data-transform="updateExample"
-     title="Expanded value to remove language">
+     title="Removing language information using an expanded value">
 <!--
 {
   "@context": {
@@ -1531,8 +1531,7 @@
 <p>Instead of using a string representation of an IRI, the IRI may be
 specified using a <tref>JSON object</tref> having an <code>@id</code> key,
 and a <tref>term</tref>, a <tref>compact IRI</tref>, or an
-<tref>absolute IRI</tref> as value. Such
-an object is called a <tref>node reference</tref>.</p>
+<tref>absolute IRI</tref> as value.</p>
 
 <pre class="example" data-transform="updateExample"
      title="Expanded term definition">
@@ -1792,7 +1791,8 @@
 <p>While the term above is only used once outside of the <code>@context</code>,
 the document above is equivalent to the following set of statements:</p>
 
-<pre class="example" data-transform="updateExample">
+<pre class="example" data-transform="updateExample"
+     title="Set of statements generated by the previous example">
 <!--
 <http://example.com/book>
   <http://purl.org/dc/terms/title>
@@ -1817,7 +1817,7 @@
     there are no circular dependencies. For example, it is common to use
     the <code>xsd</code> namespace when defining <tref>typed value</tref>s:</p>
 <pre class="example" data-transform="updateExample"
-     title="IRI expansion within context">
+     title="IRI expansion within a context">
 <!--
 {
   "@context":
@@ -1846,7 +1846,8 @@
 <p><tref title="term">Terms</tref> may also be used when defining the IRI of another
 <tref>term</tref>:</p>
 
-<pre class="example" data-transform="updateExample">
+<pre class="example" data-transform="updateExample"
+     title="Using a term to define the IRI of another term within a context">
 <!--
 {
   "@context":
@@ -1874,7 +1875,8 @@
   and <tref title="iri">IRIs</tref> may be used on the left-hand side of a
   <tref>term</tref> definition.</p>
 
-<pre class="example" data-transform="updateExample">
+<pre class="example" data-transform="updateExample"
+     title="Using a compact IRI as a term">
 <!--
 {
   "@context":
@@ -1913,7 +1915,8 @@
 <tref title="absolute iri">Absolute IRIs</tref> may also be used in the key position in a <tref>context</tref>:
 </p>
 
-<pre class="example" data-transform="updateExample">
+<pre class="example" data-transform="updateExample"
+     title="Associating context definitions with absolute IRIs">
 <!--
 {
   "@context":
@@ -1951,7 +1954,8 @@
   definition of <em>term-2</em> if <em>term-2</em> also depends on
   <em>term-1</em>. For example, the following <tref>context</tref> definition
   is illegal:</p>
-<pre class="example" data-transform="updateExample">
+<pre class="example" data-transform="updateExample"
+     title="Illegal circular definition of terms within a context">
 <!--
 {
   "@context":
@@ -1975,7 +1979,8 @@
   arrays, which are ordered by default. For example, consider the following
   simple document:</p>
 
-<pre class="example" data-transform="updateExample">
+<pre class="example" data-transform="updateExample"
+     title="Multiple values with no inherent order">
 <!--
 {
 ...
@@ -2016,7 +2021,8 @@
 
 <p>Multiple values may also be expressed using the expanded form:</p>
 
-<pre class="example" data-transform="updateExample">
+<pre class="example" data-transform="updateExample"
+     title="Using an expanded form to set multiple values">
 <!--
 {
   "@id": "http://example.org/articles/8",
@@ -2063,7 +2069,8 @@
 <p>As the notion of ordered collections is rather important in data
   modeling, it is useful to have specific language support. In JSON-LD,
   a list may be represented using the <code>@list</code> <tref>keyword</tref> as follows:</p>
-<pre class="example" data-transform="updateExample">
+<pre class="example" data-transform="updateExample"
+     title="An ordered collection of values in JSON-LD">
 <!--
 {
 ...
@@ -2081,7 +2088,8 @@
   and order is maintained when processing a document. If every use of a given multi-valued
   property is a list, this may be abbreviated by setting <code>@container</code>
   to <code>@list</code> in the <tref>context</tref>:</p>
-<pre class="example" data-transform="updateExample">
+<pre class="example" data-transform="updateExample"
+     title="Specifying that a collection is ordered in the context">
 <!--
 {
   ****"@context":
@@ -2131,7 +2139,8 @@
 
   <p>The example shows two nodes related by a property from the first node:</p>
 
-  <pre class="example" data-transform="updateExample">
+  <pre class="example" data-transform="updateExample"
+       title="Embedding a node definition as property value of another node definition">
   <!--
   {
   ...
@@ -2161,7 +2170,8 @@
     <code>@graph</code> <tref>keyword</tref> by pairing it with an
     <code>@id</code> <tref>keyword</tref> as shown in the following example:</p>
 
-  <pre class="example" data-transform="updateExample">
+  <pre class="example" data-transform="updateExample"
+       title="Identifying and making statements about a graph">
   <!--
   {
     "@context": {
@@ -2340,7 +2350,8 @@
 external document. The <tref>unlabeled node</tref> identifier is scoped to the
 document in which it is used.</p>
 
-<pre class="example" data-transform="updateExample">
+<pre class="example" data-transform="updateExample"
+     title="Specifying a local unlabeled node identifier">
 <!--
 {
 ...
@@ -2369,7 +2380,8 @@
 This feature also allows developers to design domain-specific implementations
 using only the JSON-LD <tref>context</tref>.</p>
 
-<pre class="example" data-transform="updateExample">
+<pre class="example" data-transform="updateExample"
+     title="Aliasing keywords">
 <!--
 {
   "@context":
@@ -2402,7 +2414,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":
@@ -2422,7 +2435,8 @@
 <p>Running the JSON-LD Expansion algorithm 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="Expanded form for the previous example">
 <!--
 [
   {
@@ -2457,7 +2471,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 expanded JSON-LD document">
 <!--
 [
   {
@@ -2474,7 +2489,8 @@
 
 <p>Additionally, assume the following developer-supplied JSON-LD context:</p>
 
-<pre class="example" data-transform="updateExample">
+<pre class="example" data-transform="updateExample"
+     title="Sample context">
 <!--
 {
   "@context": {
@@ -2492,7 +2508,8 @@
   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="Compact form of the sample document once sample context has been applied">
 <!--
 {
   "@context": {
@@ -2879,7 +2896,8 @@
 <p>The JSON-LD context has direct equivalents for the Turtle
   <code>@prefix</code> declaration:</p>
 
-<pre class="example" data-transform="updateExample">
+<pre class="example" data-transform="updateExample"
+     title="A set of statements serialized in Turtle">
 <!--
 @prefix foaf: <http://xmlns.com/foaf/0.1/> .
 
@@ -2889,7 +2907,8 @@
 -->
 </pre>
 
-<pre class="example" data-transform="updateExample">
+<pre class="example" data-transform="updateExample"
+     title="The same set of statements serialized in JSON-LD">
 <!--
 {
   "@context":
@@ -2914,7 +2933,8 @@
   <tref title="unlabeled node">unlabeled nodes</tref>.</p>
 </section>
 
-<pre class="example" data-transform="updateExample">
+<pre class="example" data-transform="updateExample"
+     title="Embedding in Turtle">
 <!--
 @prefix foaf: <http://xmlns.com/foaf/0.1/> .
 
@@ -2925,7 +2945,8 @@
 -->
 </pre>
 
-<pre class="example" data-transform="updateExample">
+<pre class="example" data-transform="updateExample"
+     title="Same embedding example in JSON-LD">
 <!--
 {
   "@context":
@@ -2947,7 +2968,8 @@
 <h4>Lists</h4>
 <p>Both JSON-LD and Turtle can represent sequential lists of values.</p>
 
-<pre class="example" data-transform="updateExample">
+<pre class="example" data-transform="updateExample"
+     title="A list of values in Turtle">
 <!--
 @prefix foaf: <http://xmlns.com/foaf/0.1/> .
 
@@ -2957,7 +2979,8 @@
 -->
 </pre>
 
-<pre class="example" data-transform="updateExample">
+<pre class="example" data-transform="updateExample"
+     title="Same example with a list of values in JSON-LD">
 <!--
 {
   "@context":
@@ -2984,7 +3007,8 @@
 <p>The following example describes three people with their respective names and
 homepages.</p>
 
-<pre class="example" data-transform="updateExample">
+<pre class="example" data-transform="updateExample"
+     title="RDFa fragment that describes three persons">
 <!--
 <div ****prefix="foaf: http://xmlns.com/foaf/0.1/"****>
    <ul>
@@ -3005,7 +3029,8 @@
 <p>An example JSON-LD implementation using a single <tref>context</tref> is
 described below.</p>
 
-<pre class="example" data-transform="updateExample">
+<pre class="example" data-transform="updateExample"
+     title="Same description in JSON-LD (context shared among node definitions)">
 <!--
 {
   "@context":
@@ -3042,7 +3067,8 @@
 <p>The following example uses a simple Microformats hCard example to express
 how the Microformat is represented in JSON-LD.</p>
 
-<pre class="example" data-transform="updateExample">
+<pre class="example" data-transform="updateExample"
+     title="HTML fragment with a simple Microformats hCard">
 <!--
 <div class="vcard">
  <a class="url fn" href="http://tantek.com/">Tantek Çelik</a>
@@ -3055,7 +3081,8 @@
 properties. Also note that the Microformat to JSON-LD processor has
 generated the proper URL type for <code>http://tantek.com/</code>.</p>
 
-<pre class="example" data-transform="updateExample">
+<pre class="example" data-transform="updateExample"
+     title="Same hCard representation in JSON-LD">
 <!--
 {
   "@context":
@@ -3084,7 +3111,8 @@
 item.
 </p>
 
-<pre class="example" data-transform="updateExample">
+<pre class="example" data-transform="updateExample"
+     title="HTML fragments that describes a book using microdata">
 <!--
 <dl itemscope
     itemtype="http://purl.org/vocab/frbr/core#Work"
@@ -3116,7 +3144,8 @@
 true to the desires of the Microdata community to avoid contexts and
 instead refer to items by their full <tref>IRI</tref>.</p>
 
-<pre class="example" data-transform="updateExample">
+<pre class="example" data-transform="updateExample"
+     title="Same book description in JSON-LD (avoiding contexts)">
 <!--
 [
   {