emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Max Nikulin <manikulin@gmail.com>
To: Bruno Cardoso <cardoso.bc@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: [PATCH] Add support for shortdoc link type
Date: Thu, 2 May 2024 17:41:05 +0700	[thread overview]
Message-ID: <4b69d3b8-cfe7-4ba2-b9b5-872bcaeb6fe6@gmail.com> (raw)
In-Reply-To: <87ttjhtjx1.fsf@gmail.com>

On 02/05/2024 02:24, Bruno Cardoso wrote:
> +++ b/lisp/ol.el
> @@ -1597,6 +1597,37 @@ PATH is a symbol name, as a string."
>   (org-link-set-parameters "help"
>                            :follow #'org-link--open-help
>                            :store #'org-link--store-help)
> +;;;; "shortdoc" link type
> +(when (version< "27" emacs-version)
> +  (defun org-link--open-shortdoc (group _)
> +    "Open a \"shortdoc\" type link.
> +GROUP is a symbol name."
> +    (if (assoc (intern group) shortdoc--groups)
> +        (shortdoc-display-group group)
> +      (user-error "Unknown shortdoc group: %s" group)))

`condition-case' may help to avoid the internal `shortdoc--groups' 
variable here. As to completion, it is better to ask for public API. 
However emacs developers likely will decline such request.

Consider the following just as ideas.

- Support of search options. Buttons in help pages move point to 
specific functions.

<shortdoc:file::#find-file>

- At first I considered adding shortdoc to help links that may call 
either `describe-function' or `describe-variable', but it is unlikely 
possible.


  reply	other threads:[~2024-05-02 10:41 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 [this message]
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
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=4b69d3b8-cfe7-4ba2-b9b5-872bcaeb6fe6@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).