Skip to content

Commit

Permalink
[guide] Add guide to menu
Browse files Browse the repository at this point in the history
  • Loading branch information
anjakefala committed Dec 21, 2023
1 parent 803d32e commit 0337c40
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions visidata/features/menu_guide.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
from visidata import GuideSheet, vd

class MenuGuide(GuideSheet):
guide_text = '''# The VisiData Menu System
VisiData's menu is at the [:black on 68]top of the screen[/]. It contains a collection of VisiData commands organised within submenu trees.
It can be navigated both as a standard, clickable GUI menu, and via keystrokes.
To navigate via keystrokes, `Alt+H` will open the **Help** menu, and from there `arrow` keys can be used to move between submenus.
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.
» indicates a submenu, which can be traversed with the `right arrow` or a mouse-click. The leaf node of every menu tree is a command.
When the cursor is on a command, the menu throws up its helpbox. This contains the description of the command, the keyboard shortcut if available, and its command longname. Clicking on the command in the menu, or pressing `Enter`, will execute the actual command.
`⎘` indicates that the command will push a sheet onto sheet stack. `…` indicates that input will be required for the command.
Sheet-specific commands will only appear in the menu when that specific sheet type is loaded. The entire menu-tree for sheet-specific commands will appear in the menu [:black on 34 green]highlighted green[/].
## Options (must reload to take effect)
- {help.options.disp_menu_fmt}
- {help.options.disp_menu}
'''

vd.addGuide('MenuGuide', MenuGuide)

0 comments on commit 0337c40

Please sign in to comment.