README

= ImageMap =

== Installing and Using ==

Copy the following directories and files to your HTML page main path:

* vendor/        contains the included js libs (seajax and jquery)
* tiles/         contains all the images for Diretas Já as tiles and DZI file
* imagemap.css   do your CSS customizations in this file
* imagemap.js    do your JS customizations in this file

Edit your HTML file and add into the header:

    <script src="./vendor/jquery-1.6.2.min.js" type="text/javascript"></script>
    <link rel="stylesheet" type="text/css" href="imagemap.css"/>
    <script src="./vendor/seadragon-ajax/seadragon-dev.js" type="text/javascript"></script>
    <script src="imagemap.js" type="text/javascript"></script>

Open imagemap.js and change these variables:
* jsonurl        put the url from where the marks data will be loaded 
* postmarks      url to post the new marks made

On some place into your HTML file, place this div:

    <div id="container"> </div>

== Creating new tiles ==

To create new image tiles use the Python script on utils/:

    python utils/seadragon.py -n tile_name image_file.jpg

This will create tile_name.dzi and tile_name/ directory containing all the tiles
for the image_file.jpg

== Licenses ==

ImageMap is distributed as GPLv3

Seadragon Ajax 0.8.9 (build 64702 on 2011-01-28) is distributed under the 
license agreement at: http://go.microsoft.com/fwlink/?LinkId=164943

jQuery JavaScript Library v1.6.2
Copyright 2011, John Resig
Dual licensed under the MIT or GPL Version 2 licenses.
http://jquery.org/license
Includes Sizzle.js
http://sizzlejs.com/
Copyright 2011, The Dojo Foundation
Released under the MIT, BSD, and GPL Licenses.