blob: 6f1ff5533ca5e59883d2ee0f77363f1d8ab3cec9 [file] [log] [blame]
<html>
<body bgcolor="FFFFFF">
<p>&nbsp;</p>
<h2><a name="R4E">R4E 0.10 Release</a></h2>
<table cellpadding="10" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="15%" bgcolor="#E0D0E6">
<p align="right"><b>Initial R4E layout</b></p>
</td>
<td valign="top" width="85%">
<p align="left">This is the first R4E release.</p>
<p><img border="0" src="../new/images/0.10/R4E_screen.png" width="100%"></p>
</td>
</tr>
<tr>
<td colspan="2">
<hr>
</td>
</tr>
<tr>
<td align="left" valign="top" width="15%" bgcolor="#E0D0E6">
<p align="right"><b>Review types </b></p>
</td>
<td valign="top" width="85%">
<p align="left">R4E provides 3 types of reviews:
<ul>
<li> Basic: Anomaly stateless, review is Active or Completed</li>
<li> Informal: Anomaly stateful, review is Active or Completed</li>
<li> Formal: Anomaly and review stateful</li>
</ul>
The review type is defined when you create a new review.</p>
<p><img border="0" src="../new/images/0.10/review_type.png"></p>
</td>
</tr>
<tr>
<td colspan="2">
<hr>
</td>
</tr>
<tr>
<td align="left" valign="top" width="15%" bgcolor="#E0D0E6">
<p align="right"><b>Review Navigator </b></p>
</td>
<td valign="top" width="85%">
<p align="left">A Review Navigator is provided for navigating within the reviews. </p>
<p><img border="0" src="../new/images/0.10/review_navigator.png"></p>
</td>
</tr>
<tr>
<td colspan="2">
<hr>
</td>
</tr>
<tr>
<td align="left" valign="top" width="15%" bgcolor="#E0D0E6">
<p align="right"><b>Review Navigator UI Legend </b></p>
</td>
<td valign="top" width="85%">
<p align="left">Here is a screenshot of the legend that
can be displayed as required while using the navigator. </p>
<p><img border="0" src="../new/images/0.10/R4E_UI_legend.png"width="100%"></p>
</td>
</tr>
<tr>
<td colspan="2">
<hr>
</td>
</tr>
<tr>
<td align="left" valign="top" width="15%" bgcolor="#E0D0E6">
<p align="right"><b>Review Item handling</b></p>
</td>
<td valign="top" width="85%">
<p align="left">R4E Integrates Mylyn Versions Connectors in
order to support multiple Version control
systems. R4E provides support for
SVN and Git. R4E can generate automatically
the review items from the version control system
or generate manual selection from a file
in your workspace.</p>
<p><img border="0" src="../new/images/0.10/svn_Git.png" width="100%"></p>
</td>
</tr>
<tr>
<td colspan="2">
<hr>
</td>
</tr>
<tr>
<td align="left" valign="top" width="15%" bgcolor="#E0D0E6">
<p align="right"><b>Platforms supported</b></p>
</td>
<td valign="top" width="85%">
<p align="left">R4E is validated and supported for Eclipse 3.6.x (Helios),
3.7.x (Indigo) and 4.x (Juno) on the following platforms:
<ul>
<li> Windows Vista 32-bit </li>
<li> Window 7 </li>
<li> Suse Linux Enterprise Desktop 32-bit and 64-bit versions </li>
<li> Solaris 10 </li>
<li> Mac OS X</li>
</ul>
It may run on other platforms, but it has not been verified.
</p>
</td>
</tr>
<tr>
<td colspan="2">
<hr>
</td>
</tr>
<tr>
<td align="left" valign="top" width="15%" bgcolor="#E0D0E6">
<p align="right"><b>Support for adding multiple Participants in batch to a Review</b></p>
</td>
<td valign="top" width="85%">
<p align="left">When using the New Participants dialog, users can now enter
multiple Participants that can be added together
as a batch to a Review. If an LDAP database is configured,
user information will automatically be pulled from
the Database and relevant dialog fields will be auto-filled.</p>
<p><img border="0" src="../new/images/0.10/new_participant.png"></p>
</td>
</tr>
<tr>
<td colspan="2">
<hr>
</td>
</tr>
<tr>
<td align="left" valign="top" width="15%" bgcolor="#E0D0E6">
<p align="right"><b>Improved LDAP Database Users lookups</b></p>
</td>
<td valign="top" width="85%">
<p align="left">It is possible to search for users by using multiple
successive filters to narrow down the query result.
It is also possible to add multiple users together to a review. </p>
<p><img border="0" src="../new/images/0.10/find_user_dialogue.png" width="100%"></p>
</td>
</tr>
<tr>
<td colspan="2">
<hr>
</td>
</tr>
<tr>
<td align="left" valign="top" width="15%" bgcolor="#E0D0E6">
<p align="right"><b>Participants Lists</b></p>
</td>
<td valign="top" width="85%">
<p align="left">R4E adds support for Participants Lists. Participants Lists
are similar to mailing lists and provide a way for the users
to bundle together selected users (and their email addresses)
under a single list that can be added as a whole to a Review.
When adding such a list to a Review, all the Users included
in the list will be added to the Review. Participants
Lists can be defined in the R4E User Preferences. </p>
<p><img border="0" src="../new/images/0.10/R4E_user_preference.png" width="100%"></p>
</td>
</tr>
<tr>
<td colspan="2">
<hr>
</td>
</tr>
<tr>
<td align="left" valign="top" width="15%" bgcolor="#E0D0E6">
<p align="right"><b>Assigning Participants to Review Items, Files and Changes</b></p>
</td>
<td valign="top" width="85%">
<p align="left">It is possible in R4E to assign specific Review Items,
File Contexts and Changes (Delta/Selections) to specific
participants to split the review among multiple reviewers.
The users can also filter the Review Navigator view to
only see the elements assigned to a particular participant.</p>
<p><img border="0" src="../new/images/0.10/assign_participant.png"></p>
<p><img border="0" src="../new/images/0.10/review_item_property.png" width="100%"></p>
</td>
</tr>
<tr>
<td colspan="2">
<hr>
</td>
</tr>
<tr>
<td align="left" valign="top" width="15%" bgcolor="#E0D0E6">
<p align="right"><b>Navigator View Alternative Display</b></p>
</td>
<td valign="top" width="85%">
<p align="left">Review Navigator View has two ways to display the
Review elements:
<ul>
<li>tree view </li>
<li>table view </li>
</ul>
The table format displays the currently
active review items and files, including file name,
path, assignees, number of changes and number of
anomalies as shown below. Elements can be sorted
using the table columns headers and the representation
can be switched between the original and the
alternative one using the new Change Display
view toolbar button.</p>
<p><img border="0" src="../new/images/0.10/ReviewNavigatorViewAlternateDisplay.png" width="100%"></p>
</td>
</tr>
<tr>
<td colspan="2">
<hr>
</td>
</tr>
<tr>
<td align="left" valign="top" width="15%" bgcolor="#E0D0E6">
<p align="right"><b>Anomaly creation</b></p>
</td>
<td valign="top" width="85%">
<p align="left">The dialogue allow you to define mandatory and optional
information concerning the issue.</p>
<p><img border="0" src="../new/images/0.10/anomaly_creation.png"></p>
</td>
</tr>
<tr>
<td colspan="2">
<hr>
</td>
</tr>
<tr>
<td align="left" valign="top" width="15%" bgcolor="#E0D0E6">
<p align="right"><b>Anomaly Rejection shall include a mandatory comment</b></p>
</td>
<td valign="top" width="85%">
<p align="left">The reason for rejection requires a new comment from
the user upon transitioning to the REJECT state.</p>
<p><img border="0" src="../new/images/0.10/reason_for_rejection.png"></p>
</td>
</tr>
<tr>
<td colspan="2">
<hr>
</td>
</tr>
<tr>
<td align="left" valign="top" width="15%" bgcolor="#E0D0E6">
<p align="right"><b>Postponed Anomalies</b></p>
</td>
<td valign="top" width="85%">
<p align="left">Import anomalies from a review having the same files and
the anomaly was saved as "Postponed" in the previous review.
e.g. Reference
to original review is available at the anomaly level.</p>
<p><img border="0" src="../new/images/0.10/import_anomalies.png"></p>
</td>
</tr>
<tr>
<td colspan="2">
<hr>
</td>
</tr>
<tr>
<td align="left" valign="top" width="15%" bgcolor="#E0D0E6">
<p align="right"><b>R4E property view</b></p>
</td>
<td valign="top" width="85%">
<p align="left">R4E properties view is used in conjunction with the navigator view.
Depending of the selected items in the R4E navigator view,
some fields are adjusted from the property view.</p>
<p><img border="0" src="../new/images/0.10/property_view.png"></p>
<p align="left">It's possible to copy R4E properties from the Eclipse
properties view e.g. Absolute path, Project Relative Path, etc...</p>
<p><img border="0" src="../new/images/0.10/copy_from_property.png"></p>
</td>
</tr>
<tr>
<td colspan="2">
<hr>
</td>
</tr>
<tr>
<td align="left" valign="top" width="15%" bgcolor="#E0D0E6">
<p align="right"><b>Short keys</b></p>
</td>
<td valign="top" width="85%">
<p align="left">R4E defines some keys as accelerator keys to help the user
to perform reviews. Each command starts with ALT + 4 as below: </p>
<p><img border="0" src="../new/images/0.10/short_key.png"></p>
</td>
</tr>
<tr>
<td colspan="2">
<hr>
</td>
</tr>
<tr>
<td align="left" valign="top" width="15%" bgcolor="#E0D0E6">
<p align="right"><b>Design Rules</b></p>
</td>
<td valign="top" width="85%">
<p align="left">R4E support the use of Design Rules, to help
reviewers enforce consistent design conventions
and rules. A Rule Set is a container that includes
multiple related Rules. Rule Sets are independently
defined and can be shared among multiple Review
Groups. Take note that the use of Design Rules is
completely optional. When you create a new Rule Set,
its references are automatically included in your
workspace. To import other Rule Set references, open
the R4E Preference Rule Sets Tab.</p>
<p><img border="0" src="../new/images/0.10/create_rule_set.png"></p>
<p>This opens the New Rule dialog.</p>
<p><img border="0" src="../new/images/0.10/details_rule_set.png"></p>
</td>
</tr>
<tr>
<td colspan="2">
<hr>
</td>
</tr>
<tr>
<td align="left" valign="top" width="15%" bgcolor="#E0D0E6">
<p align="right"><b>Disable/Restore elements</b></p>
</td>
<td valign="top" width="85%">
<p align="left">When Review Navigator elements are not relevant anymore
(e.g. completed reviews), they can be removed from the
view by using the ''Disable ''command from the element's
context menu.<br>
Ideally, disabled elements should never be shown, but
there could be a need to restore mistakenly disabled elements.
To do so, first go to the Eclipse preferences R4E page, on the
Filters tab and enable the Show Disabled Elements filter,
then return to the Navigator view and select the ''Restore ''
command from the disabled element context menu.
</p>
<p><img border="0" src="../new/images/0.10/disable.png"></p>
</td>
</tr>
<tr>
<td colspan="2">
<hr>
</td>
</tr>
<tr>
<td align="left" valign="top" width="15%" bgcolor="#E0D0E6">
<p align="right"><b>Filters and sorters</b></p>
</td>
<td valign="top" width="85%">
<p align="left">The Navigator elements can currently be sorted alphabetically
or by review type, by selecting the appropriate sorter in the
Review Navigator Toolbar menu.<br>
The Navigator view provides also different filters that
can be used to limit the visibility of elements within
the navigator tree. Filters are available in the
Review Navigator Toolbar menu. If you select the "Go Into" option,
it will focus on a particular element and its children. This is a
special filter that will take the selected element of the Navigator
and put it at the root of the Navigator tree.
</p>
<p><img border="0" src="../new/images/0.10/filter_and_sorter.png"></p>
</td>
</tr>
<tr>
<td colspan="2">
<hr>
</td>
</tr>
<tr>
<td align="left" valign="top" width="15%" bgcolor="#E0D0E6">
<p align="right"><b>Email notifications</b></p>
</td>
<td valign="top" width="85%">
<p align="left">E-mail notification can be sent on Review Navigator
elements by using the Send Email/Notification
command from the selected element context menu.
Once the command is triggered, a dialog appears
asking the kind of notification to be sent. Take
note that not all the options are available depending
on the element selected, the review type and other factors.
A notification can be sent to other review participants. </p>
<p><img border="0" src="../new/images/0.10/notification.png"></p>
</td>
</tr>
<tr>
<td colspan="2">
<hr>
</td>
</tr>
<tr>
<td align="left" valign="top" width="15%" bgcolor="#E0D0E6">
<p align="right"><b>Reports</b></p>
</td>
<td valign="top" width="85%">
<p align="left">To generate a statistical report, select in the
Review Navigator view one or more review, the
right click and select "Generate Report".
Two types of report can be generated.
<ul>
<li> Inspection record: when you select only one review
to generate a report, this type of report will be
initiated. You will see a list of anomalies at the end
of the report.</li>
<li> Global report: when two or more review are selected.
It gives a summary of information based on the selected reviews. </li>
</ul>
</p>
<p><img border="0" src="../new/images/0.10/inspection_report.png" width="100%"></p>
</td>
</tr>
<tr>
<td colspan="2">
<hr>
</td>
</tr>
<tr>
<td align="left" valign="top" width="15%" bgcolor="#E0D0E6">
<p align="right"><b>Issues and Limitations</b></p>
</td>
<td valign="top" width="85%">
<p align="left">It is strongly recommended to run Eclipse with a
JRE1.6 virtual machine or later. R4E is also supported
in Eclipse running JRE1.5, but the Send Meeting Request
Notification functionality will not work if using the
SMTP mail extension.</p>
</td>
</tr>
</table>
</body>
</html>