Re: [PATCH] Add support for shortdoc link type

On 2024-06-06, 11:53 +, Ihor Radchenko wrote: > > Thanks! > Applied, onto main, with amendments. > I re-worded the manual and news entries, moved the news entry to new > features, addressed compiler warnings, and added a FIXME marking the > Emacs version check for removal when we drop Emacs

Re: [PATCH] Add support for shortdoc link type

Bruno Cardoso writes: > The attached patch is now rebased to new Org version. Thanks! Applied, onto main, with amendments. I re-worded the manual and news entries, moved the news entry to new features, addressed compiler warnings, and added a FIXME marking the Emacs version check for removal whe

Re: [PATCH] Add support for shortdoc link type

On 2024-06-05, 22:37 +0700, Max Nikulin wrote: > > A couple of notes that unlikely affect real life usage. > >> + (defun org-link--store-shortdoc (&optional _interactive?) >> +"Store \"shortdoc\" type link." >> +(when (eq major-mode 'shortdoc-mode) > > `derived-mode-p' is more reliable i

Re: [PATCH] Add support for shortdoc link type

Ihor Radchenko writes: > Bruno Cardoso writes: Please, proceed with the copyright agreement form. >>> >>> Thank you very much, Max. Just sent the form. >> >> Hi all. My copyright assignment with the FSF is complete. > > Bastien, may you please confirm? I do. Thanks Bruno for contributing!

Re: [PATCH] Add support for shortdoc link type

On 13/05/2024 20:04, Bruno Cardoso wrote: +++ b/etc/ORG-NEWS Bruno, I am sorry, but Org-9.7 has been released and your patch can not be cleanly applied any more. Please, rebase it and check that the new feature is described in the proper section for changes that have not released yet. A co

Re: [PATCH] Add support for shortdoc link type

Bruno Cardoso writes: >>> Please, proceed with the copyright agreement form. >> >> Thank you very much, Max. Just sent the form. > > Hi all. My copyright assignment with the FSF is complete. Bastien, may you please confirm? -- Ihor Radchenko // yantar92, Org mode contributor, Learn more about O

Re: [PATCH] Add support for shortdoc link type

On 2024-05-17, 11:55 -0300, Bruno Cardoso wrote: > On 2024-05-16, 17:58 +0700, Max Nikulin wrote: >> >> Thank you. Now your patch can be applied on my side as well. >> >> Please, proceed with the copyright agreement form. > > Thank you very much, Max. Just sent the form. Hi all. My copyright

Re: [PATCH] Add support for shortdoc link type

On 2024-05-16, 17:58 +0700, Max Nikulin wrote: > > Thank you. Now your patch can be applied on my side as well. > > Please, proceed with the copyright agreement form. Thank you very much, Max. Just sent the form.

Re: [PATCH] Add support for shortdoc link type

On 13/05/2024 20:04, Bruno Cardoso wrote: On 2024-05-13, 18:14 +0700, Max Nikulin wrote: Sorry, but did you manually edit the patch? I didn't. I generated it again and applied without errors. Thank you. Now your patch can be applied on my side as well. Please, proceed with the copyright ag

Re: [PATCH] Add support for shortdoc link type

On 2024-05-13, 18:14 +0700, Max Nikulin wrote: > Sorry, but did you manually edit the patch? I didn't. I generated it again and applied without errors. > If you wish to use `user-error' as in earlier revisions then you may use > > (error (user-error "Unknown shortdoc group or malforme

Re: [PATCH] Add support for shortdoc link type

On 11/05/2024 23:58, Bruno Cardoso wrote: On 2024-05-10, 18:09 +0700, Max Nikulin wrote: I haven't yet. Will be glad to. I hope, next patch revision will be the final one, so it can be notification that the procedure is completed. (Re

Re: [PATCH] Add support for shortdoc link type

On 2024-05-10, 18:09 +0700, Max Nikulin wrote: > Thank you for the explanation. Reading "lists all" I expected something > like list of all info manuals in the case of M-x info RET when there are > no info buffers yet. I see. I replaced the term "lists all" with "shows all" to avoid this conf

Re: [PATCH] Add support for shortdoc link type

On 09/05/2024 04:26, Bruno Cardoso wrote: On 2024-05-08, 18:20 +0700, Max Nikulin 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'. Interactve

Re: [PATCH] Add support for shortdoc link type

On 2024-05-08, 18:20 +0700, Max Nikulin 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 fr

Re: [PATCH] Add support for shortdoc link type

On 08/05/2024 08:11, Bruno Cardoso wrote: The following now work as expected: - [[shortdoc:string]] - [[shortdoc:string::#try-completion]] - [[shortdoc:string::identical contents]] Thanks. Bruno, the patch should have proper commit message, see

Re: [PATCH] Add support for shortdoc link type

On 2024-05-06, 17:55 +0700, Max Nikulin wrote: > 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: > - that may be handled solely by > `shortdoc-display-group' with second argument. > - that should cause >(s

Re: [PATCH] Add support for shortdoc link type

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 corr

Re: [PATCH] Add support for shortdoc link type

On 2024-05-05, 18:01 +0700, Max Nikulin wrote: > I would consider explicit mention that it is related to Emacs Lisp and > perhaps that the origin of its name is the ~shortdoc-display-group~ user > command. might be a better link. > > This line is rather long though I do not have a link where

Re: [PATCH] Add support for shortdoc link type

On 05/05/2024 00:33, Bruno Cardoso wrote: I updated the patch to use the optional function argument instead. Thanks +++ b/doc/org-manual.org @@ -3372,6 +3372,10 @@ Here is the full set of built-in link types: Execute a shell command upon activation. +- =shortdoc= :: + +Link to short

Re: [PATCH] Add support for shortdoc link type

On 2024-05-04, 14:38 +0700, Max Nikulin wrote: > It is necessary to maintain backward compatibility for `ol-info'. I do > not know what kind of separator was added earlier: "::" or "#". I > suppose, for new link type, rules more close to file: links may be used, see > (info "(org) Search Optio

Re: [PATCH] Add support for shortdoc link type

On 04/05/2024 04:41, Bruno Cardoso wrote: On 2024-05-02, 17:41 +0700, Max Nikulin wrote: [...] I implemented the search option by borrowing the regexp from `ol-info': It is necessary to maintain backward compatibility for `ol-info'. I do not know what kind of separator was added earlier:

Re: [PATCH] Add support for shortdoc link type

On 2024-05-02, 17:41 +0700, Max Nikulin wrote: > `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. > >

Re: [PATCH] Add support for shortdoc link type

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 +(

Re: [PATCH] Add support for shortdoc link type

On 2024-05-01, 17:55 +, Ihor Radchenko wrote: > Bruno Cardoso writes: > >> Thanks for your comments. See attached the updated patch. > > Thanks for the update! > >> +- =shortdoc= :: >> + >> + Link to short documentation summary for a function group. > > Might be useful to throw a link to E

Re: [PATCH] Add support for shortdoc link type

Bruno Cardoso writes: > Thanks for your comments. See attached the updated patch. Thanks for the update! > +- =shortdoc= :: > + > + Link to short documentation summary for a function group. Might be useful to throw a link to Emacs manual here - [[info:emacs#Name Help]] > +*** =ol.el=: Suppor

Re: [PATCH] Add support for shortdoc link type

Hi Ihor, Thanks for your comments. See attached the updated patch. diff --git a/doc/org-manual.org b/doc/org-manual.org index d66d95a22..c9e307c94 100644 --- a/doc/org-manual.org +++ b/doc/org-manual.org @@ -3372,6 +3372,10 @@ Here is the full set of built-in link types: Execute a shell com

Re: [PATCH] Add support for shortdoc link type

Bruno Cardoso writes: > This patch adds support for "shortdoc:" links. Thanks! > --- a/etc/ORG-NEWS > +++ b/etc/ORG-NEWS You also need to document the new built-in link type in the manual. > +(defun org-link--open-shortdoc (group _) > + "Open a \"shortdoc\" type link. > +GROUP is a symbol na