[PATCH] org-protocol: Fix missing '+' in js snippet

[PATCH] org-protocol: Fix missing '+' in js snippet

[David Asabina]

* org-protocol (org-protocol-capture): Add missing plus-sign to
javascript snippet to allow readers of the doc string to use example
snippet with minimal edits.

TINYCHANGE
---
 lisp/org-protocol.el | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lisp/org-protocol.el b/lisp/org-protocol.el
index 731f51e19..7e9f3b26a 100644
--- a/lisp/org-protocol.el
+++ b/lisp/org-protocol.el
@@ -464,7 +464,7 @@ This function detects an URL, title and optional text, separated
 by `/'.  The location for a browser's bookmark looks like this:
 
   javascript:location.href = \\='org-protocol://capture?url=\\='+ \\
-        encodeURIComponent(location.href) + \\='&title=\\=' \\
+        encodeURIComponent(location.href) + \\='&title=\\=' + \\
         encodeURIComponent(document.title) + \\='&body=\\=' + \\
         encodeURIComponent(window.getSelection())
 
-- 
2.29.3

Re: [PATCH] org-protocol: Fix missing '+' in js snippet

[Maxim Nikulin]

On 19/04/2021 17:53, David Asabina wrote:
>   
>     javascript:location.href = \\='org-protocol://capture?url=\\='+ \\
> -        encodeURIComponent(location.href) + \\='&title=\\=' \\
> +        encodeURIComponent(location.href) + \\='&title=\\=' + \\
>           encodeURIComponent(document.title) + \\='&body=\\=' + \\
>           encodeURIComponent(window.getSelection())

I am not a maintainer, so I can not merge the patch. I hope, finally it 
will happen, maybe some months later.

I have a question that is a bit off-topic in this thread however. Since 
you are setting up org-protocol, you may notice other issues. There were 
reports that two slashes after "org-protocol:" cause some problems. My 
guess is that capture is recognized as hostname, so another slash is 
inserted after it. There was a patch allowing "/" before "?" to get 
things work (perhaps on Windows). Could you try, please, if one or three 
slashes in org-protocol URIs ("org-protocol:/capture?url=..." and 
"org-protocol:///capture?url=...") works properly in your environment? 
Maybe code examples in docs would benefit from one more correction.

Re: [PATCH] org-protocol: Fix missing '+' in js snippet

[Bastien]

Hi Maxim,

Maxim Nikulin <manikulin@gmail.com> writes:

> On 19/04/2021 17:53, David Asabina wrote:
>>       javascript:location.href =
>> \\='org-protocol://capture?url=\\='+ \\
>> -        encodeURIComponent(location.href) + \\='&title=\\=' \\
>> +        encodeURIComponent(location.href) + \\='&title=\\=' + \\
>>           encodeURIComponent(document.title) + \\='&body=\\=' + \\
>>           encodeURIComponent(window.getSelection())
>
> I am not a maintainer, so I can not merge the patch. I hope, finally
> it will happen, maybe some months later.

Would you like to volunteer as the maintainer for org-protocol.el?

For now org-protocol.el indicates that Sebastian Rose, the original
author, is the maintainer, but I don't think he would mind handing it
to someone else.

Re: [PATCH] org-protocol: Fix missing '+' in js snippet

[Maxim Nikulin]

Hi Bastien.

On 28/04/2021 12:40, you wrote:
> Hi Maxim,
> 
> Would you like to volunteer as the maintainer for org-protocol.el?
> 
> For now org-protocol.el indicates that Sebastian Rose, the original
> author, is the maintainer, but I don't think he would mind handing it
> to someone else.

I am proud to get such offer, but I am afraid, it is too early. I do not 
have enough experience with elisp and emacs. Beware of putting a vimer 
into maintainer position...

Example of my ignorance: I suspect, I did not recognize that apostrophe 
needs special escaping in doc strings
https://orgmode.org/list/s4hsag$ogg$1@ciao.gmane.io/

Actually, I do not think, org-protocol requires a dedicated maintainer. 
There are a few things that may be improved, but they should be 
discussed at first. It seems, all current user already managed to 
configure their handlers and prefer to not experiment any more. So there 
is a little interest in this area.

Re: [PATCH] org-protocol: Fix missing '+' in js snippet

[Bastien]

Hi Maxim,

Maxim Nikulin <manikulin@gmail.com> writes:

> On 28/04/2021 12:40, you wrote:
>> Hi Maxim,
>> Would you like to volunteer as the maintainer for org-protocol.el?
>> For now org-protocol.el indicates that Sebastian Rose, the original
>> author, is the maintainer, but I don't think he would mind handing it
>> to someone else.
>
> I am proud to get such offer, but I am afraid, it is too early. I do
> not have enough experience with elisp and emacs. Beware of putting a
> vimer into maintainer position...

Fine :)

> Example of my ignorance: I suspect, I did not recognize that
> apostrophe needs special escaping in doc strings
> https://orgmode.org/list/s4hsag$ogg$1@ciao.gmane.io/
>
> Actually, I do not think, org-protocol requires a dedicated
> maintainer. There are a few things that may be improved, but they
> should be discussed at first. It seems, all current user already
> managed to configure their handlers and prefer to not experiment any
> more. So there is a little interest in this area.

I don't use org-protocol.el myself and I'd rather have someone using
it being able to reproduce bugs and help maintainers fix problems.

Anyway, glad to have your input/patches on org-protocol.el anyway.

Thanks,

-- 
 Bastien

Re: [PATCH] org-protocol: Fix missing '+' in js snippet

[Maxim Nikulin]

On 30/04/2021 14:21, Bastien wrote:
> Maxim Nikulin writes:
>> On 28/04/2021 12:40, Bastien wrote:
>>>
>>> Would you like to volunteer as the maintainer for org-protocol.el?
>>> For now org-protocol.el indicates that Sebastian Rose, the original
>>> author, is the maintainer, but I don't think he would mind handing it
>>> to someone else.

Let me rise an issue related to org protocol that I consider important 
enough. Test are not executed by default, so there is a chance that 
breaking changes will be committed untested. There are two options:

1. Add org-protocol to the list of loaded packaged. The drawback is that 
test run will not detect unintentional dependency of org core on 
org-protocol.
2. Add a separate command to Makefile that tests exclusively 
org-protocol and update testing/README with reminder concerning 
org-protocol.

I believe that variant 2 is better, but opinion of core maintainers and 
their workflow is certainly more important.

> ...
>> Example of my ignorance: I suspect, I did not recognize that
>> apostrophe needs special escaping in doc strings
>> https://orgmode.org/list/s4hsag$ogg$1@ciao.gmane.io/

By the way, the patch (I have updated it in meanwhile) is not tracked on 
https://updates.orgmode.org/. I could not figure out what was the 
difference from e.g. 
https://orgmode.org/list/s6c1cm$174s$1@ciao.gmane.io/ Should I file an 
issue at github?

>> Actually, I do not think, org-protocol requires a dedicated
>> maintainer. There are a few things that may be improved, but they
>> should be discussed at first. It seems, all current user already
>> managed to configure their handlers and prefer to not experiment any
>> more. So there is a little interest in this area.
> 
> I don't use org-protocol.el myself and I'd rather have someone using
> it being able to reproduce bugs and help maintainers fix problems.

It is funny, but I am not an active org-protocol user as well. I tried 
it, then I decided to create a browser extension that extracts some 
metadata in addition to page title. Since I am not satisfied with 
capture quality yet, I have to inspect page structure often enough. That 
is why there is no point to minimize interaction (primary goal of 
org-protocol) and I usually copy result and call org-paste-subtree. 
Though I test from time to time that org-protocol is not broken in my 
extension. The goal of my patches to org-protocol is to avoid some 
surprises I have faced.

Since I use linux, I can not reproduce windows or mac problems. 
Extrapolation of linux issues is not always applicable.

There were ~10 threads related to org protocol issues over 1.5 years I 
have in local cache, so it is not a hot topic that deserves a 
maintainer. Do not worry.

Re: [PATCH] org-protocol: Fix missing '+' in js snippet

[David Asabina]

[-- Attachment #1: Type: text/plain, Size: 2967 bytes --]

> Thank you. However on linux there is another degree of freedom: various
> desktop environments can be different in respect to treatment of URLs before
> passing them to protocol handlers. I have tried KDE and a kind of
> minimalistic setup inside container (xdg-utils) so far. Anyway it is good to
> receive confirmation that it could work for other people.
Perhaps the following helps provide more context:

- OS: NixOS 20.09
- WM: Xmonad 0.15

> In the meanwhile I have realized that bug report I mentioned was for Windows
> with emacs running in WSL
> https://orgmode.org/list/87zhbq7zin.fsf@pie.tf/
I have no access to Windows setups at the moment to test that -- just
NixOS and macOS.

> P.S. Since your response was private, I am unsure if Cc:
> emacs-orgmode@gnu.org should be added.
I'm definitely new with this workflow of `git send-email` so I totally
missed that I didn't reply to the group -- I didn't reply-to-group in
mutt so that was on me.

Not sure what the policy is on keeping the signal-to-noise manageably
low on the mailing groups as I'm very much of a noob here 🤣 so I'll
just add the CC address and I trust that I'll hear when I'm contributing
to more noise than signal. 😉

On Tue, May 04, 2021 at 11:44:34PM +0700, Maxim Nikulin wrote:
> On 03/05/2021 22:25, David Asabina wrote:
> > > I have a question that is a bit off-topic in this thread however. Since you
> > > are setting up org-protocol, you may notice other issues. There were reports
> > > that two slashes after "org-protocol:" cause some problems. My guess is that
> > > capture is recognized as hostname, so another slash is inserted after it.
> > > There was a patch allowing "/" before "?" to get things work (perhaps on
> > > Windows). Could you try, please, if one or three slashes in org-protocol
> > > URIs ("org-protocol:/capture?url=..." and "org-protocol:///capture?url=...")
> > > works properly in your environment? Maybe code examples in docs would
> > > benefit from one more correction.
> > 
> > I've tried:
> > - org-protocol:/capture?template=t&url=emacs.org and
> > - org-protocol:///capture?template=t&url=emacs.org
> > and both worked like a charm on my setup (Firefox on NixOS).
> 
> Thank you. However on linux there is another degree of freedom: various
> desktop environments can be different in respect to treatment of URLs before
> passing them to protocol handlers. I have tried KDE and a kind of
> minimalistic setup inside container (xdg-utils) so far. Anyway it is good to
> receive confirmation that it could work for other people.
> 
> In the meanwhile I have realized that bug report I mentioned was for Windows
> with emacs running in WSL
> https://orgmode.org/list/87zhbq7zin.fsf@pie.tf/
> 
> P.S. Since your response was private, I am unsure if Cc:
> emacs-orgmode@gnu.org should be added.

-- 
David Asabina
@vidbina on GitHub, Twitter, Instagram, etc.

+49 1768 7062 719

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH] org-protocol: Fix missing '+' in js snippet

[Bastien]

Applied, thanks a lot.

David Asabina <vid@bina.me> writes:

> * org-protocol (org-protocol-capture): Add missing plus-sign to
> javascript snippet to allow readers of the doc string to use example
> snippet with minimal edits.