awesome-emacs/org-roam
1
0
Fork 0
mirror of https://github.com/org-roam/org-roam synced 2025-08-01 12:17:21 -05:00
Code Issues Packages Projects Releases Wiki Activity

(doc): update mac protocol instructions (#1390)

Browse Source 
use native script editor, rather than Platypus.
This commit is contained in:
Jethro Kuan
2021-01-18 23:02:53 +08:00
committed by GitHub
parent 1b3a0abd36
commit 16c7a7bd93
2 changed files with 65 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
doc/org-roam.org
View File

@ -1087,41 +1087,40 @@ make the new policy take effect.
See [[https://www.chromium.org/administrators/linux-quick-start][here]] for more info on the ~/etc/opt/chrome/policies/managed~ directory and
[[https://cloud.google.com/docs/chrome-enterprise/policies/?policy=ExternalProtocolDialogShowAlwaysOpenCheckbox][here]] for information on the ~ExternalProtocolDialogShowAlwaysOpenCheckbox~ policy.
For MacOS, one solution is to use [[https://github.com/sveinbjornt/Platypus][Platypus]]. Here are the instructions for
setting up with Platypus and Chrome:
For MacOS, we need to create our own application.
1. Install and launch Platypus (with [[https://brew.sh/][Homebrew]]):
1. Launch Script Editor
2. Use the following script, paying attention to the path to ~emacsclient~:
#+BEGIN_SRC bash
brew install --cask platypus
#+END_SRC
#+begin_src emacs-lisp
on open location this_URL
set EC to "/usr/local/bin/emacsclient --no-wait "
set filePath to quoted form of this_URL
do shell script EC & filePath
tell application "Emacs" to activate
end open location
#+end_src
2. Create a script ~launch_emacs.sh~:
3. Save the script in ~/Applications/OrgProtocolClient.app~, changing the script type to
"Application", rather than "Script".
4. Edit ~/Applications/OrgProtocolClient.app/Contents/Info.plist~, adding the
following before the last ~</dict>~ tag:
#+BEGIN_SRC bash
#!/usr/bin/env bash
/usr/local/bin/emacsclient --no-wait $1
#+END_SRC
#+begin_src text
<key>CFBundleURLTypes</key>
<array>
<dict>
<key>CFBundleURLName</key>
<string>org-protocol handler</string>
<key>CFBundleURLSchemes</key>
<array>
<string>org-protocol</string>
</array>
</dict>
</array>
#+end_src
3. Create a Platypus app with the following settings:
| Setting | Value |
|--------------------------------+---------------------------|
| App Name | "OrgProtocol" |
| Script Type | "env" · "/usr/bin/env" |
| Script Path | "path/to/launch-emacs.sh" |
| Interface | None |
| Accept dropped items | true |
| Remain running after execution | false |
Inside ~Settings~:
| Setting | Value |
|--------------------------------+----------------|
| Accept dropped files | true |
| Register as URI scheme handler | true |
| Protocol | "org-protocol" |
5. Save the file, and run the ~OrgProtocolClient.app~ to register the protocol.
To disable the "confirm" prompt in Chrome, you can also make Chrome
show a checkbox to tick, so that the ~OrgProtocol~ app will be used

82
doc/org-roam.texi
View File

@ -1509,64 +1509,54 @@ make the new policy take effect.
See @uref{https://www.chromium.org/administrators/linux-quick-start, here} for more info on the @code{/etc/opt/chrome/policies/managed} directory and
@uref{https://cloud.google.com/docs/chrome-enterprise/policies/?policy=ExternalProtocolDialogShowAlwaysOpenCheckbox, here} for information on the @code{ExternalProtocolDialogShowAlwaysOpenCheckbox} policy.
For MacOS, one solution is to use @uref{https://github.com/sveinbjornt/Platypus, Platypus}. Here are the instructions for
setting up with Platypus and Chrome:
For MacOS, we need to create our own application.
@itemize
@item
Install and launch Platypus (with @uref{https://brew.sh/, Homebrew}):
Launch Script Editor
@item
Use the following script, paying attention to the path to @code{emacsclient}:
@end itemize
@lisp
on open location this_URL
set EC to "/usr/local/bin/emacsclient --no-wait "
set filePath to quoted form of this_URL
do shell script EC & filePath
tell application "Emacs" to activate
end open location
@end lisp
@itemize
@item
Save the script in @code{/Applications/OrgProtocolClient.app}, changing the script type to
``Application'', rather than ``Script''.
@item
Edit @code{/Applications/OrgProtocolClient.app/Contents/Info.plist}, adding the
following before the last @code{</dict>} tag:
@end itemize
@example
brew install --cask platypus
<key>CFBundleURLTypes</key>
<array>
<dict>
<key>CFBundleURLName</key>
<string>org-protocol handler</string>
<key>CFBundleURLSchemes</key>
<array>
<string>org-protocol</string>
</array>
</dict>
</array>
@end example
@itemize
@item
Create a script @code{launch_emacs.sh}:
Save the file, and run the @code{OrgProtocolClient.app} to register the protocol.
@end itemize
@example
#!/usr/bin/env bash
/usr/local/bin/emacsclient --no-wait $1
@end example
@itemize
@item
Create a Platypus app with the following settings:
@end itemize
@multitable {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaa}
@headitem Setting
@tab Value
@item App Name
@tab ``OrgProtocol''
@item Script Type
@tab ``env'' · ``/usr/bin/env''
@item Script Path
@tab ``path/to/launch-emacs.sh''
@item Interface
@tab None
@item Accept dropped items
@tab true
@item Remain running after execution
@tab false
@end multitable
Inside @code{Settings}:
@multitable {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaa}
@headitem Setting
@tab Value
@item Accept dropped files
@tab true
@item Register as URI scheme handler
@tab true
@item Protocol
@tab ``org-protocol''
@end multitable
To disable the ``confirm'' prompt in Chrome, you can also make Chrome
show a checkbox to tick, so that the @code{OrgProtocol} app will be used
without confirmation. To do this, run in a shell: