Changeset 33697

Show
Ignore:
Timestamp:
15.11.2019 23:10:13 (3 weeks ago)
Author:
ak19
Message:

Changes to the README to provide instructions on making the fewest changes to switch from the default localsite to the waikato-edu Greenstone 3 site

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • main/trunk/model-sites-dev/waikato-edu/README.txt

    r33673 r33697  
    44The content here is meant to work on Greenstone 3 (not Greenstone 2), and has been tested with version Greenstone 3.09, but is likely to work with later versions of Greenstone 3. 
    55 
     6If you prefer, you can ask your department's tech-support to install Greenstone for you. Nevertheless, you'll want to read through these instructions once yourself, as there may be points to bear in mind to notify tech support about. 
     7 
    681. Download Greenstone 3.09 or later from http://www.greenstone.org/download 
    79Greenstone is available for Windows, Linux and Mac. 
    810 
    9 IMPORTANT NOTE 1: 2 custom scripts have been written to "pre-prepare" the content to go into the Education Department's "Science Activities" and "Maths Activities" Greenstone collections. These scripts are WINDOWS-SPECIFIC. Although they're not a part of Greenstone and not necessary, they were created to automatically assign useful hierarchical metadata to your documents for readily browsing by such a hierarchical structure in Greenstone. 
    10 NOTE 2: Moreover, the custom script for the "Maths Activities" can be easily reused to create further collections that are similar. The instructions for doing so are within the README file of the "TC4.12_Math Resources_Activities" folder. (But first finish reading these instructions here in this file.) 
     11IMPORTANT NOTE 1: 2 custom scripts have been written to "pre-prepare" the content to go into the Education Department's "science-activities" and "maths-activities" Greenstone collections. These scripts are WINDOWS-SPECIFIC. Although they're not a part of Greenstone and not necessary, they were created to automatically assign useful hierarchical metadata to your documents for readily browsing by such a hierarchical structure in Greenstone. 
     12NOTE 2: Moreover, the custom script for the "maths-activities" can be easily reused to create further collections that are similar. The instructions for doing so are in the README-maths-activities.txt. (But first finish reading these instructions here in this file.) 
    1113 
    1214You can always use a Windows machine to make use of the custom scripts, and then transfer the content produced into a Greenstone 3 installation on Mac and Linux machines. So other than using the custom scripts to prepare content for your Greenstone collections, you are not in any way bound to Windows machines.  
    1315 
    14  If you don't want to use the custom Windows script for the Math collection to pre-prepare your content for Greenstone (which means you want to assign metadata to your documents manually through the Greenstone Librarian Interface/GLI) but if you still do want to use the custom "educationresources.mds" Greenstone Metadata Set that we've created, copy the file "WaikatoEducationDept/TC4.12_Math Resources_Activities/math.gs3coll/metadata/educationresources.mds" into your Greenstone 3 installation's gli/metadata folder. 
     16 If you don't want to use the custom Windows script for the Math collection to pre-prepare your content for Greenstone (which means you want to assign metadata to your documents manually through the Greenstone Librarian Interface/GLI) but if you still do want to use the custom "educationresources.mds" Greenstone Metadata Set that we've created, copy the file "waikato-edu/collect/maths-activities/metadata/educationresources.mds" into your Greenstone 3 installation's gli/metadata folder. 
    1517 
    16182. Installing Greenstone mostly involves double clicking on the downloaded installer file and then repeatedly clicking Next and then finish in the installer dialog. 
    1719For more detailed instructions on installation, see http://wiki.greenstone.org/doku.php?id=en:release:3.09_release_notes#installing_and_running_the_binary_release 
    1820 
    19 3. Finally, 
    20 - copy the siteConfig.xml file that exists at this level into your Greenstone 3 installation's web/sites/localsite folder. 
    21 - also copy the ijpg.gif file into your Greenstone 3 installation's web/interfaces/default/images folder 
     213. Finally, grab a copy of the waikato-edu.zip file, the "waikato-edu" Greenstone site containing the 2 Greenstone collections "maths-activities" and science-activities" from http://trac.greenstone.org/browser/main/trunk/model-sites-dev/waikato-edu 
     22Unzip this zip file into your Greenstone 3 installation's web/sites folder. 
    2223 
    23 4. Proceed to reading the README instructions in  
    24 - WaikatoEducationDept/TC4.12_Math Resources_Activities/README.txt: if you want to recreate from scratch OR rebuild the Maths Activities collection or create your own collection that works similarly. 
    25 - WaikatoEducationDept/TT4.02_Science Resources_Crates/README.txt: if you specifically want to recreate from scratch OR just rebuild the Science Activities collection. 
     244. The zipped file contains a Greenstone 3 "site" we've prepared called "waikato-edu", which is customised for the education department's Maths and Science Activity materials. 
     25In order to make this Greenstone site the default site, you need to do 2 things: 
    2626 
    27 5. For more information on Greenstone 3: 
     27a. Use a text editor to open the file servlets.xml located in your Greenstone 3 installation's web/WEB-INF/servlets.xml file. 
     28In the text editor, locate the following text (which tends to be at the start of the file): 
     29    <servlet> 
     30        <servlet-name>library</servlet-name> 
     31        <description>The standard gsdl3 library program</description> 
     32        <servlet-class>org.greenstone.gsdl3.LibraryServlet</servlet-class> 
     33        <init-param> 
     34            <param-name>library_name</param-name> 
     35            <param-value>library</param-value> 
     36        </init-param> 
     37        <init-param> 
     38            <param-name>site_name</param-name> 
     39            <param-value>localsite</param-value> <-------------- YOU'RE GOING TO BE CHANGING THIS LINE BELOW 
     40        </init-param> 
     41     
     42Change the 2nd to last line in the above (the line indicated) to refer to the custom "waikato-edu" site instead of the default "localsite", so it looks like: 
     43    <servlet> 
     44        <servlet-name>library</servlet-name> 
     45        <description>The standard gsdl3 library program</description> 
     46        <servlet-class>org.greenstone.gsdl3.LibraryServlet</servlet-class> 
     47        <init-param> 
     48            <param-name>library_name</param-name> 
     49            <param-value>library</param-value> 
     50        </init-param> 
     51        <init-param> 
     52            <param-name>site_name</param-name> 
     53            <param-value>waikato-edu</param-value>  
     54        </init-param> 
     55         
     56Save the file in the text editor and close it. 
     57 
     58Essentially, this is a quick fix to maming use of the existing default look of Greenstone 3 to present all the collections in the custom "waikato-edu" site. At present the site contains the 2 collections "maths-activities" and "science-activities". 
     59     
     60The details and reasons for making the change above don't matter at this stage, but if you're interested, the ideas behind it are discussed and explained in the Greenstone 3 tutorial at http://files.greenstone.org/tutorial/gs3-current/en/defining_libraries.htm 
     61 
     62 
     63b. The next change to make is that the first time you run the Greenstone Librarian Interface, GLI, the first thing you need to do is to go into File > Preferences menu and select the "Connection" tab. For the "Site" field, select "waikato-edu" in its drop down. 
     64You can then quit GLI by pressing the X button to the top right of GLI's window. (Always close Greenstone applications this way.) 
     65 
     66Making the above change will allow you to immediately see and open collections available in the "waikato-edu" site. 
     67 
     685. Proceed to reading the README instructions located in the unzipped contents: 
     69- waikato-edu/README-maths-activities.txt: if you want to recreate from scratch OR rebuild the maths-activities collection or create your own collection that works similarly. 
     70- waikato-edu/README-science-activities.txt: if you specifically want to recreate from scratch OR just rebuild the science-activities collection. 
     71 
     726. For more information on Greenstone 3: 
    2873- Go through the very helpful Greenstone 3 tutorials at http://wiki.greenstone.org/doku.php?id=en:tutorials (Make sure to select the Greenstone 3 tab near the top of that page) 
    2974- Peruse the information organised in the Greenstone wiki at http://wiki.greenstone.org/ 
    3075(searching the site using Google is more powerful than the wiki's own search feature) 
    3176- You can also join the greenstone-users mailing list to ask Greenstone questions, see http://wiki.greenstone.org/doku.php?id=en:support#central_english_mailing_lists 
    32 The Waikato University Education department staff are also welcome to write to us directly, if that's preferred, at greenstone_team@cs.waikato.ac.nz 
     77