NaviKey 2.0 FAQ


So what is NaviKey?
NaviKey is an interface to viewing Delta files. In it's second release, NaviKey usefully presents a method to identify specimens.

How does NaviKey work?
NaviKey is split into four sections.

  • Top Left: Character Panel, displays all pertinent characters.
  • Top Right: State Panel, after a character has been selected, displays pertinent information.
  • Bottom Left: Selection Information, lists all choices you have made so far.
  • Bottom Right: Items List, lists all possible items matching your selections.
     Each of these four sections also has some additional capabilities. Every "item" displayed in the bottom right contains a complete description of itself -- selecting an item will pop up this description. If there are any resources for the item, namely images, buttons along the top of the description enable viewing the resource. The selection information area contains two additional buttons, enabling removal of any individual selection or the entire set of selections you have entered. The state panel actually consists of two panels -- a multi-state list for selecting possible matches, and an input layout for entering numeric data. The panel automatically adjusts to the correct type depending on what type of character is selected. The character list itself is somewhat intelligent, as selections are made and the list of possible "items" shrinks, the character lists trims itself by removing any "non-pertinent" characters, or elements that no matter what the selection will not refine the list of items beyond its current state.

    What's up with this "Resource" thing, and how do I get pictures working?
    Instead of simply enabling image files, we created a more generic "resource." Currently it only supports images, in the form of gif or jpg files, but the options of adding sound or movies is possible. In the items file any text state can instead be read as a resource. Should a text state contain a .gif or .jpg string in its comment, and should the .gif or .jpg file specified exist in a directory NaviKey can find, a button will appear in the item description panel with a link to the image. Currently only images of items are detected, although eventually images for characters and states will be added.

    How do I specify where the pictures are?
    In the properties file required by NaviKey, (downloadable from our download page if you've lost or corrupted it), an image directory field must be set. This should point to a directory containing the images named in your items file. Please note that NaviKey, unlike most Windows products, is case sensitive. While this will eventually be fixed, for now to get image files working both the names and the cases must match exactly.

    Can I put my Delta files on the web through NaviKey?
    Absolutely.

    What do I need to have to get it to work?
    All you need is access to a web server, your DELTA files, and NaviKey.

    How do I put the key on the web?
    Check out the instructions on our download page.

    Can I use NaviKey without putting it in a web page?
    Yes. If you have java installed on your system, install NaviKey as described you would for a web page but then run the command "appletviewer navikey.html" or if you don't have java installed, run it through your favorite browser with a command like "netscape navikey.html". NaviKey no longer runs as an application from a java ... command.

    Which browsers will run NaviKey?
    All current browsers should support NaviKey, but please report any problems running with recent versions of Netscape or Internet Explorer.

    Any other cool aspects not covered elsewhere?
    Yup. The biggest advantage in NaviKey 2.0 is its object model. There are essentially three layers -- the user interface, the delta object model, and the input stage. The object model is fairly secure, and will be expanded as more features of delta are incorporated into NaviKey. The input layer is swappable, currently we have layers to read text files or attach to an access database running DeltaAccess. The user interface layer is the part that actually is the applet, and is swappable in how it connects to the delta objects. This allows for both the standalone version, where the objects, interface, and files get downloaded, and the client-server model, where only the interface gets downloaded and then http calls between the client and the server keep the applet displaying proper messages.

    So what's the benefit of client-server, and how do I use it?
    The biggest benefit is when dealing with large Delta data sets. Instead of waiting the long wait for the files to download before NaviKey will start, NaviKey loads quickly. The downside is a slightly longer delay when making any selection, as NaviKey has to both send and recieve information, but on larger data sets this is a good choice. The code for it is available on our download page, but it utilizes javax.servlet classes not in the base java 1.0 package.