Getting Started


If you have not already done what is described in Before you begin, it is time to do it.

Logiscope Commands

Once the Logiscope Plug-in is installed and configured, a new Logiscope item is available in the main menu bar with 2 available commands:

                Logiscope menu

The Logiscope menu and commands are also available in the project popup menu (select a project and right click) as well as in the main tool bar of Eclipse:

                Logiscope commands

These 2 Logiscope commands are only available when a project is selected or any other resource from which the project can be known.

Checking programming rules on a project

To find programming rule violations in the source files of the selected project, use the menu Logiscope > Rule Checker or click on the RuleChecker command command.

During the check, Logiscope opens a console named Logiscope. If the console does not open automatically you can open it using the command Window > Show View > Console.
If warnings or errors should occur during the check, this would be reported in the console.
 
Once the check is finished, the Problems view is populated with all the rule violations found in the source files.
Use the standard Eclipse problems filtering mechanisms to show or hide Logiscope RuleChecker violations.

Browsing rules violations

Once the check is finished, the Problems view looks like:

                Problems view

Double click on a problem line opens the corresponding file editor, highlighting the line of the violation and showing violations with markers in the document margin:

                Markers in File Editor

Generating a Logiscope RuleChecker html report

Once the check is finished, the link Logiscope Rule Report.html is added to the project, at the top level. This is a link to the standard Logiscope RuleChecker report: i.e. the html rule report produced by default from Logiscope Studio.
To open it, use the popup menu Open With > Web Browser.

Opening Logiscope Studio on your project

Once the check is finished, the link Logiscope Rule Project.ttp is added to the project, at the top level. This is a link to the Logiscope RuleChecker project associated to your project.
On Windows, double click on the link will open Logiscope Studio on the project.

Logiscope RuleChecker Quick Fix

By default Logiscope Plug-in is configured to support rule violation relaxations. Logiscope Quick Fix allows to relax a rule violation in a very simple way.
  1. Right click on a violation marker in the text editor.
  2. Choose Quick Fix menu:

    Right click on marker

  3. Click on Justify and Relax violation of <mnemonic of the rule>:

    Quick Fix menuLogisc

  4. Enter a text explaining why the violation to the rule should be relaxed:

    Justify dialog

  5. Press the OK button
  6. The relaxation text is automatically inserted into the source file as a comment:

    Source code

  7. The violation marker is now removed. During the next check, the violation will be ignored.

Removing Logiscope results from your project

When a project has been checked by Logiscope, the following Logiscope information is present:
It is possible to remove all the information from the project. To do so, just use the menu Logiscope > Clean or click on the Clean Command command.


Licensed Materials – Property of Kalimetrix (c) Copyright Kalimetrix 2014. All Rights Reserved.