Chapter 15. Menu

15.1.  Project

15.1.1.  Open ...

(ProjectOpen ...)

Use this menu item to open a review project (xml or qrx files).
[See] Load An Existing Project

15.1.2.  Join ...

(ProjectJoin ...)

Use this menu item to join different project files (can be export files as well), which depend to the same review.
This is necessary e.g. if the project file has been sent to different reviews by email, so the results can be stored in one review sheet again.
[See] Load An Existing Project

15.1.3.  Find Open Projects ...

(ProjectFind Open Projects ...)

The menu item opens the Find Open Projects dialog which lets you search for unfinished reviews.
[Tip]Tip
The search for open projects can be started via command line options as well (e.g. java -jar QuickRev.jar -find .). For more information take a look at the Command Line Options.

Figure 15.1. Find Open Projects - dialog

Find Open Projects - dialog

  1. Define start path
    To define the path where the search for open projects has start make use of the Add, Edit and Delete buttons and select the path from Directory list.

  2. Start search
    To start the search click the Find Open Projects button. Make use of the Recursive check box, to define whether the search has to be performed recursively or not.

  3. Select found project
    The found projects will be shown in the table. There is one tab for the current user (named with the user name) and one tab for other users (named Others). The brackets behind the user name or Others define the number of found unfinished projects. To open a project either double click on the project or select it and press the OK button.

  4. Exclude Directories
    To speed up the search directories can be excluded from the search via regular expressions. Click the Exclude Directories ... button and add some regular expressions to it. Note, the given pattern matches if a part of a path contains the pattern, so e.g. 'test' excludes all paths containing the phrase 'test'.

  5. Refresh
    Refresh removes all projects from the table, which are finished in the meanwhile. This is useful, if the search for open projects was started, one was selected and finished and now the dialog is opened again to select the next unfinished review. So no new search is needed, the table items will just be cleaned up.

15.1.4.  Recent Projects

(ProjectRecent Projects)

Opens a list with the last opened projects to select them easily for opening.

15.1.5.  Save

(ProjectSave)

Saves the loaded project (even in case an export file was loaded).
This menu item is enabled only if changes have been made.

15.1.6.  Save As ...

(ProjectSave As ...)

Saves the project for the first time or under a different name.

15.1.7.  Reload

(ProjectReload)

Reloads to current project. This can be useful if the project file is under version control and another reviewer has added comments in between.
The reloading of the project can be triggered via the tools menu as well. So it can be combined with an update of the project file.
[See]See Example Tools for a reload example.

15.1.8.  Close

(ProjectClose)

Closes the currently opened project. If no project has been loaded or the project has never been saved all values will be reset (but QuickRev asks before).

15.1.9.  Export ...

(ProjectExport ...)

Use this menu item to export a project.
[See] Export A Project (qrx-files)

15.1.10.  Add File ...

(ProjectAdd File ...)

Use this menu item to add new files to the project.
Note: the selected review phase has to be Creation to add new files. For more information about this menu item and other possibilities to add new files refer to chapter Create A New Project.

15.1.11.  Add Files From Changeset ...

(ProjectAdd Files From Changeset ...)

15.1.12.  Reload File Versions

(ProjectReload File Versions)

Updates the version history of all files added to the project, this can be helpful if new versions have been created while QuickRev was running already.
A limit of file versions configured via the Preferences dialog will not be taken into account. To reload the version history of individual files only, use the Reload button assigned to each file at the File References tab.

15.1.13.  Create New Review Cycle (<name of new cycle>) ...

(ProjectCreate New Review Cycle (<name of new cycle>) ...)

Use this menu item to create a new review cycle.
[See] Create new review cycle

15.1.14.  Verify Input ...

(ProjectVerify Input ...)

The Verify Input menu opens the Input Verification dialog which shows you whether there are input fields where no value has been given yet or if everything is fine. The links will lead you to the components which have to be filled out. The Input Verification dialog can be used even with the user defined tools. See chapter Tools for more information about the tools.

Figure 15.8. Input Verification Dialog showing incomplete input

Input Verification Dialog showing incomplete input

Figure 15.9. Input Verification Dialog when everything is OK

