From: Max Nikulin <manikulin@gmail.com>
To: emacs-orgmode@gnu.org
Cc: Bruno Cardoso <cardoso.bc@gmail.com>
Subject: Re: [PATCH] Add support for shortdoc link type
Date: Mon, 6 May 2024 17:55:33 +0700 [thread overview]
Message-ID: <938098de-6933-4668-85b0-fbfbc02dd949@gmail.com> (raw)
In-Reply-To: <87y18ondrt.fsf@gmail.com>
On 06/05/2024 04:35, Bruno Cardoso wrote:
> Fixed.
I have tried the patch. It mostly works, so I do not insist on further
polishing. However it should be resent with proper description.
> I had dropped the search code because I wasn't considering the search
> option properly. If I understand correctly, both "::" and "::#" should
> match a function OR a search string? (e.g.:
> `shortdoc:text-properties::#pos-property' will also search for
> "pos-property" in the shortdoc buffer). This is the current behavior in
> the attached patch.
It seems my comments have led mostly to confusion rather than
improvements. I am sorry for that. I have in mind 2 kind of links:
- <shortdoc:string::#try-completion> that may be handled solely by
`shortdoc-display-group' with second argument.
- <shortdoc::string::identical contents> that should cause
(shortdoc-display-group group)
(search-forward fn nil t) ; or (word-search-forward fn nil t)
For `re-search-forward' used in the latest patch revision, from my point
of view, link should be <shortdoc::string::/identical contents/>
(similar to file: links).
Support of search variant may be dropped, but that case I would not
allow "::" as the separator. Mandatory "::#" allows to add text and
regexp search later.
> +++ b/doc/org-manual.org
> @@ -3382,6 +3382,13 @@ 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]]
> + and [[info:elisp#Documentation Groups]].
I am unsure that links without description is a bright idea. Try
https://orgmode.org/manual/Activation.html
and M-: (info "(org) Activation") RET
to get an impression of export result.
> +++ b/lisp/ol.el
> @@ -1582,6 +1582,44 @@ 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)
I just have realized that it is better to ignore anything unexpected
after ":", e.g. if only ::# is allowed (no search text option)
(string-match "\\`\\([^:]*\\)\\(?:::#\\(.*\\).*\\'\\)?" path)
Try [[shortdoc:string:invalid]].
next prev parent reply other threads:[~2024-05-06 10:57 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-05-01 3:29 [PATCH] Add support for shortdoc link type Bruno Cardoso
2024-05-01 11:00 ` Ihor Radchenko
2024-05-01 16:52 ` Bruno Cardoso
2024-05-01 17:55 ` Ihor Radchenko
2024-05-01 19:24 ` Bruno Cardoso
2024-05-02 10:41 ` Max Nikulin
2024-05-03 21:41 ` Bruno Cardoso
2024-05-04 7:38 ` Max Nikulin
2024-05-04 17:33 ` Bruno Cardoso
2024-05-05 11:01 ` Max Nikulin
2024-05-05 21:35 ` Bruno Cardoso
2024-05-06 10:55 ` Max Nikulin [this message]
2024-05-08 1:11 ` Bruno Cardoso
2024-05-08 11:20 ` Max Nikulin
2024-05-08 21:26 ` Bruno Cardoso
2024-05-10 11:09 ` Max Nikulin
2024-05-11 16:58 ` Bruno Cardoso
2024-05-13 11:14 ` Max Nikulin
2024-05-13 13:04 ` Bruno Cardoso
2024-05-16 10:58 ` Max Nikulin
2024-05-17 14:55 ` Bruno Cardoso
2024-06-04 23:59 ` Bruno Cardoso
2024-06-05 15:14 ` Ihor Radchenko
2024-06-05 21:15 ` Bastien Guerry
2024-06-05 15:37 ` Max Nikulin
2024-06-05 22:21 ` Bruno Cardoso
2024-06-06 11:53 ` Ihor Radchenko
2024-06-06 23:11 ` Bruno Cardoso
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=938098de-6933-4668-85b0-fbfbc02dd949@gmail.com \
--to=manikulin@gmail.com \
--cc=cardoso.bc@gmail.com \
--cc=emacs-orgmode@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).