GNU bug report logs - #36941
Please include option to link to maildir files

From: Jean Louis <bugs <at> gnu.support>
To: bug-hyperbole <at> gnu.org
Subject: Please include option to link to maildir files
Date: Tue, 06 Aug 2019 03:21:01 +0200

I use:  Editor:      GNU Emacs 27.0.50 (build 3, x86_64-pc-linux-gnu, X toolkit, Xaw3d scroll bars)

        Hyperbole:   7.0.3
        Sys Type:    x86_64-pc-linux-gnu
        OS Type:     gnu/linux
        Window Sys:  x
        News Reader: Gnus v5.13

I hope you know what are maildir messages. Each message is for itself
within a maildir folder. I know that Emacs can display such messages.

'link-to-mail'
     Displays a mail message with MAIL-MSG-ID from optional MAIL-FILE.
     See the documentation for the variable 'hmail:init-function' for
     information on how to specify the mail reader to use.

MAIL-MSG-ID is not necessary for maildir messages, as it is almost
same as link to file, the difference would be that some headers could
be hidden and message or mail mode would be turned on. Messages could
be replied, forwarded, etc.

Maybe some action can be used for maildirs, just skipping the
MAIL-MSG-ID. But it somehow need to know if it is maildir link by
asking the user.

Jean

From: Robert Weiner <rsw <at> gnu.org>
To: Jean Louis <bugs <at> gnu.support>
Cc: 36941 <at> debbugs.gnu.org
Subject: Re: bug#36941: Please include option to link to maildir files
Date: Tue, 6 Aug 2019 00:30:39 -0400

[Message part 1 (text/plain, inline)]
See the hmail.el file which offers a straightforward abstract interface for
connecting mail reader and sender formats.  Make your own maildir:
functions that that are then mapped to the hmail abstract interface via the
rmail:init function in that same file and then Hyperbole should take care
of the rest including letting you link to your messages.

We can provide pointers if you work on this.  It is a medium-difficulty
project.

Bob

On Mon, Aug 5, 2019 at 9:22 PM Jean Louis <bugs <at> gnu.support> wrote:

> I use:  Editor:      GNU Emacs 27.0.50 (build 3, x86_64-pc-linux-gnu, X
> toolkit, Xaw3d scroll bars)
>
>         Hyperbole:   7.0.3
>         Sys Type:    x86_64-pc-linux-gnu
>         OS Type:     gnu/linux
>         Window Sys:  x
>         News Reader: Gnus v5.13
>
> I hope you know what are maildir messages. Each message is for itself
> within a maildir folder. I know that Emacs can display such messages.
>
> 'link-to-mail'
>      Displays a mail message with MAIL-MSG-ID from optional MAIL-FILE.
>      See the documentation for the variable 'hmail:init-function' for
>      information on how to specify the mail reader to use.
>
> MAIL-MSG-ID is not necessary for maildir messages, as it is almost
> same as link to file, the difference would be that some headers could
> be hidden and message or mail mode would be turned on. Messages could
> be replied, forwarded, etc.
>
> Maybe some action can be used for maildirs, just skipping the
> MAIL-MSG-ID. But it somehow need to know if it is maildir link by
> asking the user.
>
> Jean
>
>
>
> _______________________________________________
> Bug-hyperbole mailing list
> Bug-hyperbole <at> gnu.org
> https://lists.gnu.org/mailman/listinfo/bug-hyperbole
>

[Message part 2 (text/html, inline)]
From: Jean Louis <bugs <at> gnu.support>
To: rswgnu <at> gmail.com
Cc: 36941 <at> debbugs.gnu.org
Subject: Re: bug#36941: Please include option to link to maildir files
Date: Tue, 6 Aug 2019 10:29:23 +0200

* Robert Weiner <rsw <at> gnu.org> [2019-08-06 06:31]:
  :PROPERTIES:
  :CREATED:  [2019-08-06 Di 10:29]
  :ID:       c8efee11-dd5b-4c68-83eb-00d3db9ad7ba
  :END:
