Interoperability of digilib HTML pages with the Alcatraz toolbar

A toolbar-friendly digilib page must define a Javascript variable toolbarEnabledURL whose value is a HTTP URL that produces a toolbar-enabled page. The toolbar should present a button to "take over" the page design by replacing the current page with the page from the given URL.

Toolbar-enabled page

A toolbar-enabled page must offer the following Javascript functions:

Identification

• dlScriptVersion: a String variable that contains the version number of the Javascript code (e.g. "1.12b3")
  The existence of this variable can be used to test for a toolbar-enabled page

Interactive operations

• setMark(): lets the user click and sets a mark at the clicked location
• zoomArea(): lets the user click to select an area and zooms to the selected area
• moveCenter(): lets the user click and recenters the image around the clicked location

Page operations

• getRef(): returns a String with a URL reference to the current document
• removeMark(): removes the last mark
• zoomBy(float factor): magnifies the image by the given factor around the current center
• zoomFullpage(): zooms out so that the whole image is visible
• display(int prio): reloads the page with the current parameters

Parameter operations

• newParameter(String name, String defaultValue, int prio): declares a new parameter with name, default value (can be of any type) and priority
• getParameter(String name): returns the value of the parameter with the name name
• setParameter(String name, String value): sets the value of the named parameter (value can be of any type)
• getAllParameters(int prio): returns a String of all parameters in HTTP request format (name=value) below the given priority
• addMark(Position pos): adds a mark with the given Position
• deleteMark(): removes the last mark form the list
• getAllMarks(): returns a String with all current marks in digilib format (for parameter "mk")
• addFlag(String name): adds a digilib mode flag with the given name
• hasFlag(String name): returns if the given flag is currently set
• removeFlag(String name): removes the given flag
• toggleFlag(String name): toggles the given flag
• getAllFlags(): returns a String with all current flags in digilib format (for parameter "mo")