added naming conventions section, updated status to 'ED', and misc. updates to a note comment.
--- 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 @@
<prov:elem1 />
<prov:elem2 />
...
- <prov:attr1>val1</prov:attr1>
- <prov:attr2>val2</prov:attr2>
+ <ex:attr1>val1</ex:attr1>
+ <ex:attr2>val2</ex:attr2>
...
</prov:thing>
</pre>
@@ -339,30 +329,48 @@
<p>which is transformed to:</p>
-<div class="codeexample">
-<prov:wasDerivedFrom><br/>
- <prov:generatedEntity prov:ref="a"/><br/>
- <prov:usedEntity prov:ref="b"/><br/>
- <prov:type xsi:type="xsd:QName">prov:Quotation</prov:type><br/>
+<pre class="codeexample">
+<prov:wasDerivedFrom>
+ <prov:generatedEntity prov:ref="a"/>
+ <prov:usedEntity prov:ref="b"/>
+ <prov:type xsi:type="xsd:QName">prov:Quotation</prov:type>
</prov:wasDerivedFrom>
-</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">
-<prov:Quotation><br/>
- <prov:generatedEntity prov:ref="a"/><br/>
- <prov:usedEntity prov:ref="b"/><br/>
-</prov:Quotation>
-</div>
+<p>Additions to the schema:</p>
+<pre class="codeexample">
+ <xs:element name="wasQuotedFrom" type="prov:Quotation"/>
+
+ ...
+
+ <xs:complexType name="Quotation">
+ <xs:complexContent>
+ <xs:extension base="prov:Derivation"/>
+ </xs:complexContent>
+ </xs:complexType>
+</pre>
+<p>New serialization:</p>
+<pre class="codeexample">
+<prov:wasQuotedFrom>
+ <prov:generatedEntity prov:ref="a"/>
+ <prov:usedEntity prov:ref="b"/>
+</prov:wasQuotedFrom>
+</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">