Installation guidelines:

Once you have downloaded the XMLViewer.jar file, you should invoke it by running in the command line: java -jar XMLViewer.jar

Above command assumes following:

  1. You have Java installed on your machine and its version is at list 1.5.0.
  2. The command is invoked from the same directory where XMLViewer.jar file resides. If this is not the case, change to the installation directory or provide the path to the XMLViewer.jar file in the command itself.

Usage guidelines:

If all installation pre-requisites are fulfilled, you should see following window:


As you can see in the above picture, there are two bars in the upper side of the window - Menubar and Toolbar.

Toolbar has following options:

Menu bar has following options:

  1. File:
    1. Open menu which has similar options as in the tool bar:
      1. Open Xlink files
      2. Open  source file
      3. Open target file
    2. Configuration…, which opens following pop-up window:

      The values in the configuration dialog are taken from the .xmlviewer.conf file which resides in user's home directory (Every operating system defines the user home directory in a different place). In case the file doesn't exist, it is created automatically by the application and following default values are stored:

      Default xml' directory  - user's home directory
      Default dtd's directory - by default:  www.cs.technion.ac.il/~ssdl/veritech/xml/dtd
      Default xsl's directory  - by default:  www.cs.technion.ac.il/~ssdl/veritech/xml/xsl
      (Default dtd's/xsl's directory is a directory where all dtds/xsl's should be found in case the XLink file or source/target XML file contain references to files, which do not exist.)

       

    3.     Exit from the program

     

  2. Window menu - once the files are opened, this menu enables to order open files windows:
    1. Arrange windows - this option arranges windows in the following order:
      Source Text file XLink file tree Target Text file
      Source XML file Target XML file

       

    2. Show all windows - in case some of the windows are closed or minimized, they will be shown again
    3. XLink viewer - change focus to the XLink viewer (if the window is closed ore minimized it will be restored)
    4. Source XML viewer - change focus to the source XML viewer (if the window is closed or minimized it will be restored)
    5. Target XML viewer - change focus to the target XML viewer (if the window is closed or minimized it will be restored)
    6. Source Text viewer - change focus to the source Text viewer (if the window is closed or minimized it will be restored)
    7. Target Text viewer - change focus to the target Text viewer (if the window is closed or minimized it will be restored)

     

  3. Help menu
    1. User Manuel - displays this Manuel
    2. VeriTech site - open a browser, displaying the home page of the VeriTech project (this option might fail on Unix / Linux machines)

 

Working with languages

When one of the "open languages" buttons is pressed the following window appears:

Once opened, browse for the wanted files locally:

The selection may be also an http location

If the language file must be edited, the user will be presented with two choices. First, to modify the original file, second, to create a temporary file. All temporary files are deleted when the program is closed.

Working with the viewers:

Automatic file checking:

When opening a language file, the application checks that all references to other files (as DTD files or XSL files) contain valid values (meaning that if the file a.xml contains reference to b.dtd file, b.dtd file should exist). In case references contain invalid values, the user cannot continue until
  1. User  provide path to valid dtd/xsl file or to use default value (which is taken from "Default dtd's/xsl's directory" value in .xmlviewer.conf configuration file)
  2. If some of the files are missing or not available ,the user is prompted to choose between two possibilities:
    1.  Working on a temporary file that will be deleted after the program exits.
    2.  Editing the original XML file to work with the new files

Opening existing file:

For start working with XMLViewer application, one should click on open "Xlink file" option, choose some additional information file and click OK. Automatically all  relevant files will be opened (source and target XML files, source and target HTML files and additional information file itself).

Additional files:

XMLViewer depends on additional files’ existence in its work. These files are: