From 54f2722fea4e3c2d993d0077f66a20ab195be88b Mon Sep 17 00:00:00 2001 From: Martino Ferrari Date: Tue, 3 Nov 2026 07:32:20 +0100 Subject: [PATCH] ui: the tour names the dock button; the user guide's key table follows shortcuts.cpp Co-Authored-By: Claude Sonnet 4.6 --- docs/USER-GUIDE.md | 29 +++++++++++++++++------------ src/ui_app.hpp | 4 ++-- src/ui_probe.cpp | 4 ++-- src/ui_tour.cpp | 2 +- 4 files changed, 22 insertions(+), 17 deletions(-) diff --git a/docs/USER-GUIDE.md b/docs/USER-GUIDE.md index 0e80b76..b5e9651 100644 --- a/docs/USER-GUIDE.md +++ b/docs/USER-GUIDE.md @@ -203,19 +203,24 @@ per sample, `time`, `stream_time`, then one column per signal. |---|---| | `space` | pause / resume | | `a` | arm / disarm the trigger | -| `t` | the trigger panel | -| `l` | the layout editor | -| `g` | go live | -| `f` | fit to data | -| `d` | add the first free signal to the focused row | -| `c` | cursors on/off | -| `m` | measurements pane | -| `e` | export | -| `?` | shortcuts | +| `t` | enable / disable trigger mode | +| `c` | enable / disable the cursors | +| `m` | open or close the Measurements page | +| `g` | open or close the Signals page (the `+` badge opens it too) | +| `l` | show / hide the layout editor | +| `s` | show / hide the dock | +| `Esc` | close the slide-over page (the guided tour takes it first) | +| `f` | fit to data (the plot's own key) | +| `Ctrl+E` | export visible range | +| `F1` | open the manual | +| `Ctrl+/` | open the shortcut overview | +| `Ctrl+T` | start the guided tour | +| `Ctrl+H` | turn the contextual help on or off | +| `Ctrl+Q` | quit | -`Ctrl+E` exports, `Ctrl+Q` quits, `Ctrl+plus`/`Ctrl+minus` zoom x and `Alt+plus`/`Alt+minus` zoom y. -A keystroke is ignored while a text field has focus, so typing in the window control never arms the -trigger. +The plot also answers `+`/`-` (zoom both axes), `Ctrl+plus`/`Ctrl+minus` (zoom x only), +`Alt+plus`/`Alt+minus` (zoom y only) and the arrow keys (pan). A keystroke is ignored while a text +field has focus, so typing in the window control never arms the trigger. ## 13. Troubleshooting diff --git a/src/ui_app.hpp b/src/ui_app.hpp index 9a94b0d..63cc958 100644 --- a/src/ui_app.hpp +++ b/src/ui_app.hpp @@ -786,8 +786,8 @@ struct App { std::string config_comment; /// The cache of captured events, and whether latches are being written to it. The store is created /// once the source is known (it is keyed on `-`, like the packet capture); - /// `event_recording` is the trigger panel's switch and defaults on -- the cache is only useful if - /// it was already on when the event you wanted happened. + /// `event_recording` is the trigger panel's switch and starts off; the cache is only useful if + /// it was already on when the event you wanted happened, so switch it on before the events you want. std::unique_ptr event_store; /// Whether the cache holds anything, refreshed once a second: what keeps the dock's Events block and the /// `events` page live for a source whose events are already written, even with recording switched off. diff --git a/src/ui_probe.cpp b/src/ui_probe.cpp index 8b884a7..6939297 100644 --- a/src/ui_probe.cpp +++ b/src/ui_probe.cpp @@ -185,8 +185,8 @@ gboolean exit_probe_step3b(gpointer user) { a->dbg_dock_sensitive = gtk_widget_get_sensitive(a->side_box) ? 1 : 0; a->dbg_dock_w = a->dbg_side_w; { - // The dock holds only the readouts box; the full cursors and measurements panels are slide-over pages, - // registered whether or not either is open. + // The dock holds only the readouts box, a separator and the events block; the full cursors and + // measurements panels are slide-over pages, registered whether or not either is open. int children = 0; for (GtkWidget* c = gtk_widget_get_first_child(a->dock_page); c != nullptr; c = gtk_widget_get_next_sibling(c)) { diff --git a/src/ui_tour.cpp b/src/ui_tour.cpp index d967bd6..b32b4fc 100644 --- a/src/ui_tour.cpp +++ b/src/ui_tour.cpp @@ -459,7 +459,7 @@ constexpr TourStep kTourSteps[] = { "fixed width, with the recorded events below them: one row per latched event, newest first, and " "one click on a row replays it. Edit, beside each heading, opens that instrument's full panel " "over the plot, Manage opens the full list of events; a click on a measurement opens its " - "dialog. The side-panel button in the bar above shows and hides the dock.", + "dialog. The dock button in the bar above shows and hides the dock.", &App::side_box}, {"signals", "signals", "Adding a signal", "What can be added: the signals the source declares that are not acquired yet, each with the "