在 Firefox 上使用 Org 協定捕獲 URL

2019-03-04 01:35:00

介紹

作為一名 Emacs 人,我盡可能讓所有的工作流都在 Org 模式Org-mode 上進行 —— 我比較喜歡文字。

我傾向於將書籤記錄在 Org 模式 代辦列表中,而 Org 協定Org-protocol 則允許外部進程利用 Org 模式 的某些功能。然而,要做到這一點設定起來很麻煩。(搜尋引擎上)有很多教學,Firefox 也有這類 擴充套件,然而我對它們都不太滿意。

因此我決定將我現在的設定記錄在這篇部落格中,方便其他有需要的人使用。

設定 Emacs Org 模式

啟用 Org 協定:

(require 'org-protocol)

新增一個捕獲模板capture template —— 我的設定是這樣的:

(setq org-capture-templates      (quote (...              ("w" "org-protocol" entry (file "~/org/refile.org")               "* TODO Review %a\n%U\n%:initial\n" :immediate-finish)               ...)))

你可以從 Org 模式 手冊中 捕獲模板 章節中獲取幫助。

設定預設使用的模板:

(setq org-protocol-default-template-key "w")

執行這些新增設定讓它們在當前 Emacs 對談中生效。

快速測試

在下一步開始前,最好測試一下設定:

emacsclient -n "org-protocol:///capture?url=http%3a%2f%2fduckduckgo%2ecom&title=DuckDuckGo"

基於的設定的模板,可能會彈出一個捕獲視窗。請確保正常工作,否則後面的操作沒有任何意義。如果工作不正常,檢查剛才的設定並且確保你執行了這些程式碼塊。

如果你的 Org 模式 版本比較老(老於 7 版本),測試的格式會有點不同:這種 URL 編碼後的格式需要改成用斜槓來分割 url 和標題。在網上搜一下很容易找出這兩者的不同。

Firefox 協定

現在開始設定 Firefox。瀏覽 about:config。右擊設定項列表,選擇 “New -> Boolean”,然後輸入 network.protocol-handler.expose.org-protocol 作為名字並且將值設定為 true

有些教學說這一步是可以省略的 —— 配不配因人而異。

新增 Desktop 檔案

大多數的教學都有這一步:

增加一個檔案 ~/.local/share/applications/org-protocol.desktop

[Desktop Entry]Name=org-protocolExec=/path/to/emacsclient -n %uType=ApplicationTerminal=falseCategories=System;MimeType=x-scheme-handler/org-protocol;

然後執行更新器。對於 i3 視窗管理器我使用下面命令(跟 gnome 一樣):

update-desktop-database ~/.local/share/applications/

KDE 的方法不太一樣……你可以查詢其他相關教學。

在 FireFox 中設定捕獲按鈕

建立一個書籤(我是在工具列上建立這個書籤的),位址列輸入下面內容:

javascript:location.href="org-protocol:///capture?url="+encodeURIComponent(location.href)+"&title="+encodeURIComponent(document.title||"[untitled page]")

儲存該書籤後,再次編輯該書籤,你應該會看到其中的所有空格都被替換成了 %20 —— 也就是空格的 URL 編碼形式。

現在當你點選該書籤,你就會在某個 Emacs 框架中,可能是一個任意的框架中,開啟一個視窗,顯示你預定的模板。