On 2024-05-08, 18:20 +0700, Max Nikulin <[email protected]> wrote:
> I have not managed to get all known groups with `shortdoc-display-group'
> in Emacs-28. Is it a feature of `shortdoc' in Emacs-29?
In Emacs-29 `shortdoc' is an alias for `shortdoc-display-group'. Interactvely,
it prompts the user for a group from `shortdoc--groups' (that's what I meant by
"all known groups"). I'm unsure if `shortdoc-display-group' behaves differently
in Emacs-28.
> Likely it is better to not allow empty group or function, so "+" instead
> of "*"
>
> "\\`\\([^:]+\\)\\(?:::\\(.+\\)\\'\\)?"
>
> since <shortdoc:::file> is hardly a valid link. However it might be
> search text link in the list of all groups (Emacs-29+ only?).
>
> It is related to corner cases, so I do not insist.
`shortdoc-display-group' already handles empty group or function. Replacing "*"
by "+" will throw an "Args out of range" error in the corner case you mentioned
("shortdoc:::file"). So I think it's fine to keep "*" there.
> Nitpick, feel free to ignore:
> - `when' is redundant here due to `and' inside its condition.
> - `string-patch-p' would not affect match groups, so it is a bit cheaper.
> - Since it is already known that first character is "#", `substring'
> instead of `string-remove-prefix' is an extra step in microoptimization
Noted.
Thank you for all your comments and suggestions, Max!
ol.el: Add support for `shortdoc' link type
* lisp/ol.el: Add support for storing and inserting links to `shortdoc'
documentation groups for Emacs Lisp functions.
* doc/org-manual.org (External Links): Add shortdoc link type
documentation.
* etc/ORG-NEWS (=ol.el=: Support for =shortdoc= link type): Document
the new feature.
---
diff --git a/doc/org-manual.org b/doc/org-manual.org
index 1feb5ed60..8894f4231 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -3382,6 +3382,15 @@ Here is the full set of built-in link types:
Execute a shell command upon activation.
+- =shortdoc= ::
+
+ Link to short documentation summary for an Emacs Lisp function group.
+ Since Emacs 28, user command ~shortdoc-display-group~ lists all known
+ documentation groups.
+
+ For more information, see [[info:emacs#Name Help][Name Help]]
+ and [[info:elisp#Documentation Groups][Documentation Groups]].
+
For =file:= and =id:= links, you can additionally specify a line
number, or a text search string, separated by =::=. In Org files, you
@@ -3423,6 +3432,8 @@ options:
| irc | =irc:/irc.com/#emacs/bob= |
| help | =help:org-store-link= |
| info | =info:org#External links= |
+| shortdoc | =shortdoc:text-properties= |
+| | =shortdoc:text-properties::#get-pos-property= |
| shell | =shell:ls *.org= |
| elisp | =elisp:(find-file "Elisp.org")= (Elisp form to evaluate) |
| | =elisp:org-agenda= (interactive Elisp command) |
diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS
index 99dd8839c..1623873c0 100644
--- a/etc/ORG-NEWS
+++ b/etc/ORG-NEWS
@@ -1405,6 +1405,11 @@ place the entry in the ~Misc~ category if ~TEXINFO_DIR_CATEGORY~ is missing.
=TEXINFO_DIR_TITLE= is renamed to =TEXINFO_DIR_NAME=.
The old name is obsolete.
+*** =ol.el=: Support for =shortdoc= link type
+
+Add support for storing and inserting links to =shortdoc= documentation
+groups for Emacs Lisp functions.
+
** New functions and changes in function arguments
*** New optional argument =UPDATE-HEADING= for ~org-bibtex-yank~
diff --git a/lisp/ol.el b/lisp/ol.el
index bc9682e4a..928db29e1 100644
--- a/lisp/ol.el
+++ b/lisp/ol.el
@@ -1582,6 +1582,46 @@ PATH is a symbol name, as a string."
:follow #'org-link--open-help
:store #'org-link--store-help)
+;;;; "shortdoc" link type
+(when (version<= "28.0.90" emacs-version)
+ (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)))
+ (user-error "Unknown shortdoc group: %s" group))))
+
+ (defun org-link--store-shortdoc (&optional _interactive?)
+ "Store \"shortdoc\" type link."
+ (when (eq major-mode 'shortdoc-mode)
+ (let* ((buffer (buffer-name))
+ (group (when (string-match "*Shortdoc \\(.*\\)\\*" buffer)
+ (match-string 1 buffer))))
+ (if (and group (assoc (intern-soft group) shortdoc--groups))
+ (org-link-store-props :type "shortdoc"
+ :link (format "shortdoc:%s" group)
+ :description nil)
+ (user-error "Unknown shortdoc group: %s" group)))))
+
+ (defun org-link--complete-shortdoc ()
+ "Create a \"shortdoc\" link using completion."
+ (concat "shortdoc:"
+ (completing-read "Shortdoc summary for functions in: "
+ (mapcar #'car shortdoc--groups))))
+
+ (org-link-set-parameters "shortdoc"
+ :follow #'org-link--open-shortdoc
+ :store #'org-link--store-shortdoc
+ :complete #'org-link--complete-shortdoc))
+
;;;; "http", "https", "mailto", "ftp", and "news" link types
(dolist (scheme '("ftp" "http" "https" "mailto" "news"))
(org-link-set-parameters scheme