> See the hmail.el file which offers a straightforward abstract interface for
> connecting mail reader and sender formats.  Make your own maildir:
> functions that that are then mapped to the hmail abstract interface via the
> rmail:init function in that same file and then Hyperbole should take care
> of the rest including letting you link to your messages.
> 
> We can provide pointers if you work on this.  It is a medium-difficulty
> project.

That is why I suggested making customization group for buttons. As
that would easy everything. One can add Elisp function and link type is added. 

From: Robert Weiner <rsw <at> gnu.org>
To: Jean Louis <bugs <at> gnu.support>
Cc: 36941 <at> debbugs.gnu.org
Subject: Re: bug#36941: Please include option to link to maildir files
Date: Tue, 6 Aug 2019 22:32:12 -0400

[Message part 1 (text/plain, inline)]
On Tue, Aug 6, 2019 at 4:29 AM Jean Louis <bugs <at> gnu.support> wrote:

>
> That is why I suggested making customization group for buttons. As
> that would easy everything. One can add Elisp function and link type is
> added.
>

Can you show a very simple example of what you want with a detailed
explanation?  I did not follow your prior org mode examples in detail.  I
don't understand that last sentence other than that Org lets you specify
the type of link as part of the link text whereas Hyperbole doesn't embed
the types in the buffer text itself.  Just produce a very simple use case
and explain it step by step and then I will be able to tell what if
anything is missing from Hyperbole now that you need to build what you want.

Bob

[Message part 2 (text/html, inline)]
From: Jean Louis <bugs <at> gnu.support>
To: rswgnu <at> gmail.com
Cc: 36941 <at> debbugs.gnu.org
Subject: Re: bug#36941: Please include option to link to maildir files
Date: Wed, 7 Aug 2019 09:20:03 +0200

* Robert Weiner <rsw <at> gnu.org> [2019-08-07 04:33]:
> On Tue, Aug 6, 2019 at 4:29 AM Jean Louis <bugs <at> gnu.support> wrote:
> 
> >
> > That is why I suggested making customization group for buttons. As
> > that would easy everything. One can add Elisp function and link type is
> > added.
> >
> 
> Can you show a very simple example of what you want with a detailed
> explanation?  I did not follow your prior org mode examples in detail.  I
> don't understand that last sentence other than that Org lets you specify
> the type of link as part of the link text whereas Hyperbole doesn't embed
> the types in the buffer text itself.  Just produce a very simple use case
> and explain it step by step and then I will be able to tell what if
> anything is missing from Hyperbole now that you need to build what you want.

Request is for simple customization option so that new links and
button types can easily be customized and created.

Do this:

1. M-x customize-group RET org-link RET

2. Find "Org Link Abbrev List"

3. That is what Hyperbole needs, customization of links. Or maybe it
   could simply re-use Org functionality.

For example I could add a new link with protocol "SMS" and Value Menu
Format: SMS:%s

Or maybe new protocl "gpatent" meaning Google Patent with value
"https://www.google.com/patents/US%s"

Then if I make this link in Org:

[[gpatent:481550][Ore washer and concentrator, by Arthur L. Dana]]

It will be shown as "Ore washer and concentrator, by Arthur L. Dana"
and if I click on this link, I can see the Google Patent online.

However, web search is not as important: More important is elisp
functions. Than I would not need to work with Hyperbole intervals.

But functions are not well implemented in Org. They allow only
function without parameter.

What we need is link that allows parameters, which can be customized
to run on such parameter.

Synonym is <[Media]>: "~/Media"

However, that implementation does not look well.

As Hyperbola us using special file outside of the text to define
links, I see no reason why such links, even parameters could not be
defined in that separate file.

Even simple words could be defined in that separate file to be links
for something. Isn't it?

I could define word GNU in the directory, to be the link in the file
about-gnu.txt to https://www.gnu.org

Then for example, I could define word "notes" to be link to the action
"notes" with parameter ID: 123.

Jean

From: Robert Weiner <rswgnu <at> gmail.com>
To: Jean Louis <bugs <at> gnu.support>
Cc: hyperbole-users <at> gnu.org, 36941 <at> debbugs.gnu.org
Subject: Re: bug#36941: Please include option to link to maildir files
Date: Wed, 7 Aug 2019 08:11:10 -0400

