How to Review Other Document Types
Who is this article for?Review Authors reviewing other document types in the classic interface.
Please Review Administrators can define user types for document reviewing.
The following article will explain how to review other document types in the classic interface. However, this article won't show how to review word, excel or PDF documents. For more information on this, please visit Further Reading.
- Reviewing PowerPoint
- Reviewing Images
- Reviewing Plain Text
- Reviewing Source Code
- Split Screen View
- Unrecognised Document Types
- Further Reading
Reviewing PowerPoint
PowerPoint slides are displayed as images and the image functionality applies. Slide notes are displayed as text and allow comments and proposed changes in the usual way.
Reviewing Images
To make a comment simply click on the image in the location where you want the comment to appear. The comment window will then open.
Reviewing Plain Text
To make a comment simply click on the line you wish to comment upon. The comment window will then open.
Plain text files will show proposed changes as mark-up in the document.
Reviewing Source Code
Please Review supports the review of source code (and other plain text file types) directly through the standard Please Review interface. C, C++, C#, Java, ADA vhdl, fortran and xml source are directly supported for syntax highlighting.
Some key features of this are:
- Syntax highlighting.
- Extraction of method names for a ‘table of contents.
- Support for different line endings.
- Any unknown file type may be treated as plain text.
- Split screen view allows the Reviewer to navigate to two different places in the same module at once.
- Document close-out download will automatically update code with accepted proposed changes and insert Please Review comments as comments into the source file.
The code is presented in the right hand ‘document pane’ with the left hand ‘navigation pane’ displaying the methods in the code when ‘Contents’ is selected. The method names are automatically extracted.
- To make a comment or propose a change, the Reviewer simply selects the line by clicking on it.
- The standard Please Review comment window (or comment pane) opens.
- The comment window (or pane) operates as described elsewhere in the manual and permits proposed changes and comments as well as categorization.
- Lines with comments and/or proposed changes are identified with the standard Please Review icon.
Split Screen View
When reviewing code only, there is the option of a split screen which allows the Reviewer to navigate to two different places in the same module/ document at once.
The split screen view is selected using the ‘Layout’ view icon on the toolbar.
Either screen area may be used for commenting. When you navigate using the navigation pane or comment window, the top pane is scrolled to the correct location. The comment pane (or window) will reflect the line most recently selected.
Unrecognized Document Types
When an unsupported document format is included in a review and a participant accesses it, instead of simply opening the document automatically, they will be presented with a message.
Where the participant is using the pop-up comment window, the general comment window is included in the document view.