Add documentation for org-protocol.el to the manual
This commit is contained in:
parent
d288e665dc
commit
446856b861
114
doc/org.texi
114
doc/org.texi
|
@ -236,8 +236,9 @@ Deadlines and scheduling
|
|||
Capture
|
||||
|
||||
* Remember:: Capture new tasks/ideas with little interruption
|
||||
* RSS Feeds:: Getting input from RSS feeds
|
||||
* Attachments:: Add files to tasks.
|
||||
* RSS Feeds:: Getting input from RSS feeds
|
||||
* Protocols:: External (e.g. Browser) access to Emacs and Org
|
||||
|
||||
Remember
|
||||
|
||||
|
@ -5377,11 +5378,12 @@ related to a task (@i{attachments}) in a special directory.
|
|||
|
||||
@menu
|
||||
* Remember:: Capture new tasks/ideas with little interruption
|
||||
* RSS Feeds:: Getting input from RSS feeds
|
||||
* Attachments:: Add files to tasks.
|
||||
* RSS Feeds:: Getting input from RSS feeds
|
||||
* Protocols:: External (e.g. Browser) access to Emacs and Org
|
||||
@end menu
|
||||
|
||||
@node Remember, RSS Feeds, Capture, Capture
|
||||
@node Remember, Attachments, Capture, Capture
|
||||
@section Remember
|
||||
@cindex @file{remember.el}
|
||||
|
||||
|
@ -5664,52 +5666,8 @@ Use the refile interface to jump to a heading.
|
|||
Jump to the location where @code{org-refile} last moved a tree to.
|
||||
@end table
|
||||
|
||||
@node RSS Feeds, Attachments, Remember, Capture
|
||||
@section RSS feeds
|
||||
|
||||
Org has the capablity to add and change entries based on information found in
|
||||
RSS feeds. You could use this to make a task out of each new podcast in a
|
||||
podcast feed. Or you could use a phone-based note-creating service on the
|
||||
web to import tasks into Org.
|
||||
|
||||
To access feeds, you need to configure the variable @code{org-feed-alist}.
|
||||
The docstring of this variable has detailed information. Here is just an
|
||||
example:
|
||||
|
||||
@example
|
||||
(setq org-feed-alist
|
||||
'(("ReQall"
|
||||
"http://www.reqall.com/user/feeds/rss/a1b2c3....."
|
||||
"~/org/feeds.org" "ReQall Entries")
|
||||
@end example
|
||||
|
||||
will configure that new items from the feed provided by @file{reqall.com}
|
||||
will result in new entries in the file @file{~/org/feeds.org} under the
|
||||
heading @samp{ReQall Entries}, whenever the following command is used:
|
||||
|
||||
@table @kbd
|
||||
@kindex C-c C-x g
|
||||
@item C-c C-x g
|
||||
Collect items from the feeds configured in @code{org-feed-alist} and act upon
|
||||
them.
|
||||
@kindex C-c C-x G
|
||||
@item C-c C-x G
|
||||
Prompt for a feed name and go to the inbox configured for this feed.
|
||||
@end table
|
||||
|
||||
Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
|
||||
it will store information about the status of items in the feed, to avoid
|
||||
adding the same item several times. You should add @samp{FEEDSTATUS} to the
|
||||
list of drawers in the file where you collect feed data:
|
||||
|
||||
@example
|
||||
#+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
|
||||
@end example
|
||||
|
||||
For more information, see the file header of @file{org-feed.el} and the
|
||||
docstring of @code{org-feed-alist}.
|
||||
|
||||
@node Attachments, , RSS Feeds, Capture
|
||||
@node Attachments, RSS Feeds, Remember, Capture
|
||||
@section Attachments
|
||||
@cindex attachments
|
||||
|
||||
|
@ -5808,6 +5766,64 @@ same directory for attachments as the parent.
|
|||
@end table
|
||||
@end table
|
||||
|
||||
@node RSS Feeds, Protocols, Attachments, Capture
|
||||
@section RSS feeds
|
||||
@cindex RSS feeds
|
||||
|
||||
Org has the capablity to add and change entries based on information found in
|
||||
RSS feeds. You could use this to make a task out of each new podcast in a
|
||||
podcast feed. Or you could use a phone-based note-creating service on the
|
||||
web to import tasks into Org. To access feeds, you need to configure the
|
||||
variable @code{org-feed-alist}. The docstring of this variable has detailed
|
||||
information. Here is just an example:
|
||||
|
||||
@example
|
||||
(setq org-feed-alist
|
||||
'(("ReQall" "http://www.reqall.com/user/feeds/rss/a1b2c3....."
|
||||
"~/org/feeds.org" "ReQall Entries")
|
||||
@end example
|
||||
|
||||
will configure that new items from the feed provided by @file{reqall.com}
|
||||
will result in new entries in the file @file{~/org/feeds.org} under the
|
||||
heading @samp{ReQall Entries}, whenever the following command is used:
|
||||
|
||||
@table @kbd
|
||||
@kindex C-c C-x g
|
||||
@item C-c C-x g
|
||||
Collect items from the feeds configured in @code{org-feed-alist} and act upon
|
||||
them.
|
||||
@kindex C-c C-x G
|
||||
@item C-c C-x G
|
||||
Prompt for a feed name and go to the inbox configured for this feed.
|
||||
@end table
|
||||
|
||||
Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
|
||||
it will store information about the status of items in the feed, to avoid
|
||||
adding the same item several times. You should add @samp{FEEDSTATUS} to the
|
||||
list of drawers in that file:
|
||||
|
||||
@example
|
||||
#+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
|
||||
@end example
|
||||
|
||||
For more information, see @file{org-feed.el} and the docstring of
|
||||
@code{org-feed-alist}.
|
||||
|
||||
@node Protocols, , RSS Feeds, Capture
|
||||
@section Protocols for external access
|
||||
@cindex protocols, for external access
|
||||
@cindex emacsserver
|
||||
|
||||
You can set up Org for handling protocol calls from outside applications that
|
||||
are passed to Emacs through the @file{emacsserver}. For example, you can
|
||||
configure bookmarks in your webbrowser to send a link to the current page to
|
||||
Org and create a note from it using remember (@pxref{Remember}). Or you
|
||||
could create a bookmark that will tell Emacs to open the local source file of
|
||||
a remote website you are looking at with the browser. See
|
||||
@uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
|
||||
documentation and setup instructions.
|
||||
|
||||
|
||||
@node Agenda Views, Embedded LaTeX, Capture, Top
|
||||
@chapter Agenda Views
|
||||
@cindex agenda views
|
||||
|
@ -6459,7 +6475,7 @@ correct customization for this is
|
|||
@end lisp
|
||||
|
||||
Note that if a project is identified as non-stuck, the subtree of this entry
|
||||
will still be search for stuck projets.
|
||||
will still be searched for stuck projets.
|
||||
|
||||
@node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
|
||||
@section Presentation and sorting
|
||||
|
|
Loading…
Reference in New Issue