Skip to content

help

The community/core/help directory contains files that implement a help system for Talon. This system provides information about available commands, contexts, and other aspects of the Talon configuration.

The most important files are:

  • help.talon: This file defines the voice commands to trigger the help system. It contains commands to display help for various elements like the alphabet, symbols, numbers, punctuation, modifiers, special keys, function keys, and arrows. It also includes commands to toggle the scope display, search for commands, display help for specific contexts, formatters and reformatters and to open the main help window.

  • help_open.talon: This file defines the voice commands that are available when the help window is open. It includes commands to navigate through help pages, select a specific context by index, refresh, and close the help window.

  • help_scope_open.talon: This file defines the voice command to toggle the scope display.

  • help.py: This Python file contains the core logic for the help system. It manages the display of help information in an ImGui window, including:

    • Fetching and organizing data about contexts, commands, and lists.
    • Displaying paginated lists of contexts and commands.
    • Filtering and searching commands.
    • Handling navigation, selection, and display of help information.
    • Managing the formatting and display of information.
    • Provides actions to trigger the display of help information in various formats, such as the list of available formatters, or active contexts only.

  • help_scope.py: This Python file implements a window to display the current Talon scope, including active modes, tags, and other relevant information. It allows the user to view the current state of Talon and is useful for debugging and understanding the system's behavior.

These files work together to provide a comprehensive help system:

  1. The user triggers a help command defined in help.talon.
  2. The help.py script opens an ImGui window and renders the requested information.
  3. The user can navigate through the help system using commands defined in help_open.talon.
  4. The user can toggle the scope display using a command defined in help_scope_open.talon, which is rendered by help_scope.py.

The system allows users to discover and understand the available commands, contexts, and settings in their Talon configuration.