> On Aug 7, 2019, at 3:20 AM, Jean Louis <bugs <at> gnu.support> wrote:
> 
> * Robert Weiner <rsw <at> gnu.org> [2019-08-07 04:33]:
>>> On Tue, Aug 6, 2019 at 4:29 AM Jean Louis <bugs <at> gnu.support> wrote:
>>> 
>>> 
>>> That is why I suggested making customization group for buttons. As that would easy everything. One can add Elisp function and link type is added.
>>> 
>> 
>> Can you show a very simple example of what you want with a detailed explanation?  I did not follow your prior org mode examples in detail.  I don't understand that last sentence other than that Org lets you specify the type of link as part of the link text whereas Hyperbole doesn't embed the types in the buffer text itself.  Just produce a very simple use case
>> and explain it step by step and then I will be able to tell what if
>> anything is missing from Hyperbole now that you need to build what you want.
> 
> Request is for simple customization option so that new links and button types can easily be customized and created.
> 
> Do this:
> 
> 1. M-x customize-group RET org-link RET
> 
> 2. Find "Org Link Abbrev List"
> 
> 3. That is what Hyperbole needs, customization of links. Or maybe it
>   could simply re-use Org functionality.

As of the 7.0.3a test release, any Org links should work via the Action Key but only in Org mode.  For this kind of behavior anywhere, you would define an implicit button type that recognized a double quoted link type name followed by some number of parameters and then its action type would dispatch to functions from a list of type names, just as Org mode does now.  I will show you a sample implementation when I get a chance but my point is that no new features are needed in Hyperbole to implement this, except that the type and parameters will be displayed in the buffer unless you create the buttons as explicit ones.

> 
> For example I could add a new link with protocol "SMS" and Value Menu
> Format: SMS:%s
> 
> Or maybe new protocl "gpatent" meaning Google Patent with value
> "https://www.google.com/patents/US%s"
> 
> Then if I make this link in Org:
> 
> [[gpatent:481550][Ore washer and concentrator, by Arthur L. Dana]]
> 
> It will be shown as "Ore washer and concentrator, by Arthur L. Dana"
> and if I click on this link, I can see the Google Patent online.
> 
> However, web search is not as important: More important is elisp
> functions. Than I would not need to work with Hyperbole intervals.
> 
> But functions are not well implemented in Org. They allow only
> function without parameter.
> 
> What we need is link that allows parameters, which can be customized
> to run on such parameter.
> 
> Synonym is <[Media]>: "~/Media"
> 
> However, that implementation does not look well.

We are still open to other syntaxes but the label must itself be delimited.
> 
> As Hyperbola is using special file outside of the text to define
> links, I see no reason why such links, even parameters could not be defined in that separate file.

They are with explicit buttons which each have an action type that can take an arbitrary number of parameters and prompt for each one.

> 
> Even simple words could be defined in that separate file to be links for something. Isn't it?

That would be implicit button types.

> 
> I could define word GNU in the directory, to be the link in the file about-gnu.txt to https://www.gnu.org
> 
> Then for example, I could define word "notes" to be link to the action
> "notes" with parameter ID: 123.

Basically, you want to be able to define implicit link types as you would in a database table, as a list of typed fields and then instantiate these types within buffers just as you now do.  The missing part is being able to create, edit and look up the types from a table rather than as a list of types that we have now that covers not just link types but all button types.

Bob

From: Robert Weiner <rsw <at> gnu.org>
To: Jean Louis <bugs <at> gnu.support>
Cc: 36941 <at> debbugs.gnu.org
Subject: Re: bug#36941: Please include option to link to maildir files
Date: Sun, 18 Aug 2019 13:53:57 -0400

[Message part 1 (text/plain, inline)]
On Mon, Aug 5, 2019 at 9:22 PM Jean Louis <bugs <at> gnu.support> wrote:

