Skip to content

Commit cab0bb1

Browse files
committed
[guide] Add guide to menu
1 parent 5e611e3 commit cab0bb1

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

visidata/guides/MenuGuide.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# The Menu System
2+
3+
Located at the very top of the screen, the menu organizes many commands within submenu trees.
4+
5+
Navigate the menu like a GUI by using the mouse to click on menu items.
6+
7+
To navigate with the keyboard, `Alt+H` will open the **Help** menu, and from there use the arrow keys to move between submenus.
8+
9+
Additionally, each top-level menu name has a single letter underlined. `Alt+<underlined letter>` will open that menu. For example, `Alt+F` will open the **File** menu.
10+
11+
To open a submenu (indicated by `{vd.options.disp_menu_more}`) press the `` key or click on it with the mouse. Each non-submenu item is a command.
12+
13+
The menu shows the description of the current command, along with the command name and its keyboard shortcut (if available). Execute the current command by clicking on it or pressing `Enter`.
14+
15+
Some other indicators:
16+
17+
- `{vd.options.disp_menu_push}`: the command opens another sheet.
18+
- `{vd.options.disp_menu_input}`: the command requires input.
19+
20+
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.
21+
22+
## Options
23+
24+
- {help.options.disp_menu}

0 commit comments

Comments
 (0)