1. Installing R4E
   1. 1) Provision Software Sites
   2. 2) Install Version Control System Features
   3. 3) Install R4E feature
   4. 4) Install Versions Connectors
2. Getting Started
   1. Overview
      1. R4E main interfaces
   2. Starting R4E
   3. R4E Configuration
      1. R4E General Preferences
         1. User Tab
         2. Groups Tab
         3. Rule Sets Tab
         4. Filter Tabs
      2. R4E LDAP Settings
      3. SMTP Hosts Definitions
      4. R4E Capabilities
      5. Version Compatibility
   4. Eclipse Project Configuration
   5. Tutorials
      1. Configuration and Set-up
      2. Tutorial 1: Performing a Basic Review
      3. Tutorial 2: Performing an Informal Review
      4. Tutorial 3: Performing a Formal Review
3. Concepts
   1. Basic and Informal Reviews workflows
      1. Create new review
      2. Identify what needs to be reviewed
      3. Items ready for review
      4. Review item examination, anomaly/time logging
      5. Progress notification
      6. Examine and fix/reject anomalies
      7. Completion notification
      8. Examine and fix/reject anomalies
      9. Mark review completed
   2. Formal Review workflow
      1. Planning Phase
      2. Preparation Phase
      3. Decision Phase
      4. Rework Phase
   3. Author
   4. Anomaly
   5. Comment
   6. Commit Review Item
   7. Delta
   8. File Context
   9. Global Anomaly
   10. Lead
   11. Organizer
   12. Participant
   13. Participants List
   14. Postponed Anomaly
   15. Resource Review Item
   16. Reviewer
   17. Review Group
   18. Review
   19. Review Item
   20. Rule
   21. Rule Set
   22. Rule Area
   23. Rule Violation
   24. Selection
4. Tasks
   1. Working with the Navigator View
      1. Disabling and Restoring Elements
      2. Sorting Review Navigator Elements
      3. Filtering Review Navigator Elements
      4. Setting Elements Reviewed State
      5. Other Review Navigator Commands
   2. Handling Review Groups and Reviews
      1. Creating a Review Group
      2. Opening an Existing Review Group
      3. Creating a Review
      4. Opening and Closing of Review Groups and Reviews
      5. Adding Participants to a Review
      6. Creating a Review Item
         1. Creating a Resource Review Item
         2. Creating a Commit Review Item
      7. Assigning Review Elements
      8. Creating an Anomaly
      9. Cloning an existing Anomaly
      10. Creating Comments on an existing Anomaly
      11. Cloning existing Comments to an Anomaly
      12. Importing Postponed Anomalies
   3. Handling Design Rules
      1. Creating a Rule Set
      2. Importing an Existing Rule Set
      3. Creating a Rule Area
      4. Creating a Rule Violation
      5. Creating a Rule
   4. Working with Editors
   5. Working with R4E Properties
      1. Working with Review Groups Properties
      2. Working with Reviews Properties
      3. Working with Review Items Properties
      4. Working with File Contexts Properties
      5. Working with Selections and Deltas Properties
      6. Working with Anomalies Properties
      7. Working with Comments Properties
      8. Working with Participant Properties
      9. Working with Rule Sets Properties
      10. Working with Rule Areas and Rule Violations Properties
      11. Working with Rules Properties
   6. Using Key Bindings and Hotkeys
      1. Keys
      2. Bindings
   7. Using Notifications
      1. Using Email Notifications
      2. Using Meeting Notifications
   8. Using Statistical Reports
      1. Generating Reports
      2. Report Contents
         1. Report Summary
         2. Review Anomaly Statistics
         3. Review Efficiency Statistics
            1. Review Items
            2. Review Anomalies
            3. Average Time Line
            4. Average Effort per Participant
            5. Total Review Effort
            6. List of Anomalies
   9. Performing Reviews
      1. Performing Basic Reviews
      2. Performing Informal Reviews
      3. Performing Formal Reviews
         1. Planning Phase
         2. Preparation Phase
         3. Decision Phase
         4. Rework Phase
         5. Other Considerations
5. Advanced Topics
   1. Working with multiple patch set of the same commit in a review
6. Updating This Document

# Installing R4E

## 1) Provision Software Sites

R4E uses some Mylyn components so you will need to add the Mylyn Release update site.

Add the following Software Sites to the Eclipse workspace (Help -> Install New Software -> Add)

Mylyn Release: http://download.eclipse.org/mylyn/releases/latest

Mylyn Reviews R4E Updates: http://download.eclipse.org/r4e/updates/

if Subversion is to be used, add the subclipse site of the subclipse version you want to use e.g. http://subclipse.tigris.org/update_1.6.x

## 2) Install Version Control System Features

R4E uses Mylyn Versions to interact with different version control systems.

- Git: Git support is provided by interfacing with Egit/Jgit, Installing the R4E feature automatically installs Egit/Jgit if it's not yet available in the Eclipse installation.So no specific action is needed for Egit installation in this step.

- Subversion (SVN): If there is a need to interact with an SVN repository, install the subclipse feature.Help -> Install New Software, and select the subclipse site provisioned above.

## 3) Install R4E feature

Help -> Install New Software, and select the Mylyn Reviews site provisioned above.

## 4) Install Versions Connectors

Help -> Install New Software, and select the Mylyn Versions site provisioned above.
Select the connector(s) needed to interface your version control system(s).
currently, R4E supports Git and Subclipse connectors.