diff --git a/docs/7.-Report-Viewer.md b/docs/7.-Report-Viewer.md index 72964e0c4..d71a86ff9 100644 --- a/docs/7.-Report-Viewer.md +++ b/docs/7.-Report-Viewer.md @@ -64,13 +64,11 @@ Similar to the production build, this build will have `demo` as its base url. ## Features ### File Upload / Landing Page (`/`) -![Landing Page](./images/7_landing_dark.png#gh-dark-mode-only) -![Landing Page](./images/7_landing_light.png#gh-light-mode-only) +![Landing Page](./images/7_landing_light.png) This view is used to load files into the report viewer. More information can be found [above](#landing-page). ### Overview (`/overview`) -![Overview View](./images/7_overview_dark.png#gh-dark-mode-only) -![Overview View](./images/7_overview_light.png#gh-light-mode-only) +![Overview View](./images/7_overview_light.png) The Overview shows general information about the entire dataset and is not specific to a single comparison. The top shows some general information about the report. More [information](#information-information) can be accessed over the more button. @@ -90,8 +88,7 @@ When hovering over a name, an eye will show up. Clicking this eye toggles the an Clicking the other parts of the [opens the comparison](#comparison-comparison). ### Comparison (`/comparison`) -![Comparison View](./images/7_comparison_dark.png#gh-dark-mode-only) -![Comparison View](./images/7_comparison_light.png#gh-light-mode-only) +![Comparison View](./images/7_comparison_light.png) At the top of the comparison view, different similarities for the submission can be seen. The average similarity is the same as that shown in the comparison table. The similarities labeled with the submission names show the percentage of tokens for the named submission that appear in the other one. Below that, the bubbles represent a single match. They show the file names in both submissions and the number of tokens in the match. Clicking on this bubble will scroll to both matches in the code. @@ -109,16 +106,14 @@ Clicking on this header expands and collapses the file content. The matches are visualized via colored blocks. Clicking on one scrolls to the match in the other submissions code. ### Cluster (`/cluster`) -![Cluster View](./images/7_cluster_dark.png#gh-dark-mode-only) -![Cluster View](./images/7_cluster_light.png#gh-light-mode-only) +![Cluster View](./images/7_cluster_light.png) At the top of the page, some general information about the cluster, such as its similarity, is given. On the left, there are two ways to display a cluster In the graph, each node represents a submission. The thickness and opacity of the edge is an indicator for the similarity of the comparison between the two submissions. When a comparison is not part of the report, its edge will be gray and dotted. Hovering over an edge will highlight it in the table on the right. -![Radar Chart](./images/7_radar_dark.png#gh-dark-mode-only) -![Radar Chart](./images/7_radar_light.png#gh-light-mode-only) +![Radar Chart](./images/7_radar_light.png) The other option to display a cluster is a radar chart. It may not be available in some reports when there are not enough comparisons of this cluster present. It shows the similarity of the other submissions in a cluster relative to one submission. This submission can be changed in the dropdown at the top. Not all submissions may be available here due to them not having enough comparisons in the report. @@ -127,8 +122,7 @@ The mode called "Members" shows a similar comparison table to the [overview](#ov The mode called "Related Comparisons" also holds a similar table. Each comparison in this table has one submission from the cluster while the other is not part of the cluster. This can be used to identify false negatives of the clustering. ### Information (`/information`) -![Information View](./images/7_information_dark.png#gh-dark-mode-only) -![Information View](./images/7_information_light.png#gh-light-mode-only) +![Information View](./images/7_information_light.png) The information view displays data about the run, like date, execution time and number of submission. It also displays all the options used by JPlag. @@ -138,8 +132,7 @@ When anonymizing a submission, its name gets replaced by the word `anon` followe There are two ways to anonymize a submission. When hovering over a submission in a table, an eye will become visible. Clicking it will change its anonymization status. -![Annonymization in table](./images/7_anoneye_dark.png#gh-dark-mode-only) -![Annonymization in table](./images/7_anoneye_light.png#gh-light-mode-only) +![Annonymization in table](./images/7_anoneye_light.png) The other option is to clock the "Hide All" button at the top of the comparison table. When all submissions are anonymized, it will change to a "Show All" button that will de-anonymize all submissions. diff --git a/docs/images/7_anoneye_dark.png b/docs/images/7_anoneye_dark.png deleted file mode 100644 index 8d4590aa1..000000000 Binary files a/docs/images/7_anoneye_dark.png and /dev/null differ diff --git a/docs/images/7_cluster_dark.png b/docs/images/7_cluster_dark.png deleted file mode 100644 index f4020cb67..000000000 Binary files a/docs/images/7_cluster_dark.png and /dev/null differ diff --git a/docs/images/7_comparison_dark.png b/docs/images/7_comparison_dark.png deleted file mode 100644 index 52e464a64..000000000 Binary files a/docs/images/7_comparison_dark.png and /dev/null differ diff --git a/docs/images/7_information_dark.png b/docs/images/7_information_dark.png deleted file mode 100644 index 0f74ed2d5..000000000 Binary files a/docs/images/7_information_dark.png and /dev/null differ diff --git a/docs/images/7_landing_dark.png b/docs/images/7_landing_dark.png deleted file mode 100644 index a1839bda7..000000000 Binary files a/docs/images/7_landing_dark.png and /dev/null differ diff --git a/docs/images/7_overview_dark.png b/docs/images/7_overview_dark.png deleted file mode 100644 index b16098b87..000000000 Binary files a/docs/images/7_overview_dark.png and /dev/null differ diff --git a/docs/images/7_radar_dark.png b/docs/images/7_radar_dark.png deleted file mode 100644 index 6bc9a5782..000000000 Binary files a/docs/images/7_radar_dark.png and /dev/null differ