provo html section narratives update from lodspk
authorTim L <lebot@rpi.edu>
Mon, 02 Apr 2012 08:56:27 -0400
changeset 2198 471cf17a0ebd
parent 2197 c5f4add94d48
child 2199 8e3421adf993
provo html section narratives update from lodspk
ontology/prov-o-html-sections/description-expanded-terms.inc.html
ontology/prov-o-html-sections/description-qualified-terms.inc.html
ontology/prov-o-html-sections/description-starting-points.inc.html
--- a/ontology/prov-o-html-sections/description-expanded-terms.inc.html	Mon Apr 02 13:51:47 2012 +0100
+++ b/ontology/prov-o-html-sections/description-expanded-terms.inc.html	Mon Apr 02 08:56:27 2012 -0400
@@ -1,9 +1,24 @@
      <section id="description-expanded-terms">
 	  	<h3>Expanded Terms</h3>
-        <p>        
-This section presents the rest of classes and properties textually without using a diagram. We may use some examples in English. 
+        <!-- *****Initial comments*****
+This section presents the rest of classes and properties textually 
+without using a diagram. We may use some examples in English. 
 The classes and properties covered in this section are: 
-Note, hasAnnotation, tracedTo, wasRevisionOf, hadOriginalSource, wasQuotatedFrom, hadQuotatedAgent, hadQuoterAgent, wasSummaryOf, alternateOf, terms related to Collection? Bundle? Role?? , hadRole, Location??, hadLocation?, wasStartedByActivity?? specializationOf?
+Note, hasAnnotation, tracedTo, wasRevisionOf, hadOriginalSource, 
+wasQuotatedFrom, hadQuotatedAgent, hadQuoterAgent, wasSummaryOf, 
+alternateOf, terms related to Collection? Bundle? Role?? , hadRole, 
+Location??, hadLocation?, wasStartedByActivity?? specializationOf?
+DanielG: I'd say that hadRole, hadLocation, collection, bundle, location, alternate, specialization should not be here.
+*****End comments*********
+       -->
 
-		</p>
-	  </section> < !-- Expaned Terms subsection -->
+        <p>This section defines additional terms to describe provenance at a greater level of specificity (for example, prov:Person or prov:SoftwareAgent in place of prov:Agent) and with more details (for example, prov:Location to describe address of a prov:Organization). In addition, the new terms in this section facilitate modeling of common provenance assertions related to web resources. For example, different version of a web page can be represented using the prov:wasRevisionOf property and the prov:hadOriginalSource property can be used to reference the original source of information used in a web resource. Many of the properties introduced in this section are also "shortcut" notations for combining the PROV-O terms introduced in Section 3.1 "Starting Point Terms", which make it easier for provenance annotation of a resource. 
+        </p>
+
+        <div class="exampleOuter">
+           <p>We illustrate the use of the new terms using an example below </p> 
+           <pre class="example">
+              {% include "includes/eg-22-blog-original-source.ttl" %}
+           </pre>
+        </div>
+	  </section>
--- a/ontology/prov-o-html-sections/description-qualified-terms.inc.html	Mon Apr 02 13:51:47 2012 +0100
+++ b/ontology/prov-o-html-sections/description-qualified-terms.inc.html	Mon Apr 02 08:56:27 2012 -0400
@@ -1,83 +1,66 @@
      <section id="description-qualified-terms">
