----------------
GENERAL README
----------------
The 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.

If 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.

1. Download Greenstone 3.09 or later from http://www.greenstone.org/download
Greenstone is available for Windows, Linux and Mac.

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.
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 in the README-maths-activities.txt. (But first finish reading these instructions here in this file.)

You 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. 

 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.

2. Installing Greenstone mostly involves double clicking on the downloaded installer file and then repeatedly clicking Next and then finish in the installer dialog.
For 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

3. 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
Unzip this zip file into your Greenstone 3 installation's web/sites folder.

4. 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.
In order to make this Greenstone site the default site, you need to do 2 things:

a. Use a text editor to open the file servlets.xml located in your Greenstone 3 installation's web/WEB-INF/servlets.xml file.
In the text editor, locate the following text (which tends to be at the start of the file):
	<servlet>
		<servlet-name>library</servlet-name>
		<description>The standard gsdl3 library program</description>
		<servlet-class>org.greenstone.gsdl3.LibraryServlet</servlet-class>
		<init-param>
			<param-name>library_name</param-name>
			<param-value>library</param-value>
		</init-param>
		<init-param>
			<param-name>site_name</param-name>
			<param-value>localsite</param-value> <-------------- YOU'RE GOING TO BE CHANGING THIS LINE BELOW
		</init-param>
	
Change 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:
	<servlet>
		<servlet-name>library</servlet-name>
		<description>The standard gsdl3 library program</description>
		<servlet-class>org.greenstone.gsdl3.LibraryServlet</servlet-class>
		<init-param>
			<param-name>library_name</param-name>
			<param-value>library</param-value>
		</init-param>
		<init-param>
			<param-name>site_name</param-name>
			<param-value>waikato-edu</param-value> 
		</init-param>
		
Save the file in the text editor and close it.

Essentially, 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".
	
The 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


b. 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.
You can then quit GLI by pressing the X button to the top right of GLI's window. (Always close Greenstone applications this way.)

Making the above change will allow you to immediately see and open collections available in the "waikato-edu" site.

5. Proceed to reading the README instructions located in the unzipped contents:
- 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.
- waikato-edu/README-science-activities.txt: if you specifically want to recreate from scratch OR just rebuild the science-activities collection.

6. For more information on Greenstone 3:
- 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)
- Peruse the information organised in the Greenstone wiki at http://wiki.greenstone.org/
(searching the site using Google is more powerful than the wiki's own search feature)
- 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