Input Verification Dialog when everything is OK

15.1.15.  Review History

(ProjectReview History)

15.1.15.1.  Update History

(ProjectReview HistoryUpdate History)
If the review history has been configured via the menu ProjectReview HistoryConfigure History ... the history database can be updated here.
The menu starts the search for new project files in the configured directories and updates the history database accordingly. Make use of this menu if new projects have been added to your review directory while working with QuickRev or generally if you disabled the auto load functionality during startup of QuickRev.

[See] Configure History ... for configuration of this history database and startup behaviour.

15.1.15.2.  Configure History ...

(ProjectReview HistoryConfigure History ...)

QuickRev can be configured to automatically load the review history of the review files assigned to the project. For doing this QuickRev has to know where the project files are located. Furthermore it can be configured to automatically add new project files to the review history and to automatically select the last reviewed version of a file as base version for a new review.

Menu ProjectReview HistoryConfigure History ... opens the History Configuration dialog which lets you specify the behaviour of the history functionality and configure the history database so that QuickRev knows where the project files can be found.
The history database stores the information where the project files are located and information about open reviews to be shown in the Task List.

Figure 15.10. Review History Configuration (Main Options)

Review History Configuration (Main Options)

The Main Options tab lets you configure the following behaviour.
  1. Select, to automatically update projects in the history database for the configured review directories during startup of QuickRev. The update will be performed in background. (To start the update manually use menu ProjectReview HistoryUpdate History.)

  2. Select, to add new created and loaded projects and the corresponding path to the review history, to be taken into account for later reviews.

  3. Select, to automatically select the base version when adding new files to a review. The selected base version is the latest reviewed version found in the history database.

  4. The history functions can be disabled via this check box. This includes the Task List feature as well.

Figure 15.11. Review History Configuration (Database Configuration)

Review History Configuration (Database Configuration)

The History DB tab lets you configure the history database. Everything what can be configured here can be done via command line options as well.
[See]See Command Line Options for more information about the command line options.
  1. Select directories to be added to the history-DB. All project files found in the added directories will be added to the history-DB as well.

  2. Select a directory to start a recursive search for directories which contain project files to be added to the history-DB. All project files found in the added directories will be added to the history-DB as well. Make use of the Exclude Paths button to define directories which have to be excluded from search (performance boost).

  3. Select a directory to start a recursive search for directories with the defined name to be added to the history-DB. All project files found in the added directories will be added to the history-DB as well. Make use of the Exclude Paths button to define directories which have to be excluded from search (performance boost).

  4. Searches in all directories known in the history-DB for review files and adds or updates the found review files. This is the same as using the menu ProjectReview HistoryUpdate History.

  5. Select directories to be removed from the history-DB. All sub directories and project files contained in these directories will be removed from the history-DB as well. Alternatively you can use the Directory tab to show all directories contained in the history-DB and select the directories to be removed.

  6. Remove all project files and directories from the history-DB which cannot be found in the local file system.

  7. Remove all project files and directories from the history-DB.

  8. Define paths which have to be ignored during search of review directories.
    The same exclude paths will be used for menu ProjectFind Open Projects ....

    [Configuration]Configuration
    Default values for the paths to be excluded from search can be configured via configuration files.

Figure 15.12. Review History Configuration (Directory View)

Review History Configuration (Directory View)

Use the Directories tab to show or delete review directories stored in the history database.
  1. Use the Refresh button to show all directories stored in the history-DB. To delete directories and all sub-directories select the directory and use the Remove Selected Directories buttons.

    [Note]Note
    The directories stored in the history-DB are the directories which contain the project files. So after removing such a directory the parent directories might disappear as well, if they are not added explicitly as review directory.

  2. Use the directory view to navigate and select the directories to be removed.

15.1.16.  Preferences ...

(ProjectPreferences ...)

This menu item opens the Preferences dialog, which shows the preferences which can be changed by the user. These settings will be stored in a separate configuration file (.quickRev/config/main) in the users home directory. Most values can be predefined in configuration files.

The following topics are covered by the Preferences dialog.

15.1.16.1.  General

(ProjectPreferences ...General)

This tab allows changes of general preferences.

Figure 15.13. General Preferences

General Preferences

  1. Here you can change the user name and email address of the default user.

  2. Select Use Side-By-Side Diff and Ignore White Spaces to define the default behavior if a review file is selected for delta-review or changes in a follow-up review cycle have to be shown. These settings can be changed in the context menu of the diff window individually for each review file.

    To make tabs and spaces visible use option Show Tabs And White Spaces.

    To get rid of the comment tool tips select Disable Comment Tool Tips.

    To show the file annotations (blame) for every single code line (about the author who changed this line or the version of last change) by default select the Show Annotations About Author and/or Show Annotations About Version.

    To change the tab width change the value of Tab Width. Note: the change of the tab width will take affect after a restart of QuickRev only.

    Change the value of Font Size to change the font size of the diff windows.

    Change the value of Scroll Width to define a different number of lines to scroll with the scroll bar or mouse wheel.

    To show a print margin in the diff window select Show Print Margins and select the column where to show the print margin.

  3. To hide completed comments (all fields are filled out) automatically during the Correction phase select one of the following items from the Auto Hide Completed Comments list.

    1. never - disables this option

    2. always - hides the completed comment as soon as the comment is accepted

    3. if all references are marked as hidden - hides the completed comment if all references are marked as hidden

    4. if all references are marked as hidden or there is just one reference - hides the completed comment if all references are marked as hidden or there is just one reference to this comment

    This can be helpful when working in comments, so the comments which have been worked in will be hidden until no comment is visible anymore. The hiding of the comments will take place when the Accept button in the Comments dialog has been pressed.

    Select Auto Hide Comments Where All References Have Been Marked As Hidden, to automatically hide a comment from the Comments dialog if all references to this comment have been marked as hidden. This function is independent from any review phase.
    Note: this function is restricted to comments with completed information.

    Select Save Project On 'Accept' Or 'OK' Button to additionally save the project if the 'Accept' or 'OK' button in the comment dialog was pressed.

  4. For different features QuickRev will show you a hint about how and when to use it (something like a tip of the day). The messages can be disabled permanently via a corresponding checkbox in the message. To enable all these disabled message again use the Reset button.

[See] Changing some of the settings via configuration files

15.1.16.2.  Version Control Systems

(ProjectPreferences ...Version Control Systems)

This tab allows changing the settings of the used version control systems.

Figure 15.14. Version Control Systems Preferences

Version Control Systems Preferences

The path to the clients of the version control systems have to be given at this page.

Version control systems which are not needed can be disabled via the corresponding check boxes. I.e. if a new file is assigned to a review QuickRev tries the available version control systems to find out the version information of the file. Disabling a version control system may increase the performance.

If additional arguments have to be applied to the commands (e.g. username) they can be assigned in the Arguments field.

If Load Annotations is selected, the annotations of a file (blame) will be loaded by default, so they are available if the annotations shall be shown and do not have to be reloaded afterwards. Since the loading of annotations may need more time than loading the file content only, this can be disabled here.
Note: If Show Annotations About Autor / Version is selected on the General tab the annotations will be loaded nevertheless even if the corresponding fields are not selected here.

If the user name differs from the user name used for QuickRev the user name for the version control systems can be defined in the User field. This is useful to be able to select a file version by user name.

For GIT the path to the local GIT Repository has to be defined here.

The number of version loaded per file can be limited by specifying an individual File Version Count, this may lead to increased performance during loading of the file information.

Path Mapping
For ClearCase path mapping can be enabled, which is useful, if the ClearCase VOBs of different users are mapped to different locations (drives). So even if one user used Windows and another one used linux reviews between the different operating systems can be performed. After enabling the Path Mapping functionality the local path has to be defined in the Local Path field. In the External field(s) all the pathes used by other reviewers have to be defined. To add a new external path use the Add External Path button. When saving your project files you can decide, which path will be stored in the project file. Select the local path to always store your local path in the review sheet, select an external path to use this path or select Preserve Path, which stores the path which has been in the project file when opening it (during creation it will be the local path).
[See] Changing the settings via configuration files

15.1.16.3.  Default Comments

(ProjectPreferences ...Default Comments)

