Merge pull request linkeddata#350 from linkeddata/Documentation

fetcher-block-diagram
ontola · Sep 12, 2019 · 3443e7f · 3443e7f
2 parents d84af88 + b0d0a01
commit 3443e7f
Show file tree

Hide file tree

Showing 6 changed files with 2,613 additions and 7 deletions.
diff --git a/Documentation/diagrams/fetcher-block-diagram-2.epgz b/Documentation/diagrams/fetcher-block-diagram-2.epgz
diff --git a/Documentation/diagrams/fetcher-block-diagram-2.svg b/Documentation/diagrams/fetcher-block-diagram-2.svg
diff --git a/Documentation/diagrams/fetcher-block-diagram.epgz b/Documentation/diagrams/fetcher-block-diagram.epgz
diff --git a/Documentation/diagrams/fetcher-block-diagram.svg b/Documentation/diagrams/fetcher-block-diagram.svg
diff --git a/Documentation/index.html b/Documentation/index.html
@@ -33,19 +33,36 @@
 </style>
 </head>
 <body>
-<h1>Introductory material</h1>
+<h1>Block diagrams</h1>
 
 <div>
+  <p>See also</p>
 <ul>
 
+  <li><a href="https://linkeddata.github.io/rdflib.js/doc/">rdflib documentation home page</a></li>
   <li><a href="webapp-intro.html">Introduction to using rdflib in a Solid WebApp</a></li>
-
   <li><a href="turtle-intro.html">Introduction to Turtle</a>.  Learn to chat in, and think in, this basic data language</li>
 
 </ul>
 
+<p>The rdflib library is modular.  Higher level functions such as the Update Manager and the Fetcher depend on the
+  core modules stch as the Store, which depends on low level parts such as the basic RDF model.
+<p>
  <img src="diagrams/rdflib-block-diagram.svg" alt="Separate modules perform different functions to provide local query, web access, and live update." />
-
+
+<p>
+  The Fetcher module adds an awareness of the web of linked data, rather than just abstract RDF.
+  It implements http(s): and file: URIs and tracks the metadata from the HTTP transaction and stores that also in the store.
+  This diagram points out that the responsability for retrying accesss based which fail because of different HTTP errors and browser blocking in CORS
+  are handled in various different places.
+</p>
+
+ <img src="diagrams/fetcher-block-diagram-2.svg" alt="In the Fetcher, separate modules perform different functions." />
+
+<p>
+The Fetcher does not handle PATCH - that is done by the Update Manager.
+</p>
+
 </div>
 </body>
 </html>
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ Javascript RDF library for browsers and Node.js.
 - Read/Write Linked Data client, using WebDav or SPARQL/Update
 - Local API for querying a store
 - Compatible with [RDFJS task force spec](https://github.com/rdfjs/representation-task-force/blob/master/interface-spec.md)
-- SPARQL queries (not full SPARQL)
+- SPARQL queries (not full SPARQL - just graph match and optional)
 - Smushing of nodes from `owl:sameAs`, and `owl:{f,inverseF}unctionProperty`
 - Tracks provenance of triples keeps metadata (in RDF) from HTTP accesses
 
@@ -17,9 +17,14 @@ Javascript RDF library for browsers and Node.js.
 See:
 
 * The [API documentation](https://linkeddata.github.io/rdflib.js/doc/) is partial but useful
-* [Using rdflib in a web app](https://linkeddata.github.io/rdflib.js/Documentation/webapp-intro.html)
-* [Tutorial for using rdflib.js](https://github.com/solid/solid-tutorial-rdflib.js)
-* [Using Turtle](https://linkeddata.github.io/rdflib.js/Documentation/turtle-intro.html)
+* [Tutorial: Using rdflib in a Solid web app](https://linkeddata.github.io/rdflib.js/Documentation/webapp-intro.html)
+* [Tutorial: Using rdflib.js](https://github.com/solid/solid-tutorial-rdflib.js)
+* [Tutorial: Using Turtle](https://linkeddata.github.io/rdflib.js/Documentation/turtle-intro.html)
+* [Block diagram: rdflib modules](https://linkeddata.github.io/rdflib.js/Documentation/diagrams/rdflib-block-diagram.svg)
+* [Block diagram: The Fetcher](https://linkeddata.github.io/rdflib.js/Documentation/diagrams/fetcher-block-diagram.svg)
+* [Block diagram: The Fetcher - handling retries](https://linkeddata.github.io/rdflib.js/Documentation/diagrams/fetcher-block-diagram-2.svg)
+
+
 * [The Solid developer portal at Inrupt](https://solid.inrupt.com/)
 
 for more information.