diff --git a/docs/7.-Report-Viewer.md b/docs/7.-Report-Viewer.md index 8b1a43c54..530ca2ade 100644 --- a/docs/7.-Report-Viewer.md +++ b/docs/7.-Report-Viewer.md @@ -1,13 +1,15 @@ The JPlag Report Viewer is a web application that can be used to display the result zip file generated by JPlag. ## Opening Reports -The report viewer can be started over the Jar, by specifying a view mode. This is done over the `--mode`/`-M` flag: +The report viewer can be started over the Jar, by specifying a view mode. This is done over the `--mode`/`-M` flag (available since version 6.0.0): |Value|Effect| |---|---| -| run_and_view (default) | Runs JPlag on the given files with the given options. After Running it opens the report viewer. The report viewer will then automatically load the result. | +| run_and_view | Runs JPlag on the given files with the given options. After Running it opens the report viewer. The report viewer will then automatically load the result. | | view | Opens the report viewer. When providing a result zip file from a previous JPlag run - either in a way a source directory would be given or through the `-r` flag. If no file is given the landing page will be opened. | | run | Runs JPlag without opening the report viewer. | +When no value is given for the mode flag JPlag tries to guess the best mode. When calling it with submission files, it executes the `run_and_view` mode. When the positional argument is a zip file including a report, it starts the `view` mode and opens the given report. When no arguments are given, the report viewer is started in `view` mode without any given file, leading to the [landing page](###landing-page) + ### Landing Page On the landing page a report can be opened by either dragging the zip file onto the page. Alternatively when clicking the red square a file chooser will open.