initial structure for the primer
authorNandana Mihindukulasooriya <nmihindu@fi.upm.es>
Wed, 03 Jul 2013 14:13:55 +0200
changeset 139 514e6a5e0479
parent 138 42c94374d4c7
child 140 7b8b634fbce8
initial structure for the primer
ldp-primer/ldp-primer.html
ldp-primer/product_lookup.png
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ldp-primer/ldp-primer.html	Wed Jul 03 14:13:55 2013 +0200
@@ -0,0 +1,1 @@
+<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.1//EN" "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-2.dtd">
<html 
  xmlns="http://www.w3.org/1999/xhtml"
prefix="td: http://www.w3.org/2006/03/test-description# tn: http://ldp.example.org/NewTestDefinitions# ht: http://www.w3.org/2011/http#">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <!--    rgarcia: Had to uncomment it so it can read the local image
<base href="http://www.w3.org/TR/ldp/TestCases">-->
    <title>Linked Data Platform 1.0 Primer</title>
    <script src='https://www.w3.org/Tools/respec/respec-w3c-common' class='remove' async></script> 
    <script class='remove'>
      var respecConfig = {
          // specification status (e.g. WD, LCWD, NOTE, etc.). If in doubt use ED.
          specStatus:           "ED",
          
          // the specification's short name, as in http://www.w3.org/TR/short-name/
          shortName:            "ldp-primer",
          // TODO: Confirm short name

          // if your specification has a subtitle that goes below the main
          // formal title, define it here
          // subtitle   :  "an excellent document",

          // if you wish the publication date to be other than today, set this
          // publishDate:  "2009-08-06",

          // if the specification's copyright date is a range of years, specify
          // the start date here:
          // copyrightStart: "2005"

          // if there is a previously published draft, uncomment this and set its YYYY-MM-DD date
          // and its maturity status
          //previousPublishDate:  "2013-03-07",
          //previousMaturity:  	"FPWD",
          //previousURI: 			"http://www.w3.org/TR/2013/WD-ldp-20130307/",

          // if there a publicly available Editor's Draft, this is the link
          //edDraftURI:           "http://www.w3.org/2012/ldp/hg/ldp.html",

          // if this is a LCWD, uncomment and set the end of its review period
          // lcEnd: "2009-08-05",

          // if you want to have extra CSS, append them to this list
          // it is recommended that the respec.css stylesheet be kept
          //extraCSS:             ["https://dvcs.w3.org/hg/ldpwg/css/respec.css"],

          // editors, add as many as you like
          // only "name" is required
          editors:  [
              { name: "Nandana Mihindukulasooriya", 
              	url: "http://mayor2.dia.fi.upm.es/oeg-upm/index.php/en/universitystaff/290-nandana",
                company: "Ontology Engineering Group, Universidad Politécnica de Madrid", 
                companyURL: "http://www.oeg-upm.net/"},
              { name: "Roger Menday", 
              	url: "#",
                company: "Fujitsu Limited", 
                companyURL: "#" },
          ],

          // authors, add as many as you like. 
          // This is optional, uncomment if you have authors as well as editors.
          // only "name" is required. Same format as editors.

          //authors:  [
          //    { name: "Your Name", url: "http://example.org/",
          //      company: "Your Company", companyURL: "http://example.com/" },
          //],
          
          // name of the WG
          wg:           "Linked Data Platform Working Group",
          
          // URI of the public WG page
          wgURI:        "http://www.w3.org/2012/ldp",
          
          // name (without the @w3c.org) of the public mailing to which comments are due
          wgPublicList: "public-ldp-wg",
          
          // URI of the patent status for this WG, for Rec-track documents
          // !!!! IMPORTANT !!!!
          // This is important for Rec-track documents, do not copy a patent URI from a random
          // document unless you know what you're doing. If in doubt ask your friendly neighbourhood
          // Team Contact.
          wgPatentURI:  "http://www.w3.org/2004/01/pp-impl/55082/status",
          doRDFa: "1.1",
      };
    </script>
  </head>
  <body>
    
    <section id='abstract'>
      This primer provides an introduction to Linked Data Platform (LDP), including the basic concepts 
      of LDP including Linked Data Platform Resource (LDPR) and Linked Data Platform Container (LDPC) 
      and their affordances, and a running example showing how an LDP client can interact with a LDP server 
      in the context of read-write Linked Data application i.e. how to HTTP for accessing, updating, 
      creating and deleting resources from servers that expose their resources as Linked Data.
    </section>
    
    <section id="intro-section">
    <h1><a id="Introduction">Introduction</a></h1>
    <p>A bit about Linked Data, current state, and the need for a Linked Data Platform (Read/Write LD) etc.
