Inote Help Documentation
For a demonstration, a general description, and information about support, distribution, copyright, and authorship, see the main Inote page.
You can download Inote and associated utilities from the Inote download page. On that page, you will find two downloadable Inote packages--a Windows95 application with installer and with the Java Runtime Environment built in, and a tar file containing only the Inote class files. If you are a Windows95 user, we recommend the you download the application package. If you are on other platforms, we recommend downloading the tar file. If you intend to distribute annotated images via the Web, you will need the tar file in any case.
- Installing the Windows95 application package:
When you have downloaded the file (in6ins.exe) and stored it in a temporary directory, double-click on the file icon to run the installer. The installer will place the executable in a directory called IATH/Inote6.0, under your Program Files directory, and it will create a program group for Inote with an icon for the program. To run the program, you double-click on that icon. Once you have installed the application, you can discard in6ins.exe from the temporary directory. You do not need to modify any existing CLASSPATH statements, nor do you need to download a separate JDK: the Java Runtime Environment allows Inote to run as a completely self-contained Java application.
- Installing the tar file:
If you are using the Windows95 executable version described above, you do not need to download or install the tar file (unless you want to run Inote as an applet via the Web). If you are using Inote on a platform other than Windows95, you do need to download the tar file. When you have downloaded, untar the file in the directory where you want Inote stored, and make sure that your CLASSPATH environment variable includes the path to that directory. In order to use the straight Java version of Inote, you will need to have downloaded and installed Sun's JDK 1.1.5, as well. If you have not done that, see Sun's JDK site for information and download. When both the JDK and Inote are installed, type:
from the command line to run the application. For information on how to use Inote as an applet through the Web, see the instructions below.
If desired, an image file and an overlay file associated with that image can be loaded into Inote at startup by including the appropriate filenames at the end of this command. For example, to view the image in file flibble.gif with the overlays from file flibble.ovl
you would type:
java Inote flibble.gif flibble.ovl
- Open Local Image: This option allows the user to load an image from your local file system: file selection is done with a standard dialogue box. Inote can only load JPEG and GIF images.
- Open Image via HTTP: This option allows the user to open a JPEG or GIF image from any Web server, by giving the fully qualified URL of that image (including the server name, domains, path, and filename).
- Remove New Overlay: This option allows the user to remove a new overlay from the image.
- Load Local Overlays: This option allows the user to load overlays from a local file system through a standard dialog box.
- Load Overlays via HTTP: This option allows the user to open an existing Inote overlay from any Web server, by giving the fully qualified URL of that overlay (including the server name, domains, path, and filename).
- Save Local Overlays: This option allows the user to save current overlays to a local file system.
- Save Overlays Via HTTP: This option is not functional at present.
- Save Overlays Locally: This option saves overlays to the local file system.
- Close Image: This option will discard Inote's currently loaded image and allow you to load another image into Inote from the local filesystem or via HTTP.
- Exit: This option will exit the Inote program and close all Inote windows.
- Screen Size: This option resizes the Inote frame (but not the loaded image) to the total viewable area of your monitor.
- Half Screen (Landscape): This option will size the Inote frame to half the total viewable area of your monitor, in landscape orientation.
- Half Screen (Portrait): This option will size the Inote frame to half the total viewable area of your monitor, in portrait orientation.
- Quarter Screen: This option will size the Inote frame to one quarter of the total viewable area of your monitor.
- Fit to Image: This option will size the Inote frame to fit the loaded image.
- Double Size:Choosing this menu option will magnify the loaded image to twice its current size. See also plus/minus buttons, below.
- Half Size: Choosing this option will reduce the loaded image to half its current size. See also plus/minus buttons, below.
- Fit to Frame: This option will fit the image inside the Inote frame; if the frame is a different shape than the image, you may see some gray space in the Inote frame around the image.
- Actual-size Imaging: This option will return the image to its original size.
- Browse: This option allows the user to click on existing details and view associated annotations.
- Edit: This option presents the user with a series of buttons controlling the editing, addition and removal of overlays, details and annotations
- Detail: All mouse selections control choice of details as well as moving, resizing and deleting details. A mouse-click upon a detail produces a dialog with the single detail or a list of overlapping details upon which the user can select items to rename, delete or copy the annotations to a new overlay of autogenerate new details. Holding the mouse button down while over a detail allows the user to move that detail within the image.
- Annotation: Mouse clicks select, create and edit annotations. A mouse click selects a detail and produces a dialog box displaying that detail or overlapping details and allows the user to select an annotation from those details. The user may then move the annotations toa new detail, delete the annotation, edit it, copy it to a new detail, cancel the operation, or browse.
- Rectangle Drawing Tool: To use this tool the user selects a corner and drags the mouse to create a rectangle by enclosing the desired region.
- Polygon Drawing Tool: A series of mouse clicks create a polygon by enclosing a space.
- Circle Drawing Tool: To create a circle the user selects a center point with a mouse click and drags the mouse to determine the circle's radius. Release of the mouse button produces a circle enclosing the desired region.
- Point Drawing Tool: A single mouse click creates a new point in the top overlay.
- Overlay: This option presents a dialog box. The user's first option is "new," which produces a new overlay. The "delete" option removes a selected overlay. The "copy" option reproduces the contents of a selected layer to another overlay. The "move" option relocates a selected overlay to the top layer.
- Select Overlay: Selection of this option allows the user to determine the uppermost overlay in use.
- Overlay Color: Selection of this option allows the user to change the color used to accent details in the overlay in use.
- Overlay Visibility: This option allows the user to display and hide overlays.
- Contents: Choosing this option will display the URL for this document.
- About Inote: Choosing this option will bring up a pop-up window with information about Inote's programmers, download and documentation, copyright, licensing, and liability.
- Show Panner will pop up Inote's panner window, a navigational device for images larger than the Inote frame. When the panner appears, you will see a blue box representing the area of the Inote frame relative to the image as a whole: by clicking your mouse on that box and holding the mouse-button down, you can drag the panner box around the image, which will move the image inside the Inote frame. NB: Inote will allow you to drag the panner outside of the area occupied by the loaded image: if, by doing this, you lose the image in the Inote and/or panner window, clicking on a scrollbar in the Inote window will recenter the image for you.
- Hide Panner will make the panner window disappear. Scrollbars are also available as an alternative navigational device.
This button (available in both Inote and the ImageSizer applet) will display information about the image loaded, including any textual information embedded in the image header (screen shot).
These buttons magnify or reduce the size of the loaded image by 5% for each click.
At the bottom left of the Inote window you will see status messages for the Inote software, such as "Loading Data" or "Ready".
- Button Method: This option allows the user to launch Inote from a single applet button. The user can open Inote to an entire image or zoom to a preselected detail.
- Autoload Method: This option loads Inote automatically as soon as the page containing the applet tag is loaded in a Web browser. This method is not recommended, in general, because of the extra time it takes to load the image.
In either case, to run Inote as an applet, you need an html page with some variation on the following code:
<APPLET Codebase="http://www.iath.virginia.edu/Inote/" CODE="Inote.class"
<PARAM NAME=asButton VALUE="true">
<PARAM NAME=imageName VALUE="/images/thel.F.P8.100.jpg">
<PARAM NAME=overlayName VALUE="http://www.iath.virginia.edu/overlays/thelfp8100.ovr">
<PARAM NAME=regionName VALUE="L">
The first line identifies the Inote class file as the applet to be loaded, and sets the pagespace allotted to this applet. For this to work, Inote.class should be in the same directory as the html file that's trying to load it, or the path to it should be set in the codebase statement. The second line sets a value for the asButton parameter: if this value is true, Inote will only appear as a button on the page--it won't load the image and the overlay until that button is pushed; if the value is false, Inote will autoload the image and overlay (see below). The third line sets the value for the ImageName parameter--this is the image you want Inote to load, and it should identify the image by a fully qualified URL. The fourth line sets the value for the overlayName parameter: the value supplied should be a fully qualified URL pointing to an existing overlay created by Inote to go with the image being loaded. The last line sets the value of the regionName parameter: this is an optional parameter, and its purpose is to open Inote zoomed in on a particular detail in the overlay. If you use the regionName parameter, the value supplied needs to correspond to the label of an existing detail in the overlay file being called.
- The Inote DTD
Inote overlay information, including the coordinates of detail boundaries, the labels assigned those details, and the labels and contents of text annotations are all stored in a text file (the overlay file): this text file is written in XML, and the format used (the XML DTD) is available here.
- The ImageSizer Applet
(Screen shot). Before using ImageSizer, see Known Bugs and Limitations, below. The ImageSizer applet is not directly connected to Inote in any way, and it can be used indpendently. To download the applet, see the download page. Once you've downloaded it, untar it into a Web-accessible directory (this directory will be specified as the codebase in the applet tag--see below). To use the applet, you will need an html page with some version of the following code:
<PARAM name='ImageResolution' value='100'>
<PARAM name='ScreenResolution' value='76'>
For calibration, use the calibrate.html page distributed with the package, as is (screen shot).
- At present, annotations are text-only; in future versions of Inote, we plan to offer the option of using sound and image files as annotations, and we plan to enable URL linking from within text annotations. We will also add enhanced rendering capabilities (already supported in the Inote DTD) to the annotation editor and browser.
- We plan to enable Inote to read other image formats in addition to JPEG and GIF.
- We plan to enable saving of overlays by http.
- We also plan to release a generic command-line Java utility for producing overlays out of SGML/XML data in batch mode, provided that this data incorporates the Inote dtd; eventually, we will use architectural forms in the Inote software and in this utility, instead of the Inote DTD itself.
- We'd like Inote to perform its automatic detail generation (for identifying lines of text in manuscript images) in batch mode, and we'd like to have the generic SGML utility (described above) operate in conjunction with that.
NB: The bugs and limitations listed here are those which apply to the most recent version of the software: older versions may have bugs, not listed here, which have been fixed. The latest version of Inote 6.0 was uploaded on 3/31/98.
- If you create a shortcut to the Win95/NT executable version of Inote and in the shortcut properties specify a working directory other than the Inote bin directory, all buttons in the edit mode will come up blank. You can solve this by using the Inote bin directory as the working directory--in fact, that's what it will be set to by default, when you create the shortcut, so you won't have this problem unless you change that property.
- Inote only reads JPEG and GIF images
- Inote isn't available as a stand-alone application on the Mac: Apple's latest MRJ implements JDK 1.1.3, and Inote needs JDK 1.1.5. Inote will, however, run on a Mac through a Web browser. The latest information on Java for Mac is available here.
- Inote doesn't yet save overlays by http.
Document URL: http://www.iath.virginia.edu/inote/help.html
Last Modified: Monday, 12-Jul-2010 13:23:24 EDT