FrameBuilder Manual

This page is intended to be a simple usage guide for the FrameBuilder applet. The installation and maintenance documentation can be found elsewhere.

Note, as of this writing Framebuilder doesn't work, mostly because Java applets no longer seem to be supported.

Table of Contents

  1. What is FrameBuilder?
  2. Overview
  3. Starting FrameBuilder
  4. The Main Control Panel
    1. The "Login..." Button
    2. The "Load Image..." Button
    3. The "Load Frame..." Button
    4. The Toolbar
  5. The Frame Window
    1. The "Save Frame..." Button
    2. The "Close Frame" Button
    3. The "Info" Button
    4. The "Try" Button

What is FrameBuilder?

FrameBuilder is a authoring utility that allows the author/owner of a Digital Anatomist atlas to create and modify his atlas. This program allows the author to open existing GIF files from his atlas and annotate them by outlining, and naming or linking structural regions on top of the image, and adding textual descriptor fields. FrameBuilder also provides a mechanism for opening existing frame files and modifying them. In addition to the authoring features, FrameBuilder has a "Try" mode that allows the author to test out a frame to see if it is to his particular liking.

FrameBuilder is written in Java, and runs with the help of your web browser. Since FrameBuilder is in it's first release version, this system may seem somewhat fragile. Please remember to be patient.


Overview

FrameBuilder has two areas of importance. The first is the main control panel, of which FrameBuilder has only one copy, located in the web browser window. This is where the login information and global toolbar are kept. The second area is the frame window, which represents a frame. There is a unique frame window for each open frame, that contains the GIF image for that frame, as well as its structural outlines. When FrameBuilder is started up, there are no frame windows open. Each frame window also contains it's own button strip.

Starting FrameBuilder

Using a Java-enchanced web browser, such as Netscape 2.0+ (for certain platforms), open the URL that points to the FrameBuilder applet. If configured properly, the URL to FrameBuidler for your atlas should be:
http://your.server.name.here/DA/framebuilder.html/

The Main Control Panel

The main control panel is the portion of FrameBuilder that can be found inside the web browser window. It contains a number of buttons, some login information, and the toolbar. Everything in the main control panel is global to all open frame windows. Through the main control panel you can log in to one atlas at a time, and select one tool for use at a time.

Login Indicator Fields

You may only edit or create frames if you are logged into an atlas. In the middle of the main control panel, are three fields labelled: Host, Atlas, and User. These denote which host machine and atlas you are logged in to, and as what user. When you first start up FrameBuilder they are all set to null. This indicates that you are currently not logged in to any atlas. Whenever you switch which atlas you are connected to, this display will update. Any frames edited or created will be on the indicated host, in the indicated atlas.

The "Login..." Button

When FrameBuilder first starts up in the web browser window, you will see a panel of three buttons across the top of the applet. Below these buttons is a list of items that denote the current log in status. At the beginning, all items will be set to null denoting that you are not logged into any atlas. By clicking on the Login... button, you can log yourself into an atlas. This is the first thing you must do.

After clicking on the Login... button, a dialog box will pop up with a number of text entry fields that must be filled in. The first field is Host Addr. In this field you must enter the IP address of the web server from which your atlas is run. For example: www9.biostr.washington.edu. (in some cases, this will already be entered in for you). NOTE: For network security reasons, enforced by Java, this MUST be the same machine that you opened FrameBuilder from. The second field is Atlas. Here you must enter the name of the atlas you wish to work on. In the third field, Login, you must enter your registered author's login name. If you don't know what this is, you must contact your system administrator. The fourth field, Password , is where you will enter your password that goes along with your user name. Once all this info has been entered, hit the Login button at the bottom. If you decide not to follow through with the login, you can close the login dialog by clicking in the Cancel button.

If you wish to try Framebuilder on the Test atlas included with this package, the atlas name, login name and password are all "Test", which should therefore be typed in all three fields of the dialog box.

If successful, the Login dialog box will disappear, and the information in the applet, in the web browser, will be updated to show the correct login status. If unnsuccessful, an error dialog will appear, with some kind of error message, then when you hit "OK", both dialogs will disappear, and the login status will remain as it was before you clicked the Login... button.

If, at any time during the execution of FrameBuilder, you wish to connect to a different atlas, all you need to do is hit the Login... button again, just as you do upon startup.


Opening an Image File

To create a content or control frame, you must first open an existing image file from your gifs subdirectory, on the server. This is done by clicking on the Load Image... button in the web browser. This will open a file open dialog, that allows you to search through the gifs directory subtree for the current atlas, and select a GIF file to open.

The entries whose names end with a forward slash are directories. Selecting a directory and clicking on the Open button will move you into that directory. To go back up a directory level, hit the Parent Dir. button. NOTE: You will not be allowed to go 'up' past the top level of the gifs directory for the current atlas. To open a GIF file, select the file you wish to open and then click on the Open button. If you change your mind, and decide you do NOT want to open an image file, hit the Cancel button, and the open file dialog box will be closed.

Note that GIF files can either be loaded directly on your server if you have write privileges, or they can be uploaded using the GIF upload script accessed from the framebuilder.html page. With the current state of the software it is much easier to load the files directly.

