Browse Source

org-protocol description

* Add the current way to setup org-protocol with Linux.
* Just link to  http://kb.mozillazine.org/Register_protocol,
   so we are not in charge of keeping track with all those
  FF changes anymore.
Sebastian Rose, Hannover, Germany 10 years ago
parent
commit
53d9e57c32
1 changed files with 41 additions and 43 deletions
  1. 41 43
      org-contrib/org-protocol.org

+ 41 - 43
org-contrib/org-protocol.org

@@ -80,24 +80,45 @@ actions. Just register your custom sub-protocol and handler with the variable
 
   Windows users proceed to the section [[windows-setup][Windows]].
 
-# <<firefox-setup>>
-*** Firefox
+*** Linux Setup (Gnome)
+
+    For this to work, you'll need the Gnome-Libraries to be installed.
+
+    : gconftool-2 -s /desktop/gnome/url-handlers/org-protocol/command '/usr/local/bin/emacsclient %s' --type String
+    : gconftool-2 -s /desktop/gnome/url-handlers/org-protocol/enabled --type Boolean true
+
+
+# <<windows-setup>>
+*** Windows setup
+
+  Windows users may register the "=org-protocol=" once for all by adjusting the
+  following to their facts, save it as *.reg file and double-click it. This
+  worked for me on Windows-XP Professional and the emasc23 from ourcomments.org
+  ([[http://ourcomments.org/cgi-bin/emacsw32-dl-latest.pl]]). I'm no Windows user
+  though and enhancements are more than welcome on the org-mode mailinglist. The
+  original file is from http://kb.mozillazine.org/Register_protocol.
+
+#+begin_example
+REGEDIT4
+
+[HKEY_CLASSES_ROOT\org-protocol]
+@="URL:Org Protocol"
+"URL Protocol"=""
+[HKEY_CLASSES_ROOT\org-protocol\shell]
+[HKEY_CLASSES_ROOT\org-protocol\shell\open]
+[HKEY_CLASSES_ROOT\org-protocol\shell\open\command]
+@="\"C:\\Programme\\Emacs\\emacs\\bin\\emacsclientw.exe\" \"%1\""
+#+end_example
 
-  As of March 2009 Firefox users follow the steps documented on
-  http://kb.mozillazine.org/Register_protocol. Here is a summary:
+*** Applications
+# <<firefox-setup>>
+***** Firefox
 
-  1. Type "=about:config=" into the location bar and press enter.
-  2. Click "/I'll be careful, I promise!/" to continue.
-  3. Right-click on the grid
-  4. Choose "/New/" -> "/String/" from the context menu.
-  5. Enter "=network.protocol-handler.app.org-protocol=" as the properties name.
-  6. Click "/OK/".
-  7. Leave the value blank.
-  8. Next time you try to open a location "=org-protocol://...=" FF will ask you for
-     the program to use. Enter the path to emacsclient.
+      Please refer to http://kb.mozillazine.org/Register_protocol and use
+      "org-protocol" as protocol.
 
 # <<acrobat-setup>>
-*** Acrobat Reader
+***** Acrobat Reader
     :PROPERTIES:
     :CUSTOM_ID: acrobat-reader-setup
     :END:
@@ -114,13 +135,13 @@ actions. Just register your custom sub-protocol and handler with the variable
     menu, after restarting Adobe Reader.
 
 # <<acrobat-store-link-js>>
-***** org-store-link.js
+******* org-store-link.js
 : // from http://article.gmane.org/gmane.emacs.orgmode/6810
 : app.addMenuItem({cName:"org-store-link", cParent:"Tools",
 :    cExec:"app.launchURL('org-protocol://store-link://' + encodeURIComponent(this.URL) + '/' + encodeURIComponent(this.info.Title));"});
 
 # <<acrobat-capture-js>>
-***** org-capture.js
+******* org-capture.js
 : // from http://article.gmane.org/gmane.emacs.orgmode/6810
 : app.addMenuItem({cName:"org-capture", cParent:"Tools",
 :    cExec:"app.launchURL('org-protocol://capture://' + encodeURIComponent(this.URL) + '/' + encodeURIComponent(this.info.Title) + '/');"});
@@ -128,14 +149,14 @@ actions. Just register your custom sub-protocol and handler with the variable
     And this one, if you still use remember templates:
 
 # <<acrobat-remember-js>>
-***** org-remember.js
+******* org-remember.js
 : // from http://article.gmane.org/gmane.emacs.orgmode/6810
 : app.addMenuItem({cName:"org-remember", cParent:"Tools",
 :    cExec:"app.launchURL('org-protocol://remember://' + encodeURIComponent(this.URL) + '/' + encodeURIComponent(this.info.Title) + '/');"});
 
 
 # <<opera-setup>>
-*** Opera
+***** Opera
 
   Opera setup is described here:
   http://www.opera.com/support/kb/view/535/.
@@ -150,29 +171,6 @@ actions. Just register your custom sub-protocol and handler with the variable
      radio button "/Open with other application/" and enter the path to
      emacsclient.
 
-# <<windows-setup>>
-*** Windows setup
-
-  Windows users may register the "=org-protocol=" once for all by adjusting the
-  following to their facts, save it as *.reg file and double-click it. This
-  worked for me on Windows-XP Professional and the emasc23 from ourcomments.org
-  ([[http://ourcomments.org/cgi-bin/emacsw32-dl-latest.pl]]). I'm no Windows user
-  though and enhancements are more than welcome on the org-mode mailinglist. The
-  original file is from http://kb.mozillazine.org/Register_protocol.
-
-#+begin_example
-REGEDIT4
-
-[HKEY_CLASSES_ROOT\org-protocol]
-@="URL:Org Protocol"
-"URL Protocol"=""
-[HKEY_CLASSES_ROOT\org-protocol\shell]
-[HKEY_CLASSES_ROOT\org-protocol\shell\open]
-[HKEY_CLASSES_ROOT\org-protocol\shell\open\command]
-@="\"C:\\Programme\\Emacs\\emacs\\bin\\emacsclientw.exe\" \"%1\""
-#+end_example
-
-
 # <<test-org-protocol>>
 *** Verify the installation
 
@@ -209,8 +207,8 @@ REGEDIT4
 * Links and bookmarks: =org-protocol-store-link=
 
   =org-store-link= stores an Org-link insertable through =M-x org-insert-link= and
-  pushes the URL found on the =kill-ring= for yanking (=C-y=). The sub-protocol used
-  is "=store-link=":
+  pushes the URL found onto the =kill-ring= for yanking (=C-y=). The sub-protocol
+  used is "=store-link=":
 
   : emacsclient org-protocol:/store-link:/URL/TITLE