TRANSIENT == Transient commands — used by magit and friends. This module speech-enables transient.
Package Transient is similar to package Hydra in the sense that it can be used to create a sequence of chained/hierarchical commands that are invoked via a sequence of keys. It is used by Magit for dispatching to the various Git commands. Speech-enabling package Transient results in the various interactive commands producing auditory feedback. Transient shows an ephemeral window with the currently available commands, Emacsvox speech-enables transient–show to cache that content so it can be browsed if desired.
Finally, this module defines a new minor mode called transient-emacsvox that enables interactive browsing of the contents displayed temporarily. Note that without this functionality, learning complex packages like Magit would be difficult because the list of available commands can be very long.
I use the following customizations via .custom, adjust to taste, but use these only after reading the transient info documentations.
This displays the menu immediately and lets you move through its buttons with the up/down arrows.
When executing a command defined via Transient — e.g. command
Magit-dispatch and friends,
? twice to suspend the transient — this calls
2transient-suspend. Emacsvox now
displays a *transient-emacsvox* buffer that displays the contents of the
most recently displayed transient choices. Pressing r resumes
the transient; Pressing C-q quits the transient.
emacsvox integration with Transient. In addition to any hooks its parent mode ‘special-mode’ might have run, this mode runs the hook ‘emacsvox-transient-mode-hook’, as the final or penultimate step during initialization.
How Up and Down move through Transient menu items. Continuous navigation crosses sections and wraps around the whole menu. Section wrapping cycles within the current section. Section stops keep point at its first or last item and play a boundary cue. Left and Right move between sections in every style. This setting applies globally.
Default Value:
section-wrap
How Transient navigation announces items and sections. Item first speaks the item, then the section name and position. Section first speaks the section name and position before the item. By movement speaks only the section for section navigation and only the item for item navigation, even across sections. Section navigation still selects the first item; C-c l repeats it without moving when that review key is available. This setting applies globally, including Magit, and does not change navigation.
Default Value:
section-first
Whether Transient items include their command documentation summaries. When enabled, retain each label and value and add the first line of the command’s docstring. This applies to all Transient menus, including Magit. Items without command documentation keep their labels; Transient’s native infix controls keep their usual descriptions.
Default Value:
t