A bit about generic LDP servers and LDP servers that represent business applications. That is bit confusing for most of the people.
from test cases, Generic vs domain-specific servers
There will be two types of systems implementing the LDP specification:
Generic RDF storage systems that allow interacting with their resources by means of the LDP specification. 
These servers do not impose any restriction on LDPRs. Systems exposing their data using the LDP specification. These systems impose restrictions on LDPRs since they have an underlying business logic and data model. In order to cover both types of systems, we do not provide concrete input data in the test suite. It is up to the evaluator to define concrete input data for a certain system. Evaluators must include these input data along with the results when reporting the results of a certain system.</p>
    </section>
    
    <section id="org-section">
	<h1 id="orgnization">Organization of this Document</h1>
    	
	<p>This document is organized as follows:</p>
	<ul>	
	
	
	</ul>

    <h2 id="conventions">Conventions Used in This Document</h2>

	<p>Sample resource representations are provided in <code>text/turtle</code>
		format [[TURTLE]].</p>
	<p>Commonly used namespace prefixes:</p>
	<pre style="word-wrap: break-word; white-space: pre-wrap;">	@prefix dcterms: &lt;http://purl.org/dc/terms/&gt;.
	@prefix rdf:     &lt;http://www.w3.org/1999/02/22-rdf-syntax-ns#&gt;.
	@prefix rdfs:    &lt;http://www.w3.org/2000/01/rdf-schema#&gt;.
	@prefix ldp:     &lt;http://www.w3.org/ns/ldp#&gt;.
	@prefix xsd:     &lt;http://www.w3.org/2001/XMLSchema#&gt;.</pre>

    </section>
    
	<section id="examples">
	<h1>Examples</h1>
	
	<p>
	This section provides a set of examples to show the Linked Data Platform interactions. Note that we do not intend these examples to be representative of the manner LDP should be used, or as a canonical example of good modeling with LDP. Instead, we intend it to be a rather simple exhibition of various features of Linked Data Platform. <br/><br/>
    The examples in this section will revolve around a very simple Bug Tracker application. Bug Tracker application records the bugs of several products. The Bug Tracker allows reporting, updating and deleting bugs and products.
	We can make the Bug Tracker application a LDP application by mapping the Bug Tracker data model to LDP data model and mapping the Bug Tracker interactions to LDP interactions. We can map Bug Tracker to a LDPC that contains a set of products, Product to a LDPC that contains a set of bugs, and a Bug to a LDPR.
	</p>
	
	<table class="simple">
		<thead>
			<th>Path</th>
			<th>Method</th>
			<th>Description</th>
		</thead>
		<tbody>
			<tr>
				<td>/app/{product-id}</td>
				<td>GET</td>
				<td>Lists the bugs of a product.</td>		
			</tr>
			<tr>
				<td>/app/{product-id}/{bug-id}</td>
				<td>GET</td>
				<td>Provides the information about the bug.</td>		
			</tr>
			<tr>
				<td>/app/{product-id}</td>
				<td>POST</td>
				<td>TODO</td>		
			</tr>
			<tr>
				<td>/app/{product-id}</td>
				<td>PUT</td>
				<td>TODO</td>		
			</tr>
			<tr>
				<td>/app/{product-id}</td>
				<td>DELETE</td>
				<td>TODO</td>		
			</tr>
		</tbody>
		
		
	</table>
	
	<section id="simple-ex">
	<h2 >Simple scenarios</h2>
	
	<h3 id="ProductLookup">Lookup a Product</h3>
	<p>One of the main use cases of the bug tracker is to list of the bugs of a given product. If one has the url of the product, they can look it up to get more information about the product including the bugs it contain.</p>
	
	<table>
		<tr>
			<td><img src="product_lookup.png" /></td>
			<td>
				<p>The client request a GET with the URI of a known Product resource.</p>
<pre class="example">GET /app/product1 HTTP/1.1
Host: example.org
Accept: text/turtle 
</pre>
				<p>If the resource is available, the server responds with the representation of the resource.</p>
<pre class="example">
HTTP/1.1 200 OK 
Content-Type: text/turtle
ETag: W/&quot;123456789&quot;

 &lt;/app/product1&gt; a bt:Product, ldp:Container;
      ldp:membershipPredicate bt:hasbug ;
      dcterms:title &quot;Product 1&quot; ;
      bt:hasbug &lt;/app/product1/bug3&gt; ;
      bt:hasbug &lt;/app/product1/bug4&gt; .
</pre>				
			</td>
		</tr>
	</table>
	
	<h3 id="BugLookup">Lookup a Bug</h3>
	<p>Looking up a bug is similar to looking up a product. </p>
	
	<table>
		<tr>
			<td><img src="product_lookup.png" /></td>
			<td>
				<p>Based on links in the representation of the Product, the client uses GET to navigate to a known Bug resource.</p>
<pre class="example">GET /app/product1/bug3 HTTP/1.1
Host: example.org
Accept: text/turtle 
</pre>
				<p>The server responds with the representation of the bug.</p>
<pre class="example">
HTTP/1.1 200 OK 
 Content-Type: text/turtle
 ETag: W/&quot;123456789&quot;

 &lt;/app/product1/bug3&gt; a bt:Bug;
      dcterms:title &quot;Product A crashes when shutting down.&quot;;
      dcterms:creator &lt;/app/users/johndoe&gt;;
      dcterms:created &quot;2013-05-05T10:00&quot;^^xsd:dateTime
      bt:isInState &quot;New&quot; . 
</pre>				
			</td>
		</tr>
	</table>
	
	
	</section>
	
	<section id="basic-ex">	
	<h2>Basic scenarios</h2>
	</section>
	
	<section id="advanced-ex">	
	<h2>Advanced scenarios</h2>
	</section>
	
	</section>
	
	
	<section>
	<h2 id="ldpc">LDP Implementations</h2>
	A list of implementations that plan to be LDP compliant is available in the LDP Implementations wiki page.
LDP Implementation report provides the coverage of the specification by each LDP implementation.
	</section>
	
    
  
  </body>
</html>
\ No newline at end of file
Binary file ldp-primer/product_lookup.png has changed