From 2a7defb04c5534848e79ca0a91ccbd3460f8894b Mon Sep 17 00:00:00 2001
From: rjy7 <rjy7@43c2fc9b-1942-4403-87b2-35b4218f7473>
Date: Tue, 21 Dec 2010 13:41:11 +0000
Subject: [PATCH] NIHVIVO-1341 Added notes to list view config files on
 required and optional elements and how to structure the query. Removed
 edit-object since this can be derived from the ?subject ?property ?object
 statement in the query where clause.

---
 .../listViewConfig-authorInAuthorship.xml     | 19 +++++++++++++++++--
 .../listViewConfig-educationalTraining.xml    | 19 +++++++++++++++++--
 2 files changed, 34 insertions(+), 4 deletions(-)

diff --git a/productMods/config/listViewConfig-authorInAuthorship.xml b/productMods/config/listViewConfig-authorInAuthorship.xml
index 7c8352d0..96da0684 100644
--- a/productMods/config/listViewConfig-authorInAuthorship.xml
+++ b/productMods/config/listViewConfig-authorInAuthorship.xml
@@ -1,5 +1,22 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!-- $This file is distributed under the terms of the license in /doc/license.txt$ -->
+
+<!--
+    Required elements: 
+        - query: the sparql query used to retrieve the data
+        - template: the name of the template used to display a single property statement
+    
+    Optional elements: 
+        postprocessor: a Java class that postprocesses the data retrieved from the query before
+                       sending it to the template
+    
+    Query requirements:
+        - WHERE clause must contain a statement ?subject ?property ?objectvariable, with the variables
+          ?subject and ?property named as such. The objectvariable can be given any name, but it must be 
+          included in the SELECT terms retrieved by the query. This is the statement that will be edited 
+          from the edit links.
+-->
+
 <list-view-config>
     <query>    
         PREFIX rdfs: &lt;http://www.w3.org/2000/01/rdf-schema#&gt;   
@@ -20,7 +37,5 @@
         }  ORDER BY DESC(?dateTime)    
     </query>
     
-    <edit-object>edTraining</edit-object>
-    
     <template>propStatement-authorInAuthorship.ftl</template>
 </list-view-config>
\ No newline at end of file
diff --git a/productMods/config/listViewConfig-educationalTraining.xml b/productMods/config/listViewConfig-educationalTraining.xml
index 895bc2ef..c7c958ad 100644
--- a/productMods/config/listViewConfig-educationalTraining.xml
+++ b/productMods/config/listViewConfig-educationalTraining.xml
@@ -1,5 +1,22 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!-- $This file is distributed under the terms of the license in /doc/license.txt$ -->
+
+<!--
+    Required elements: 
+        - query: the sparql query used to retrieve the data
+        - template: the name of the template used to display a single property statement
+    
+    Optional elements: 
+        postprocessor: a Java class that postprocesses the data retrieved from the query before
+                       sending it to the template
+    
+    Query requirements:
+        - WHERE clause must contain a statement ?subject ?property ?objectvariable, with the variables
+          ?subject and ?property named as such. The objectvariable can be given any name, but it must be 
+          included in the SELECT terms retrieved by the query. This is the statement that will be edited 
+          from the edit links.
+-->
+    
 <list-view-config>
     <query>    
         PREFIX rdfs: &lt;http://www.w3.org/2000/01/rdf-schema#&gt;   
@@ -20,7 +37,5 @@
         }  ORDER BY DESC(?dateTime)    
     </query>
     
-    <edit-object>edTraining</edit-object>
-    
     <template>propStatement-educationalTraining.ftl</template>
 </list-view-config>
\ No newline at end of file