-	  	<h3>Qualified Terms</h3>
-        <p>        
-This section shows how qualified relationships in prov-dm are encoded in provo. We need two diagrams: one to show the hierarchical relationship between involvement classes, and another to using Association as an exemplar to illustrate the general pattern to qualify a binary relationship. 
-   </p>
+       <h3>Qualified Terms</h3>
+       <p>The classes and properties in the Qualified terms category are for users who wish to provide additional details about the relationships between entities, activities, and agents. The terms in this category are the result of applying the <strong>Qualification Pattern</strong> to the simple relations available in the <a href="#prov-starting-point-owl-properties-at-a-glance">Starting Point</a> and <a href="#prov-expanded-owl-properties-at-a-glance">Expanded</a> categories.
+      </p>
+      <p>For example, Figure 2 illustrates the classes and properties needed to fulfill the qualification pattern for the <a href="#used">prov:used</a> and <a href="#wasAssociatedWith">prov:wasAssociatedWith</a> properties. While prov:qualifiedUsage, prov:Usage, and prov:entity are needed to qualify prov:used relations, prov:qualifiedAssociation, prov:Association, and prov:agent are needed to qualify prov:wasAssociatedWith relations. This pattern applies to the twelve other relations that can be qualified.
+      </p>
+      <p>In the example, the prov:qualifiedUsage property parallels the prov:used property, and references an instance of prov:Usage that provides attributes of the prov:used relation between the Activity and Entity. The prov:entity property is used to cite the Entity that was used by the Activity. In this case, the time that the Activity used the Entity is provided using the prov:atTime property and a literal xsd:dateTime value.
+      </p>
+      <p>Similarly, the prov:qualifiedAssociation property parallels the prov:wasAssociatedWith property, and references an instance of prov:Association that provides attributes of the prov:wasAssociatedWith relation between the Activity and Agent. The prov:agent property is used to cite the Agent that was involved in the Activity. In this case, the plan that the Agent used is provided using the prov:hadPlan property and an instance of prov:Plan.
+      </p>
 
-      <div style="text-align: center;">
+       <div style="text-align: center;">
          <figure>
-                 <img src="prov-o-diagrams/involvements.png"
-                style="width: 70%; min-width: 25em; max-width: 60em" 
-                alt="A hierarchical illustration of simple involvements"/>
-            <figcaption>Figure 2. A hierarchical illustration of simple involvements</figcaption>
+            <img src="prov-o-diagrams/Qualified-Association.png"
+                 style="width: 50%; min-width: 25em; max-width: 60em" 
+                 alt="Express association between an activity and an agent using a binary relationship and an alternatie qualified relationship"/>
+            <figcaption>Figure 2. An illustration of the qualification pattern applied to the Starting Point properties <a href="#used">prov:used</a> and <a href="#wasAssociatedWith">prov:wasAssociatedWith</a>.</figcaption>
          </figure>
-      </div>
+       </div>
 
+      <p>The following two examples show the result of applying the Usage and Association patterns to the chart making example from <a href=#description-starting-point-terms>Section 3.1</a>.
+      </p>
+       <div class="exampleOuter">
+          <div><b>Qualified Usage</b></div>
+            <p>The prov:qualifiedUsage property parallels the prov:used property to provide an additional description to ex:illustrationActivity. The instance of prov:Usage cites the data used (ex:aggregatedByRegions) and the time the activity used it (2011-07-14T03:03:03Z).
+          </p>
+             <pre class="example">{% include "includes/eg16-journalism-qualified-usage.ttl" %}</pre>
+       </div>
+
+        <div class="exampleOuter">
+           <div><b>Qualified Association</b></div>
+            <p>The prov:qualifiedAssociation property parallels the prov:wasAssociatedWith property to provide an additional description to ex:illustrationActivity. The instance of prov:Association cites the agent (ex:derek) that followed the instructions (ex:tutorial_blog).
+            </p>
+              <pre class="example">{% include "includes/eg16-journalism-qualified-association.ttl" %}</pre>
+       </div>
+
+      <p>Usage and Association (described above) are accompanied by six other qualifications of Starting Point relations. The following table lists the simple relations that can be qualified, along with the qualification property, qualification class, and the property used to indicate the object of the qualified relation.
+      </p>
       <div style="text-align: center;">
-         <figure>
-                 <img src="prov-o-diagrams/Qualified-Association.png"
-                style="width: 70%; min-width: 25em; max-width: 60em" 
-                alt="Express association between an activity and an agent using a binary relationship and an alternatie qualified relationship"/>
-            <figcaption>Figure 3. Express association between an activity and an agent using a binary relationship and an alternatie qualified relationship</figcaption>
-         </figure>
+         {% include "includes/qualifed-forms-starting-point.html" %}
       </div>
 
