added prov:Document section and made updates to Media Type section based on IETF feedback
authorStephan Zednik <zednis@rpi.edu>
Wed, 27 Feb 2013 01:53:19 -0700
changeset 5761 12618dbee2a3
parent 5760 25eb1149862f
child 5762 7b6bb90245d7
added prov:Document section and made updates to Media Type section based on IETF feedback
xml/prov-xml.html
--- a/xml/prov-xml.html	Tue Feb 26 18:42:44 2013 +0000
+++ b/xml/prov-xml.html	Wed Feb 27 01:53:19 2013 -0700
@@ -2131,6 +2131,48 @@
 
 </section> <!-- end further-elements -->
 
+<section id="structural-elements">
+<h3>Structural Elements of PROV-XML</h3>
+
+<section id="term-Document">
+<h4>Document</h4>
+<p>The root element of all PROV-XML documents is <code>prov:document</code> which has type <code>prov:Document</code>.</p>
+<p>Similar to a <code>prov:BundleConstructor</code>, the <code>prov:Document</code> complexType is used to define a set of provenance statements.</p> 
+<p>Unlike the <code>prov:BundleConstructor</code>, a <code>prov:Document</code>
+<ul>
+<li>may contain <code>prov:bundle</code> elements (but not other <code>prov:document</code> elements)</li>
+<li>does not support the prov:id attribute.</li>
+</ul>
+</p>
+<pre class="schema-type">
+&lt;xs:complexType name="Document"&gt;
+  &lt;xs:sequence maxOccurs="unbounded"&gt;
+    &lt;xs:group ref="prov:documentElements" minOccurs="0"/&gt;
+    &lt;xs:element name="bundleContent" type="prov:BundleConstructor" minOccurs="0"/&gt;
+    &lt;xs:any namespace="##other" processContents="lax" minOccurs="0" /&gt;
+  &lt;/xs:sequence&gt;
+&lt;/xs:complexType&gt;
+</pre>
+
+<p>The element <code>prov:document</code> may only be used as the root element of a a PROV-XML document.</p>
+<pre class="schema-element" element="prov:document" schemaType="prov:Document" ignore>
+&lt;xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="document" type="prov:Document"/&gt;
+</pre>
+<pre class="example" title="prov:document">
+<b>&lt;prov:document
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+    xmlns:prov="http://www.w3.org/ns/prov#"
+    xmlns:ex="http://example.com/ns/ex#"&gt;</b>
+
+  &lt;!-- prov statements go here --&gt;
+
+<b>&lt;/prov:document&gt;</b>
+</pre>
+</section> <!-- end term-Document-->
+
+</section> <!-- end structural-elements -->
+
 </section> <!-- end schema-components -->
 
 
@@ -2168,9 +2210,9 @@
 	<dt>Required parameters:</dt>
 	<dd>none</dd>
 	<dt>Optional parameters:</dt>
-	<dd>charset - this parameter may be required when transferring non-ASCII data across some protocols.</dd>
+	<dd>Same as charset parameter of application/xml as specified in RFC3023 (Section 3.2).</dd>
 	<dt>Encoding considerations:</dt>
-	<dd>The syntax of PROV-XML is expressed over code points in Unicode [[!UNICODE]]</dd>
+	<dd>Same as encoding considerations of application/xml as specified in RFC 3023 (Section 3.2).</dd>
 	<dt>Security considerations:</dt>
 	<dd>PROV-XML is an XML language for describing the provenance of things; applications may evaluate given data to dereference URIs, invoking the security considerations of the scheme for that URI. Note in particular, the privacy issues in [[!RFC3023]] section 10 for HTTP URIs. Data obtained from an inaccurate or malicious data source may lead to inaccurate or misleading conclusions, as well as the dereferencing of unintended URIs. Care must be taken to align the trust in consulted resources with the sensitivity of the intended use of the data.</dd>
 	<dd>PROV-XML can express data which is presented to the user, for example, by means of label attributes. Application rendering strings retrieved from untrusted PROV-N documents must ensure that malignant strings may not be used to mislead the reader. The security considerations in the media type registration for XML ([[!RFC3023]] section 10) provide additional guidance around the expression of arbitrary data and markup.</dd>
@@ -2182,28 +2224,30 @@
 	<dt>Interoperability considerations:</dt>
 	<dd>There are no known interoperability issues.</dd>
 	<dt>Published specification:</dt>
-	<dd>PROV-XML: The PROV XML Schema, Hua, Tilmes, Zednik (eds), Moreau <a href="http://www.w3.org/TR/prov-xml/">http://www.w3.org/TR/prov-xml/</a>, 2012.</dd>
+	<dd>PROV-XML: The PROV XML Schema, Hua, Tilmes, Zednik (eds), Moreau <a href="http://www.w3.org/TR/prov-xml/">http://www.w3.org/TR/prov-xml/</a>, 2013.</dd>
 	<dt>Applications which use this media type:</dt>
 	<dd>It may be used by any application for publishing provenance information.  This format is designed to be an XML form of provenance.</dd>
+	<dt>Fragment identifier considerations:</dt>
+	<dd>N/A</dd>
 	<dt>Additional Information:</dt>
 	<span style="text-indent:2em;">
 	<dt>Magic number(s):</dt>
 	<dd>PROV-XML documents are XML documents and thus may have initial strings similar to any XML document.</dd>
 	<dt>File extension(s):</dt>
 	<dd>.provx</dd>
-	<dt>Base URI:</dt>
-	<dd>As in XML.</dd>
 	<dt>Macintosh file type code(s):</dt>
 	<dd>&quot;TEXT&quot;</dd>
 	</span>
-	<dt>Person &amp; email address to contact for further information</dt>
+	<dt>Person &amp; email address to contact for further information:</dt>
 	<dd>Ivan Herman, [email protected]</dd>
 	<dt>Intended usage:</dt>
 	<dd>COMMON</dd>
 	<dt>Restrictions on usage:</dt>
-	<dd>None</dd>
-	<dt>Author/Change controller:</dt>
-	<dd>The PROV-XML specification is the product of the World Wide Web Consortium's Provenance Working Group. The W3C has change control over this specification.</dd>
+	<dd>none</dd>
+	<dt>Author:</dt>
+	<dd>The PROV-XML specification is the product of the World Wide Web Consortium's Provenance Working Group.</dd>
+	<dt>Change controller:</dt>
+	<dd>The W3C, and the W3C Provenance Working Group, have change control over this specification.</dd>
 </dl>
 
 </section> <!-- end media-type -->
@@ -2668,6 +2712,7 @@
     &lt;/xs:sequence&gt;
   &lt;/xs:group&gt;
 
+  &lt;xs:element name="document" type="prov:Document" /&gt;
   &lt;xs:complexType name="Document"&gt;
     &lt;xs:sequence maxOccurs="unbounded"&gt;
       &lt;xs:group ref="prov:documentElements" minOccurs="0"/&gt;