> I use:  Editor:      GNU Emacs 27.0.50 (build 3, x86_64-pc-linux-gnu, X
> toolkit, Xaw3d scroll bars)
>
>         Hyperbole:   7.0.3
>         Sys Type:    x86_64-pc-linux-gnu
>         OS Type:     gnu/linux
>         Window Sys:  x
>         News Reader: Gnus v5.13
>
> I hope you know what are maildir messages. Each message is for itself
> within a maildir folder. I know that Emacs can display such messages.
>
> 'link-to-mail'
>      Displays a mail message with MAIL-MSG-ID from optional MAIL-FILE.
>      See the documentation for the variable 'hmail:init-function' for
>      information on how to specify the mail reader to use.
>
> MAIL-MSG-ID is not necessary for maildir messages, as it is almost
> same as link to file, the difference would be that some headers could
> be hidden and message or mail mode would be turned on. Messages could
> be replied, forwarded, etc.
>
> Maybe some action can be used for maildirs, just skipping the
> MAIL-MSG-ID. But it somehow need to know if it is maildir link by
> asking the user.
>

I am still unclear on precisely what you would want.

Do you want a Hyperbole action type that links to maildir messages where
you would specify the full path to the maildir message file and Hyperbole
would display the message in the mail reader that you assigned to
hmail:reader variable?  Then you could use that in explicit button and
implicit button type definitions.

Do you want an implicit button type that recognizes maildir message ids in
buffers?

Something else?

Bob

[Message part 2 (text/html, inline)]
From: Jean Louis <bugs <at> gnu.support>
To: rswgnu <at> gmail.com
Cc: 36941 <at> debbugs.gnu.org
Subject: Re: bug#36941: Please include option to link to maildir files
Date: Sun, 18 Aug 2019 20:59:16 +0200

* Robert Weiner <rsw <at> gnu.org> [2019-08-18 19:55]:
> > 'link-to-mail'
> >      Displays a mail message with MAIL-MSG-ID from optional MAIL-FILE.
> >      See the documentation for the variable 'hmail:init-function' for
> >      information on how to specify the mail reader to use.
> >
> > MAIL-MSG-ID is not necessary for maildir messages, as it is almost
> > same as link to file, the difference would be that some headers could
> > be hidden and message or mail mode would be turned on. Messages could
> > be replied, forwarded, etc.
> >
> > Maybe some action can be used for maildirs, just skipping the
> > MAIL-MSG-ID. But it somehow need to know if it is maildir link by
> > asking the user.
> >
> 
> I am still unclear on precisely what you would want.
> 
> Do you want a Hyperbole action type that links to maildir messages where
> you would specify the full path to the maildir message file and Hyperbole
> would display the message in the mail reader that you assigned to
> hmail:reader variable?  Then you could use that in explicit button and
> implicit button type definitions.
> 
> Do you want an implicit button type that recognizes maildir message ids in
> buffers?
> 
> Something else?

Thank you Bob.

You have created `link-to-mail`. But that probably means to link to
mail message in mbox file. I cannot be so sure, as I do not use mbox
format.

Maildir format is well known, it is already standard for many pieces
of software[1][2][3][4].

As part of the `link-to-mail` function I propose that you expand the
function that it supports to link to mail file which is part of
maildir format. That is explicit button extension to your function
which does not support maildirs.

Example maildir directory is shown here:

  /home/data1/protected/Maildir/rsw <at> gnu.org:
  insgesamt 12K
  drwx------ 2 4,0K 12. Aug 13:04 cur
  drwx------ 2 4,0K 23. Nov 2017  new
  drwx------ 2 4,0K 12. Aug 13:04 tmp

Example messages in `cur` are shown here:

  /home/data1/protected/Maildir/rsw <at> gnu.org/cur:
  insgesamt 16K
  -rw------- 1 6,0K 23. Nov 2017  1511412843.18643_5.protected:2,S
  -rw------- 1 4,6K 11. Aug 17:58 1565607852.20344_65.protected:2,S

Thus to link to certain message in Maildir format is equivalent to
linking it to the file such as it is:

/home/data1/protected/Maildir/rsw <at> gnu.org/cur/1511412843.18643_5.protected:2,S

and turning on certain mode to read such message, maybe message-mode
in read-only mode, this I do not know.

I have 300,000 messages in Maildir format, and very few in mbox
format.

