Changeset 5063

Timestamp:

04/25/14 11:43:06 (10 years ago)

Author:

Twan Goosen

Message:

Updated UPGRADE,CHANGES,README and DEPLOY-README files

Location:

vlo/branches/vlo-3.0

Files:

• CHANGES (modified) (3 diffs)
• DEPLOY-README (modified) (2 diffs)
• README (modified) (1 diff)
• UPGRADE (modified) (1 diff)

vlo/branches/vlo-3.0/CHANGES

@@ -1 +1 @@
 Bug Fixes and Features
 
-VLO 3.0-alpha (March 2014)
+VLO 3.0-beta (April 2014)
+* Added a 'simple search' front page
+* Added expansion of search results items to see more details
+* Added federated content search support
+* Added links to 'search pages' if provided by a record
+* Added an 'About' page
+* Added links to help and error report form
+* Added support for themes, included a CLARIN-D theme 
+        (enabled by query parameter theme=clarin-d)
+* Added a filter or 'quick search' input to facet selection panels
+* Added filtering on minimal number of occurrences in all facet values popup/page
+* Added an advanced search options box with the option to filter on FCS option
+* Added resolving of handles of resources to show the actual filename
+* Added support for UBN:NBN
+* Added a link to the CLARIN language info page for language values of records
+* Resource details now shown in tooltip instead of separate page section
+* Lazy rendering of the 'all metadata fields' view (generated by CMDI-to-HTML stylesheet)
+* Improved error handling
+* Numerous fixes and small enhancements to the user interface and code base
+
+* Solr configuration: data directory is configured through java system property 
+        'solr.data.dir', which needs to be configured in the Tomcat instance
+
+VLO 3.0-alpha1 (March 2014)
 * Reimplemented Wicket front-end, see <https://trac.clarin.eu/milestone/VLO-3.0>
 * Upgraded to Solr 4.6.0
@@ -25 +48 @@
 'sessionCacheSize' to control the size of the Wicket page cache
 
-Beta release 2.17 (november 2013)
+Beta release 2.17 (November 2013)
 
 Added facet overview to the search bar
@@ -33 +56 @@
 Added support for fulltext search on header (441)
 
-Beta release 2.16 (July October 2013)
+Beta release 2.16 (October 2013)
 
 Fixed broken web links (#311, #420)

vlo/branches/vlo-3.0/DEPLOY-README

@@ -73 +73 @@
         vlo/config/solr 
 
+   Solr needs a location to store its index data. This needs to be configured
+   through a Java system property 'solr.data.dir'. Configure this in your
+   Tomcat instance, for example by adding the following to 
+   ${catalina.home}/bin/setenv.sh:
+   
+    export JAVA_OPTS="$JAVA_OPTS -Dsolr.data.dir=/var/vlo/solr/data"
+
+   The directory does not have to exist, but its parent does and the Tomcat
+   user needs write access in that location.
+   
    Copy the new context.xml file to the Tomcat configuration:
 
@@ -82 +92 @@
 
         apps/WEB-INF/classes/log4j.properties
-
+   
    If necessary, change the ownership of the files in the tree starting in 
 

vlo/branches/vlo-3.0/README

@@ -4 +4 @@
 
         https://trac.clarin.eu/wiki/CmdiVirtualLanguageObservatory
+
+= Setting up =
+
+Follow the instructions in DEPLOY-README to set up a development environment.
+You may deploy the Solr instance and the web app from your IDE. Make sure to
+set the required Java system property for the Solr data location (solr.data.dir)!
 
 == Preparing for release ==

vlo/branches/vlo-3.0/UPGRADE

@@ -1 +1 @@
 Upgrading from 2.18 to 3.0
+
+* In version 3.0, the context parameters for the VLO web application have changed, see
+the file META-INF/context.xml for examples. The following parameters are now being
+processed:      
+
+- eu.carlin.cmdi.vlo.config.location
+        Optional but recommended. Should point to the location of VloConfig.xml that
+        should be used. Replaces The previously available parameter 'externalConfig', which is
+        no longer supported.
+
+- eu.carlin.cmdi.vlo.solr.serverUrl
+        Optional. Configures the base URL of the SOLR instance to connect to.
+
+* New options have been added to the shared VLO configuration file VloConfig.xml 
+(in vlo-3.0/config):
+
+- The 'length' attributes in list elements can be removed
+
+- The following elements should be added:
+
+        <!-- begin added in 3.0 -->
+
+        <collectionFacet>collection</collectionFacet> 
+
+        <simpleSearchFacetFields>
+                <simpleSearchFacetField>language</simpleSearchFacetField>
+                <simpleSearchFacetField>resourceClass</simpleSearchFacetField>
+                <simpleSearchFacetField>genre</simpleSearchFacetField>
+                <simpleSearchFacetField>nationalProject</simpleSearchFacetField>
+        </simpleSearchFacetFields>
+
+        <!-- Fields shown in expanded search results on the search page -->
+        <searchResultFields>
+                <searchResultField>name</searchResultField>
+                <searchResultField>country</searchResultField>
+                <searchResultField>languages</searchResultField>
+                <searchResultField>modality</searchResultField>
+                <searchResultField>subject</searchResultField>
+                <searchResultField>genre</searchResultField>
+                <searchResultField>organisation</searchResultField>
+                <searchResultField>collection</searchResultField>
+                <searchResultField>nationalProject</searchResultField>
+        </searchResultFields>
+
+        <!-- Fields ignored in the record page -->
+        <ignoredFields>
+                <ignoredField>format</ignoredField>
+        </ignoredFields>
+
+        <!-- Fields shown as technical fields in the record page -->
+        <technicalFields>
+                <technicalField>id</technicalField>
+                <technicalField>dataProvider</technicalField>
+                <technicalField>metadataSource</technicalField>
+                <technicalField>_landingPageRef</technicalField>
+                <technicalField>_searchPageRef</technicalField>
+                <technicalField>_contentSearchRef</technicalField>
+                <technicalField>_lastSeen</technicalField>
+                <technicalField>_componentProfile</technicalField>
+        </technicalFields>
+
+        <!-- end added in 3.0 -->
+
+- The element 'facetfield' should be replaced with new values:
+
+        <!-- begin changed in 3.0 -->
+
+        <facetFields>
+                <facetField>language</facetField>
+                <facetField>resourceClass</facetField>
+                <facetField>continent</facetField>
+                <facetField>country</facetField>
+                <facetField>modality</facetField>
+                <facetField>genre</facetField>
+                <facetField>subject</facetField>
+                <facetField>organisation</facetField>
+                <facetField>nationalProject</facetField>
+                <facetField>format</facetField>
+                <facetField>keywords</facetField>
+                <facetField>dataProvider</facetField>
+        </facetFields>
+
+        <!-- end changed in 3.0 -->
+
+* The location of the Solr index data directory is now governed through a java system
+property 'solr.data.dir'. Add the following to ${catalina.home}/bin/setenv.sh:
+
+        export JAVA_OPTS="$JAVA_OPTS -Dsolr.data.dir=/lat/webapps/vlo/solr/data-beta"
+
+Substitute the directory with the actual desired location of the index data. The
+parent directory has to exist and should be writable by the Tomcat user.
 
 TODO: EXTEND!!