From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: Mario Martelli <tlmtr@schnuddelhuddel.de>
Cc: emacs-orgmode@gnu.org
Subject: Re: org-protocol documentation
Date: Sat, 01 Jul 2017 18:42:09 +0200 [thread overview]
Message-ID: <8760fc2joe.fsf@nicolasgoaziou.fr> (raw)
In-Reply-To: <CF831D7D-3C02-4FB6-BA13-7A0E60A9568D@schnuddelhuddel.de> (Mario Martelli's message of "Sat, 1 Jul 2017 15:13:47 +0200")
Mario Martelli <tlmtr@schnuddelhuddel.de> 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’s more than we have at the moment :)
That is true.
> I’m 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 consult 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 set
> +@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 valid
> +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 function.
> +@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
> +protocol, there are many possibilities to do so. You can invoke emacsclient
> +by a shortcut on your desktop for example. Or by adding a bookmark to your browser.
^^^
Ditto
> +@table @asis
> +@item @code{org-store-link}
> + store a link, insertable through @kbd{M-x org-insert-link} and
-> Store
> Subject: [PATCH 2/2] org.texi: Fixes missing space after dot.
>
> * org.texi Minor change regarding missing space
Good catch. Applied. Thank you.
Regards,
next prev parent reply other threads:[~2017-07-01 16:42 UTC|newest]
Thread overview: 42+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-06-19 10:14 org-protocol documentation Mario Martelli
2017-06-19 10:41 ` Nicolas Goaziou
2017-06-19 12:37 ` Mario Martelli
2017-06-19 13:41 ` Chunyang Xu
2017-06-21 17:29 ` Nicolas Goaziou
2017-06-21 18:58 ` Mario Martelli
2017-06-21 19:12 ` Nicolas Goaziou
2017-06-22 8:40 ` Mario Martelli
2017-06-22 19:32 ` Mario Martelli
2017-06-22 20:03 ` Nicolas Goaziou
2017-06-23 7:50 ` Mario Martelli
2017-06-23 16:46 ` Mario Martelli
2017-06-25 6:49 ` [PATCH] org-protocol: fixes open-source and extends rewriting of URLs Mario Martelli
2017-06-25 7:17 ` Nicolas Goaziou
2017-06-25 8:21 ` Mario Martelli
2017-06-26 20:46 ` Nicolas Goaziou
2017-06-27 6:54 ` Mario Martelli
2017-06-28 9:32 ` Nicolas Goaziou
2017-06-28 14:44 ` Mario Martelli
2017-06-28 15:49 ` Nicolas Goaziou
2017-06-29 8:28 ` Mario Martelli
2017-06-29 12:47 ` Nicolas Goaziou
2017-06-25 10:15 ` org-protocol documentation Mario Martelli
2017-06-29 12:42 ` Nicolas Goaziou
2017-06-29 18:30 ` Mario Martelli
2017-06-30 12:05 ` Mario Martelli
2017-07-01 10:34 ` Nicolas Goaziou
2017-07-01 13:13 ` Mario Martelli
2017-07-01 16:42 ` Nicolas Goaziou [this message]
2017-07-01 16:44 ` Nicolas Goaziou
2017-07-01 19:24 ` Mario Martelli
2017-07-03 17:21 ` Nick Dokos
2017-07-03 18:09 ` Mario Martelli
2017-07-06 17:54 ` Nicolas Goaziou
2017-07-23 16:18 ` Mario Martelli
2017-07-23 20:49 ` Nicolas Goaziou
2017-07-23 22:39 ` Adam Porter
2017-07-24 6:17 ` Colin Baxter
2017-07-24 23:53 ` Adam Porter
2017-07-25 8:13 ` Colin Baxter
2017-06-30 4:42 ` Mario Martelli
2017-06-19 12:26 ` Chunyang Xu
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=8760fc2joe.fsf@nicolasgoaziou.fr \
--to=mail@nicolasgoaziou.fr \
--cc=emacs-orgmode@gnu.org \
--cc=tlmtr@schnuddelhuddel.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).