JVISION 1.2.1 README

November 11, 1999


Thank you for downloading this version of JVISION 1.2.1.  It is only
with feedback from our user community that we can provide continuous
improvement to our products.

This is a non-commercial version of JVISION which is not officially 
supported, but we do appreciate and hope to receive your comments.
Please write to

	bugs@object-insight.com

We will use your comments to improve the tool and to determine what 
goes into the next release, but we probably will not respond 
individually to each email.

For answers to other questions, please write to:

       info@object-insight.com


WHAT'S NEW IN THIS RELEASE (build of November 11)

* Path names which contain spaces broke the documentor.  Fixed.

* Placing the documentation path inside the project path lead to
  endless recursion. Now it's forbidden!

* Due to syntactical problems the JAVADOC call didn't work. Fixed.

* Diagrams with class filters containing dynamic relations
  couldn't be saved. Now they can.

* Dynamic relations are printed correctly with arrows now.

* JVISIONs internal editor features now a tool bar.  It also became
  more intelligent about entering comments.  Finally, it got an 
  experimental macro feature:  Try ESC plus of of c,i,j,f,m,t, or w.

* Since 1.2, the source file reader's method to parse package-level
  import statements was broken.  This has been fixed.

* A bug prevented JVISION from reading diagrams of version 1.1 has
  been fixed.

* There are two new DDE and/or command line arguments for using
  JVISION's internal editor from other tools.  Yes, you can now 
  configure your favorite IDE to use JVISION as source editor!

  --edit filename - open an internal editor on the file filename.
  +linenumer filename - open an internal editor and sets the cursor.
                        For unix vi compatibility.

* JVISION got Windows Drap&Drop support!  You can now drag files from 
  your Windows Explorer to either a diagram painter or an internal 
  editor.  The editor will load whatever file you drag onto its window.
  If you drop more than one file, all but the first are ignored.  
  The diagram interprets the dropped files as class or source files 
  and will load and show them. Believe me, once you tried this feature,
  you wonder how you could live without it :-)

* JVISION got real Windows Clipboard support!  You can now copy
  diagrams to other applications without any restriction of screen 
  depth or size. All colors are correctly preserved.


WHAT'S NEW IN VERSION 1.2

* JVISION is now available for Linux and Solaris platforms.  This
  should have no impact on the Windows version, but as we use the
  same code base for all platforms we might have accidently broken
  something.

  For Unix and Solaris users it's important to know that JVISION
  originally was a Windows program.  While it should run without
  problem on Unix platforms its GUI follows the Windows conventions.
  We're looking forward any suggestion how to improve the feel
  on Unix.

* Postscript printing is now in color.  While you actually should
  use Windows printing on Windows machines - even if you have a
  postscript printer - Postscript printing can be useful in combination
  with the free Aladdin Ghostscript application, too.  Ghostscript is
  a Postscript interpreter that not only prints Postscript files on
  non-postscript printers but it also allows you to generate different
  kinds of bitmap graphics and PDF output.

  You can download Aladdin Ghostscript here: 
  ftp://ftp.cs.wisc.edu/ghost/aladdin/gs550/

* Free lines can now be attached to text objects or class boxes.
  Drag a line end over an object and it should snap to the border
  of that object.  To detach the line, drag it away.

* In addition to detecting normal associations based on instance
  variables JVISION can now infer dynamic dependency relations based on
  method return types and method parameter types. If a method's
  return type is a reference type X and the diagram also contains
  a class X, a relation with stereotype "creates" is added to the
  diagram.  Similar for parameter types, "uses" relations are added.

  For existing diagrams, this behavior is switched off for compatibility.
  You can use the diagram property dialog to activate it.  For new
  diagrams, you can choose whether you want this feature in the settings
  dialog.  The class filter dialog has been extended to allow the user
  to enable or disable these dynamic relations on an individual base.

* Association lines can be annotated with a rhombus to show
  UML-style aggregation or composition.

* JVISION doesn't freak out anymore if the ZLIB.DLL (or libz.so.1
  on unix systems) is missing.

* Fixed a number of minor bugs related to the documentor, parsing
  of ill-formed java code and printing.


KNOWN ISSUES

JVISION's online help is available separately for download at
http://www.object-insight.com/html/download.html.

JVISION deals with most of its runtime errors itself.  However,
uncaught exceptions are signaled by the runtime system presenting a
small dialog showing the options to "Exit" the tool or to "Continue".
In most cases it is safe to continue but we cannot guarantee the
consistency of the tool.  We recommend you save and then restart the
tool.  In both cases, a file "jvision.log" is written that contains a
snapshot of the state that caused the tool to misbehave.  Please
attach this logfile to your bugreport!

JVISION needs the free zlib library to access compressed ZIP and JAR
files and to create PNG images.  For Windows, the ZLIB.DLL is
provided.  For Linux/Solaris, a library libz.so.1 must be in your
LD_LIBRARY_PATH.  Both RedHat 6.0 and SuSE 6.1 are known to provide
this library.  Please contact your system administrator otherwise.

The documentor only works with javadoc of the JAVA 2 (JDK 1.2 or JDK
1.3 beta) platform.  It will not work with earlier version of javadoc.
If you don't get output, please look for a file called "document.log"
which contains a transcript of the javadoc program.  This might help
you to find the problem.  In case of a bug report, please attach this
file to your bugreport!


SPECIAL LINUX / SOLARIS ISSUES

JVISION is an X11 application and has been tested with TWM, FVWM, KDE
and Gnome (using Enlightment).  Depending on the window manager and
your desktop font settings, dialogs may show overlapping labels or
partially hide the last line of text.

JVISION cannot be shared between users because it needs write access
to its installation directory.  It will store its "jvision.ini" file
and a directory "filters" that contains named filters here.  A later
version will use the user's HOME directory instead.

Diagram files are portable across platforms ONLY if you transfer them
in BINARY mode -- even if they look like text files. All diagram files
must contain CR/LF as line end, not a single LF.

You can choose the default external editor, webbrowser and printer
using the shell variables EDITOR, BROWSER and PRINTER.  See the
provided "jvision" shell script for details.


INSTALLATION DETAILS

The JVISION distribution consists of the following directories and
files.  When extracting the archive, make sure that all directories
are created and that these directories are readable and writeable by
JVISION.

Windows only:

 jvision.exe    Start program to launch JVISION
 zlib.dll       Free zlib compression library
                (see http://www.cdrom.com/pub/infozip/zlib/zlib.html)

Unix only:

 jvision        Shell script to start JVISION

All platforms:

 jvision.vm     Main program (actually a virtual machine to run the
                program which is written in VisualWorks(tm) Smalltalk)
 jvision.im     System file (contains the Smalltalk code)
 jvision.ini    Tool settings (created automatically)
 projects/      Default root for documentor projects
 documents/     Default target directory for documentor
 filters/       Storage for named filters (created automatically)


sma
