Preliminaries

Exhibit's code is stored in our Subversion code repository, just like all of our other projects. You need a Subversion client and here is a list of Subversion clients we know of.

Downloading Exhibit

After having installed one of the Subversion client, go to the command prompt and change to the directory where you want to download Exhibit's code and type

 svn checkout http://simile.mit.edu/repository/exhibit/branches/2.0 exhibit

If you're checking out Exhibit's code from within Eclipse, then you probably know what to do with that URL above.

Running Exhibit

Exhibit's code can be used straight off the file system. For example, you can just drag exhibit/src/webapp/site/index.html into your web browser.

If you want to serve Exhibit through a web server, you can type

 run

in the exhibit directory. That will launch the Jetty web server that Exhibit includes. You can then browse to http://127.0.0.1:8888/exhibit/. And the API is at http://127.0.0.1:8888/exhibit/api/exhibit-api.js.

Caveats

Note that the examples in the source code are hardwired to include the Exhibit API from http://static.simile.mit.edu/exhibit/api-2.0/exhibit-api.js rather than the API in the source code that you checked out. (This is so that other people can copy our examples without having to change that reference.) If you make changes to the checked out API and want to test the examples, you must change that reference to the URL given above.

Also, note that by default, Exhibit loads its bundled code generated by concatenating its original code and stripping out whitespace (for better performance). If you make changes to any of the .js or .css file, you need to do one of the following:

• In an HTML file that references the Exhibit API on your computer, you need to add the bundle parameter to that reference, as follows:

 <script href="http://127.0.0.1:8888/exhibit/api/exhibit-api.js?bundle=false" type="text/javascript"></script>

• You can re-bundle Exhibit's .js and .css files by running ant in the exhibit directory, given that you have installed Apache Ant.

One more caveat: map markers and exhibit logos are hardwired to our site. They are not included in the download because they take too much space. And obviously, Google Maps and Timeline ain't included.