editing prov-n to realign optionals new conventions
authorPaolo Missier <pmissier@acm.org>
Wed, 09 May 2012 18:06:00 +0100
changeset 2741 d1d9362b9cf7
parent 2740 b519b33a8c6e
child 2742 b93ae20cce4e
editing prov-n to realign optionals new conventions
model/prov-n.html
--- a/model/prov-n.html	Wed May 09 11:41:25 2012 +0100
+++ b/model/prov-n.html	Wed May 09 18:06:00 2012 +0100
@@ -481,7 +481,7 @@
 </div>
 
 <p>The general rule for optionals is that, if <em>none</em> of the optionals are used in the expression, then they are simply omitted, resulting in a simpler expression as in the examples above.</p>
-However, it may be the case that only some of the optional terms are omitted. Because the position of the terms in the expression matters, an additional marker must be used to indicate that a particular term is not available. The symbol  <span class="name">-</span> is used for this purpose.
+However, it may be the case that only some of the optional terms are omitted. Because the position of the terms in the expression matters, an additional marker must be used to indicate that a particular term is not available. The symbol  <span class="name">'-'</span> is used for this purpose.
 
 <div class="anexample">
 <p>In the first expression below, all optionals are specified. However in the second, only the last one is specified, forcing the use of the marker for the missing terms. In the last, no marker is necessary because all <em>remaining</em> optionals after <span class="name">a</span> are missing.
@@ -577,7 +577,7 @@
 <pre class="codeexample">
 entity(tr:WD-prov-dm-20111215, [ prov:type="document" ])
 </pre>
-  Here <span class="name">tr:WD-prov-dm-20111215</span> is the optional entity identifier, and <span class="name">[ prov:type="document" ]</span> groups the optional attributes with their values.
+  Here <span class="name">tr:WD-prov-dm-20111215</span> is the entity identifier, and <span class="name">[ prov:type="document" ]</span> groups the optional attributes, only one in this example,  with their values.
   <pre class="codeexample">
 <!-- entity(tr:WD-prov-dm-20111215, [ prov:type="document", ex:version=2 ]) -->
 entity(tr:WD-prov-dm-20111215)
@@ -609,7 +609,7 @@
 <pre class="codeexample">
 activity(ex:a10, 2011-11-16T16:00:00, 2011-11-16T16:00:01, [prov:type="createFile"])
 </pre>
-<p>Here <span class="name">ex:a10</span> is the optional activity identifier, <span class="name">2011-11-16T16:00:00</span> and <span class="name">2011-11-16T16:00:01</span> are the optional start and end times for the activity, and <span class="name">[prov:type="createFile"]</span> are optional attributes. </p>
+<p>Here <span class="name">ex:a10</span> is the  activity identifier, <span class="name">2011-11-16T16:00:00</span> and <span class="name">2011-11-16T16:00:01</span> are the optional start and end times for the activity, and <span class="name">[prov:type="createFile"]</span> are optional attributes. </p>
 The remaining examples show cases where some of the optionals are omitted.
 <pre class="codeexample">
 activity(ex:a10)
@@ -634,11 +634,11 @@
 <span class="nonterminal">generationExpression</span>&nbsp;::=  
 <span class="name">wasGeneratedBy</span>
 <span class="name">(</span>
-<span class="optional">( <span class="nonterminal">identifier</span> | <span class="name">-</span> ) <span class="name">,</span> </span>
-<span class="nonterminal">eIdentifier</span>
+<span class="optional">( <span class="nonterminal">identifier</span> | <span class="name">-</span> ) <span class="name">;</span> </span>
+<span class="nonterminal">eIdentifier</span>(
 <span class="name">,</span>
 ( <span class="nonterminal">aIdentifier</span> | <span class="name">-</span> )
-<span class="name">,</span> ( <span class="nonterminal">time</span> | <span class="name">-</span> )
+<span class="name">,</span> ( <span class="nonterminal">time</span> | <span class="name">-</span> ))?
 <span class="nonterminal">optional-attribute-values</span>
 <span class="name">)</span><br/>
 </div>
@@ -647,19 +647,19 @@
 <div class="anexample">
 
 <pre class="codeexample">
-wasGeneratedBy(ex:g1, tr:WD-prov-dm-20111215, ex:edit1, 2011-11-16T16:00:00,  [ex:fct="save"])
+wasGeneratedBy(ex:g1; tr:WD-prov-dm-20111215, ex:edit1, 2011-11-16T16:00:00,  [ex:fct="save"])
 </pre>
 <p>  Here <span class="name">ex:g1</span> is the optional generation identifier, <span class="name">tr:WD-prov-dm-20111215</span> is the identifier of the entity being generated,
   <span class="name">ex:edit1</span> is the optional identifier of the generating activity, <span class="name">2011-11-16T16:00:00</span> is the optional generation time, and <span class="name"> [ex:fct="save"]</span> are optional attributes. </p>
 The remaining examples show cases where some of the optionals are omitted.
   
 <pre class="codeexample">
-wasGeneratedBy(tr:WD-prov-dm-20111215, ex:edit1, -)
+wasGeneratedBy(tr:WD-prov-dm-20111215, ex:edit1)
 wasGeneratedBy(tr:WD-prov-dm-20111215, ex:edit1, 2011-11-16T16:00:00)
 wasGeneratedBy(e2, a1, -, [ex:fct="save"])     
 wasGeneratedBy(e2, -, -, [ex:fct="save"])     
-wasGeneratedBy(ex:g1, tr:WD-prov-dm-20111215, ex:edit1, -)
-wasGeneratedBy(-, tr:WD-prov-dm-20111215, ex:edit1, -)
+wasGeneratedBy(ex:g1; tr:WD-prov-dm-20111215, ex:edit1)
+wasGeneratedBy(-; tr:WD-prov-dm-20111215, ex:edit1)   // here '-;' is redundant. I would omit the example
 </pre>
 </div>