Jean

Footnotes:
[1]  https://en.wikipedia.org/wiki/Maildir

[2]  https://wiki2.dovecot.org/MailboxFormat/Maildir

[3]  https://cr.yp.to/proto/maildir.html

[4]  http://www.courier-mta.org/maildir.html

From: Robert Weiner <rsw <at> gnu.org>
To: Jean Louis <bugs <at> gnu.support>
Cc: 36941 <at> debbugs.gnu.org
Subject: Re: bug#36941: Please include option to link to maildir files
Date: Sun, 18 Aug 2019 15:30:23 -0400

[Message part 1 (text/plain, inline)]
I looked at some doc for maildir, so I understand the format though your
examples are very helpful.  The question is how a user would link to a
message and how you normally read such a message (what mode do you
invoke).  I would suspect you would want to link to the message when
displaying it in some window, when on the file name in a dired buffer and
potentially something like "link to most recent message from <user>".  All
of these require different bits of code.

Have you tried using Hyperbole's drag actions to create an explicit link to
a file?  Just type the label for the new button you want, select that
label, depress the Action Mouse Key somewhere in the label, drag to the
dired entry of the email message you want a link to and voila, you have an
explicit button linked to that file.  But to make it use some mode, you
would need a custom action type that invoked the mode.

Bob

[Message part 2 (text/html, inline)]
From: Jean Louis <bugs <at> gnu.support>
To: rswgnu <at> gmail.com
Cc: 36941 <at> debbugs.gnu.org
Subject: Re: bug#36941: Please include option to link to maildir files
Date: Sun, 18 Aug 2019 21:53:43 +0200

* Robert Weiner <rsw <at> gnu.org> [2019-08-18 21:31]:
> I looked at some doc for maildir, so I understand the format though your
> examples are very helpful.  The question is how a user would link to a
> message

If I am in the message, it has its filename, right? So I can just get
its file path. That is my idea on how to link to the message. It is
also very simple idea.

If I would change flag on the message to become new again, it would be
renamed by Maildir standard and be placed in Maildir/new directory,
and I would not mind loosing such link in that case.

> and how you normally read such a message (what mode do you invoke).

Right now within Emacs I am reading emails with `maildir` package.

It is invoking from message-mode derived mode maildir-message-mode.

I would suggest that it should be option which mode to invoke open
reading such message, with default to be message-mode, as such is
standard in Emacs.

Or you could make derived mode in Hyperbole for that, you could look
into maildir package and maybe make it nicer, as for example if I
invoke just message-mode on the message, I cannot reply, and there are
too many headers, some of them shall be hidden, as linking to message
is usually not for purpose of replying to the message, but to present
the message as a note to the salesman who must understand the
background of person and conversation in question.

> I would suspect you would want to link to the message when
> displaying it in some window, when on the file name in a dired
> buffer and potentially something like link to most recent message
> from <user>.  All of these require different bits of code.

No, not from dired. As from dired I can read it anyway.

My suggestion is related to function link-to-mail which shall be
expanded to link to certain message within maildir directory.

I would provide the path to the message, and link would appear as I
wish, for example <(Message from 10/10/2019)> could be link to the
message that points to ~/Maildir/user <at> example.com/cur/message and is
invoking the mode by my choice, maybe maildir-message-mode or
message-mode 

> Have you tried using Hyperbole's drag actions to create an explicit link to
> a file?

That is about the same workflow.

I could use link-to-file and then I could make some tweaks in Emacs to
invoke certain maildir message reading mode when such message is
located in certain directory, right? Sure it would work this way.

My proposal is related to your function link-to-mail as if you have
never used Maildirs you may not be aware that it is widely used. So
when user finds link-to-mail, that is first to think how to link to
message but Maildir is not support. It is your decision on that. At
least it gives enough substantial reasons based on reality of
Maildirs, but not that it gives real demand.

There are not so many users of Maildirs that may require such
function, that may be so.

> Just type the label for the new button you want, select that label,
> depress the Action Mouse Key somewhere in the label, drag to the
> dired entry of the email message you want a link to and voila, you
> have an explicit button linked to that file.  But to make it use
> some mode, you would need a custom action type that invoked the
> mode.

