Skip to content

Add initial tips section #165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/advanced/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@ exporting_annotations
command_line
omero
view_tracker
tips
```
31 changes: 31 additions & 0 deletions docs/advanced/tips.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
(tips-and-tricks)=
# Tips & tricks

This page contains a (growing) collection of tips & tricks that can help make life with QuPath more pleasant.

Some of these are always applicable, while others depend upon which specific operating system you are using.



## macOS

### Conflicting shortcuts
Some of QuPath's shortcuts conflict with built-in shortcuts in macOS.

In particular, the handy shortcut to select all detections is {kbd}`Option`+`Cmd`+`D`.
On a Mac, this tends to show or hide the Dock... leaving the detections just as visible as they were before.

In cases where you don't use the macOS shortcut and want to turn it off, you can do so system-wide under {menuselection}`System Settings --> Keyboard --> Keyboard Shortcuts`.
For example, unchecking {guilabel}`Turn Doc hiding on/off` can enable QuPath's shortcut to function as expected.


### Lost windows
QuPath doesn't play entirely nicely with multiple monitors on macOS.
For example, when dragging a (sub)window (e.g. the Brightness/Contrast dialog) to a different monitor, it might become 'detached' from the main QuPath window.

The {menuselection}`Window --> Center all windows` and {menuselection}`Window --> Center off-screen windows` were introduced in QuPath v0.6.0 to help find windows that might have gotten lost.

The problem is [described on GitHub](https://github.com/qupath/qupath/issues/1785) and is not something that can be fixed entirely within QuPath, since it [relates to JavaFX's behavior](https://bugs.openjdk.org/browse/JDK-8252373).

Nevertheless, there is a macOS system setting that can *influence* the behavior, and so may be worth trying if you find it too annoying.
It is found under {menuselection}`System Settings --> Desktop & Dock --> Displays have separate Spaces`.