Function: hywiki-find-referent

hywiki-find-referent is an autoloaded, interactive and byte-compiled function defined in hywiki.el.

Signature

(hywiki-find-referent &optional WIKIWORD PROMPT-FLAG)

Documentation

Display optional HyWiki WIKIWORD referent or if nil, use current buffer.

If called interactively, use the WIKIWORD at point or if none, prompt for an existing or new one. With a prefix arg PROMPT-FLAG, prompt for the type of referent to link to. See hywiki-referent-menu for valid referent types.

Return the referent if successfully found or nil otherwise. A valid referent is a cons of (<referent-type> . <referent-value>).

If the referent is a HyWiki page:
    Return a cons of the symbol 'page and the absolute path
    to any page successfully found. Return nil if failed or
    if displaying a regular file (read in via a find-file call).

    By default, create any non-existent page. When not in batch
    mode, with optional PROMPT-FLAG t or if this is the first
    HyWiki page in hywiki-directory, prompt to create if
    non-existent. If PROMPT-FLAG is :existing or with a prefix
    argument when called interactively, return nil unless the
    page already exists. After successfully finding a page and
    reading it into a buffer, run hywiki-display-referent-hook.

After successfully finding any kind of referent, run hywiki-find-referent-hook.

Key Bindings

Source Code

;; Defined in ~/.emacs.d/elpa/hyperbole-20260414.325/hywiki.el
;;;###autoload
(defun hywiki-find-referent (&optional wikiword prompt-flag)
  "Display optional HyWiki WIKIWORD referent or if nil, use current buffer.
If called interactively, use the WIKIWORD at point or if none, prompt for
an existing or new one.  With a prefix arg PROMPT-FLAG, prompt for the
type of referent to link to.  See `hywiki-referent-menu' for valid
referent types.

Return the referent if successfully found or nil otherwise.
A valid referent is a cons of (<referent-type> . <referent-value>).

If the referent is a HyWiki page:
    Return a cons of the symbol \\='page and the absolute path
    to any page successfully found.  Return nil if failed or
    if displaying a regular file (read in via a `find-file' call).

    By default, create any non-existent page.  When not in batch
    mode, with optional PROMPT-FLAG t or if this is the first
    HyWiki page in `hywiki-directory', prompt to create if
    non-existent.  If PROMPT-FLAG is :existing or with a prefix
    argument when called interactively, return nil unless the
    page already exists.  After successfully finding a page and
    reading it into a buffer, run `hywiki-display-referent-hook'.

After successfully finding any kind of referent, run
`hywiki-find-referent-hook'."
  (interactive (list (hywiki-word-read-new "Add/Edit HyWikiWord: ")
		     (when current-prefix-arg t)))
  (let ((referent (hywiki-display-referent wikiword prompt-flag)))
    (run-hooks 'hywiki-find-referent-hook)
    referent))