This tab allows creation of default comments to be applied easily.

Figure 15.15. Default Comments Preferences

Default Comments Preferences

Default comments can be assigned to the review files via the context menu.

To create a new default comment click the new button and insert a name. The name will be used in the context menu to select a default comment. Select a severity, insert the comment text and if checklists are loaded select a rule from the checklist (if any). The comment text can be formatted via the context menu.

15.1.16.4.  Default Solutions

(ProjectPreferences ...Default Solutions)

This tab allows creation of default solutions to be applied easily.

Figure 15.16. Default Solutions Preferences

Default Solutions Preferences

Default solutions can be assigned to every state, to be inserted in the solution text of a comment directly. To create a new default solution click the new button, insert a name and select a state the default solution is assigned to. The name will be used as postfix in the state selection combo box. The solution can be formatted via the context menu.

15.1.16.5.  Syntax Highlighting

(ProjectPreferences ...Syntax Highlighting)

This tab allows changing the file extensions, colors and font styles of syntax highlighting.

Figure 15.17. Syntax Highlighting Preferences

Syntax Highlighting Preferences

At the syntax highlighting page you can change the colors, font style and default file extensions for the available highlighters.

15.1.16.6.  UML

(ProjectPreferences ...UML)
This tab allows changing the settings for UML diagrams.
Note that a corresponding plug-in has to be loaded to view UML diagram.

Figure 15.18. UML Preferences

UML Preferences

15.1.16.7.  Email Client Settings

(ProjectPreferences ...Email Client Settings)

This tab allows changing the email client settings.

Figure 15.19. Email Client Preferences

Email Client Preferences

For using the email notification functionality the email client has to be configured first. QuickRev uses JavaMail to send the email by use of the SMTP-protocol. The preferences dialog shows a list of all configured properties, where the value of mail.host has to be replaced with your host-name and the mail.user with your email user name. If an authorization if required for sending emails set the value of mail.smtp.auth to true.

It is best to configure the general settings in a configuration file, which can be loaded when starting QuickRev or used as built-in configuration file. So not every user has to specify these settings.

Additional properties (such as using TLS) can be found of the following JavaMail documentation pages:
[See] http://java.sun.com/products/javamail/javadocs/javax/mail/package-summary.html#package_description
[See] http://java.sun.com/products/javamail/javadocs/com/sun/mail/smtp/package-summary.html#package_description


To get more information during configuring the properties you can set mail.debug to true, which results in more debug information written to standard out, so start QuickRev from console to see the debug information.
[See] Changing the settings via configuration files.

15.1.16.8.  Email Notification

(ProjectPreferences ...Email Notification)

This tab allows changing the templates for email notifications.

Figure 15.20. Email Notification Preferences

Email Notification Preferences

At the Email Notification tab you can define two different email templates which will be used depending on whether you are in the role of initiator or reviewer. To specify the templates there are different placeholders, which will be replaced by QuickRev when sending the email.

To insert the placeholders make use of the context menu.

Figure 15.21. Email Placeholders

Email Placeholders

Use the Show List Of Placeholders link to show this dialog.
[See] Defining default email templates via configuration files.

15.1.16.9.  Users

(ProjectPreferences ...Users)

This tab allows changing the users to be assigned to the review as reviewers and to send email notifications to.

Figure 15.22. Users Preferences

Users Preferences

Users and their email addresses can be defined either generally via configuration files or in this dialog. Users defined in configuration files can not be deleted within the dialog.
[See] Defining users via configuration files

15.1.16.10.  Config

(ProjectPreferences ...Config)

This tab shows some configuration values read from configuration files which cannot be changed and allows changing of others.

Figure 15.23. Config Preferences

Config Preferences

Stylesheet lets you define the path to the stylesheet referenced from the saved project files.

For files which cannot be displayed in QuickRev you can defined the file extensions of these files under Non Text File Extensions.
[See] Changing the settings via configuration files.

15.1.17.  Exit

(ProjectExit)

Quits QuickRev.

Get QuickRev at SourceForge.net. Fast, secure and Free Open Source software downloadsCopyright 2008 - 2016 Tom SeidelLast Update: 2016-11-5