core/ui/views/keys: Add a Contextual Help Menu.

Assigned an arbitrary hotkey. Will be overloaded onto the HELP command.

Help Menus do not currently work from within editors or popups.

Hotkeys document regenerated.

Author: Niloth-p

docs/hotkeys.md

@@ -6,6 +6,7 @@
 |Command|Key Combination|
 | :--- | :---: |
 |Show/hide Help Menu|<kbd>?</kbd>|
+|Show/hide Contextual Help Menu|<kbd>Meta</kbd> + <kbd>c</kbd>|
 |Show/hide Markdown Help Menu|<kbd>Meta</kbd> + <kbd>m</kbd>|
 |Show/hide About Menu|<kbd>Meta</kbd> + <kbd>?</kbd>|
 |Copy information from About Menu to clipboard|<kbd>c</kbd>|

zulipterminal/config/keys.py

@@ -38,6 +38,13 @@ class KeyBinding(TypedDict):
         'key_category': 'general',
         'key_contexts': ['general'],
     },
+    'CONTEXTUAL_HELP': {
+        'keys': ['meta c'],
+        'help_text': 'Show/hide Contextual Help Menu',
+        'excluded_from_random_tips': True,
+        'key_category': 'general',
+        'key_contexts': ['general'],
+    },
     'MARKDOWN_HELP': {
         'keys': ['meta m'],
         'help_text': 'Show/hide Markdown Help Menu',

zulipterminal/core.py

@@ -252,8 +252,8 @@ def is_any_popup_open(self) -> bool:
     def exit_popup(self) -> None:
         self.loop.widget = self.view
 
-    def show_help(self) -> None:
-        help_view = HelpView(self, f"Help Menu {SCROLL_PROMPT}")
+    def show_help(self, context: Optional[str] = None) -> None:
+        help_view = HelpView(self, f"Help Menu {SCROLL_PROMPT}", context)
         self.show_pop_up(help_view, "area:help")
 
     def show_markdown_help(self) -> None:

zulipterminal/ui.py

@@ -350,6 +350,9 @@ def keypress(self, size: urwid_Box, key: str) -> Optional[str]:
             # Show help menu
             self.controller.show_help()
             return key
+        elif is_command_key("CONTEXTUAL_HELP", key):
+            self.controller.show_help(self.context)
+            return key
         elif is_command_key("MARKDOWN_HELP", key):
             self.controller.show_markdown_help()
             return key

zulipterminal/ui_tools/views.py

@@ -1238,13 +1238,16 @@ def _fetch_user_data(
 
 
 class HelpView(PopUpView):
-    def __init__(self, controller: Any, title: str) -> None:
+    def __init__(
+        self, controller: Any, title: str, context: Optional[str] = None
+    ) -> None:
         help_menu_content = []
         for category in HELP_CATEGORIES:
             keys_in_category = (
                 binding
                 for binding in KEY_BINDINGS.values()
                 if binding["key_category"] == category
+                and (not context or context in binding["key_contexts"])
             )
             key_bindings = [
                 (
@@ -1254,6 +1257,8 @@ def __init__(self, controller: Any, title: str) -> None:
                 for binding in keys_in_category
             ]
 
+            if not key_bindings:
+                continue
             help_menu_content.append((HELP_CATEGORIES[category], key_bindings))
 
         popup_width, column_widths = self.calculate_table_widths(