From f1f00a7660e396c4e684429ec250c89e7dcce9bd Mon Sep 17 00:00:00 2001
From: rjy7 <rjy7@43c2fc9b-1942-4403-87b2-35b4218f7473>
Date: Mon, 3 Jan 2011 16:00:42 +0000
Subject: [PATCH] Moved list view configuration guidelines out of config files
 into a text file.

---
 .../listViewConfig-authorInAuthorship.xml     | 50 +-----------------
 .../listViewConfig-educationalTraining.xml    | 51 +------------------
 ...Config-informationResourceInAuthorship.xml | 50 +-----------------
 .../list_view_configuration_guidelines.txt    | 46 +++++++++++++++++
 4 files changed, 49 insertions(+), 148 deletions(-)
 create mode 100644 productMods/config/list_view_configuration_guidelines.txt

diff --git a/productMods/config/listViewConfig-authorInAuthorship.xml b/productMods/config/listViewConfig-authorInAuthorship.xml
index 9157e7ea..66decab3 100644
--- a/productMods/config/listViewConfig-authorInAuthorship.xml
+++ b/productMods/config/listViewConfig-authorInAuthorship.xml
@@ -1,55 +1,7 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!-- $This file is distributed under the terms of the license in /doc/license.txt$ -->
 
-<!--
-    List view configuration guidelines
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-    
-    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:
-        - Use a SELECT DISTINCT clause rather than a simple SELECT. There can still be cases where 
-          the same individual is retrieved more than once, if there are multiple solutions to the
-          other assertions. 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 
-          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:
-            - 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 
-              retrieved in the template using the localname(uri) method. 
-          
-        - Each assertion or set of optional assertions must reference a different graph variable, so that
-          no requirement about which assertions are in the same graph is imposed (unless this is desired
-          in a specific case).
-          
-        - For collated properties: 
-            - Include a ?subclass variable, named as such, in the SELECT claus. 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
-              ?infoResource and core:InformationResource:
-                OPTIONAL { GRAPH ?g4 { ?subclass rdfs:subClassOf core:InformationResource }
-                    GRAPH ?g5 { ?infoResource a ?subclass } 
-                    FILTER (?g5 != &lt;http://vitro.mannlib.cornell.edu/default/inferred-tbox&gt; &amp;&amp; 
-                            ?g5 != &lt;http://vitro.mannlib.cornell.edu/default/vitro-kb-inf&gt; ) 
-                }  
-              The filter blocks the retrieval of inferred type statements, so that, for example, we get
-              subclass bibo:Book but not bibo:Document, assuming the latter is inferred. If both have been
-              asserted, we will get both.
-                     
--->
+<!-- See guidelines in list_view_configuration_guidelines.txt -->
 
 <list-view-config>
     <query>    
diff --git a/productMods/config/listViewConfig-educationalTraining.xml b/productMods/config/listViewConfig-educationalTraining.xml
index 4c48b2a4..b1739641 100644
--- a/productMods/config/listViewConfig-educationalTraining.xml
+++ b/productMods/config/listViewConfig-educationalTraining.xml
@@ -1,57 +1,8 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!-- $This file is distributed under the terms of the license in /doc/license.txt$ -->
 
-<!--
-    List view configuration guidelines
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-    
-    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:
-        - Use a SELECT DISTINCT clause rather than a simple SELECT. There can still be cases where 
-          the same individual is retrieved more than once, if there are multiple solutions to the
-          other assertions. 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 
-          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:
-            - 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 
-              retrieved in the template using the localname(uri) method. 
-          
-        - Each assertion or set of optional assertions must reference a different graph variable, so that
-          no requirement about which assertions are in the same graph is imposed (unless this is desired
-          in a specific case).
-          
-        - For collated properties: 
-            - Include a ?subclass variable, named as such, in the SELECT claus. 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
-              ?infoResource and core:InformationResource:
-                OPTIONAL { GRAPH ?g4 { ?subclass rdfs:subClassOf core:InformationResource }
-                    GRAPH ?g5 { ?infoResource a ?subclass } 
-                    FILTER (?g5 != &lt;http://vitro.mannlib.cornell.edu/default/inferred-tbox&gt; &amp;&amp; 
-                            ?g5 != &lt;http://vitro.mannlib.cornell.edu/default/vitro-kb-inf&gt; ) 
-                }  
-              The filter blocks the retrieval of inferred type statements, so that, for example, we get
-              subclass bibo:Book but not bibo:Document, assuming the latter is inferred. If both have been
-              asserted, we will get both.
-                     
--->
+<!-- See guidelines in list_view_configuration_guidelines.txt -->
 
-    
 <list-view-config>
     <query>    
         PREFIX rdfs: &lt;http://www.w3.org/2000/01/rdf-schema#&gt;   
diff --git a/productMods/config/listViewConfig-informationResourceInAuthorship.xml b/productMods/config/listViewConfig-informationResourceInAuthorship.xml
index 5ded23af..973c50be 100644
--- a/productMods/config/listViewConfig-informationResourceInAuthorship.xml
+++ b/productMods/config/listViewConfig-informationResourceInAuthorship.xml
@@ -1,55 +1,7 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!-- $This file is distributed under the terms of the license in /doc/license.txt$ -->
 
-<!--
-    List view configuration guidelines
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-    
-    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:
-        - Use a SELECT DISTINCT clause rather than a simple SELECT. There can still be cases where 
-          the same individual is retrieved more than once, if there are multiple solutions to the
-          other assertions. 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 
-          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:
-            - 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 
-              retrieved in the template using the localname(uri) method. 
-          
-        - Each assertion or set of optional assertions must reference a different graph variable, so that
-          no requirement about which assertions are in the same graph is imposed (unless this is desired
-          in a specific case).
-          
-        - For collated properties: 
-            - Include a ?subclass variable, named as such, in the SELECT claus. 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
-              ?infoResource and core:InformationResource:
-                OPTIONAL { GRAPH ?g4 { ?subclass rdfs:subClassOf core:InformationResource }
-                    GRAPH ?g5 { ?infoResource a ?subclass } 
-                    FILTER (?g5 != &lt;http://vitro.mannlib.cornell.edu/default/inferred-tbox&gt; &amp;&amp; 
-                            ?g5 != &lt;http://vitro.mannlib.cornell.edu/default/vitro-kb-inf&gt; ) 
-                }  
-              The filter blocks the retrieval of inferred type statements, so that, for example, we get
-              subclass bibo:Book but not bibo:Document, assuming the latter is inferred. If both have been
-              asserted, we will get both.
-                     
--->
+<!-- See guidelines in list_view_configuration_guidelines.txt -->
 
 <list-view-config>
     <query>    
diff --git a/productMods/config/list_view_configuration_guidelines.txt b/productMods/config/list_view_configuration_guidelines.txt
new file mode 100644
index 00000000..40653657
--- /dev/null
+++ b/productMods/config/list_view_configuration_guidelines.txt
@@ -0,0 +1,46 @@
+List view configuration guidelines
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* 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:
+    - Use a SELECT DISTINCT clause rather than a simple SELECT. There can still be cases where 
+      the same individual is retrieved more than once, if there are multiple solutions to the
+      other assertions. 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 
+      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:
+        - 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 
+          retrieved in the template using the localname(uri) method. 
+      
+    - Each assertion or set of optional assertions must reference a different graph variable, so that
+      no requirement about which assertions are in the same graph is imposed (unless this is desired
+      in a specific case).
+      
+    - For collated properties: 
+        - Include a ?subclass variable, named as such, in the SELECT claus. 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
+          ?infoResource and core:InformationResource:
+            OPTIONAL { GRAPH ?g4 { ?subclass rdfs:subClassOf core:InformationResource }
+                GRAPH ?g5 { ?infoResource a ?subclass } 
+                FILTER (?g5 != &lt;http://vitro.mannlib.cornell.edu/default/inferred-tbox&gt; &amp;&amp; 
+                        ?g5 != &lt;http://vitro.mannlib.cornell.edu/default/vitro-kb-inf&gt; ) 
+            }  
+          The filter blocks the retrieval of inferred type statements, so that, for example, we get
+          subclass bibo:Book but not bibo:Document, assuming the latter is inferred. If both have been
+          asserted, we will get both.
\ No newline at end of file