root/other-projects/GlamED/trunk/README.txt @ 31364

Revision 26603, 3.4 KB (checked in by davidb, 7 years ago)

Changed instructions in regards to importing GSDL collections into GlamED. User no longer needs to create an Import Collections action item.

Line 
1GlamED -- Galleries Libriaries Archives Museums Editor
2
3This 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.
4
5We 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.
6
7COMPILING GlamED
8
91. Compile Greenstone3:
10    > cd GlamED-svn
11    > cd greenstone3-svn
12    > ant prepare
13    > ant install
14   
15        Note: You will need 'svn' command line, 'ant', 'perl' and 'java'.
16       
17        Our PATH environment variable was set to:
18       
19        "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"
20       
21    BEFORE running 'ant install':
22       
23        Set JAVA_HOME appropriately.
24
25        Make sure the Visual Studio compiling environment is set up:
26               
27            cd into your Visual Studio directory
28                > cd C:\Program Files (x86)\Microsoft Visual Studio 10.0
29            cd into the '\VC\bin' directory:
30                > cd VC\bin
31            run the vcvars32 batch file:
32                > vcvars.bat
33               
34   
35    Optionally, test that Greenstone3 has installed successfully.
36       
37        > gs3-setup.bat
38        > ant start
39       
40        Open your web browser and go to: http://localhost:8383/greenstone3/library
41   
42               
432. Compile Expeditee
44           
45    Open Expeditee (expeditee-svn) in Eclipse and  build from there. In Eclipse:
46   
47        > Go to File -> New -> Java Project.
48        > In the 'Project Name:' textbox, enter 'expeditee-svn'.
49        > Make sure that the 'Use Default Location' checkbox is NOT checked.
50        > Click on the 'Browse' button next to the 'Location' textbox and select the 'expeditee-svn' directory located within the 'GlamED' directory.
51        > Click on the 'Finish' button.
52
53        NOTE: Do NOT use the 'Import...' option in Eclipse's 'File' menu as this will import Expeditee into your workspace.
54       
55        Expeditee is now ready to compile.
56       
57        GlamED requires a jar file of the Expeditee code to operate:
58       
59            > cd expeditee-svn\makeFiles
60            > jar cvfm ..\\releases\\jars\\expeditee.jar Manifest.txt -C ..\\bin\\src org
61           
62
633. Check out the 'html-to-expeditee' Greenstone extension:
64
65    > cd C:\Users\peijones\GlamED-svn\greenstone3-svn\ext
66    > svn co http://svn.greenstone.org/gs3-extensions/html-to-expeditee/trunk/src html-to-expeditee
67   
68    Run ./INSTALL-FOR-GREENSTONE3.sh
69    (If on Windows, install Cygwin first).
70   
71    To test that this extension is running:
72   
73        Navigate to: http://localhost:8383/greenstone3/cgi-bin/html-to-expeditee.pl?site=localsite
74
75       
764. Compile GlamED
77
78    Open GlamED in Eclipse (follow instructions in Step 2)
79   
80    If a dialogue box appears asking you to select a class to run, select "Main (org.honours.Main)".
81   
82    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.
83
84Korii Scrivener and David Bainbridge
85
867/01/2013
87
Note: See TracBrowser for help on using the browser.