-
-         <p>
-         We have in the current provo HTML document a diagram about qualified involvement in Section 8 “Overview of Qualified Involvement”, but we don’t think that such a diagram is great. We need to illustrate the hierarchy of involvements and some, not necessarily all, the associated object properties. The focus in the diagram will be on the elements of prov-dm that are illustrates in the previous overview sub-section. 
-         The diagram can show the following kinds on involvements, and shows some (not necessarily all) the properties that link them together, e.g., entity, activity, agent, qualified. Note that, not all the sub-classes of involvements are included here; they will appear in section 3.3 because they are additional terms in prov-o.
-         Involvement, EntityInvolvement, ActicityInvolvement, AgentInvolvement, Derivation, Usage, Generation, Association (End, Start), Responsibility, Attribution,
-         </p>
+      <p>Six relations from the Expanded category can also be qualified. The following table lists the simple relations that can be qualified, along with the qualification property, qualification class, and the property used to indicate the object of the qualified relation.
+      </p>
+      <div style="text-align: center;">
+         {% include "includes/qualifed-forms-expanded.html" %}
+      </div>
 
-         <p>
-         Turtle + Explanation. We do not to cover all the kinds of involvement and properties in the example. We only show how Derivation, Usage, Generation and Association can be expressed using this reification pattern. If need be, examples of other types of involvement should be given in section 4, where they are defined.  For the qualified relationships we provide the following example files:
-         </p>
+       <p>This section finishes with two more examples of qualification as applied to the chart making example from <a href=#description-starting-point-terms>Section 3.1</a>.
+       </p>
 
-        <div class="anexample">
-           <div><b>Qualified DerivationExample</b></div>
-            <p>
-eg16-journalism-derivation.ttl, to show how additional information about derivation can be expressed, such as when it all happened.
+        <div class="exampleOuter">
+           <div><b>Qualified Generation</b></div>
+            <p>The prov:qualifiedGeneration property parallels the prov:wasGeneratedBy property to provide an additional description to ex:chart1. The instance of prov:Generation cites the time (2011-07-14T15:52:14Z) that the activity (ex:illustrationActivity) generated the chart (ex:chart1).
             </p>
-           <div class="exampleOuter">
-              <pre class="example">{% include "includes/eg16-journalism-qualified-derivation.ttl" %}</pre>
-           </div>
+              <pre class="example">{% include "includes/eg16-journalism-qualified-generation.ttl" %}</pre>
         </div>
 
-        <div class="anexample">
-           <div><b>Qualified Generation Example</b></div>
-            <p>
- eg16-journalism-generation.ttl, to show how additional information about generation can be expressed, such as when it all happened.
+        <div class="exampleOuter">
+           <div><b>Qualified Derivation</b></div>
+            <p>The prov:qualifiedDerivation property parallels the prov:wasDerivedFrom property to provide an additional description to ex:chart1. The instance of prov:Derivation cites the activity (ex:illustrationActivity) and the Usages and Generations that the activity conduced to create the chart (ex:chart1).
             </p>
-           <div class="exampleOuter">
-              <pre class="example">{% include "includes/eg16-journalism-qualified-generation.ttl" %}</pre>
-           </div>
+              <pre class="example">{% include "includes/eg16-journalism-qualified-derivation.ttl" %}</pre>
         </div>
 
-        <div class="anexample">
-           <div><b>Qualified Usage Example</b></div>
-            <p>
-eg16-journalism-usage.ttl, to show how additional information about usage can be expressed, such as when it all happened.
-            </p>
-           <div class="exampleOuter">
-              <pre class="example">{% include "includes/eg16-journalism-qualified-usage.ttl" %}</pre>
-           </div>
-        </div>
-
-        <div class="anexample">
-           <div><b>Qualified Association Example</b></div>
-            <p>
- eg16-journalism-association.ttl, to show how we can express plan or recipe used in an activity by an agent
-            </p>
-           <div class="exampleOuter">
-              <pre class="example">{% include "includes/eg16-journalism-qualified-association.ttl" %}</pre>
-           </div>
-        </div>
-
-         <div style="text-align: center;">
-            {% include "includes/qualifed-forms-starting-point.html" %}
-         </div>
-
-         <div style="text-align: center;">
-            {% include "includes/qualifed-forms-expanded.html" %}
-         </div>
 	  </section>
--- a/ontology/prov-o-html-sections/description-starting-points.inc.html	Mon Apr 02 13:51:47 2012 +0100
+++ b/ontology/prov-o-html-sections/description-starting-points.inc.html	Mon Apr 02 08:56:27 2012 -0400
@@ -1,38 +1,27 @@
-     <section id="description-starting-points">
+     <section id="description-starting-point-terms">
 	  	<h3>Starting Point Terms</h3>
