source: trunk/cic-hcap/help/cic-hcap.html@ 11950

Last change on this file since 11950 was 11950, checked in by mdewsnip, 18 years ago

Started a "future work" section.

  • Property svn:keywords set to Author Date Id Revision
File size: 3.3 KB
Line 
1<html>
2<head>
3<title>CIC: Historic Campus Architecture Project</title>
4</head>
5
6<body>
7<h1>CIC: Historic Campus Architecture Project</h1>
8
9The CIC Historic Campus Architecture Project (HCAP) collection contains records from a survey of architecture in colleges represented by CIC. A Microsoft Access database contains the textual information from the survey, and also links to the place images (stored separately).
10
11<h2>Configuration</h2>
12
13The HCAP collection was developed with Greenstone v2.62, and is unlikely to work with other versions. It does not have a collection-specific receptionist, but has a collection-specific plugin and highly customised macrofiles.
14
15<p>
16The steps involved to install this collection on a new computer are:
17
18<ol>
19<li>Install Greenstone v2.62.
20<li>Copy the place images from the CIC server onto the computer.
21<li>Copy the "cic-hcap" collection folder into the Greenstone "collect" directory.
22<li>Copy the "cic-hcap\main.cfg" file into the Greenstone "etc" directory.
23<li>Copy the "cic-hcap\bin\windows\perl\lib\DBI.pm" file into the Greenstone "bin\windows\perl\lib" directory.
24<li>Copy the "cic-hcap\bin\windows\perl\site" directory into the Greenstone "bin\windows\perl" directory.
25<li>Copy the current version of the database into the "cic-hcap\import" folder.
26<li>Create an ODBC Data Source for the collection database:
27 <p>
28 Start -> Control Panel -> Administrative Tools -> Data Sources (ODBC)
29 <p>
30 Add Microsoft Access Driver (*.mdb) source "CIC-HCAP" for the collection database (in the "cic-hcap\import" directory).
31</ol>
32
33<h2>Rebuilding the collection</h2>
34
35<ol>
36<li>Close Microsoft Access if it is running. (You should not edit the database while the collection is building).
37<li>Run the Greenstone Local Library (Start -> Program Files -> Greenstone Digital Library -> Greenstone Librarian Interface).
38<li>Open the "CIC Historic Campus Architecture Project" collection.
39<li>Change to the Design pane, then choose "Document Plugins", then configure the "CICPlug" plugin. Check that the "-images_directory" and "-cache_directory" options are correct, and the "-michael_mode" option isn't on.
40<li>Change to the Create pane and click "Build Collection". Check the building output for errors.
41<li>Click "Preview Collection" to view the built collection.
42</ol>
43
44<h2>Implementation notes</h2>
45
46The key files for this collection are:
47
48<dl>
49 <dt><b>etc/collect.cfg</b></dt>
50 <dd>Contains format statements for generating the place, institution and designer display pages.</dd>
51 <p>
52 <dt><b>macros/extra.dm</b></dt>
53 <dd>Contains macros for the customised look of the collection and all of the static pages.</dd>
54 <p>
55 <dt><b>perllib/plugins/CICPlug.pm</b></dt>
56 <dd>This plugin uses DBI to extract the places, institutions and designers out of the database; processes the place images; and writes the static macrofiles for the browse pages.</dd>
57</dl>
58
59<h2>Editing collection text</h2>
60
61Static text within the collection can be changed by editing the macros/extra.dm file. Search for the text you want to change and edit it, taking care with HTML tags.
62<p>
63Refresh the browser window to see the effect of your changes (you do not need to restart the Greenstone Local Library).
64
65<!--
66<h2>Future work?</h2>
67
68<ul>
69<li>Make "designer" field of places a link.
70</ul>
71-->
72
73</body>
74</html>
Note: See TracBrowser for help on using the repository browser.