updates to Salami Slice section
authorStephan Zednik <zednis@rpi.edu>
Thu, 13 Dec 2012 11:01:42 -0700
changeset 5349 d43359cada3a
parent 5348 1144785c6a61
child 5350 4bbf3c66312e
updates to Salami Slice section
xml/prov-xml.html
--- a/xml/prov-xml.html	Thu Dec 13 10:47:00 2012 -0700
+++ b/xml/prov-xml.html	Thu Dec 13 11:01:42 2012 -0700
@@ -253,13 +253,8 @@
 
 <section id="design-pattern">
 <h3><i>Salami Slice</i> Design Pattern</h3>
-
-<p>The general design pattern for the XML schema has been
-called <i>Salami Slice Design</i> (cite?).  With this design, the
-individual components are each defined at the top level as separate
-elements with distinct types.  This allows the types to be easily
-reusable for domain specific extensions.
-</p>
+<p>The general design pattern for the XML schema has been called <i>Salami Slice Design</i> (cite?).  With this design, the individual components are each defined at the top level as separate elements with distinct types.  This allows the types to be easily reusable for domain specific extensions.</p>
+<p>The <code>prov:document</code> element has been defined to act as a convenient root element for a PROV-XML document, but it's use as the root element is not required.  The schema follows the Salami Slice pattern to ensure PROV XML elements can be integrated with mixed-schema XML documents which require a different document root.</p>
 </section> <!-- end design-pattern -->
 
 <section id="elements-vs-attributes">
@@ -372,8 +367,7 @@
 <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>
+</section> <!-- end naming-conventions -->
 
 </section> <!-- end schema-design -->