Skip to content

Commit 8f2f0ea

Browse files
authored
[guide] Add guide to menu (#2168)
1 parent df09830 commit 8f2f0ea

File tree

2 files changed

+27
-1
lines changed

2 files changed

+27
-1
lines changed

visidata/guides/MenuGuide.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# The Menu System
2+
3+
The menu (on the first row of the window) contains most commands, organized within a tree of submenus.
4+
5+
Click on menu items to navigate the menu like a GUI.
6+
7+
With the keyboard:
8+
9+
- {help.commands.menu_help}
10+
- [:keys]Arrow[/] keys to move between submenus
11+
12+
Additionally, each top-level menu name has a single letter underlined. [:keys]Alt+<underlined letter>[/] to open that menu. For example, [:keys]Alt+F[/] to open the **File** menu.
13+
14+
Each non-submenu item is a command. It shows the description of the current command, along with the command name and its keyboard shortcut (if available). Click on the item or [:keys]Enter[/] to execute it.
15+
16+
Indicators:
17+
18+
- {help.options.disp_menu_more}
19+
- {help.options.disp_menu_push}
20+
- {help.options.disp_menu_input}
21+
22+
Some commands are only available on a specific sheet type, and appear [:color_menu_spec]highlighted[/] in the menu when the current sheet is that type. If the command is not available, it will not appear at all.
23+
24+
## Options
25+
26+
- {help.options.disp_menu}

visidata/menu.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -499,7 +499,7 @@ def _clickedDuringMenu():
499499
BaseSheet.addCommand('Alt+d', 'menu-data', 'pressMenu("Data")', '')
500500
BaseSheet.addCommand('Alt+p', 'menu-plot', 'pressMenu("Plot")', '')
501501
BaseSheet.addCommand('Alt+s', 'menu-system', 'pressMenu("System")', '')
502-
BaseSheet.addCommand('Alt+h', 'menu-help', 'pressMenu("Help")', '')
502+
BaseSheet.addCommand('Alt+h', 'menu-help', 'pressMenu("Help")', 'open the Help menu')
503503
BaseSheet.bindkey('Ctrl+H', 'menu-help')
504504
BaseSheet.bindkey('KEY_BACKSPACE', 'menu-help')
505505

0 commit comments

Comments
 (0)