Alright

Jean

From: Robert Weiner <rsw <at> gnu.org>
To: Jean Louis <bugs <at> gnu.support>
Cc: 36941 <at> debbugs.gnu.org
Subject: Re: bug#36941: Please include option to link to maildir files
Date: Sun, 18 Aug 2019 18:11:41 -0400

[Message part 1 (text/plain, inline)]
On Sun, Aug 18, 2019 at 3:53 PM Jean Louis <bugs <at> gnu.support> wrote:

> * Robert Weiner <rsw <at> gnu.org> [2019-08-18 21:31]:
> > I looked at some doc for maildir, so I understand the format though your
> > examples are very helpful.  The question is how a user would link to a
> > message
>
> My suggestion is related to function link-to-mail which shall be
> expanded to link to certain message within maildir directory.
>
> I would provide the path to the message, and link would appear as I
> wish, for example <(Message from 10/10/2019)> could be link to the
> message that points to ~/Maildir/user <at> example.com/cur/message and is
> invoking the mode by my choice, maybe maildir-message-mode or
> message-mode
>

I understand what you want now and am thinking about adding it in.

Also, thinking through a solution for your desire to specify parameterized
buttons entirely within a buffer.

You have good ideas and are finding issues that we can improve and make
Hyperbole better.

Thanks,

Bob

[Message part 2 (text/html, inline)]
From: Robert Weiner <rsw <at> gnu.org>
To: Jean Louis <bugs <at> gnu.support>
Cc: hyperbole-users <hyperbole-users <at> gnu.org>, 36941 <at> debbugs.gnu.org
Subject: Re: bug#36941 Want programmable parameterized link buttons: (Was:
 Please include option to link to maildir files)
Date: Sat, 24 Aug 2019 01:11:47 -0400

[Message part 1 (text/plain, inline)]
On Wed, Aug 7, 2019 at 3:21 AM Jean Louis <bugs <at> gnu.support> wrote:

> * Robert Weiner <rsw <at> gnu.org> [2019-08-07 04:33]:
> > On Tue, Aug 6, 2019 at 4:29 AM Jean Louis <bugs <at> gnu.support> wrote:
> >
> > >
> > > That is why I suggested making customization group for buttons. As
> > > that would easy everything. One can add Elisp function and link type is
> > > added.
>
> Request is for simple customization option so that new links and
> button types can easily be customized and created.
>
> For example I could add a new link with protocol "SMS" and Value Menu
> Format: SMS:%s
>
> Or maybe new protocOl "gpatent" meaning Google Patent with value
> "https://www.google.com/patents/US%s"
>
> Then if I make this link in Org:
>
> [[gpatent:481550][Ore washer and concentrator, by Arthur L. Dana]]
>
> It will be shown as "Ore washer and concentrator, by Arthur L. Dana"
> and if I click on this link, I can see the Google Patent online.
>
> However, web search is not as important: More important is elisp
> functions. Than I would not need to work with Hyperbole intervals.
>
> But functions are not well implemented in Org. They allow only
> function without parameter.
>
> What we need is link that allows parameters, which can be customized
> to run on such parameter.
>
> Synonym is <[Media]>: "~/Media"
>
> However, that implementation does not look well.
>
> As Hyperbola us using special file outside of the text to define
> links, I see no reason why such links, even parameters could not be
> defined in that separate file.
>
> Even simple words could be defined in that separate file to be links
> for something. Isn't it?
>
> I could define word GNU in the directory, to be the link in the file
> about-gnu.txt to https://www.gnu.org
>
> Then for example, I could define word "notes" to be link to the action
> "notes" with parameter ID: 123.
>

Hi Jean:

FYI, the following behavior is implemented in my working copy of Hyperbole
but not yet released anywhere.  It will be in the next test release.  Using
what is described below together with globally labeled/named implicit
buttons, you can create in-buffer, parameterized Action Buttons that you
can invoke from anywhere by name or by pressing the Action Key on them.  I
hope this will meet the bulk of your needs and be easy to use.

