Added documentation for compare window

Donders-Institute · May 13, 2024 · 98ec4ef · 98ec4ef
1 parent c372b3b
commit 98ec4ef
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 2 deletions.
diff --git a/docs/_static/bidseditor_compare.png b/docs/_static/bidseditor_compare.png
diff --git a/docs/screenshots.rst b/docs/screenshots.rst
@@ -24,6 +24,10 @@ The bidseditor
 
    The bidsmap options for BIDScoin and its plugins. The user can manage the plugins that will be used with the [Add] and [Remove] buttons, and save the current options to the template bidsmap by using the [Set as default] button.
 
+.. figure:: ./_static/bidseditor_compare.png
+
+   The comparison window showing the properties, attributes, BIDS entities and meta data for two different magnitude1 fieldmap acquisitions. Comparing these parameters directly can be useful for tracking down small differences in the acquisition protocol. Comparison windows can be made by right-clicking selected BIDS output names in the main window (use shift- or control-click to select multiple items).
+
 The bidscoiner
 ~~~~~~~~~~~~~~
 

diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst
@@ -53,7 +53,7 @@ Normally the list of items in the bidsmap is a shortlist that represents the dif
 
 I have duplicate run-items in my bidsmap
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Exact duplicates should not exist, i.e. there is probably a small difference in the properties or attributes that identify your run-items. To investigate this, you can compare these run-items by selecting their BIDS output names (use shift-/control-click), then right-click them and choose ``compare`` from the context menu
+Exact duplicates should not exist, i.e. there is probably a small difference in the properties or attributes that identify your run-items. To investigate this, you can compare these run-items by selecting their BIDS output names (use shift-/control-click), then right-click them and choose ``compare`` from the context menu (see `here <./screenshots.html>`__ for an example)
 
 My subject/session labels are wrong
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

diff --git a/docs/workflow.rst b/docs/workflow.rst
@@ -141,7 +141,7 @@ As shown below, the main window of the bidseditor opens with separate data mappi
    Clear the ``session`` label field if you have data with only one session. This will remove the optional session label from the BIDS output name
 
 .. tip::
-   You can compare or edit multiple run-items by right-clicking their selected BIDS output names (use shift-/control-click to select the run-items)
+   You can `compare <./screenshots.html>`__ or edit multiple run-items by right-clicking their selected BIDS output names (use shift-/control-click to select the run-items)
 
 Edit window
 ^^^^^^^^^^^