File Reviews Window Pane

This window pane lets you work with review documents (topics and snippets) that you have received from others. There are a couple of processes that you can use for Flare topic reviews and collaboration.

  • Central Reviews (Recommended) Flare supports review packages (i.e., bundling files such as topics and snippets) and lets you send those packages to Central to be reviewed by others. After editing and annotating the files in Central's Review Editor, the reviewers submit the finished files, sending them back to your inbox in Flare. You can then accept or reject their changes and accept the file, replacing the original source file. Because this system uses the cloud, reviewers do not need to download any software to review your files. Also, multiple reviewers can edit the same file at the same time. See Central Review Process.
  • Contributor Reviews The review process lets you send Flare files for review and receive file contributions from SMEs and other Flare authors. Non-Flare users can download a separate application called MadCap Contributor when collaborating with you and your Flare project. You can also use the same features to send files for review to other Flare authors using Flare only. See Reviews and Contributions With MadCap Contributor.

[Menu Proxy — Headings — Online — Depth3 ]

Inbox and Sent Topics

There are two different views in the window pane. The information in the window pane changes, depending on the view you select.

  • Inbox This view shows files that reviewers have returned to you.
  • Sent Files This view shows topics and snippets that you have sent for review.

To switch from one view to another, click the drop-down field at the top of the window pane and make your selection.

Toolbars

This window pane can be used for either Central file reviews or for review packages. Some of the options are available for only one process or the other. Following are the options that you will see in the Inbox and Sent Files views.

Item

Description

View

Process

Lets you switch from viewing “My” files to “All” files. In other words, you can choose to see only the files that you have added to the review, or you can see all files that you and other Flare authors have selected for review. This filter is applicable only to Central reviews; it is not relevant to Contributor reviews.

Both

Central Reviews

Refresh the active window pane.

Refreshes the window pane so that the latest information is shown.

Both

Both

Use delete to empty contents.

Deletes the selection.

Both

Both

Open

Opens a dialog asking if you want to move the files to a closed state. Select yes to close the file. Select no to preview the file as a read only file; edits can still occur until it is accepted.

Both

Both

Opens the source topic in the XML Editor.

Inbox

Both

Lets you accept the reviewed file. After accepting the file, it overwrites the source file in your project. Any edits or annotations (i.e., comments) in the reviewed file therefore become part of the original file. See Accepting Reviewed Files.

Inbox

Both

Closes the review process for the selected files. This action pertains only to Central reviews, not to Contributor reviews. After a file is closed for review, it means the file can no longer be edited on Central. You can then accept or reject any changes to the file in the editor, then accept the file back into the Flare project. See Closing Central Review Files.

Both

Central Reviews

Opens a dialog that lets you import reviewed files into the Inbox of the File Reviews window pane. This option pertains to Contributor reviews, not to Central reviews. See Importing Reviewed Files.

Inbox

Contributor Reviews

Grid

Following are the columns for the grid in the File Reviews window pane. As with the toolbar, some of the columns are available for only one process or the other. Also, the columns that you see are based on the view—Inbox or Sent Files.

Item

Description

View

Process

[Process Icon]

Indicates which process the file is being used for the file review:

Central review file

Review package file

Both

Both

[File Type Icon]

Indicates the type of file:

Topic file (the icon may be different, based on your default browser)

Snippet file

Both

Both

Status

Indicates the status of file in the Central review process:

  • Submitted The file has been submitted by all reviewers on Central. The next step is for the author to close out the review process for the file.
  • Closed The review process for the file has been closed, which means no more edits can take place for the file on Central, unless the author sends it out again for review. After a file is closed, it can then be opened in Flare so that the changes can be accepted or rejected. After that, the file can be accepted back into Flare, replacing the original source file.

Inbox

Central Reviews

Info

Indicates whether local changes have been made to the file.

Both

Both

File

Indicates the name of the topic or snippet file.

Both

Both

Package

Indicates the name of the review package file.

Both

Review Packages

Changes

Indicates the number of changes made.

Inbox

Both

Annotations

Indicates the number of annotations in the file.

Inbox

Both

Sent

Indicates when the file was sent for review.

Sent Files

Both

Received

Indicates when you received the file (after you close it out of the Central review process).

Both

Both

Send Date

Indicates when the file was sent for review.

Inbox

Both

Reviewers

Indicates the users who have been selected to review the file.

Both

Both

Path

Indicates the path of the file in the Flare project.

Both

Both