Shortcuts and scripting clarifications

qupath · Aug 13, 2020 · 9a41c0b · 9a41c0b
1 parent a8133cb
commit 9a41c0b
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 2 deletions.
diff --git a/docs/reference/shortcuts.rst b/docs/reference/shortcuts.rst
@@ -66,6 +66,7 @@ The following shortcuts are used to toggle on/off display elements in the viewer
   "Show/hide annotations", :kbd:`A`
   "Show/hide TMA grid", :kbd:`G`
   "Show/hide counting grid", :kbd:`Shift + G`
+  "Show/hide pixel classification", :kbd:`C`
   "Fill/unfill detections", :kbd:`F`
   "Fill/unfill annotations", :kbd:`Shift + F`
   "Show/hide color channel", :kbd:`Numeric keys`

diff --git a/docs/scripting/images/friendly_script.png b/docs/scripting/images/friendly_script.png
diff --git a/docs/scripting/overview.rst b/docs/scripting/overview.rst
@@ -2,7 +2,18 @@
 Custom scripts
 **************
 
-Here, we overview some of the main ideas needed to start writing custom scripts in QuPath.
+You can enter a custom script in QuPath via :menuselection:`Automate --> Show script editor`, and run it by choosing :menuselection:`Run --> Run` (or pressing :kbd:`Ctrl + R` with the script editor in focus).
+
+.. figure:: images/friendly_script.png
+  :class: shadow-image
+  :width: 75%
+  :align: center
+
+  A friendly script.
+
+The `user forum <http://forum.image.sc/tag/qupath>`_ is a good source for scripts; scripts are often posted there in response to questions that require a feature QuPath doesn't quite have yet.
+
+This section provides an overview of some of the main ideas needed to start writing custom scripts in QuPath yourself.
 
 It is based initially on `this blog post <https://petebankhead.github.io/qupath/2019/08/21/scripting-in-v020.html>`_ but should be kept updated as QuPath develops.
 It assumes you are familiar with the main :doc:`QuPath concepts <../concepts/index>`.

diff --git a/docs/tutorials/pixel_classification.rst b/docs/tutorials/pixel_classification.rst
@@ -53,6 +53,13 @@ We will further look to identify everything else that is tissue, *and a third cl
   :width: 90%
 
   OS-1.ndpi
+
+.. tip::
+
+  **Remember:** You can toggle the overlay on and off by pressing the :guilabel:`C` button in the toolbar or :kbd:`C` shortcut key (for *classification*).
+
+  You can adjust the overlay opacity using the slider at the top, or by scrolling with the :guilabel:`Ctrl` or :guilabel:`Cmd` key pressed.
+
 
 Getting started
 ===============

diff --git a/docs/tutorials/thresholding.rst b/docs/tutorials/thresholding.rst
@@ -82,7 +82,7 @@ When you adjust these settings, you should see an overlay that color-codes pixel
 
 .. tip::
 
-  You can toggle the overlay on and off by pressing the :guilabel:`C` button in the toolbar (for *classification*... for reasons we shall see later).
+  You can toggle the overlay on and off by pressing the :guilabel:`C` button in the toolbar or :kbd:`C` shortcut key (for *classification*... for reasons we shall see later).
 
   You can adjust the overlay opacity using the slider at the top, or by scrolling with the :guilabel:`Ctrl` or :guilabel:`Cmd` key pressed.