Once you have opened a GIF file, there may be a slight delay (with no 'please wait' message) before another window is opened, due to the network transfer latency that can sometimes be quite large with color images. Just be patient, and a separate window will pop up containing your image, and a row of 3 buttons across the top.


Opening a Frame file

To open a frame that already exists (ie: there is a framefile and corresponding image file), you must click on the Load Frame... button in the web browser. From there, the process is very similar to that of opening an image file. File names ending with a forward slash are directories, and to move back up in the directory heirarchy, click on the Parent Dir. button.

Once a framefile has been opened, there will be even more of a delay before the window is opened than when opening an image file. This is because not only will the image file need to be transfered, but the the framefile will also need to be read. When the window does pop up, it will be the same window you get when opening an image file, with your image in the major portion of the window, but there will also be outlined regions highlighted, if there were any defined in the frame file you opened.


The Toolbar

The toolbar, located under the login status indicator in the applet in the web browser window, allows you to select a tool to be used on the open frame windows. The toolbar is global to all open windows, meaning that if a given tool is currently selected, is will be the active tool for all image windows.

The Move Tool

The move tool is the one that looks like a hand. When this tool is selected, you can click and drag any existing structure outlines on an image.

The Query Tool

The query tool is the one that looks like an arrow. With this tool selected, you are considered to be in browser mode. This is how you can test out the regions you have defined. Simply click on areas on the image, and as long as the mouse button is held down, the name of the structure you are pointing at will be shown, with it's outline highlighted. While in browser mode, you can click on the Try button in a given image window to turn off all of the automatically displayed outlines, to give you the ability to really test out your regions. When clicking with the outlines turned off, the region you click in will still be highlighted. To turn the outlines back on, click on the Try button again. NOTE: You can only turn the outlines off while in browse mode. (And yes we realize that the atlas client itself should be in java - real soon now).

The Pencil Tool

The pencil tool (looks like a pencil) allows you to draw new regions on the image. To draw, click the mouse button and drag. To stop drawing, let up on the button. If you let up and the button when the region you are drawing has not yet been closed, it will automatically be closed for you with a direct line fromthe end point to the start point. When you are finished drawing the outline of the region, you will be prompted with a dialog box to name the new region. There is a text entry field, to enter the name of the new structure and three buttons along the bottom of the window. To give the structure a name, type the name into the text entry field and click the Ok button. Doing so will close the dialog box and allow you to continue editing the frames. In the name structure dialog, you may also click on the Make Link button. This will allow you to make the current region a link to another existing frame file, instead of a named region. When you click on the Make LInk button, an open file dialog will appear. This works exactly like the open frame dialog that you get when you click on the Load Frame... button in the web browser. When you choose a framefile, however, instead of opening it, it returns you to the name structure dialog, and enters the appropriate name into the text field in order to create the link. Then to accept this link, simply hit the Ok button. If you decide that you do not want to keep this region you just drew, hit the Cancel button. This will erase the region you just drew.

The Rectangle Tool

This is the tool that looks like a plus-sign. It allows you to draw rectangular regions on the image by clicking where one corner should be placed, on dragging to where the opposite corner should lie. When the mouse button is let up, the same dialog box for naming the new structure that is used with the pencil tool is opened.

The Edit Tool

This is the tool that looks like the capital letter 'E'. With the edit tool, you can click on an existing region to pop up an edit region dialog box. The dialog that pops up is exactly the same as the name structure dialog box used in conjunction with the pencil and rectangle tools, except that the text entry field defaults to have the current name of the structure already typed in. To change the name of the structure, simple enter in a new name, or use the Make Link button as discussed in the pencil tool section.

The Kill Tool

The kill tool is the one that looks like the skull and cross-bones. With this tool selected, you can click on regions in the frame to delete them. Be careful, clicking on a region will make it disappear without an undo command.

Adding Text Descriptions

Version 2.0 and above of the Digital Anatomist CGI Package support textual Frame-Info fields to be displayed along with the rest of the frame. To add a text field to a frame, click the Info button on the frame you wish to annotate. This will open a text entry dialog that will allow you to type the text you desire. Note that carriage returns, tabs and extra spaces will all be displayed as single spaces.

Saving a Framefile

Once you are satisfied with the regions you have drawn (or edited) on your image, you can save the framefile back to the Index directory subtree for the current atlas. To do this, click on the Save Frame... button in the frame window you want to save. This will open up a dialog very similar to the open frame dialog. File names ending with a forward slash are directories. The Up button takes you up in the directory heirarchy, as the Parent Dir. button does in the open frame dialog. The Open button moves you into the selected directory. If you click Open while a framefile is selected, nothing will happen. You are not allowed to open framefiles from this dialog. The text field at the bottom of the dialog box defaults to show the current name of the frame you are saving. You may change this if you so desire. The New button will enable you to create a new directory within the current directory. When you hit this button, a dialog box will pop open, prompting you to enter the name of the new directory. You can either type in a new name and hit Ok or cancel the operation by hitting the Cancel button. When you have entered the desired file name into the text field at the bottom, and have navigated into the desired directory, you can hit the Save button to save the frame file to the server. Due to network transfer times, this may take a few seconds, please be patient. If you decide you do not want to save the frame, rather you want to discard any editing that has been done, you can simply click on the Close Frame button to close the frame window. This will not save any changes, nor will it warn you of this.
Last Updated: 2018 June 12 by jfb