• Resource Description
• Framework and File Structure
  • Basic Framework
  • Directory Structure
  • Files in Maps Directory
    • doc.html
    • template.shtml
    • update.bash
    • style/maps.css
    • scripts/locationRewrite.html
  • Files in the Floor Directories
  • Files in Location Directories
    • index.shtml
    • floor.txt
    • location.txt
    • ladd_map_[location].gif
    • image.txt
    • localNav.html
  • Files in Other Directories
• Maintenance Task HowTo
  • Change the Location Webpage Layout
  • Add a Location
  • Rename a Location
  • Change or Remove a Location
  • Edit a Master Map

File Locations

• Catalog maps project respository/backup:

  https://lockbox.bates.edu/ils/library/catalogMaps/ (this is a snapshot of abacus 9/14/2009; backups will reside in Dreamweaver local files)

• Master map files:

  https://lockbox.bates.edu/ils/library/libraryMaps/

• Deployed catalog maps:

  server: abacus.bates.edu
  Library/resources/catalog/maps/ sandbox dev filepath: Library/resources/catalog/mapsdev/ [This can be used as a model, should we want to have the floorplans directly avaialbe from the Library web site (not just through the catalog)]
  

• Deployed catalog map URLs:

  Library/resources/maps/floor[#]/[location_name]/
  e.g. http://abacus.bates.edu/Library/resources/catalog/maps/floor0/Q/

Connected systems

Catalog links to maps are generated in Webbridge, in the Resource Definitions corresponding to title locations (Location Information category).

Resource Description Map Links

This is an example map thumbnail URL in webbridge.

http://abacus.bates.edu/Library/resources/catalog/maps/floor2/G/?lc=#@CallNumber#

The display link in webridge will look something like the following, with #LinkImage# being the part that pulls in the map thumbnail URL:

<span class=webbridgeLocation><div class=webbridgeCallNo><span class=webbridgeStatus>Bookstacks #@CallNumber#</span> is located on the <span class=webbridgeFloor>Second Floor</span></div><div class=webbridgeMap>#LinkImage#</div></span>

Framework and File Structure

• Basic Framework
• Directory Structure
• Files in Maps Directory

Basic Framework

• URLs (without GET or other parameters) correspond to specific map locations, and to actual directory paths on the server.
• Location data is contained at the directory terminals as text files, images, and HTML files.
• The HTML display for a URL is generated by an SHTML template that pulls in this data to create location-appropriate output.

Directory Structure

• maps: global configuration and display files
  • [floor]
    • [location]: files containing data specific to the location

Files in Maps Directory

• doc.html
• template.shtml
• update.bash
• style/maps.css
• scripts/locationRewrites.html

doc.html

Catalog maps documentation.

template.shtml

This is the template for the pages that display the maps.

Every location directory contains a copy of this template as index.shtml.

See location files for more information about index.shtml.

update.bash

This script copies template.shtml to any folder directly below a floor in the file structure (the location folders).

This script also creates a floor.txt file at this level, if one does not exist.

To run the script, type ./update.bash on the command line from the maps directory [10/1/2009: bash ./update.bash].

style/maps.css

This is the CSS file for the catalog maps

scripts/locationRewrite.html

This is the JavaScript that gets the call number passed in the URL and re-writes the display of the locaiton to incorporate this datum.

Files in the Floor Directories

The floor directories only contain location directories

Files in the Location Directories

• index.shtml
• floor.txt
• location.txt
• ladd_map_[location].gif
• image.txt
• localNav.html

index.shtml

This should be a copy of template.shtml. It should never need to be edited directly.

This file pulls in the following files in order to construct the output HTML:

• floor.txt
• location.txt
• image.txt
• localNav.html
• laddfoot4.shtml

floor.txt

This file contains the label for the floor, e.g. "Ground Floor"

location.txt

This file contains the label for the specific location, e.g. "Bookstacks H"

ladd_map_[location].gif

The map image for the location.

image.txt

This file contains the name of the map image file, e.g. "ladd_map_stacks_H.gif"

localNav.html

This is the HTML for the display of the Subject and LC Subclasses for the location. If no such information is to be displayed, this file should be empty.

Files in Other Directories

/usr/local/httpd/htdocs/Library/Includes/laddfoot4.shtml

This contains the Google Analytics script

Maintenance Task Howto

For All Changes

Ideally, the SVN respository (AKA lockbox) will be used to track and save changes (especially to the master image files). In this scenario, the master map images or the maps directories would be checked out, edited, tested, and then checked back in. The new version would then be deployed in place of the old version.

In any case, see below regarding edits to the master map.

Change the Location Webpage Layout

• Edit template.shtml as appropriate
• run update.bash (enter ./update.bash in the maps directory)

Add a Location

• Create a new location directory in the appropriate floor directory.
• From the appropriate master image file, generate a new map image highlighting the location and upload it to the directory
• Create the following files in the location directory
  • location.txt (this text will display as the location)
  • image.txt (this text should match the name of the image file)
  • localNav.html (this may be empty, see file description)
• run update.bash from the maps directory (enter ./update.bash)
• Add a Data Field test (if necessary) and Resource Description for the location in webbridge

Rename a Location

If you want to change the location display name, edit the location.txt file.

Change or Remove a Location

If all you want to do is rename a location directory, keeping it on the same floor, move the location directory to the new name and change the link in webbridge

If you need to move a location to another floor, move the location directory to the appropriate floor directory, and run update.bash (enter ./update.bash in the maps directory).

Nothing needs to be done to remove a location, though the directory may be deleted if the webbridge link to it has been removed.

Edit a Master Map

See existing catalog maps for a reference as to appropriate cropping, resizing, and layer settings.

Important:

• Do NOT save over the master with an edited version, unless the original is in SVN
• Do NOT save over the original with a display/output version (e.g. a file with reduced dimensions, a file that has been cropped)

If a master map is edited, all person(s) responsible for map output should be notified that they may want to update their products. Currently, this includes Connie Mullane, who is responsible for the location flyer.

This is the svn directory for the master photoshop maps (used for generating the images for paper maps, as well as the online catalog maps):

https://lockbox.bates.edu/ils/library/libraryMaps/trunk/

To create an updated version of a catalog map there are several steps (something like what follows):

1. Edit the map to reflect any changes in location. Locations have at least two associated layers in the file: text and color. Layers are grouped by type. Note that some layers pertain to print maps only. You should only need to edit the color layers if regions change in boundary. At this point the edited map can then be saved as a new, current version of the master map.
2. Create a thumbnail for each floor that has changed (no masking of locations), of the appropriate size and file type. This involves cropping and resizing, and this should not be saved over the source file. This is the image that displays in webbridge; it must be uploaded into the catalog.
3. For each location on the floor that has changed, create a cropped map, reduced to the appropriate width (currently a max width of 600 and max height of 550), highlighting the location.
   Currently, this involves cropping the image, masking the text for the other locations using a masking layer, turning on the color layer for the location in question but not the other locations, reducing the image size, and saving for web as a gif using a palate with enough colors to not loose any detail but few enough that the file size is relatively small, using the appropriate file name.
   Refer to existing files to see what output and file names should be like. Make sure not to save over the source map at any point during this process. In practice one will go through this process for one location, then backtrack to the point of location highlighting (i.e., post crop) and repeat the process for another location. These are the images that display when you view a given location. They are located on abacus.
4. Consult with Connie on providing output of any new master maps in a form she can use for print maps (e.g., PDFs of the appropriate size, with the appropriate map layers visible, 2 orientatinos per floor). See print floor maps and map handouts for some idea of what map layers should be visible.