Function: hywiki-add-spec

hywiki-add-spec is an autoloaded, interactive and byte-compiled function defined in hywiki.el.

Signature

(hywiki-add-spec WIKIWORD)

Documentation

Create a WIKIWORD spec whose action selects and displays its referent type.

The specified WIKIWORD is highlighted. This replaces any existing referent the WIKIWORD may have. Use hywiki-get-referent to determine any referent type associated with WIKIWORD prior to invoking this.

This differs from hywiki-word-create-and-display in that selection and display of the WIKIWORD referent is deferred until the first Action Key activation of the WIKIWORD.

When the WIKIWORD spec is activated, prompt for and choose a typed referent. See hywiki-referent-menu for valid referent types. Select Page for a standard HyWiki page.

If WIKIWORD is invalid, trigger an error if called interactively or return nil if not.

After successfully adding the spec, run hywiki-add-referent-hook.

Key Bindings

Source Code

;; Defined in ~/.emacs.d/elpa/hyperbole-20260822.1645/hywiki.el
;;;###autoload
(defun hywiki-add-spec (wikiword)
  "Create a WIKIWORD spec whose action selects and displays its referent type.
The specified WIKIWORD is highlighted.  This replaces any existing referent
the WIKIWORD may have.  Use `hywiki-get-referent' to determine any referent
type associated with WIKIWORD prior to invoking this.

This differs from `hywiki-word-create-and-display' in that selection and
display of the WIKIWORD referent is deferred until the first Action Key
activation of the WIKIWORD.

When the WIKIWORD spec is activated, prompt for and choose a typed referent.
See `hywiki-referent-menu' for valid referent types.  Select Page for a
standard HyWiki page.

If WIKIWORD is invalid, trigger an error if called interactively
or return nil if not.

After successfully adding the spec, run `hywiki-add-referent-hook'."
  (interactive (list (or (hywiki-word-at)
			 (hywiki-word-read-new "Add HyWikiWord Spec: "))))
  (when (or (not (stringp wikiword)) (string-empty-p wikiword))
    (error "(hywiki-word-create-spec): No HyWikiWord specified"))
  (setq hkey-value wikiword)
  (hywiki-add-referent wikiword '(spec . t)))