> On Jun 26, 2025, at 2:44 AM, Christian Moe <m...@christianmoe.com> wrote:
> 
> Please add "header" to the subject line of the patch for clarity (we're
> removing the header, not the apps).

Amended subject line for this thread.

> 
> I was going to just apply this simple change right away, but it strikes
> me that it entails some further changes that might as well be done in
> the same patch. Suggestions:
> 
> - A more descriptive section header: "Construct Org protocol URL
>  request" doesn't really cover the contents, since the section isn't
>  really about constructing URLs (the schemes are covered elsewhere),
>  and e.g. with Captee you wouldn't need to think about it (I think?).
>  It's about *making* requests to Org protocol from external apps or
>  scripts. E.g. "Make a request with Org protocol"?
> - An extra item in the bullet list at the beginning of the section to
>  reflect that that third-party apps are incorporated. (The list does
>  refer to "program/script generation", but from context that would be
>  understood more as user scripts, not applications like Acrobat or
>  Opera.)
> 
> - Perhaps delete the line "Once the URL request has been constructed, it
>  can be sent to Emacs via the scheme handler" or consolidate it with
>  the opening line, e.g.: "Numerous approaches can be used to construct
>  an Org protocol request and send it to Emacs via the scheme handler:".
> 
> - In any case, add a brief line of bridging text should before the
>  detailed items on "Web browser bookmark", "Captee" etc. begin, e.g.
>  "Specific information on some of the available options follows:".
> 
> (- It seems slightly strange to have separate items for "Web browser
>  bookmark" and "Opera", but I'm inclined to leave this for now, as: we
>  may remove or change the Opera bit in any case.)
> 

Perhaps a more concise rewording is as follows in the draft text below:

— BEGIN TEXT — 
* Using Org Protocol (replaces “Construct Org protocol URL Request")

With Org protocol successfully setup, you are ready to use it. There are two 
steps that are required:

1. Construct the Org protocol URL request.
2. Issue the URL request via the OS scheme handler.

Numerous approaches to implementing the above can be used:

- As a web browser bookmark that can invoke Javascript.
- Via program/script generation (Bash, Python, Java, Go, Rust, C#, etc.)


Listed below describe some approaches to making an Org protocol URL request.


** Web Browser Bookmark
(retain existing content)

** Captee (macOS)
(retain existing content)

** Terminal/Shell
Users with shell access can issue the URL request via command line utility. 
This utility is platform-dependent.

On systems supporting XDG (https://www.freedesktop.org/wiki/), the ~xdg-open~ 
utility can be used.

On macOS, the ~open~ 
(https://support.apple.com/guide/terminal/execute-commands-and-run-tools-apdb66b5242-0d18-49fc-9c47-a2498b7c91d5/mac)
 utility can be used.

The utilities listed above will honor the scheme handler setup for 
~org-protocol://~. In this way, 3rd party applications can delegate to the 
scheme handler the responsibility of processing the URL request.

The scheme handler can be bypassed by direct invocation of ~emacsclient~. That 
said, on platforms like macOS this will lead to security restrictions that 
prevent its usage by 3rd party applications.

** Acrobat Reader
(retain existing content)
— END TEXT — 

I really don’t think there is much merit to keeping the Opera section as the 
link is stale and the guidance is likely too. I would be in favor of deleting 
it completely, not even mentioning it in the history. 

If there are no objections to the above amended text I can prepare a patch 
containing it.


All my best - 

Charles


Charles Y. Choi, Ph.D.
kickingve...@gmail.com


Reply via email to