------
From the DEMO file:

** Action Buttons

A new feature of Hyperbole is a universal syntax for creating implicit
buttons of any existing type, known as Action Buttons.  Such buttons are
delimited by angle brackets, < > and come in three forms:

  1. action type invocations - these begin with an action type name (from
the
     list displayed by {C-h h d t a RET}) and are followed by any needed
     arguments to form the action, e.g.

          <link-to-file-line "${hyperb:dir}/hact.el" 40>

  2. function calls - these are similar to action type invocations but begin
     with an Elisp function name rather than an action type name, e.g.

          <find-file-other-window "/tmp">

  3. variable displays - these consist of just an Elisp variable name and
     display a message with the variable name and value, e.g.

          <fill-column>

Since implicit buttons can be labeled with a name and placed in the global
button file for invocation by name, you can give short names to any such
buttons you want to invoke frequently.

An Action Button is recognized only if the first name within the angle
brackets is an existing action type or Elisp symbol.  Otherwise, other
implicit button types will be tested and may activate instead.

With Action Buttons you need not remember any special syntax for each type
of
implicit button.  You can freely embed them in any type of text and use the
Action and Assist keys on them as you do with any other type of implicit
button.

Bob

[Message part 2 (text/html, inline)]
From: Jean Louis <bugs <at> gnu.support>
To: rswgnu <at> gmail.com
Cc: hyperbole-users <hyperbole-users <at> gnu.org>, 36941 <at> debbugs.gnu.org
Subject: Re: bug#36941 Want programmable parameterized link buttons: (Was:
 Please include option to link to maildir files)
Date: Sun, 25 Aug 2019 23:25:18 +0200

This is great Robert, thank you.

Myself I am thinking in terms of HyperScope as envisioned by Doug
Engelbart, so in the mean time I have started building a system.

My system is based on the database.

Do you think that I can bind .hypb file to certain key which is not a
file?

For example I have database table hlinks with hlinks_id and I would
like to bind .hypb maybe also as a string to the hlinks_text database
field.

Is there such function already in Hyperbole, to tell "where is the
.hypb" file? I could place it temporarily maybe in any directory and
then after usage delete it automatically.

Does that exist?

Jean

* Robert Weiner <rsw <at> gnu.org> [2019-08-24 07:12]:
> FYI, the following behavior is implemented in my working copy of Hyperbole
> but not yet released anywhere.  It will be in the next test release.  Using
> what is described below together with globally labeled/named implicit
> buttons, you can create in-buffer, parameterized Action Buttons that you
> can invoke from anywhere by name or by pressing the Action Key on them.  I
> hope this will meet the bulk of your needs and be easy to use.
> 
> ------
> From the DEMO file:
> 
> ** Action Buttons
> 
> A new feature of Hyperbole is a universal syntax for creating implicit
> buttons of any existing type, known as Action Buttons.  Such buttons are
> delimited by angle brackets, < > and come in three forms:
> 
>   1. action type invocations - these begin with an action type name (from
> the
>      list displayed by {C-h h d t a RET}) and are followed by any needed
>      arguments to form the action, e.g.
> 
>           <link-to-file-line ${hyperb:dir}/hact.el 40>
> 
>   2. function calls - these are similar to action type invocations but begin
>      with an Elisp function name rather than an action type name, e.g.
> 
>           <find-file-other-window /tmp>
> 
>   3. variable displays - these consist of just an Elisp variable name and
>      display a message with the variable name and value, e.g.
> 
>           <fill-column>
> 
> Since implicit buttons can be labeled with a name and placed in the global
> button file for invocation by name, you can give short names to any such
> buttons you want to invoke frequently.
> 
> An Action Button is recognized only if the first name within the angle
> brackets is an existing action type or Elisp symbol.  Otherwise, other
> implicit button types will be tested and may activate instead.
> 
> With Action Buttons you need not remember any special syntax for each type
> of
> implicit button.  You can freely embed them in any type of text and use the
> Action and Assist keys on them as you do with any other type of implicit
> button.

