From 54e6941282ec06d306fdb1da2392044a5a73b13c Mon Sep 17 00:00:00 2001
From: rjy7 <rjy7@440791e1-c2bf-4c1e-ad7c-caf3f8b0ebe8>
Date: Wed, 5 Jan 2011 20:05:28 +0000
Subject: [PATCH] Clean up list view config documentation.

---
 doc/list_view_configuration_guidelines.txt    | 12 ++++++-----
 .../listViewConfig-default-collated.xml       | 20 ++-----------------
 .../listViewConfig-default-uncollated.xml     | 20 ++-----------------
 3 files changed, 11 insertions(+), 41 deletions(-)

diff --git a/doc/list_view_configuration_guidelines.txt b/doc/list_view_configuration_guidelines.txt
index 84cc3e320..df2099db2 100644
--- a/doc/list_view_configuration_guidelines.txt
+++ b/doc/list_view_configuration_guidelines.txt
@@ -15,7 +15,8 @@ Optional elements
 ----------------- 
     
 - postprocessor: a Java class that postprocesses the data retrieved from the query before
-                 sending it to the template
+                 sending it to the template. If no postprocessor is specified, the default
+                 postprocessor will be invoked.
 
 
 ------------------
@@ -27,12 +28,13 @@ the same individual is retrieved more than once, if there are multiple solutions
 other assertions, but DISTINCT provides a start at uniqueness.
       
 - The WHERE clause must contain a statement ?subject ?property ?object, with the variables
-?subject and ?property named as such. The object can be given any name, but it must be 
+?subject and ?property named as such. For a default list view, the ?object variable must
+also be named as such. For a custom list view, the object 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.
       
-- It is generally necessary to provide for a missing linked individual, due to incomplete data.
-Make sure the query does the following:
+- In a custom list view, it is generally necessary to provide for a missing linked individual, 
+due to the possibility of incomplete data. Make sure the query does the following:
     - Enclose the clause for the linked individual in an OPTIONAL block. 
     - Select the object's localname using the ARQ localname function, so that the template can 
       display the local name in the absence of the linked individual. Alternatively, this can be 
@@ -43,7 +45,7 @@ no requirement about which assertions are in the same graph is imposed (unless t
 in a specific case).
       
 - For collated properties: 
-    - Include a ?subclass variable, named as such, in the SELECT claus. If the ?subclass variable
+    - Include a ?subclass variable, named as such, in the SELECT clause. If the ?subclass variable
       is missing, the property will be displayed without collation.
     - ?subclass must be the first term in the ORDER BY clause
     - Include the following in the WHERE clause, substituting in the relevant variables for
diff --git a/webapp/web/config/listViewConfig-default-collated.xml b/webapp/web/config/listViewConfig-default-collated.xml
index fb3c446d2..ace147ef2 100644
--- a/webapp/web/config/listViewConfig-default-collated.xml
+++ b/webapp/web/config/listViewConfig-default-collated.xml
@@ -1,25 +1,9 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!-- $This file is distributed under the terms of the license in /doc/license.txt$ -->
 
-<!-- 
-    Default list view config file for collated object properties 
-
-    Required elements: 
-        - query: the sparql query used to retrieve the data
-        - template: the name of the template used to display a single property statement
+<!-- Default list view config file for collated object properties 
     
-    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 ?object, with the variables
-          ?subject and ?property named as such. The object 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.
-        - Each assertion or set of optional assertions must reference a different graph variable, so that
-          we do not impose a requirement about which assertions are in the same graph.           
--->
+     See guidelines in vitro/doc/list_view_configuration_guidelines.txt --> 
 
 <list-view-config>
     <query>    
diff --git a/webapp/web/config/listViewConfig-default-uncollated.xml b/webapp/web/config/listViewConfig-default-uncollated.xml
index c04fbd9c3..e9c5ff27d 100644
--- a/webapp/web/config/listViewConfig-default-uncollated.xml
+++ b/webapp/web/config/listViewConfig-default-uncollated.xml
@@ -1,25 +1,9 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!-- $This file is distributed under the terms of the license in /doc/license.txt$ -->
 
-<!-- 
-    Default list view config file for uncollated object properties 
+<!-- Default list view config file for uncollated object properties 
     
-    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 ?object, with the variables
-          ?subject and ?property named as such. The object 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.
-        - Each assertion or set of optional assertions must reference a different graph variable, so that
-          we do not impose a requirement about which assertions are in the same graph.           
--->
+     See guidelines in vitro/doc/list_view_configuration_guidelines.txt -->
 
 <list-view-config>
     <query>