Requality

h1. Requality Installation

To install the latest stable version of Requality, please use the following update site:

http://forge.ispras.ru/repo/requality/site/

h1. System requirements

# Windows and Linux (both x86 and x86-64) are supported. Please note if you use Windows x86-64, all the tools have to be x86 (32-bits), because there is no supported browser engine for Windows x86-64, that could be integrated into Eclipse.

# "Sun Java SE":http://www.oracle.com/technetwork/java/javase/downloads/index.html (recommended 7.0, supported 6.0 and higher).

# "Eclipse Platform":https://eclipse.org/downloads/ (3.7 recommended). You can use minimal Eclipse package "Platform Runtime Binary":http://archive.eclipse.org/eclipse/downloads/drops/R-3.7.2-201202080800/#PlatformRuntime (about 50MB) or any other package based on it.

To install Eclipse unpack the archive to any convenient place. This creates an ''eclipse'' sub-directory.

# "XULRunner":https://developer.mozilla.org/en-US/docs/Mozilla/Projects/XULRunner 1.9.2.19. XULRunner Eclipse plugin: http://forge.ispras.ru/repo/xulrunner-eclipse/site/. For Linux you can use "WebKit":http://www.webkit.org/ instead of XULRunner.

# "Subversive":http://eclipse.org/subversive/, "EGit":http://www.eclipse.org/egit/ or any other Eclipse Team Provider — it depends on your version control system. EGit is recommended.

|_. Dependency |_. Min version |_. Recommended version |_. Windows x86, x86-64 |_. Linux x86 |_. Linux x86-64 |

| "Sun/Oracle Java SE":https://www.java.com/en/download/ | 6.0 | 7.0 | x86 | x86 | x86 or x86-64 |

| "Eclipse Platform":http://eclipse.org/ |3.7.2 | 4.3.2 | x86 | x86 | x86 or x86-64 |

| "XULRunner":https://developer.mozilla.org/en-US/docs/Mozilla/Projects/XULRunner | 1.9.2.19 | 1.9.2.19 | x86 | x86 | x86 or x86-64 |

h1. Preparation to Requality installation

h2. Step 1. Eclipse installation

To install Eclipse unpack the archive to any convenient place. This creates an ''eclipse'' sub-directory.

h2. Step 2. Browser integration to Eclipse

Requality requires a browser engine to be integrated with Eclipse. Mozilla Foundation XULRunner and WebKit are supported.

*NOTE!* After Requality installation you can check if browser engine has been installed successfully. See instructions below in "After installation" section.

*NOTE!* To use XULRunner on *Windows x86_64* install "Visual C++ 2010 runtime":http://www.microsoft.com/en-us/download/details.aspx?id=13523

For *Eclipse 4.4* on *Linux* it''s necessary to use WebKit because of Eclipse 4.4 "incompatibility":http://www.eclipse.org/swt/faq.php#browserlinux with XULRunner. To install WebKit you should install libwebkitgtk-1.0-0. For example, on Ubuntu/Debian run in command line following command:

sudo apt-get install libwebkitgtk-1.0-0

For *Eclipse 3.8 and higher* to install Mozilla XULRunner it is required to download an appropriate "XULRunner 10.0.4":http://ftp.mozilla.org/pub/mozilla.org/xulrunner/releases/10.0.4esr/runtimes/, to unpack the downloaded archive to any convenient place and to add the following strings to the end of ''eclipse.ini'' file: 

@-Dorg.eclipse.swt.browser.DefaultType=mozilla

-Dorg.eclipse.swt.browser.XULRunnerPath=<path to XULRunner>@

For example, if XULRunner was unpacked to C:\xulrunner, the second string should be:

@-Dorg.eclipse.swt.browser.XULRunnerPath=C:\xulrunner@

For *Eclipse 3.7 and lower* follow the same instructions but use "XULRunner":http://ftp.mozilla.org/pub/mozilla.org/xulrunner/releases/1.9.2.19/runtimes/

h2. Step 3 (optional). Installation of plugin for interaction with control version system

Version  control system provides support for collobarative work with requirements. Check if there are plugins to interact with chosen version control system (Subversion, git and others) in Eclipse. If needed, appropriate plugin could be installed from Eclipse repository. In the case of Subversion it is recommended to use Subversive plugin (Subclipse plugin is not recommended).

h1. Requality installation

There are 2 ways how to install the tool: to eclipse/dropins directory or by Eclipse Update Manager. The first one allows using the tool both in Eclipse environment and in console mode. The second one simplifies the process of the tool version update, but restricts the use by only Eclipse environment.

h2. Installing Requality by Eclipse Update Manager (from update site)

*Install*

To install Requality by Eclipse Update Manager open Main menu and choose ''Install New Software...'' 

!InstallNewSoftware.png!

In opened window insert Requality update site address.

!AddUpdateSiteRequality.png!

Name: Requality

Location: http://forge.ispras.ru/repo/requality/site/

!InstallRequality.png!

Then choose Requality plugin from the available plugins list and follow install plugin Wizard.

While installing there will appear Security Warning about unsigned content. Push ''OK''.

!SecurityWarning.png!

Restart Eclipse after installation.

For more information about installation of plugins from update sites see "the following instructions":http://help.eclipse.org/indigo/index.jsp?topic=%2Forg.eclipse.platform.doc.user%2Ftasks%2Ftasks-124.htm.

*Delete*

To delete the plugin choose in menu Help -> About Eclipse. In the opened window (''About Eclipse'') push button ''Installation Details'', in ''Eclipse Installation Details'' window select required plugin - Requality, push ''Uninstall'' and continue deletion with the help of plugin delete wizard.

Restart Eclipse after deletion.

*Update*

To update Requality that was installed by Eclipse Update Manager choose in main menu Help -> Check for Updates. Wait until updates search finish. In the opened window (''Available Updates'') select Requality plugin and continue installation with the help of plugin update wizard.

!RequalityUpdate.png!

There are 2 reasons why the plugin can not be in the list: the plugin is not installed or there are no updates. Restart Eclipse after installation.

h2. Installing to dropins directory

*Install*

To install Requality unpack the archive to eclipse/dropins directory.

*Delete*

You should do following steps to delete Requality that is installed in eclipse/dropins directory:

Run Eclipse with Requality. Set any not-Requality perspective. Close Eclipse.

Delete Requality-directory from eclipse/dropins.

Run Eclipse to update data about installed plugins. Close Eclipse.

*Update*

Delete previous Requality version, then install new version as it described in ''Install'' and ''Delete'' sections.

h1. After installation

After Requality installation it''s recommended to check if browser has been successfully installed to Eclipse.

In Eclipse main menu select ''Window -> Preferences''. In ''Preferences'' select menu ''Requality''. On the right you can see what browser engines are integrated with ''Eclipse'' and which one is currently in use.

!CheckEngine_en.png!

To change active browser engine click on ''Browser Engine'' field and select required one in the drop-down list. Then save changes by ''Apply'' button. After that Eclipse should be restarted for the changes to take effect.

If required browser engine has ''not available'' status in the drop-down list, this means that either you have not installed it yet or the installation has been failed. You can activate only browser engine with status ''available''.