added naming conventions section, updated status to 'ED', and misc. updates to a note comment.
authorStephan Zednik <zednis@rpi.edu>
Thu, 13 Dec 2012 10:37:05 -0700
changeset 5346 5319c09a9218
parent 5345 f0b507e4e7e4
child 5347 e10318b31d7c
added naming conventions section, updated status to 'ED', and misc. updates to a note comment.
xml/prov-xml.html
--- a/xml/prov-xml.html	Thu Dec 13 17:06:29 2012 +0100
+++ b/xml/prov-xml.html	Thu Dec 13 10:37:05 2012 -0700
@@ -82,7 +82,7 @@
       };
       var respecConfig = {
           // specification status (e.g. WD, LCWD, NOTE, etc.). If in doubt use ED.
-          specStatus:           "FPWD-NOTE",
+          specStatus:           "ED",
           
           // the specification's short name, as in http://www.w3.org/TR/short-name/
           shortName:            "prov-xml",
@@ -93,7 +93,7 @@
 
  
           // if you wish the publication date to be other than today, set this
-          publishDate:  "2012-12-11",
+          //publishDate:  "2012-12-11",
  
           // if the specification's copyright date is a range of years, specify
           // the start date here:
@@ -101,13 +101,11 @@
  
           // if there is a previously published draft, uncomment this and set its YYYY-MM-DD date
           // and its maturity status
-          //previousPublishDate:  false,
-          //previousMaturity:  "WD",
+          previousPublishDate:  "2012-12-11",
+          previousMaturity:  "FPWD-NOTE",
  
           // if there a publicly available Editor's Draft, this is the link
           edDraftURI:           "http://dvcs.w3.org/hg/prov/raw-file/default/xml/prov-xml.html",
-
-		  //implementationReportURI: "http://dvcs.w3.org/hg/prov/raw-file/default/reports/prov-implementations.html",
  
           // if this is a LCWD, uncomment and set the end of its review period
           // lcEnd: "2009-08-05",
@@ -229,14 +227,6 @@
 This specification goal is to provide a succinct definition of the XML form of PROV-DM, thus, we refer the reader to the PROV-DM to provide overall justification and context to the definitions presented here.  
 </p>
 
-<!--
-<section id="structure-of-this-document"> 
-<h3>Structure of this Document</h3>
-<p><a href="#schema-components">Section 2</a> provides an overview of the PROV XML Schema elements and types</p>
-<p><a href="#prov-xml-schema">Appendix A</a> contains the full PROV-XML Schema</p>
-</section>
--->
-
 <section id="prov-namespace">
 <h3>PROV Namespace</h3>
 <p>The PROV namespace is <span class="name">http://www.w3.org/ns/prov#</span>.</p>
@@ -302,8 +292,8 @@
   &lt;prov:elem1 /&gt;
   &lt;prov:elem2 /&gt;
   ...
-  &lt;prov:attr1&gt;val1&lt;/prov:attr1&gt;
-  &lt;prov:attr2&gt;val2&lt;/prov:attr2&gt;
+  &lt;ex:attr1&gt;val1&lt;/ex:attr1&gt;
+  &lt;ex:attr2&gt;val2&lt;/ex:attr2&gt;
   ...
 &lt;/prov:thing&gt;
 </pre>
@@ -339,30 +329,48 @@
 
 <p>which is transformed to:</p>
 
-<div class="codeexample">
-&lt;prov:wasDerivedFrom&gt;<br/>
-&nbsp;&nbsp;&lt;prov:generatedEntity prov:ref="a"/&gt;<br/>
-&nbsp;&nbsp;&lt;prov:usedEntity prov:ref="b"/&gt;<br/>
-&nbsp;&nbsp;&lt;prov:type xsi:type="xsd:QName">prov:Quotation&lt;/prov:type&gt;<br/>
+<pre class="codeexample">
+&lt;prov:wasDerivedFrom&gt;
+&nbsp;&nbsp;&lt;prov:generatedEntity prov:ref="a"/&gt;
+&nbsp;&nbsp;&lt;prov:usedEntity prov:ref="b"/&gt;
+&nbsp;&nbsp;&lt;prov:type xsi:type="xsd:QName">prov:Quotation&lt;/prov:type&gt;
 &lt;/prov:wasDerivedFrom&gt;
-</div>
+</pre>
 
-<p>This proposal would replace that with an explicit "Quotation" element:
+<p>This proposal would replace that with an explicit <code>prov:wasQuotedFrom</code> element which has type <code>prov:Quotation</code>, which is an extension of <code>prov:Derivation</code>:
 </p>
-
-<div class="codeexample">
-&lt;prov:Quotation&gt;<br/>
-&nbsp;&nbsp;&lt;prov:generatedEntity prov:ref="a"/&gt;<br/>
-&nbsp;&nbsp;&lt;prov:usedEntity prov:ref="b"/&gt;<br/>
-&lt;/prov:Quotation&gt;
-</div>
+<p>Additions to the schema:</p>
+<pre class="codeexample">
+&nbsp;&lt;xs:element name="wasQuotedFrom" type="prov:Quotation"/&gt;
+  
+&nbsp;...
+  
+&nbsp;&lt;xs:complexType name="Quotation"&gt;
+&nbsp;&nbsp;&lt;xs:complexContent&gt;
+&nbsp;&nbsp;&nbsp;&lt;xs:extension base="prov:Derivation"/&gt;
+&nbsp;&nbsp;&lt;/xs:complexContent&gt;
+&nbsp;&lt;/xs:complexType&gt;
+</pre>
+<p>New serialization:</p>
+<pre class="codeexample">
+&lt;prov:wasQuotedFrom&gt;
+&nbsp;&nbsp;&lt;prov:generatedEntity prov:ref="a"/&gt;
+&nbsp;&nbsp;&lt;prov:usedEntity prov:ref="b"/&gt;
+&lt;/prov:wasQuotedFrom&gt;
+</pre>
 
 <p>Other "typed" concepts and relations would be handled similarly.
 </p>
 
 </div>
 
-</section>
+<h3>Naming Conventions</h3>
+<p>Element names are aligned with [[PROV-N]] record names (e.g. <code>prov:wasGeneratedBy</code>, <code>prov:actedOnBehalfOf</code>) and record parameter roles (e.g. <code>prov:delegate</code>, <code>prov:responsible</code> on a Delegation).  Elements are named in camelCase which also conforms with [[PROV-N]] naming conventions.</p>
+<p>ComplexType names are aligned with [[PROV-DM]] type names (e.g. <code>prov:Generation</code>, <code>prov:Delegation</code>).  ComplexTypes are named in PascalCase which conforms to [[PROV-DM]] naming conventions and differentiates complexTypes from elements in the schema.</p>
+<p>The document root in a PROV-XML serialization is expected to be <code>prov:document</code>.</p>
+
+
+</section> <!-- end schema-design -->
 
 <!-- should we instead break the schema down into complex types and elements? -->
 <section id="schema-components">