From: Robert Weiner <rswgnu <at> gmail.com>
To: Jean Louis <bugs <at> gnu.support>
Cc: hyperbole-users <hyperbole-users <at> gnu.org>, 36941 <at> debbugs.gnu.org
Subject: Re: bug#36941: Want programmable parameterized link buttons: (Was:
 Please include option to link to maildir files)
Date: Sun, 25 Aug 2019 18:22:46 -0500

The .hypb file for a button is always in the same directory as the Button’s file, so just take its dirne and append .hypb.

-- Bob

> On Aug 25, 2019, at 4:25 PM, Jean Louis <bugs <at> gnu.support> wrote:
> 
> This is great Robert, thank you.
> 
> Myself I am thinking in terms of HyperScope as envisioned by Doug
> Engelbart, so in the mean time I have started building a system.
> 
> My system is based on the database.
> 
> Do you think that I can bind .hypb file to certain key which is not a
> file?
> 
> For example I have database table hlinks with hlinks_id and I would
> like to bind .hypb maybe also as a string to the hlinks_text database
> field.
> 
> Is there such function already in Hyperbole, to tell "where is the
> .hypb" file? I could place it temporarily maybe in any directory and
> then after usage delete it automatically.
> 
> Does that exist?
> 
> Jean
> 
> * Robert Weiner <rsw <at> gnu.org> [2019-08-24 07:12]:
>> FYI, the following behavior is implemented in my working copy of Hyperbole
>> but not yet released anywhere.  It will be in the next test release.  Using
>> what is described below together with globally labeled/named implicit
>> buttons, you can create in-buffer, parameterized Action Buttons that you
>> can invoke from anywhere by name or by pressing the Action Key on them.  I
>> hope this will meet the bulk of your needs and be easy to use.
>> 
>> ------
>> From the DEMO file:
>> 
>> ** Action Buttons
>> 
>> A new feature of Hyperbole is a universal syntax for creating implicit
>> buttons of any existing type, known as Action Buttons.  Such buttons are
>> delimited by angle brackets, < > and come in three forms:
>> 
>>  1. action type invocations - these begin with an action type name (from
>> the
>>     list displayed by {C-h h d t a RET}) and are followed by any needed
>>     arguments to form the action, e.g.
>> 
>>          <link-to-file-line ${hyperb:dir}/hact.el 40>
>> 
>>  2. function calls - these are similar to action type invocations but begin
>>     with an Elisp function name rather than an action type name, e.g.
>> 
>>          <find-file-other-window /tmp>
>> 
>>  3. variable displays - these consist of just an Elisp variable name and
>>     display a message with the variable name and value, e.g.
>> 
>>          <fill-column>
>> 
>> Since implicit buttons can be labeled with a name and placed in the global
>> button file for invocation by name, you can give short names to any such
>> buttons you want to invoke frequently.
>> 
>> An Action Button is recognized only if the first name within the angle
>> brackets is an existing action type or Elisp symbol.  Otherwise, other
>> implicit button types will be tested and may activate instead.
>> 
>> With Action Buttons you need not remember any special syntax for each type
>> of
>> implicit button.  You can freely embed them in any type of text and use the
>> Action and Assist keys on them as you do with any other type of implicit
>> button.
> 
> 
> 
> _______________________________________________
> Bug-hyperbole mailing list
> Bug-hyperbole <at> gnu.org
> https://lists.gnu.org/mailman/listinfo/bug-hyperbole

From: Jean Louis <bugs <at> gnu.support>
To: Robert Weiner <rswgnu <at> gmail.com>
Cc: hyperbole-users <hyperbole-users <at> gnu.org>, 36941 <at> debbugs.gnu.org
Subject: Re: bug#36941: Want programmable parameterized link buttons: (Was:
 Please include option to link to maildir files)
Date: Mon, 26 Aug 2019 22:39:22 +0200

* Robert Weiner <rswgnu <at> gmail.com> [2019-08-26 01:23]:
> The .hypb file for a button is always in the same directory as the
> Button’s file, so just take its dirne and append .hypb.

Thanks I get it.
Jean

GNU bug report logs - #36941 Please include option to link to maildir files

GNU bug report logs - #36941
Please include option to link to maildir files