source: other-projects/GlamED/trunk/README.txt@ 33325

GlamED -- Galleries Libriaries Archives Museums Editor

This software is designed to manage digital cultural collections through a graphical interface. More specifically, a digital library collection developed in Greenstone can be exported to Expeditee frames. From there these frames can be edited including changing metadata values and page style/layout. These changes can then be sent back to Greenstone.

We had thought of naming this project G2E2G to emphasise this roundtrip ability between Greenstone and Expeditee, but while a good functional description of what it does and doesn't convey much information unless you already know what the "G" and the "E" are referring to.

COMPILING GlamED

1. Compile Greenstone3: 
    > cd GlamED-svn
    > cd greenstone3-svn
    > ant prepare
    > ant install
    
        Note: You will need 'svn' command line, 'ant', 'perl' and 'java'.
        
        Our PATH environment variable was set to: 
        
        "C:\Windows\system32;C:\Windows;C:\Windows\System32\Wbem;C:\Windows\System32\WindowsPowerShell\v1.0\;C:\Program Files\TortoiseSVN\bin;C:\strawberry\c\bin;C:\strawberry\perl\site\bin;C:\strawberry\perl\bin;C:\Program Files (x86)\Java\jdk1.7.0_09\bin;C:\apache-ant-1.8.4\bin"
        
    BEFORE running 'ant install':
        
        Set JAVA_HOME appropriately.

        Make sure the Visual Studio compiling environment is set up:
                
            cd into your Visual Studio directory
                > cd C:\Program Files (x86)\Microsoft Visual Studio 10.0
            cd into the '\VC\bin' directory:
                > cd VC\bin
            run the vcvars32 batch file:
                > vcvars.bat
                
    
    Optionally, test that Greenstone3 has installed successfully.
        
        > gs3-setup.bat
        > ant start
        
        Open your web browser and go to: http://localhost:8383/greenstone3/library
    
                
2. Compile Expeditee
            
    Open Expeditee (expeditee-svn) in Eclipse and  build from there. In Eclipse:
    
        > Go to File -> New -> Java Project.
        > In the 'Project Name:' textbox, enter 'expeditee-svn'.
        > Make sure that the 'Use Default Location' checkbox is NOT checked.
        > Click on the 'Browse' button next to the 'Location' textbox and select the 'expeditee-svn' directory located within the 'GlamED' directory.
        > Click on the 'Finish' button.

        NOTE: Do NOT use the 'Import...' option in Eclipse's 'File' menu as this will import Expeditee into your workspace.
        
        Expeditee is now ready to compile.
        
        GlamED requires a jar file of the Expeditee code to operate:
        
            > cd expeditee-svn\makeFiles
            > jar cvfm ..\\releases\\jars\\expeditee.jar Manifest.txt -C ..\\bin\\src org
            

3. Check out the 'html-to-expeditee' Greenstone extension:

    > cd C:\Users\peijones\GlamED-svn\greenstone3-svn\ext
    > svn co http://svn.greenstone.org/gs3-extensions/html-to-expeditee/trunk/src html-to-expeditee
    
    Run ./INSTALL-FOR-GREENSTONE3.sh
    (If on Windows, install Cygwin first).
    
    To test that this extension is running:
    
        Navigate to: http://localhost:8383/greenstone3/cgi-bin/html-to-expeditee.pl?site=localsite

        
4. Compile GlamED

    Open GlamED in Eclipse (follow instructions in Step 2)
    
    If a dialogue box appears asking you to select a class to run, select "Main (org.honours.Main)".
    
    Click on "Manage Collections". To import collections from Greenstone into GlamED, click on the "Import Collections into GlamED" action text item at the top of the frame.

Korii Scrivener and David Bainbridge

7/01/2013