Function: org-link--open-shortdoc

org-link--open-shortdoc is a byte-compiled function defined in ol.el.gz.

Signature

(org-link--open-shortdoc PATH _)

Documentation

Open a "shortdoc" type link.

PATH is a group name, "group::#function" or "group::search string".

Source Code

;; Defined in /usr/src/emacs/lisp/org/ol.el.gz
(defun org-link--open-shortdoc (path _)
  "Open a \"shortdoc\" type link.
PATH is a group name, \"group::#function\" or \"group::search
string\"."
  (string-match "\\`\\([^:]*\\)\\(?:::\\(.*\\)\\'\\)?" path)
  (let* ((group (match-string 1 path))
         (str (match-string 2 path))
         (fn (and str
                  (eq ?# (string-to-char str))
                  (intern-soft (substring str 1)))))
    (condition-case nil
        (progn
          (shortdoc-display-group group fn)
          (and str (not fn) (search-forward str nil t)))
      (error (user-error "Unknown shortdoc group or malformed link: `%s'"
                         path)))))