Function: hywiki-word:help

hywiki-word:help is a byte-compiled function defined in hibtypes.el.

Signature

(hywiki-word:help IBUT)

Documentation

Dispatch to desired HyWikiWord Assist Key function based on prefix arg.

This table summarizes the function run for each prefix argument:
|--------------------------------------+-------------------------------------|
| Function | Key Binding |
|--------------------------------------+-------------------------------------|
| 1. Set Referent Type and Display | {M-0 M-RET} or {C-u C-u M-RET} |
| 2. Create a WikiWord Spec | {M-1 M-RET} or {M-0 M-RET s} |
| (Set Referent on Activation) | |
| 3. Show Assist Key Help for WikiWord | {C-u M-RET} or any other prefix arg |
|--------------------------------------+-------------------------------------|

#1 prompts for a referent type, creates and displays the wikiword's
referent. With an Assist Key press on a non-existing wikiword, it prompts for its wikiword referent type, then creates and displays it. A call to (hywiki-active-in-current-buffer-p) must return non-nil for this to activate.

#2 creates a wikiword spec that when activated via the Action Key with
{M-RET} prompts for and replaces the spec with the chosen referent type
and associated attributes (it follows the procedure in #2 above).

#3 shows the wikiword attributes and this doc string.

Aliases

hywiki-existing-word:help

Source Code

;; Defined in ~/.emacs.d/elpa/hyperbole-20260822.1645/hibtypes.el
(defun hywiki-word:help (ibut)
  "Dispatch to desired HyWikiWord Assist Key function based on prefix arg.

This table summarizes the function run for each prefix argument:
|--------------------------------------+-------------------------------------|
| Function                             | Key Binding                         |
|--------------------------------------+-------------------------------------|
| 1. Set Referent Type and Display     | {M-0 M-RET} or {C-u C-u M-RET}      |
| 2. Create a WikiWord Spec            | {M-1 M-RET} or {M-0 M-RET s}        |
|    (Set Referent on Activation)      |                                     |
| 3. Show Assist Key Help for WikiWord | {C-u M-RET} or any other prefix arg |
|--------------------------------------+-------------------------------------|

#1 prompts for a referent type, creates and displays the wikiword's
referent.  With an Assist Key press on a non-existing wikiword, it prompts
for its wikiword referent type, then creates and displays it.  A call
to (hywiki-active-in-current-buffer-p) must return non-nil for this to
activate.

#2 creates a wikiword spec that when activated via the Action Key with
{M-RET} prompts for and replaces the spec with the chosen referent type
and associated attributes (it follows the procedure in #2 above).

#3 shows the wikiword attributes and this doc string."
  (pcase current-prefix-arg
    ((or '(16) 0) (hywiki-word-create-and-display
                   (ibut:key-to-label (hattr:get ibut 'lbl-key))
                   t))
    (1 (let ((wikiword (ibut:key-to-label (hattr:get ibut 'lbl-key))))
         (hywiki-add-spec wikiword)
         (hywiki-message-spec wikiword)))
    ;; Any other prefix arg, show wikiword attributes and the doc string.
    (_ (hkey-help t))))