Create a review file

Overview

Before starting a review, create a review file to register the review information.
To conduct a review, create a review file using the following procedure.

1. Create a review file
   Prepare a review file to register review information.

2. Set basic review information
   Register basic information such as the purpose of the review file and the review format.

3. Register documents to be reviewed
   Register documents to be reviewed in the review file.

Create a review file

Create a review file using one of the following methods.

• Create a new review file
  

  1. Create a review file from the [File]-[New] menu.
     
  2. Create a review file from [New] under [Start a review] on the start page.

In both methods, you need to define information about review participants and attributes of comments.

• Copy the review file for the template
  This method defines the information of the review participants and the attributes of the comments in the review file in advance and then duplicates them.
  This is recommended because you do not need to define it every time you review, and you can start the review immediately.
  

We recommend that you store the review file you created in the workspace folder so that other members can open it.

Set the basic information of the review

For the contents and procedures to set in the review file, please refer to the following link: Set the basic information of the review

Register the document to be reviewed

You can register the document to be reviewed in the following three ways.

Register manually

Register the document manually using the following method.

1. Click ① and add "Document".
2. Click ② and enter the chapter structure in the document.

This is useful when there is no file to review or when you want to keep a provisional record.

Drop onto the "Outline Tree"

Drop the file to review onto the outline tree to register it as a document.
In addition, a link to the file is automatically set.
You can start reviewing right away without having to go through the trouble of registering files and setting links.

When you register a file stored in a workspace folder, other members can access the file to be reviewed from the review file.

Add from a link on the clipboard

You can add a document from a file path or other information copied to the clipboard by following the steps below.

1. Copy the file path or URL to the clipboard in advance.
2. Right-click on the "Outline Tree".
3. Select "Add document from clipboard link".
   

Set related links to documents

You can set a URL or file path to a registered document and associate it with the document.

You can open the associated file with one click.

• By associating the deliverables before and after the revision, you can quickly check the contents before and after the revision.
  You can set up to five links, so you can register related materials and check them smoothly.
• You can edit or delete the links you set later.

Right-click the target document to set it and select the operation you want to perform.

By naming it, you can easily find the document you want to check.
You can also set the following, so please use it according to your operation.

Setting the relative path

The document path is also recorded as a relative path from the review file.

If the relative path from the review file to the document being reviewed does not change,
you can jump to the document link, so the review can proceed smoothly in the following cases.

• When the path changes when moving an entire folder in a shared folder
• When the review file and the document being reviewed are managed in the same repository using GitHub or Subversion

Even if you register with an absolute path, the relative path is automatically saved, so there is no need to be concerned about whether it is a relative path or absolute path.

Setting the URL

You can set a URL for the document, so you can also associate the following documents.

• Documents stored in cloud services
• Documents registered in configuration management tools such as "Subversion" and "GitHub"
• URLs for homepages, etc.

By setting a URL for a document, you can quickly check the results by using the button to automatically launch a browser and display the document.

Adding a document outline

Not only documents, but also internal chapter structures, etc. can be added as outlines.

You can create an outline with one click if the following conditions are met.

• The document is associated with a file.
  For details, see the following link: "Set associated links to document"

• The file format is as follows.

  File format	Extension(*1)	Link to details
  Microsoft Office documents (Word, Excel, PowerPoint)	Not required
  PDF files	Not required
  Source code (C, C++, C#, Java, Python, VB.NET, Typescript)	Not required
  Markdown format files	Required	*
  Next Design project files	Required	*

  *1 If the extension is "not required", you can use it by installing Lightning Review.

Select the target file, right-click and select "Create outline from document".

You can also create an outline manually.

Please refer to the following link for instructions.
"Register a file manually"

Opening a document

By opening the link set in the document from the button on the registered document, you can reduce the effort of opening documents required for review, such as the document to be reviewed or the input document.

Notes

• If a URL is set in the link, the page will be opened in the browser, but an outline will not be created.
  
• If the URL link destination is an Office document, etc., the file will be downloaded from the browser.

Sharing a review file

You can share the review file you created with other users.
Multiple people can register comments on the same file at the same time.

Preparations

1. Select "Share reviews" from the "Tools" menu.
2. Check "Allow multiple users to edit and share reviews simultaneously."
   

Review execution

By saving the review file, the contents saved by other users will be reflected on the screen.

• There is no need to restart LR.
• If the same issue is edited simultaneously, the contents of the issue saved last will be reflected.

It can be used in the same way as sharing Excel files.

Restoring issues deleted while sharing

Information about issues deleted while in share mode remains in the review file.
Indications that have been accidentally deleted can be restored using the method at the following link.

• "Troubleshooting: I accidentally deleted a comment in the review file"

Even if you intentionally deleted a comment, the information remains in the review file.

If you delete many comments, the file size may become large.

• In that case, turn off sharing mode and save the review file.
  The file size will become smaller because the information about the deleted file will also be deleted.
• After that, turn on sharing mode again.