-       <p>
-      The classes and properties that constitute the starting-point terms of provo are illustrated in Figure 1. 
+       <p>The Starting Point category is a small collection of classes and properties that can be used to create simple, initial provenance descriptions.
+         Three classes provide a basis for the rest of PROV-O:  
+         <ul>
+            <li> <a href="#Entity">prov:Entity</a>: An entity is a thing one wants to provide provenance for. Things can be physical, digital, conceptual, or otherwise.
+            </li>
+            <li> <a href="#Activity">prov:Activity</a>: An activity is something that occurs over a period of time and acts upon or with entities. This action can take multiple forms: consuming, processing, transforming, modifying, relocating, using, generating, etc.
+            </li>
+            <li> <a href="#Agent">prov:Agent</a>: An agent bears some form of responsibility for an activity taking place. Further, an agent may act on behalf of another agent when involved with an activity.
+            </li>
+         </ul> 
+      These three classes and the properties that relate them are illustrated in the following figure. 
       </p>
 
       <div style="text-align: center;">
          <figure>
             <img src="prov-o-diagrams/Starting-points-terms.png"
-                 style="width: 70%; min-width: 25em; max-width: 60em" 
-                 alt="provo starting-point terms"/>
-            <figcaption>Figure 1. Starting-point classes and properties in PROV-O</figcaption>
+                 style="width: 50%; min-width: 25em; max-width: 60em" 
+                 alt="PROV-O Starting Point terms"/>
+            <figcaption>Figure 1. The three Starting Point classes and the properties that relate them.</figcaption>
          </figure>
       </div>
 
-          <p>
-         There are three starting point classes in provo: Entity, Activity and Agent.  
-         </p>
-
-
-         <ul>
-         <li>
-         <a href="#Entity">prov:Entity</a>: Entities are things that one wants to provide provenance for. 
-         </li>
-         <li>
-         <a href="#Activity">prov:Activity</a>: Activities act upon Entities. An activity is 
-         characterized by a start and end time. It may use one or more entities, 
-         and may generate one or more entities.
-         </li>
-         <li>
-         <a href="#Agent">prov:Agent</a>: An agent is a kind of Entity that bears some form of responsibility for an activity 
-         taking place. The agent may act on behalf of another agent.
-         </li>
-         </ul> 
-
          <p>
          Entities are related to each other using derivation, which is used to 
          specify that the creation/existence of an entity was influenced in some 
@@ -43,7 +32,7 @@
          </p>
 
          <p>
-         Activities may depend on each other. provo distinguishes between two 
+         Activities may depend on each other. PROV-O distinguishes between two 
          kinds of dependencies which are specified using the properties 
          wasInformedBy and wasStartedBy. 
          The first is used to specify that an activity used an entity that was 
@@ -71,23 +60,10 @@
         </div>
 
 
-         <p>
-         Here is a basic example that shows how  the above starting-point terms 
-         can be used to describe provenance information specifying how some 
-         government data about crime statistics, ex:dataset1, was processed to 
-         generate a graphical chart, ex:chart1 that depicts the statistics in 
-         ex:dataset1 according to national regions.
-         </p> 
-
-        <div class="anexample">
-           <div><b>Example</b></div>
-            <p>
-Turtle + Explanation. The example does not have to illustrate all the terms. Instead, it focuses on the main ones. (see eg16-journalism-simple-without-comments.ttl). We chose this example over others because we think it is simple, intuitive. Moreover, it is used in the primer, and therefore people who read the primer before the provo HTML document, will find it easy to follow.
-
-            </p>
-           <div class="exampleOuter">
-              <pre class="example">{% include "includes/eg16-journalism-simple-without-comments.ttl" %}</pre>
-           </div>
+        <div class="exampleOuter">
+           <p>The following PROV-O describes the resources involved when creating a chart about crime statistics. The example uses only Starting Point terms and serves as a basis for elaboration that will be described in subsequent sections. In the example, Derek performs an aggregation of some government crime data, grouping by national regions that are described in a separate dataset by a civil action group.
+           </p> 
+           <pre class="example">{% include "includes/eg16-journalism-simple-without-comments.ttl" %}</pre>
         </div>
 
       <p>The example states that the agent ex:derek was associated with two