From mboxrd@z Thu Jan 1 00:00:00 1970 From: Nicolas Goaziou Subject: Re: org-protocol documentation Date: Sat, 01 Jul 2017 18:42:09 +0200 Message-ID: <8760fc2joe.fsf@nicolasgoaziou.fr> References: <68E12968-9AF5-440A-B22C-AC55B70BA910@schnuddelhuddel.de> <87k248b6p8.fsf@nicolasgoaziou.fr> <7C76EDC3-CC7E-4AFE-B45B-867752C1B33A@schnuddelhuddel.de> <87a8519rlg.fsf@nicolasgoaziou.fr> <8760fp9mui.fsf@nicolasgoaziou.fr> <2FAD7DF2-2A0C-4703-A383-BA8D3346C691@schnuddelhuddel.de> <18D83D3C-C472-4614-988F-1F1DA5EB5CEC@schnuddelhuddel.de> <87efub7psj.fsf@nicolasgoaziou.fr> <87lgobrmm7.fsf@nicolasgoaziou.fr> <4D8D18D3-FBA7-4878-AB6A-76CE57635127@schnuddelhuddel.de> <878tk84fab.fsf@nicolasgoaziou.fr> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:51970) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dRLTO-00061r-2z for emacs-orgmode@gnu.org; Sat, 01 Jul 2017 12:42:19 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dRLTK-0005Zv-U2 for emacs-orgmode@gnu.org; Sat, 01 Jul 2017 12:42:18 -0400 Received: from relay3-d.mail.gandi.net ([2001:4b98:c:538::195]:47089) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1dRLTK-0005Xc-KZ for emacs-orgmode@gnu.org; Sat, 01 Jul 2017 12:42:14 -0400 In-Reply-To: (Mario Martelli's message of "Sat, 1 Jul 2017 15:13:47 +0200") List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: "Emacs-orgmode" To: Mario Martelli Cc: emacs-orgmode@gnu.org Mario Martelli writes: >> Genuine question: is this documentation actually complete enough to use >> the feature? > > I suppose so, if one knows how to configure URL handlers on their OS. > Of course there are some things missing from the documentation. But > it=E2=80=99s more than we have at the moment :) That is true. > I=E2=80=99m not happy with that there is so much information - although > outdated - in the old Worg documentation which might be hidden to the > reader. Note that > +Org protocol comes with three predefined handlers: > +@table @asis > +@item @code{org-protocol-store-link} > + Triggered through the sub-protocol @code{store-link}. Store a > +link and push the URL to the kill-ring. > +@item @code{org-protocol-capture} > + Fill a @code{capture} buffer with information gathered somewhere > +else. This handler is triggered through the @code{capture} sub-protocol= and > +uses the function @code{org-capture}. > +@item @code{org-protocol-open-source} > + @code{open-source}. Map a URL to local filename. Use this to open > +sources of already published contents in Emacs for editing. You probably missed my remark about this part. I think each sub-protocol should be introduced in a similar way. > +@end table > + > +@node Setting up Org protocol > +@subsection Setting up Org protocol This is the trick part. We need to feed the index. For example, we could add the following right below the @subsection line @cindex Org protocol, set-up @cindex Installing Org protocol Feel free to adapt. > +You need to set up a custom URL handler on your system to trigger Emacs = by a > +URL. This URL handler could be already installed by Emacs. Please cons= ult the > +handbook of your operating system how to install a custom URL handler if= you > +need to. > + > +To map a website with @code{open-source} to local files you have to set = up > +the mapping in @code{org-protocol-project-alist}. Just above this paragraph, you need @vindex org-protocol-project-alist > +For example, in order to open files published on Worg locally, you can s= et > +@code{org-protocol-project-alist} to the following > + > +@lisp > +(setq org-protocol-project-alist > + '(("Worg" > + :base-url "http://orgmode.org/worg/" > + :working-directory "/home/user/worg/" > + :online-suffix ".html" > + :working-suffix ".org"))) > +@end lisp > + > +Two functions can help you fill @code{org-protocol-project-alist} with v= alid > +contents: @code{org-protocol-create} and @code{org-publish-project-alist= }. The > +latter is of use if you're editing an Org file that is part of a > +publishing project. Just above this paragraph, we need @findex org-protocol-project-alist @findex org-protocol-create Though, I'm puzzled, `org-publish-project-alist' is a variable, not a funct= ion. > +@node Using Org protocol > +@subsection Using Org protocol See above about the @cindex: @cindex Org protocol, usage ... > +Org protocol is triggered by @file{emacsclient}. If you want to use Org ^^^ Gotcha =20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20= =20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20 > +protocol, there are many possibilities to do so. You can invoke emacscl= ient > +by a shortcut on your desktop for example. Or by adding a bookmark to yo= ur browser. ^^^ Ditto > +@table @asis > +@item @code{org-store-link} > + store a link, insertable through @kbd{M-x org-insert-link} and -> Store =20 > Subject: [PATCH 2/2] org.texi: Fixes missing space after dot. > > * org.texi Minor change regarding missing space Good catch. Applied. Thank you. Regards,