[guide] Add guide to menu

Author: anjakefala

visidata/features/menu_guide.py

@@ -0,0 +1,28 @@
+from visidata import GuideSheet, vd
+
+class MenuGuide(GuideSheet):
+    guide = '''# The VisiData Menu System
+
+VisiData's menu is at the [:black on 68]top of the screen[/].
+
+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)
+
+- [:onclick options-sheet disp_menu_fmt]`disp_menu_fmt`[/] to set the right side menu format string
+- [:onclick options-sheet disp_menu]`disp_menu`[/] to toggle the presence of the menu on top line, when it is not active
+'''
+
+vd.addGuide('MenuGuide', MenuGuide)