summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKyle Meyer <kyle@kyleam.com>2019-12-03 21:32:18 -0500
committerKyle Meyer <kyle@kyleam.com>2019-12-03 21:57:27 -0500
commitba228ee82e017c9339a8b15703df632ee30df655 (patch)
tree50446a8be319de73f9f03eee0574f6ffc932d7b0
parent317028952eb3790201e9d0f8870a8bc267802738 (diff)
downloadorg-mode-ba228ee82e017c9339a8b15703df632ee30df655.tar.gz
org.texi: Generate from org-manual.org
$ emacs --batch -Q -L lisp --eval "(require 'ox-texinfo)" \ --visit doc/org-manual.org --eval "(org-texinfo-export-to-texinfo)"
-rw-r--r--doc/org.texi7315
1 files changed, 4065 insertions, 3250 deletions
diff --git a/doc/org.texi b/doc/org.texi
index a59a38d..ae9fcce 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -13,7 +13,7 @@
@c %**end of header
@copying
-This manual is for Org version 9.2.
+This manual is for Org version 9.3.
Copyright @copyright{} 2004--2019 Free Software Foundation, Inc.
@@ -31,7 +31,7 @@ modify this GNU manual.''
@end quotation
@end copying
-@dircategory Emacs editing modes
+@dircategory Emacs
@direntry
* Org Mode: (org). Outline-based notes management and organizer.
@end direntry
@@ -39,7 +39,7 @@ modify this GNU manual.''
@finalout
@titlepage
@title The Org Manual
-@subtitle Release 9.2
+@subtitle Release 9.3
@author The Org Mode Developers
@page
@vskip 0pt plus 1filll
@@ -64,7 +64,8 @@ modify this GNU manual.''
* Tags:: Tagging headlines and matching sets of tags.
* Properties and Columns:: Storing information about an entry.
* Dates and Times:: Making items useful for planning.
-* Capture, Refile, Archive: Capture Refile Archive. The ins and outs for projects.
+* Refiling and Archiving:: Moving and copying information with ease.
+* Capture and Attachments:: Dealing with external data.
* Agenda Views:: Collecting information into views.
* Markup for Rich Contents:: Compose beautiful documents.
* Exporting:: Sharing and publishing notes.
@@ -100,7 +101,6 @@ Document Structure
* Plain Lists:: Additional structure within an entry.
* Drawers:: Tucking stuff away.
* Blocks:: Folding blocks.
-* Creating Footnotes:: How footnotes are defined in Org's syntax.
Visibility Cycling
@@ -163,7 +163,7 @@ TODO Extensions
Progress Logging
-* Closing items:: When was this entry marked DONE?
+* Closing items:: When was this entry marked as done?
* Tracking TODO state changes:: When did the status change?
* Tracking your habits:: How consistent have you been?
@@ -218,15 +218,22 @@ Clocking Work Time
* The clock table:: Detailed reports.
* Resolving idle time:: Resolving time when you've been idle.
-Capture, Refile, Archive
+Refiling and Archiving
-* Capture:: Capturing new stuff.
-* Attachments:: Add files to tasks.
-* RSS Feeds:: Getting input from RSS feeds.
-* Protocols:: External access to Emacs and Org.
* Refile and Copy:: Moving/copying a tree from one place to another.
* Archiving:: What to do with finished products.
+Archiving
+
+* Moving subtrees:: Moving a tree to an archive file.
+* Internal archiving:: Switch off a tree but keep it in the file.
+
+Capture and Attachments
+
+* Capture:: Capturing new stuff.
+* Attachments:: Attach files to outlines.
+* RSS Feeds:: Getting input from RSS feeds.
+
Capture
* Setting up capture:: Where notes will be stored.
@@ -239,16 +246,13 @@ Capture templates
* Template expansion:: Filling in information about time and context.
* Templates in contexts:: Only show a template in a specific context.
-Protocols
-
-* @code{store-link} protocol:: Store a link, push URL to kill-ring.
-* @code{capture} protocol:: Fill a buffer with external information.
-* @code{open-source} protocol:: Edit published contents.
-
-Archiving
+Attachments
-* Moving subtrees:: Moving a tree to an archive file.
-* Internal archiving:: Switch off a tree but keep it in the file.
+* Attachment defaults and dispatcher:: How to access attachment commands
+* Attachment options:: Configuring the attachment system
+* Attachment links:: Hyperlink access to attachments
+* Automatic version-control with Git:: Everything safely stored away
+* Attach from Dired:: Using dired to select an attachment
Agenda Views
@@ -274,7 +278,7 @@ Presentation and Sorting
* Categories:: Not all tasks are equal.
* Time-of-day specifications:: How the agenda knows the time.
* Sorting of agenda items:: The order of things.
-* Filtering/limiting agenda times:: Dynamically narrow the agenda.
+* Filtering/limiting agenda items:: Dynamically narrow the agenda.
Custom Agenda Views
@@ -293,6 +297,7 @@ Markup for Rich Contents
* Images:: Display an image.
* Captions:: Describe tables, images...
* Horizontal Rules:: Make a line.
+* Creating Footnotes:: Edit and read footnotes.
Embedded @LaTeX{}
@@ -309,7 +314,7 @@ Exporting
* Macro Replacement:: Use macros to create templates.
* Comment Lines:: What will not be exported.
* ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding.
-* Beamer Export::
+* Beamer Export:: Producing presentations and slides.
* HTML Export:: Exporting to HTML.
* @LaTeX{} Export:: Exporting to @LaTeX{} and processing to PDF.
* Markdown Export:: Exporting to Markdown.
@@ -337,6 +342,7 @@ HTML Export
* HTML doctypes:: Exporting various (X)HTML flavors.
* HTML preamble and postamble:: Inserting preamble and postamble.
* Quoting HTML tags:: Using direct HTML in Org files.
+* Headlines in HTML export:: Formatting headlines.
* Links in HTML export:: Inserting and formatting links.
* Tables in HTML export:: How to modify the formatting of tables.
* Images in HTML export:: How to insert figures into HTML output.
@@ -439,25 +445,37 @@ Miscellaneous
* Completion:: @kbd{M-@key{TAB}} guesses completions.
* Structure Templates:: Quick insertion of structural elements.
-* Escape Character::
* Speed Keys:: Electric commands at the beginning of a headline.
-* Code Evaluation Security:: Org files evaluate in-line code.
-* Customization:: Adapting Org to your taste.
-* In-buffer Settings:: Overview of keywords.
-* The Very Busy @kbd{C-c C-c} Key:: When in doubt, press @kbd{C-c C-c}.
* Clean View:: Getting rid of leading stars in the outline.
-* TTY Keys:: Using Org on a tty.
+* Dynamic Headline Numbering:: Display and update outline numbering.
+* The Very Busy @kbd{C-c C-c} Key:: When in doubt, press @kbd{C-c C-c}.
+* In-buffer Settings:: Overview of keywords.
+* Org Syntax:: Formal description of Org's syntax.
* Documentation Access:: Read documentation about current syntax.
+* Escape Character::
+* Code Evaluation Security:: Org files evaluate in-line code.
* Interaction:: With other Emacs packages.
+* TTY Keys:: Using Org on a tty.
+* Protocols:: External access to Emacs and Org.
* Org Crypt:: Encrypting Org files.
* Org Mobile:: Viewing and capture on a mobile device.
-* Org Syntax:: Formal description of Org's syntax.
+
+Clean View
+
+* Org Indent Mode::
+* Hard indentation::
Interaction
* Cooperation:: Packages Org cooperates with.
* Conflicts:: Packages that lead to conflicts.
+Protocols
+
+* The @code{store-link} protocol:: Store a link, push URL to kill-ring.
+* The @code{capture} protocol:: Fill a buffer with external information.
+* The @code{open-source} protocol:: Edit published contents.
+
Org Mobile
* Setting up the staging area:: For the mobile device.
@@ -630,7 +648,7 @@ $ cd org-mode/
$ make autoloads
@end example
-Note that in this case, @code{make autoloads} is mandatory: it defines
+Note that in this case, @samp{make autoloads} is mandatory: it defines
Org's version in @samp{org-version.el} and Org's autoloads in
@samp{org-loaddefs.el}.
@@ -669,8 +687,8 @@ For a better experience, the three Org commands @code{org-store-link},
@code{org-capture} and @code{org-agenda} ought to be accessible anywhere in
Emacs, not just in Org buffers. To that effect, you need to bind them
to globally available keys, like the ones reserved for users (see
-@ref{Key Binding Conventions,,,elisp,}). Here are suggested
-bindings, please modify the keys to your own liking.
+@ref{Key Binding Conventions,,,elisp,}). Here are suggested bindings,
+please modify the keys to your own liking.
@lisp
(global-set-key (kbd "C-c l") 'org-store-link)
@@ -694,10 +712,10 @@ which selects Org mode for this buffer no matter what the file's name
is. See also the variable @code{org-insert-mode-line-in-empty-file}.
Many commands in Org work on the region if the region is @emph{active}. To
-make use of this, you need to have @code{transient-mark-mode} turned on,
-which is the default. If you do not like @code{transient-mark-mode}, you
-can create an active region by using the mouse to select a region, or
-pressing @kbd{C-@key{SPC}} twice before moving point.
+make use of this, you need to have Transient Mark mode turned on,
+which is the default. If you do not like it, you can create an active
+region by using the mouse to select a region, or pressing
+@kbd{C-@key{SPC}} twice before moving point.
@node Feedback
@section Feedback
@@ -896,7 +914,6 @@ the entire show and hide functionalities into a single command,
* Plain Lists:: Additional structure within an entry.
* Drawers:: Tucking stuff away.
* Blocks:: Folding blocks.
-* Creating Footnotes:: How footnotes are defined in Org's syntax.
@end menu
@node Headlines
@@ -932,7 +949,10 @@ as a title for your own headings.
Some people find the many stars too noisy and would prefer an outline
that has whitespace followed by a single star as headline starters.
-See @ref{Clean View}.
+This can be achieved using a Org Indent minor mode. See @ref{Clean View} for more information.
+
+Headlines are not numbered. However, you may want to dynamically
+number some, or all, of them. See @ref{Dynamic Headline Numbering}.
@vindex org-cycle-separator-lines
An empty line after the end of a subtree is considered part of it and
@@ -1001,13 +1021,13 @@ Point must be on a headline for this to work@footnote{See, however, the option @
@end example
When @kbd{S-@key{TAB}} is called with a numeric prefix argument N,
-the CONTENTS view up to headlines of level N are shown. Note
-that inside tables (see @ref{Tables}), @kbd{S-@key{TAB}} jumps to the
-previous field instead.
+the CONTENTS view up to headlines of level N are shown. Note that
+inside tables (see @ref{Tables}), @kbd{S-@key{TAB}} jumps to the previous
+field instead.
@vindex org-cycle-global-at-bob
-You can run global cycling using @kbd{@key{TAB}} only if point is
-at the very beginning of the buffer, but not on a headline, and
+You can run global cycling using @kbd{@key{TAB}} only if point is at
+the very beginning of the buffer, but not on a headline, and
@code{org-cycle-global-at-bob} is set to a non-@code{nil} value.
@item @kbd{C-u C-u @key{TAB}} (@code{org-set-startup-visibility})
@@ -1027,18 +1047,18 @@ Show all, including drawers.
@kindex C-c C-r
@findex org-reveal
Reveal context around point, showing the current entry, the
-following heading and the hierarchy above. Useful for working
-near a location that has been exposed by a sparse tree command
-(see @ref{Sparse Trees}) or an agenda command (see @ref{Agenda Commands}). With a prefix argument show, on each level, all
-sibling headings. With a double prefix argument, also show the
-entire subtree of the parent.
+following heading and the hierarchy above. Useful for working near
+a location that has been exposed by a sparse tree command (see
+@ref{Sparse Trees}) or an agenda command (see @ref{Agenda Commands}). With a prefix argument show, on each level, all sibling
+headings. With a double prefix argument, also show the entire
+subtree of the parent.
@item @kbd{C-c C-k} (@code{outline-show-branches})
@cindex show branches, command
@kindex C-c C-k
@findex outline-show-branches
-Expose all the headings of the subtree, CONTENTS view for just
-one subtree.
+Expose all the headings of the subtree, CONTENTS view for just one
+subtree.
@item @kbd{C-c @key{TAB}} (@code{outline-show-children})
@cindex show children, command
@@ -1056,8 +1076,8 @@ original buffer, but without affecting visibility in that buffer. For
more information about indirect buffers, see @ref{Indirect Buffers,GNU Emacs Manual,,emacs,}.}. With
a numeric prefix argument, N, go up to level N and then take that
tree. If N is negative then go up that many levels. With
-a @kbd{C-u} prefix, do not remove the previously used
-indirect buffer.
+a @kbd{C-u} prefix, do not remove the previously used indirect
+buffer.
@item @kbd{C-c C-x v} (@code{org-copy-visible})
@kindex C-c C-x v
@@ -1093,9 +1113,9 @@ for this property are @samp{folded}, @samp{children}, @samp{content}, and @samp{
@item @kbd{C-u C-u @key{TAB}} (@code{org-set-startup-visibility})
@kindex C-u C-u TAB
@findex org-set-startup-visibility
-Switch back to the startup visibility of the buffer, i.e.,
-whatever is requested by startup options and @samp{VISIBILITY}
-properties in individual entries.
+Switch back to the startup visibility of the buffer, i.e., whatever
+is requested by startup options and @samp{VISIBILITY} properties in
+individual entries.
@end table
@node Catching invisible edits
@@ -1206,22 +1226,20 @@ See also the variable @code{org-goto-interface}.
@vindex org-M-RET-may-split-line
Insert a new heading, item or row.
-If the command is used at the @emph{beginning} of a line, and if there
-is a heading or a plain list item (see @ref{Plain Lists}) at point,
-the new heading/item is created @emph{before} the current line. When
-used at the beginning of a regular line of text, turn that line
-into a heading.
+If the command is used at the @emph{beginning} of a line, and if there is
+a heading or a plain list item (see @ref{Plain Lists}) at point, the new
+heading/item is created @emph{before} the current line. When used at the
+beginning of a regular line of text, turn that line into a heading.
-When this command is used in the middle of a line, the line is
-split and the rest of the line becomes the new item or headline.
-If you do not want the line to be split, customize
+When this command is used in the middle of a line, the line is split
+and the rest of the line becomes the new item or headline. If you
+do not want the line to be split, customize
@code{org-M-RET-may-split-line}.
Calling the command with a @kbd{C-u} prefix unconditionally
inserts a new heading at the end of the current subtree, thus
-preserving its contents. With a double @kbd{C-u C-u}
-prefix, the new heading is created at the end of the parent
-subtree instead.
+preserving its contents. With a double @kbd{C-u C-u} prefix,
+the new heading is created at the end of the parent subtree instead.
@item @kbd{C-@key{RET}} (@code{org-insert-heading-respect-content})
@kindex C-RET
@@ -1232,9 +1250,8 @@ Insert a new heading at the end of the current subtree.
@kindex M-S-RET
@findex org-insert-todo-heading
@vindex org-treat-insert-todo-heading-as-state-change
-Insert new TODO entry with same level as current heading. See
-also the variable
-@code{org-treat-insert-todo-heading-as-state-change}.
+Insert new TODO entry with same level as current heading. See also
+the variable @code{org-treat-insert-todo-heading-as-state-change}.
@item @kbd{C-S-@key{RET}} (@code{org-insert-todo-heading-respect-content})
@kindex C-S-RET
@@ -1249,8 +1266,8 @@ subtree.
In a new entry with no text yet, the first @kbd{@key{TAB}} demotes
the entry to become a child of the previous one. The next
@kbd{@key{TAB}} makes it a parent, and so on, all the way to top
-level. Yet another @kbd{@key{TAB}}, and you are back to the
-initial level.
+level. Yet another @kbd{@key{TAB}}, and you are back to the initial
+level.
@item @kbd{M-@key{LEFT}} (@code{org-do-promote})
@kindex M-LEFT
@@ -1297,17 +1314,16 @@ With a numeric prefix argument N, kill N sequential subtrees.
@item @kbd{C-c C-x M-w} (@code{org-copy-subtree})
@kindex C-c C-x M-w
@findex org-copy-subtree
-Copy subtree to kill ring. With a numeric prefix argument N,
-copy the N sequential subtrees.
+Copy subtree to kill ring. With a numeric prefix argument N, copy
+the N sequential subtrees.
@item @kbd{C-c C-x C-y} (@code{org-paste-subtree})
@kindex C-c C-x C-y
@findex org-paste-subtree
Yank subtree from kill ring. This does modify the level of the
-subtree to make sure the tree fits in nicely at the yank
-position. The yank level can also be specified with a numeric
-prefix argument, or by yanking after a headline marker like
-@samp{****}.
+subtree to make sure the tree fits in nicely at the yank position.
+The yank level can also be specified with a numeric prefix argument,
+or by yanking after a headline marker like @samp{****}.
@item @kbd{C-y} (@code{org-yank})
@kindex C-y
@@ -1318,23 +1334,21 @@ Depending on the variables @code{org-yank-adjusted-subtrees} and
@code{org-yank-folded-subtrees}, Org's internal @code{yank} command pastes
subtrees folded and in a clever way, using the same command as
@kbd{C-c C-x C-y}. With the default settings, no level
-adjustment takes place, but the yanked tree is folded unless
-doing so would swallow text previously visible. Any prefix
-argument to this command forces a normal @code{yank} to be executed,
-with the prefix passed along. A good way to force a normal yank
-is @kbd{C-u C-y}. If you use @code{yank-pop} after a yank, it
-yanks previous kill items plainly, without adjustment and
-folding.
+adjustment takes place, but the yanked tree is folded unless doing
+so would swallow text previously visible. Any prefix argument to
+this command forces a normal @code{yank} to be executed, with the prefix
+passed along. A good way to force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a yank, it yanks previous kill
+items plainly, without adjustment and folding.
@item @kbd{C-c C-x c} (@code{org-clone-subtree-with-time-shift})
@kindex C-c C-x c
@findex org-clone-subtree-with-time-shift
-Clone a subtree by making a number of sibling copies of it. You
-are prompted for the number of copies to make, and you can also
-specify if any timestamps in the entry should be shifted. This
-can be useful, for example, to create a number of tasks related
-to a series of lectures to prepare. For more details, see the
-docstring of the command @code{org-clone-subtree-with-time-shift}.
+Clone a subtree by making a number of sibling copies of it. You are
+prompted for the number of copies to make, and you can also specify
+if any timestamps in the entry should be shifted. This can be
+useful, for example, to create a number of tasks related to a series
+of lectures to prepare. For more details, see the docstring of the
+command @code{org-clone-subtree-with-time-shift}.
@item @kbd{C-c C-w} (@code{org-refile})
@kindex C-c C-w
@@ -1349,8 +1363,8 @@ entries in the region are sorted. Otherwise the children of the
current headline are sorted. The command prompts for the sorting
method, which can be alphabetically, numerically, by time---first
timestamp with active preferred, creation time, scheduled time,
-deadline time---by priority, by TODO keyword---in the sequence
-the keywords have been defined in the setup---or by the value of
+deadline time---by priority, by TODO keyword---in the sequence the
+keywords have been defined in the setup---or by the value of
a property. Reverse sorting is possible as well. You can also
supply your own function to extract the sorting key. With
a @kbd{C-u} prefix, sorting is case-sensitive.
@@ -1373,13 +1387,13 @@ Widen buffer to remove narrowing.
@item @kbd{C-c *} (@code{org-toggle-heading})
@kindex C-c *
@findex org-toggle-heading
-Turn a normal line or plain list item into a headline---so that
-it becomes a subheading at its location. Also turn a headline
-into a normal line by removing the stars. If there is an active
-region, turn all lines in the region into headlines. If the
-first line in the region was an item, turn only the item lines
-into headlines. Finally, if the first line is a headline, remove
-the stars from all headlines in the region.
+Turn a normal line or plain list item into a headline---so that it
+becomes a subheading at its location. Also turn a headline into
+a normal line by removing the stars. If there is an active region,
+turn all lines in the region into headlines. If the first line in
+the region was an item, turn only the item lines into headlines.
+Finally, if the first line is a headline, remove the stars from all
+headlines in the region.
@end table
@cindex region, active
@@ -1424,16 +1438,16 @@ command.
@kindex C-c / /
@findex org-occur
@vindex org-remove-highlights-with-change
-Prompts for a regexp and shows a sparse tree with all matches.
-If the match is in a headline, the headline is made visible. If
-the match is in the body of an entry, headline and body are made
+Prompts for a regexp and shows a sparse tree with all matches. If
+the match is in a headline, the headline is made visible. If the
+match is in the body of an entry, headline and body are made
visible. In order to provide minimal context, also the full
hierarchy of headlines above the match is shown, as well as the
-headline following the match. Each match is also highlighted;
-the highlights disappear when the buffer is changed by an editing
-command, or by pressing @kbd{C-c C-c}@footnote{This depends on the option @code{org-remove-highlights-with-change}.}. When called
-with a @kbd{C-u} prefix argument, previous highlights are
-kept, so several calls to this command can be stacked.
+headline following the match. Each match is also highlighted; the
+highlights disappear when the buffer is changed by an editing
+command, or by pressing @kbd{C-c C-c}@footnote{This depends on the option @code{org-remove-highlights-with-change}.}. When called with
+a @kbd{C-u} prefix argument, previous highlights are kept, so
+several calls to this command can be stacked.
@item @kbd{M-g n} or @kbd{M-g M-n} (@code{next-error})
@kindex M-g n
@@ -1577,30 +1591,29 @@ to disable them individually.
@kindex TAB
@findex org-cycle
@vindex org-cycle-include-plain-lists
-Items can be folded just like headline levels. Normally this
-works only if point is on a plain list item. For more details,
-see the variable @code{org-cycle-include-plain-lists}. If this
-variable is set to @code{integrate}, plain list items are treated like
-low-level headlines. The level of an item is then given by the
-indentation of the bullet/number. Items are always subordinate
-to real headlines, however; the hierarchies remain completely
-separated. In a new item with no text yet, the first
-@kbd{@key{TAB}} demotes the item to become a child of the previous
-one. Subsequent @kbd{@key{TAB}}s move the item to meaningful
-levels in the list and eventually get it back to its initial
-position.
+Items can be folded just like headline levels. Normally this works
+only if point is on a plain list item. For more details, see the
+variable @code{org-cycle-include-plain-lists}. If this variable is set
+to @code{integrate}, plain list items are treated like low-level
+headlines. The level of an item is then given by the indentation of
+the bullet/number. Items are always subordinate to real headlines,
+however; the hierarchies remain completely separated. In a new item
+with no text yet, the first @kbd{@key{TAB}} demotes the item to
+become a child of the previous one. Subsequent @kbd{@key{TAB}}s move
+the item to meaningful levels in the list and eventually get it back
+to its initial position.
@item @kbd{M-@key{RET}} (@code{org-insert-heading})
@kindex M-RET
@findex org-insert-heading
@vindex org-M-RET-may-split-line
Insert new item at current level. With a prefix argument, force
-a new heading (see @ref{Structure Editing}). If this command is used
-in the middle of an item, that item is @emph{split} in two, and the
-second part becomes the new item@footnote{If you do not want the item to be split, customize the
-variable @code{org-M-RET-may-split-line}.}. If this command is
-executed @emph{before item's body}, the new item is created @emph{before}
-the current one.
+a new heading (see @ref{Structure Editing}). If this command is used in
+the middle of an item, that item is @emph{split} in two, and the second
+part becomes the new item@footnote{If you do not want the item to be split, customize the
+variable @code{org-M-RET-may-split-line}.}. If this command is executed
+@emph{before item's body}, the new item is created @emph{before} the current
+one.
@item @kbd{M-S-@key{RET}}
@kindex M-S-RET
@@ -1615,9 +1628,9 @@ Insert a new item with a checkbox (see @ref{Checkboxes}).
@vindex org-list-use-circular-motion
Jump to the previous/next item in the current list, but only if
@code{org-support-shift-select} is off@footnote{If you want to cycle around items that way, you may customize
-@code{org-list-use-circular-motion}.}. If not, you can
-still use paragraph jumping commands like @kbd{C-@key{UP}}
-and @kbd{C-@key{DOWN}} to quite similar effect.
+@code{org-list-use-circular-motion}.}. If not, you can still use
+paragraph jumping commands like @kbd{C-@key{UP}} and
+@kbd{C-@key{DOWN}} to quite similar effect.
@item @kbd{M-@key{UP}}
@itemx @kbd{M-@key{DOWN}}
@@ -1638,17 +1651,17 @@ alone.
@itemx @kbd{M-S-@key{RIGHT}}
@kindex M-S-LEFT
@kindex M-S-RIGHT
-Decrease/increase the indentation of the item, including
-subitems. Initially, the item tree is selected based on current
-indentation. When these commands are executed several times in
-direct succession, the initially selected region is used, even if
-the new indentation would imply a different hierarchy. To use
-the new hierarchy, break the command chain by moving point.
+Decrease/increase the indentation of the item, including subitems.
+Initially, the item tree is selected based on current indentation.
+When these commands are executed several times in direct succession,
+the initially selected region is used, even if the new indentation
+would imply a different hierarchy. To use the new hierarchy, break
+the command chain by moving point.
As a special case, using this command on the very first item of
a list moves the whole list. This behavior can be disabled by
-configuring @code{org-list-automatic-rules}. The global indentation
-of a list has no influence on the text @emph{after} the list.
+configuring @code{org-list-automatic-rules}. The global indentation of
+a list has no influence on the text @emph{after} the list.
@item @kbd{C-c C-c}
@kindex C-c C-c
@@ -1659,16 +1672,16 @@ indentation consistency in the whole list.
@item @kbd{C-c -}
@kindex C-c -
@vindex org-plain-list-ordered-item-terminator
-Cycle the entire list level through the different
-itemize/enumerate bullets (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset
-of them, depending on @code{org-plain-list-ordered-item-terminator},
-the type of list, and its indentation. With a numeric prefix
-argument N, select the Nth bullet from this list. If there is an
-active region when calling this, selected text is changed into an
-item. With a prefix argument, all lines are converted to list
-items. If the first line already was a list item, any item
-marker is removed from the list. Finally, even without an active
-region, a normal line is converted into a list item.
+Cycle the entire list level through the different itemize/enumerate
+bullets (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them, depending
+on @code{org-plain-list-ordered-item-terminator}, the type of list, and
+its indentation. With a numeric prefix argument N, select the Nth
+bullet from this list. If there is an active region when calling
+this, selected text is changed into an item. With a prefix
+argument, all lines are converted to list items. If the first line
+already was a list item, any item marker is removed from the list.
+Finally, even without an active region, a normal line is converted
+into a list item.
@item @kbd{C-c *}
@kindex C-c *
@@ -1679,7 +1692,7 @@ a detailed explanation.
@item @kbd{C-c C-*}
@kindex C-c C-*
Turn the whole plain list into a subtree of the current heading.
-Checkboxes (see @ref{Checkboxes}) become TODO, respectively DONE,
+Checkboxes (see @ref{Checkboxes}) become @samp{TODO}, respectively @samp{DONE},
keywords when unchecked, respectively checked.
@item @kbd{S-@key{LEFT}}
@@ -1766,107 +1779,6 @@ the variable @code{org-hide-block-startup} or on a per-file basis by using
#+STARTUP: nohideblocks
@end example
-@node Creating Footnotes
-@section Creating Footnotes
-
-@cindex footnotes
-
-Org mode supports the creation of footnotes.
-
-A footnote is started by a footnote marker in square brackets in
-column 0, no indentation allowed. It ends at the next footnote
-definition, headline, or after two consecutive empty lines. The
-footnote reference is simply the marker in square brackets, inside
-text. Markers always start with @samp{fn:}. For example:
-
-@example
-The Org homepage[fn:1] now looks a lot better than it used to.
-...
-[fn:1] The link is: https://orgmode.org
-@end example
-
-Org mode extends the number-based syntax to @emph{named} footnotes and
-optional inline definition. Here are the valid references:
-
-@table @asis
-@item @samp{[fn:NAME]}
-A named footnote reference, where @var{NAME} is a unique
-label word, or, for simplicity of automatic creation, a number.
-
-@item @samp{[fn:: This is the inline definition of this footnote]}
-A @LaTeX{}-like anonymous footnote where the definition is given
-directly at the reference point.
-
-@item @samp{[fn:NAME: a definition]}
-An inline definition of a footnote, which also specifies a name
-for the note. Since Org allows multiple references to the same
-note, you can then use @samp{[fn:NAME]} to create additional
-references.
-@end table
-
-@vindex org-footnote-auto-label
-Footnote labels can be created automatically, or you can create names
-yourself. This is handled by the variable @code{org-footnote-auto-label}
-and its corresponding @samp{STARTUP} keywords. See the docstring of that
-variable for details.
-
-The following command handles footnotes:
-
-@table @asis
-@item @kbd{C-c C-x f}
-The footnote action command.
-
-@kindex C-c C-x f
-When point is on a footnote reference, jump to the
-definition. When it is at a definition, jump to
-the---first---reference.
-
-@vindex org-footnote-define-inline
-@vindex org-footnote-section
-Otherwise, create a new footnote. Depending on the variable
-@code{org-footnote-define-inline}@footnote{The corresponding in-buffer setting is: @samp{#+STARTUP: fninline}
-or @samp{#+STARTUP: nofninline}.}, the definition is placed
-right into the text as part of the reference, or separately into
-the location determined by the variable @code{org-footnote-section}.
-
-When this command is called with a prefix argument, a menu of
-additional options is offered:
-
-@multitable @columnfractions 0.1 0.9
-@item @kbd{s}
-@tab Sort the footnote definitions by reference sequence.
-@item @kbd{r}
-@tab Renumber the simple @samp{fn:N} footnotes.
-@item @kbd{S}
-@tab Short for first @kbd{r}, then @kbd{s} action.
-@item @kbd{n}
-@tab Rename all footnotes into a @samp{fn:1} @dots{} @samp{fn:n} sequence.
-@item @kbd{d}
-@tab Delete the footnote at point, including definition and references.
-@end multitable
-
-@vindex org-footnote-auto-adjust
-Depending on the variable @code{org-footnote-auto-adjust}@footnote{The corresponding in-buffer options are @samp{#+STARTUP: fnadjust}
-and @samp{#+STARTUP: nofnadjust}.},
-renumbering and sorting footnotes can be automatic after each
-insertion or deletion.
-
-@item @kbd{C-c C-c}
-@kindex C-c C-c
-If point is on a footnote reference, jump to the definition.
-If it is at the definition, jump back to the reference. When
-called at a footnote location with a prefix argument, offer the
-same menu as @kbd{C-c C-x f}.
-
-@item @kbd{C-c C-o} or @kbd{mouse-1/2}
-@kindex C-c C-o
-@kindex mouse-1
-@kindex mouse-2
-Footnote labels are also links to the corresponding definition or
-reference, and you can use the usual commands to follow these
-links.
-@end table
-
@node Tables
@chapter Tables
@@ -1899,7 +1811,7 @@ Org makes it easy to format tables in plain ASCII@. Any line with @samp{|}
as the first non-whitespace character is considered part of a table.
@samp{|} is also the column separator@footnote{To insert a vertical bar into a table field, use @samp{\vert} or,
inside a word @samp{abc\vert@{@}def}.}. Moreover, a line starting
-with @samp{|-} is a horizontal rule. It separates rows explicitely. Rows
+with @samp{|-} is a horizontal rule. It separates rows explicitly. Rows
before the first horizontal rule are header lines. A table might look
like this:
@@ -1944,16 +1856,16 @@ you, configure the option @code{org-table-auto-blank-field}.
@item @kbd{C-c |} (@code{org-table-create-or-convert-from-region})
@kindex C-c |
@findex org-table-create-or-convert-from-region
-Convert the active region to table. If every line contains at
-least one @kbd{@key{TAB}} character, the function assumes that the
-material is tab separated. If every line contains a comma,
-comma-separated values (CSV) are assumed. If not, lines are
-split at whitespace into fields. You can use a prefix argument
-to force a specific separator: @kbd{C-u} forces CSV,
-@kbd{C-u C-u} forces @kbd{@key{TAB}}, @kbd{C-u C-u C-u}
-prompts for a regular expression to match the separator, and
-a numeric argument N indicates that at least N consecutive
-spaces, or alternatively a @kbd{@key{TAB}} will be the separator.
+Convert the active region to table. If every line contains at least
+one @kbd{@key{TAB}} character, the function assumes that the material
+is tab separated. If every line contains a comma, comma-separated
+values (CSV) are assumed. If not, lines are split at whitespace
+into fields. You can use a prefix argument to force a specific
+separator: @kbd{C-u} forces CSV, @kbd{C-u C-u} forces
+@kbd{@key{TAB}}, @kbd{C-u C-u C-u} prompts for a regular
+expression to match the separator, and a numeric argument
+N indicates that at least N consecutive spaces, or alternatively
+a @kbd{@key{TAB}} will be the separator.
If there is no active region, this command creates an empty Org
table. But it is easier just to start typing, like @kbd{| N a m e | P h o n e | A g e @key{RET} | - @key{TAB}}.
@@ -1987,15 +1899,15 @@ Re-align, move to previous field.
@item @kbd{@key{RET}} (@code{org-table-next-row})
@kindex RET
@findex org-table-next-row
-Re-align the table and move down to next row. Creates a new row
-if necessary. At the beginning or end of a line, @kbd{@key{RET}}
-still inserts a new line, so it can be used to split a table.
+Re-align the table and move down to next row. Creates a new row if
+necessary. At the beginning or end of a line, @kbd{@key{RET}} still
+inserts a new line, so it can be used to split a table.
@item @kbd{M-a} (@code{org-table-beginning-of-field})
@kindex M-a
@findex org-table-beginning-of-field
-Move to beginning of the current table field, or on to the
-previous field.
+Move to beginning of the current table field, or on to the previous
+field.
@item @kbd{M-e} (@code{org-table-end-of-field})
@kindex M-e
@@ -2042,39 +1954,58 @@ Move the current row down.
@findex org-table-kill-row
Kill the current row or horizontal line.
+@item @kbd{S-@key{UP}} (@code{org-table-move-cell-up})
+@kindex S-UP
+@findex org-table-move-cell-up
+Move cell up by swapping with adjacent cell.
+
+@item @kbd{S-@key{DOWN}} (@code{org-table-move-cell-down})
+@kindex S-DOWN
+@findex org-table-move-cell-down
+Move cell down by swapping with adjacent cell.
+
+@item @kbd{S-@key{LEFT}} (@code{org-table-move-cell-left})
+@kindex S-LEFT
+@findex org-table-move-cell-left
+Move cell left by swapping with adjacent cell.
+
+@item @kbd{S-@key{RIGHT}} (@code{org-table-move-cell-right})
+@kindex S-RIGHT
+@findex org-table-move-cell-right
+Move cell right by swapping with adjacent cell.
+
@item @kbd{M-S-@key{DOWN}} (@code{org-table-insert-row})
@kindex M-S-DOWN
@findex org-table-insert-row
-Insert a new row above the current row. With a prefix argument,
-the line is created below the current one.
+Insert a new row above the current row. With a prefix argument, the
+line is created below the current one.
@item @kbd{C-c -} (@code{org-table-insert-hline})
@kindex C-c -
@findex org-table-insert-hline
-Insert a horizontal line below current row. With a prefix
-argument, the line is created above the current line.
+Insert a horizontal line below current row. With a prefix argument,
+the line is created above the current line.
@item @kbd{C-c @key{RET}} (@code{org-table-hline-and-move})
@kindex C-c RET
@findex org-table-hline-and-move
-Insert a horizontal line below current row, and move point
-into the row below that line.
+Insert a horizontal line below current row, and move point into the
+row below that line.
@item @kbd{C-c ^} (@code{org-table-sort-lines})
@kindex C-c ^
@findex org-table-sort-lines
-Sort the table lines in the region. The position of point
-indicates the column to be used for sorting, and the range of
-lines is the range between the nearest horizontal separator
-lines, or the entire table. If point is before the first column,
-you are prompted for the sorting column. If there is an active
-region, the mark specifies the first line and the sorting column,
-while point should be in the last line to be included into the
-sorting. The command prompts for the sorting type,
-alphabetically, numerically, or by time. You can sort in normal
-or reverse order. You can also supply your own key extraction
-and comparison functions. When called with a prefix argument,
-alphabetic sorting is case-sensitive.
+Sort the table lines in the region. The position of point indicates
+the column to be used for sorting, and the range of lines is the
+range between the nearest horizontal separator lines, or the entire
+table. If point is before the first column, you are prompted for
+the sorting column. If there is an active region, the mark
+specifies the first line and the sorting column, while point should
+be in the last line to be included into the sorting. The command
+prompts for the sorting type, alphabetically, numerically, or by
+time. You can sort in normal or reverse order. You can also supply
+your own key extraction and comparison functions. When called with
+a prefix argument, alphabetic sorting is case-sensitive.
@end table
@anchor{Regions}
@@ -2085,37 +2016,34 @@ alphabetic sorting is case-sensitive.
@kindex C-c C-x M-w
@findex org-table-copy-region
Copy a rectangular region from a table to a special clipboard.
-Point and mark determine edge fields of the rectangle. If there
-is no active region, copy just the current field. The process
-ignores horizontal separator lines.
+Point and mark determine edge fields of the rectangle. If there is
+no active region, copy just the current field. The process ignores
+horizontal separator lines.
@item @kbd{C-c C-x C-w} (@code{org-table-cut-region})
@kindex C-c C-x C-w
@findex org-table-cut-region
-Copy a rectangular region from a table to a special clipboard,
-and blank all fields in the rectangle. So this is the ``cut''
-operation.
+Copy a rectangular region from a table to a special clipboard, and
+blank all fields in the rectangle. So this is the ``cut'' operation.
@item @kbd{C-c C-x C-y} (@code{org-table-paste-rectangle})
@kindex C-c C-x C-y
@findex org-table-paste-rectangle
-Paste a rectangular region into a table. The upper left corner
-ends up in the current field. All involved fields are
-overwritten. If the rectangle does not fit into the present
-table, the table is enlarged as needed. The process ignores
-horizontal separator lines.
+Paste a rectangular region into a table. The upper left corner ends
+up in the current field. All involved fields are overwritten. If
+the rectangle does not fit into the present table, the table is
+enlarged as needed. The process ignores horizontal separator lines.
@item @kbd{M-@key{RET}} (@code{org-table-wrap-region})
@kindex M-RET
@findex org-table-wrap-region
-Split the current field at point position and move the rest
-to the line below. If there is an active region, and both point
-and mark are in the same column, the text in the column is
-wrapped to minimum width for the given number of lines.
-A numeric prefix argument may be used to change the number of
-desired lines. If there is no region, but you specify a prefix
-argument, the current field is made blank, and the content is
-appended to the field above.
+Split the current field at point position and move the rest to the
+line below. If there is an active region, and both point and mark
+are in the same column, the text in the column is wrapped to minimum
+width for the given number of lines. A numeric prefix argument may
+be used to change the number of desired lines. If there is no
+region, but you specify a prefix argument, the current field is made
+blank, and the content is appended to the field above.
@end table
@anchor{Calculations}
@@ -2128,22 +2056,25 @@ appended to the field above.
@item @kbd{C-c +} (@code{org-table-sum})
@kindex C-c +
@findex org-table-sum
-Sum the numbers in the current column, or in the rectangle
-defined by the active region. The result is shown in the echo
-area and can be inserted with @kbd{C-y}.
+Sum the numbers in the current column, or in the rectangle defined
+by the active region. The result is shown in the echo area and can
+be inserted with @kbd{C-y}.
@item @kbd{S-@key{RET}} (@code{org-table-copy-down})
@kindex S-RET
@findex org-table-copy-down
@vindex org-table-copy-increment
-When current field is empty, copy from first non-empty field
-above. When not empty, copy current field down to next row and
-move point along with it. Depending on the variable
-@code{org-table-copy-increment}, integer field values can be
-incremented during copy. Integers that are too large are not
-incremented, however. Also, a @code{0} prefix argument temporarily
-disables the increment. This key is also used by shift-selection
-and related modes (see @ref{Conflicts}).
+When current field is empty, copy from first non-empty field above.
+When not empty, copy current field down to next row and move point
+along with it.
+
+Depending on the variable @code{org-table-copy-increment}, integer and
+time stamp field values, and fields prefixed or suffixed with
+a whole number, can be incremented during copy. Also, a @code{0} prefix
+argument temporarily disables the increment.
+
+This key is also used by shift-selection and related modes (see
+@ref{Conflicts}).
@end table
@anchor{Miscellaneous (1)}
@@ -2154,43 +2085,42 @@ and related modes (see @ref{Conflicts}).
@kindex C-c `
@findex org-table-edit-field
Edit the current field in a separate window. This is useful for
-fields that are not fully visible (see @ref{Column Width and Alignment}). When called with a @kbd{C-u} prefix, just make
-the full field visible, so that it can be edited in place. When
-called with two @kbd{C-u} prefixes, make the editor window
-follow point through the table and always show the current field.
-The follow mode exits automatically when point leaves the table,
-or when you repeat this command with @kbd{C-u C-u C-c `}.
+fields that are not fully visible (see @ref{Column Width and Alignment}).
+When called with a @kbd{C-u} prefix, just make the full field
+visible, so that it can be edited in place. When called with two
+@kbd{C-u} prefixes, make the editor window follow point through
+the table and always show the current field. The follow mode exits
+automatically when point leaves the table, or when you repeat this
+command with @kbd{C-u C-u C-c `}.
@item @kbd{M-x org-table-import}
@findex org-table-import
Import a file as a table. The table should be TAB or whitespace
-separated. Use, for example, to import a spreadsheet table or
-data from a database, because these programs generally can write
-TAB-separated text files. This command works by inserting the
-file into the buffer and then converting the region to a table.
-Any prefix argument is passed on to the converter, which uses it
-to determine the separator.
+separated. Use, for example, to import a spreadsheet table or data
+from a database, because these programs generally can write
+TAB-separated text files. This command works by inserting the file
+into the buffer and then converting the region to a table. Any
+prefix argument is passed on to the converter, which uses it to
+determine the separator.
@item @kbd{C-c |} (@code{org-table-create-or-convert-from-region})
@kindex C-c |
@findex org-table-create-or-convert-from-region
Tables can also be imported by pasting tabular text into the Org
-buffer, selecting the pasted text with @kbd{C-x C-x} and
-then using the @kbd{C-c |} command (see @ref{Creation and conversion}).
+buffer, selecting the pasted text with @kbd{C-x C-x} and then
+using the @kbd{C-c |} command (see @ref{Creation and conversion}).
@item @kbd{M-x org-table-export}
@findex org-table-export
@vindex org-table-export-default-format
-Export the table, by default as a TAB-separated file. Use for
-data exchange with, for example, spreadsheet or database
-programs. The format used to export the file can be configured
-in the variable @code{org-table-export-default-format}. You may also
-use properties @samp{TABLE_EXPORT_FILE} and @samp{TABLE_EXPORT_FORMAT} to
-specify the file name and the format for table export in
-a subtree. Org supports quite general formats for exported
-tables. The exporter format is the same as the format used by
-Orgtbl radio tables, see @ref{Translator functions}, for a detailed
-description.
+Export the table, by default as a TAB-separated file. Use for data
+exchange with, for example, spreadsheet or database programs. The
+format used to export the file can be configured in the variable
+@code{org-table-export-default-format}. You may also use properties
+@samp{TABLE_EXPORT_FILE} and @samp{TABLE_EXPORT_FORMAT} to specify the file
+name and the format for table export in a subtree. Org supports
+quite general formats for exported tables. The exporter format is
+the same as the format used by Orgtbl radio tables, see @ref{Translator functions}, for a detailed description.
@end table
@node Column Width and Alignment
@@ -2252,12 +2182,12 @@ with the following tools:
@findex org-table-toggle-column-width
Shrink or expand current column.
-If a width cookie specifies a width W for the column, shrinking
-it displays the first W visible characters only. Otherwise, the
-column is shrunk to a single character.
+If a width cookie specifies a width W for the column, shrinking it
+displays the first W visible characters only. Otherwise, the column
+is shrunk to a single character.
-When called before the first column or after the last one, ask
-for a list of column ranges to operate on.
+When called before the first column or after the last one, ask for
+a list of column ranges to operate on.
@item @kbd{C-u C-c @key{TAB}} (@code{org-table-shrink})
@kindex C-u C-c TAB
@@ -2510,8 +2440,7 @@ and @code{org-table-current-column}. Examples:
@table @asis
@item @samp{if(@@# % 2, $#, string(""))}
-Insert column number on odd rows, set field to empty on even
-rows.
+Insert column number on odd rows, set field to empty on even rows.
@item @samp{$2 = '(identity remote(FOO, @@@@#$1))}
Copy text or values of each row of column 1 of the table named
@@ -2630,8 +2559,8 @@ Set the internal Calc calculation precision to 20 digits.
@item @samp{n3}, @samp{s3}, @samp{e2}, @samp{f4}
Normal, scientific, engineering or fixed format of the result of
-Calc passed back to Org. Calc formatting is unlimited in
-precision as long as the Calc calculation precision is greater.
+Calc passed back to Org. Calc formatting is unlimited in precision
+as long as the Calc calculation precision is greater.
@item @samp{D}, @samp{R}
Degree and radian angle modes of Calc.
@@ -2644,20 +2573,19 @@ Duration computations in Calc or Lisp, @ref{Durations and time values}.
@item @samp{E}
If and how to consider empty fields. Without @samp{E} empty fields in
-range references are suppressed so that the Calc vector or Lisp
-list contains only the non-empty fields. With @samp{E} the empty
-fields are kept. For empty fields in ranges or empty field
-references the value @samp{nan} (not a number) is used in Calc
-formulas and the empty string is used for Lisp formulas. Add @samp{N}
-to use 0 instead for both formula types. For the value of
-a field the mode @samp{N} has higher precedence than @samp{E}.
+range references are suppressed so that the Calc vector or Lisp list
+contains only the non-empty fields. With @samp{E} the empty fields are
+kept. For empty fields in ranges or empty field references the
+value @samp{nan} (not a number) is used in Calc formulas and the empty
+string is used for Lisp formulas. Add @samp{N} to use 0 instead for both
+formula types. For the value of a field the mode @samp{N} has higher
+precedence than @samp{E}.
@item @samp{N}
Interpret all fields as numbers, use 0 for non-numbers. See the
-next section to see how this is essential for computations with
-Lisp formulas. In Calc formulas it is used only occasionally
-because there number strings are already interpreted as numbers
-without @samp{N}.
+next section to see how this is essential for computations with Lisp
+formulas. In Calc formulas it is used only occasionally because
+there number strings are already interpreted as numbers without @samp{N}.
@item @samp{L}
Literal, for Lisp formulas only. See the next section.
@@ -2707,26 +2635,24 @@ Operations,,calc,}). For example
field is set to empty with the empty string.
@item @samp{if("$1" =​= "nan" || "$2" =​= "nan", string(""), $1 + $2); E f-1}
-Sum of the first two columns. When at least one of the input
-fields is empty the Org table result field is set to empty. @samp{E}
-is required to not convert empty fields to 0. @samp{f-1} is an
-optional Calc format string similar to @samp{%.1f} but leaves empty
-results empty.
+Sum of the first two columns. When at least one of the input fields
+is empty the Org table result field is set to empty. @samp{E} is
+required to not convert empty fields to 0. @samp{f-1} is an optional
+Calc format string similar to @samp{%.1f} but leaves empty results empty.
@item @samp{if(typeof(vmean($1..$7)) =​= 12, string(""), vmean($1..$7); E}
-Mean value of a range unless there is any empty field. Every
-field in the range that is empty is replaced by @samp{nan} which lets
-@samp{vmean} result in @samp{nan}. Then @samp{typeof =} 12= detects the @samp{nan}
-from @code{vmean} and the Org table result field is set to empty. Use
-this when the sample set is expected to never have missing
-values.
+Mean value of a range unless there is any empty field. Every field
+in the range that is empty is replaced by @samp{nan} which lets @samp{vmean}
+result in @samp{nan}. Then @samp{typeof =} 12= detects the @samp{nan} from @code{vmean}
+and the Org table result field is set to empty. Use this when the
+sample set is expected to never have missing values.
@item @samp{if("$1..$7" =​= "[]", string(""), vmean($1..$7))}
-Mean value of a range with empty fields skipped. Every field in
-the range that is empty is skipped. When all fields in the range
-are empty the mean value is not defined and the Org table result
-field is set to empty. Use this when the sample set can have
-a variable size.
+Mean value of a range with empty fields skipped. Every field in the
+range that is empty is skipped. When all fields in the range are
+empty the mean value is not defined and the Org table result field
+is set to empty. Use this when the sample set can have a variable
+size.
@item @samp{vmean($1..$7); EN}
To complete the example before: Mean value of a range with empty
@@ -2854,22 +2780,22 @@ applies it to the current field, and stores it.
The left-hand side of a formula can also be a special expression in
order to assign the formula to a number of different fields. There is
no keyboard shortcut to enter such range formulas. To add them, use
-the formula editor (see @ref{Editing and debugging formulas}) or edit the
-@samp{TBLFM} keyword directly.
+the formula editor (see @ref{Editing and debugging formulas}) or edit
+the @samp{TBLFM} keyword directly.
@table @asis
@item @samp{$2=}
-Column formula, valid for the entire column. This is so common
-that Org treats these formulas in a special way, see @ref{Column formulas}.
+Column formula, valid for the entire column. This is so common that
+Org treats these formulas in a special way, see @ref{Column formulas}.
@item @samp{@@3=}
Row formula, applies to all fields in the specified row. @samp{@@>=}
means the last row.
@item @samp{@@1$2..@@4$3=}
-Range formula, applies to all fields in the given rectangular
-range. This can also be used to assign a formula to some but not
-all fields in a row.
+Range formula, applies to all fields in the given rectangular range.
+This can also be used to assign a formula to some but not all fields
+in a row.
@item @samp{$NAME=}
Named field, see @ref{Advanced features}.
@@ -2913,10 +2839,10 @@ following command:
@findex org-table-eval-formula
Install a new formula for the current column and replace current
field with the result of the formula. The command prompts for
-a formula, with default taken from the @samp{TBLFM} keyword, applies
-it to the current field and stores it. With a numeric prefix
-argument, e.g., @kbd{C-5 C-c =}, the command applies it to
-that many consecutive fields in the current column.
+a formula, with default taken from the @samp{TBLFM} keyword, applies it
+to the current field and stores it. With a numeric prefix argument,
+e.g., @kbd{C-5 C-c =}, the command applies it to that many
+consecutive fields in the current column.
@end table
@node Lookup functions
@@ -2935,14 +2861,14 @@ Searches for the first element @var{S} in list
@lisp
(PREDICATE VAL S)
@end lisp
-is non-@code{nil}; returns the value from the corresponding position
-in list @var{R-LIST}. The default @var{PREDICATE} is
-@code{equal}. Note that the parameters @var{VAL} and
-@var{S} are passed to @var{PREDICATE} in the same order
-as the corresponding parameters are in the call to
-@code{org-lookup-first}, where @var{VAL} precedes
-@var{S-LIST}. If @var{R-LIST} is @code{nil}, the matching
-element @var{S} of @var{S-LIST} is returned.
+is non-@code{nil}; returns the value from the corresponding position in
+list @var{R-LIST}. The default @var{PREDICATE} is
+@code{equal}. Note that the parameters @var{VAL} and @var{S}
+are passed to @var{PREDICATE} in the same order as the
+corresponding parameters are in the call to @code{org-lookup-first},
+where @var{VAL} precedes @var{S-LIST}. If
+@var{R-LIST} is @code{nil}, the matching element @var{S} of
+@var{S-LIST} is returned.
@item @samp{(org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)}
@findex org-lookup-last
@@ -2951,12 +2877,12 @@ element for which @var{PREDICATE} is non-@code{nil}.
@item @samp{(org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)}
@findex org-lookup-all
-Similar to @code{org-lookup-first}, but searches for @emph{all} elements
-for which @var{PREDICATE} is non-@code{nil}, and returns @emph{all}
+Similar to @code{org-lookup-first}, but searches for @emph{all} elements for
+which @var{PREDICATE} is non-@code{nil}, and returns @emph{all}
corresponding values. This function can not be used by itself in
-a formula, because it returns a list of values. However,
-powerful lookups can be built when this function is combined with
-other Emacs Lisp functions.
+a formula, because it returns a list of values. However, powerful
+lookups can be built when this function is combined with other Emacs
+Lisp functions.
@end table
If the ranges used in these functions contain empty fields, the @samp{E}
@@ -2996,9 +2922,9 @@ minibuffer. See @ref{Column formulas}, and @ref{Field and range formulas}.
@kindex C-u C-u C-c =
@findex org-table-eval-formula
Re-insert the active formula (either a field formula, or a column
-formula) into the current field, so that you can edit it directly
-in the field. The advantage over editing in the minibuffer is
-that you can use the command @kbd{C-c ?}.
+formula) into the current field, so that you can edit it directly in
+the field. The advantage over editing in the minibuffer is that you
+can use the command @kbd{C-c ?}.
@item @kbd{C-c ?} (@code{org-table-field-info})
@kindex C-c ?
@@ -3010,8 +2936,8 @@ referenced by the reference at point position in the formula.
@kindex C-c @}
@findex org-table-toggle-coordinate-overlays
Toggle the display of row and column numbers for a table, using
-overlays. These are updated each time the table is aligned; you
-can force it with @kbd{C-c C-c}.
+overlays. These are updated each time the table is aligned; you can
+force it with @kbd{C-c C-c}.
@item @kbd{C-c @{} (@code{org-table-toggle-formula-debugger})
@kindex C-c @{
@@ -3021,13 +2947,12 @@ Toggle the formula debugger on and off. See below.
@item @kbd{C-c '} (@code{org-table-edit-formulas})
@kindex C-c '
@findex org-table-edit-formulas
-Edit all formulas for the current table in a special buffer,
-where the formulas are displayed one per line. If the current
-field has an active formula, point in the formula editor marks
-it. While inside the special buffer, Org automatically
-highlights any field or range reference at point position. You
-may edit, remove and add formulas, and use the following
-commands:
+Edit all formulas for the current table in a special buffer, where
+the formulas are displayed one per line. If the current field has
+an active formula, point in the formula editor marks it. While
+inside the special buffer, Org automatically highlights any field or
+range reference at point position. You may edit, remove and add
+formulas, and use the following commands:
@table @asis
@item @kbd{C-c C-c} or @kbd{C-x C-s} (@code{org-table-fedit-finish})
@@ -3046,17 +2971,17 @@ Exit the formula editor without installing changes.
@item @kbd{C-c C-r} (@code{org-table-fedit-toggle-ref-type})
@kindex C-c C-r
@findex org-table-fedit-toggle-ref-type
-Toggle all references in the formula editor between standard
-(like @samp{B3}) and internal (like @samp{@@3$2}).
+Toggle all references in the formula editor between standard (like
+@samp{B3}) and internal (like @samp{@@3$2}).
@item @kbd{@key{TAB}} (@code{org-table-fedit-lisp-indent})
@kindex TAB
@findex org-table-fedit-lisp-indent
Pretty-print or indent Lisp formula at point. When in a line
-containing a Lisp formula, format the formula according to
-Emacs Lisp rules. Another @kbd{@key{TAB}} collapses the formula
-back again. In the open formula, @kbd{@key{TAB}} re-indents
-just like in Emacs Lisp mode.
+containing a Lisp formula, format the formula according to Emacs
+Lisp rules. Another @kbd{@key{TAB}} collapses the formula back
+again. In the open formula, @kbd{@key{TAB}} re-indents just like
+in Emacs Lisp mode.
@item @kbd{M-@key{TAB}} (@code{lisp-complete-symbol})
@kindex M-TAB
@@ -3072,10 +2997,9 @@ Complete Lisp symbols, just like in Emacs Lisp mode.
@findex org-table-fedit-ref-down
@findex org-table-fedit-ref-left
@findex org-table-fedit-ref-right
-Shift the reference at point. For example, if the reference
-is @samp{B3} and you press @kbd{S-@key{RIGHT}}, it becomes @samp{C3}.
-This also works for relative references and for hline
-references.
+Shift the reference at point. For example, if the reference is
+@samp{B3} and you press @kbd{S-@key{RIGHT}}, it becomes @samp{C3}. This also
+works for relative references and for hline references.
@item @kbd{M-S-@key{UP}} (@code{org-table-fedit-line-up})
@kindex M-S-UP
@@ -3208,10 +3132,9 @@ table header.
@kindex C-u C-u C-c *
@kindex C-u C-u C-c C-c
@findex org-table-iterate
-Iterate the table by recomputing it until no further changes
-occur. This may be necessary if some computed fields use the
-value of other fields that are computed @emph{later} in the
-calculation sequence.
+Iterate the table by recomputing it until no further changes occur.
+This may be necessary if some computed fields use the value of other
+fields that are computed @emph{later} in the calculation sequence.
@item @kbd{M-x org-table-recalculate-buffer-tables}
@findex org-table-recalculate-buffer-tables
@@ -3236,9 +3159,9 @@ characters.
@item @kbd{C-#} (@code{org-table-rotate-recalc-marks})
@kindex C-#
@findex org-table-rotate-recalc-marks
-Rotate the calculation mark in first column through the states
-@samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region, change all
-marks in the region.
+Rotate the calculation mark in first column through the states @samp{#},
+@samp{*}, @samp{!}, @samp{$}. When there is an active region, change all marks in
+the region.
@end table
Here is an example of a table that collects exam results of students
@@ -3280,20 +3203,19 @@ may refer to a column as @samp{$Tot} instead of @samp{$6}.
@item @samp{^}
This row defines names for the fields @emph{above} the row. With such
-a definition, any formula in the table may use @samp{$m1} to refer to
-the value @samp{10}. Also, if you assign a formula to a names field,
-it is stored as @samp{$name = ...}.
+a definition, any formula in the table may use @samp{$m1} to refer to the
+value @samp{10}. Also, if you assign a formula to a names field, it is
+stored as @samp{$name = ...}.
@item @samp{_}
-Similar to @samp{^}, but defines names for the fields in the row
-@emph{below}.
+Similar to @samp{^}, but defines names for the fields in the row @emph{below}.
@item @samp{$}
Fields in this row can define @emph{parameters} for formulas. For
-example, if a field in a @samp{$} row contains @samp{max=50}, then formulas
-in this table can refer to the value 50 using @samp{$max}. Parameters
-work exactly like constants, only that they can be defined on
-a per-table basis.
+example, if a field in a @samp{$} row contains @samp{max=50}, then formulas in
+this table can refer to the value 50 using @samp{$max}. Parameters work
+exactly like constants, only that they can be defined on a per-table
+basis.
@item @samp{#}
Fields in this row are automatically recalculated when pressing
@@ -3303,8 +3225,8 @@ Also, this row is selected for a global recalculation with
command.
@item @samp{*}
-Selects this line for global recalculation with @kbd{C-u C-c *}, but not for automatic recalculation. Use this when
-automatic recalculation slows down editing too much.
+Selects this line for global recalculation with @kbd{C-u C-c *}, but not for automatic recalculation. Use this when automatic
+recalculation slows down editing too much.
@item @samp{/}
Do not export this line. Useful for lines that contain the
@@ -3380,17 +3302,17 @@ Specify which column of the table to use as the @samp{x} axis.
@item @samp{deps}
Specify the columns to graph as a Lisp style list, surrounded by
-parentheses and separated by spaces for example @samp{dep:(3 4)} to
-graph the third and fourth columns. Defaults to graphing all
-other columns aside from the @samp{ind} column.
+parentheses and separated by spaces for example @samp{dep:(3 4)} to graph
+the third and fourth columns. Defaults to graphing all other
+columns aside from the @samp{ind} column.
@item @samp{type}
Specify whether the plot is @samp{2d}, @samp{3d}, or @samp{grid}.
@item @samp{with}
Specify a @samp{with} option to be inserted for every column being
-plotted, e.g., @samp{lines}, @samp{points}, @samp{boxes}, @samp{impulses}. Defaults
-to @samp{lines}.
+plotted, e.g., @samp{lines}, @samp{points}, @samp{boxes}, @samp{impulses}. Defaults to
+@samp{lines}.
@item @samp{file}
If you want to plot to a file, specify
@@ -3404,20 +3326,20 @@ headers if they exist.
Specify an entire line to be inserted in the Gnuplot script.
@item @samp{map}
-When plotting @samp{3d} or @samp{grid} types, set this to @samp{t} to graph
-a flat mapping rather than a @samp{3d} slope.
+When plotting @samp{3d} or @samp{grid} types, set this to @samp{t} to graph a flat
+mapping rather than a @samp{3d} slope.
@item @samp{timefmt}
Specify format of Org mode timestamps as they will be parsed by
Gnuplot. Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
@item @samp{script}
-If you want total control, you can specify a script file---place
-the file name between double-quotes---which will be used to plot.
+If you want total control, you can specify a script file---place the
+file name between double-quotes---which will be used to plot.
Before plotting, every instance of @samp{$datafile} in the specified
script will be replaced with the path to the generated data file.
-Note: even if you set this option, you may still want to specify
-the plot type, as that can impact the content of the data file.
+Note: even if you set this option, you may still want to specify the
+plot type, as that can impact the content of the data file.
@end table
@anchor{ASCII bar plots}
@@ -3505,18 +3427,31 @@ or alternatively
@end example
-@cindex square brackets in links
@cindex escape syntax, for links
-The @var{LINK} part cannot contain @samp{[} and @samp{]} characters. You
-can replace them with their percent-encoded counterparts, which are,
-respectively, @samp{%5B} and @samp{%5D}. You also need to encode @samp{%} characters
-as @samp{%25}. Optionally, it may also come handy to encode consecutive
-spaces as @samp{%20}.
+@cindex backslashes, in links
+Some @samp{\} and @samp{]} characters in the @var{LINK} part need to be
+``escaped'', i.e., preceded by another @samp{\} character. More
+specifically, the following character categories, and only them, must
+be escaped, in order:
+
+@enumerate
+@item
+all consecutive @samp{\} characters at the end of the link,
+@item
+any @samp{]} character at the very end of the link,
+@item
+all consecutive @samp{\} characters preceding @samp{][} or @samp{]]} patterns,
+@item
+any @samp{]} character followed by either @samp{[} or @samp{]}.
+@end enumerate
-Org takes for granted that such links are correctly escaped. Luckily,
-functions inserting links (see @ref{Handling Links}) take care of this.
-You really need to bother about it only when inserting manually a URI
-within square brackets.
+@findex org-link-escape
+Org takes for granted that such links are correctly escaped.
+Functions inserting links (see @ref{Handling Links}) take care of this.
+You only need to bother about those rules when inserting directly, or
+yanking, a URI within square brackets. When in doubt, you may use the
+function @code{org-link-escape}, which turns a link string into its
+properly escaped form.
Once a link in the buffer is complete, with all brackets present, Org
changes the display so that @samp{DESCRIPTION} is displayed instead of
@@ -3629,90 +3564,163 @@ point on or at a target.
@cindex links, external
@cindex external links
-@cindex Gnus links
+@cindex attachment links
@cindex BBDB links
-@cindex irc links
-@cindex URL links
+@cindex Elisp links
@cindex file links
-@cindex Rmail links
+@cindex Gnus links
+@cindex Help links
+@cindex IRC links
+@cindex Info links
@cindex MH-E links
-@cindex Usenet links
+@cindex Rmail links
@cindex shell links
-@cindex Info links
-@cindex Elisp links
+@cindex URL links
+@cindex Usenet links
Org supports links to files, websites, Usenet and email messages, BBDB
database entries and links to both IRC conversations and their logs.
External links are URL-like locators. They start with a short
identifying string followed by a colon. There can be no space after
-the colon. The following list shows examples for each link type.
-
-@multitable {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa}
-@item @samp{http://www.astro.uva.nl/=dominik}
-@tab on the web
-@item @samp{doi:10.1000/182}
-@tab DOI for an electronic resource
-@item @samp{file:/home/dominik/images/jupiter.jpg}
-@tab file, absolute path
-@item @samp{/home/dominik/images/jupiter.jpg}
-@tab same as above
-@item @samp{file:papers/last.pdf}
-@tab file, relative path
-@item @samp{./papers/last.pdf}
-@tab same as above
-@item @samp{file:/ssh:me@@some.where:papers/last.pdf}
-@tab file, path on remote machine
-@item @samp{/ssh:me@@some.where:papers/last.pdf}
-@tab same as above
-@item @samp{file:sometextfile::NNN}
-@tab file, jump to line number
-@item @samp{file:projects.org}
-@tab another Org file
-@item @samp{file:projects.org::some words}
-@tab text search in Org file@footnote{The actual behavior of the search depends on the value of the
+the colon.
+
+Here is the full set of built-in link types:
+
+@table @asis
+@item @samp{file}
+File links. File name may be remote, absolute, or relative.
+
+Additionally, you can specify a line number, or a text search.
+In Org files, you may link to a headline name, a custom ID, or a
+code reference instead.
+
+As a special case, ``file'' prefix may be omitted if the file name
+is complete, e.g., it starts with @samp{./}, or @samp{/}.
+
+@item @samp{attachment}
+Same as file links but for files and folders attached to the current
+node (see @ref{Attachments}). Attachment links are intended to behave
+exactly as file links but for files relative to the attachment
+directory.
+
+@item @samp{bbdb}
+Link to a BBDB record, with possible regexp completion.
+
+@item @samp{docview}
+Link to a document opened with DocView mode. You may specify a page
+number.
+
+@item @samp{doi}
+Link to an electronic resource, through its handle.
+
+@item @samp{elisp}
+Execute an Elisp command upon activation.
+
+@item @samp{gnus}, @samp{rmail}, @samp{mhe}
+Link to messages or folders from a given Emacs' MUA@.
+
+@item @samp{help}
+Display documentation of a symbol in @samp{*Help*} buffer.
+
+@item @samp{http}, @samp{https}
+Web links.
+
+@item @samp{id}
+Link to a specific headline by its ID property, in an Org file.
+
+@item @samp{info}
+Link to an Info manual, or to a specific node.
+
+@item @samp{irc}
+Link to an IRC channel.
+
+@item @samp{mailto}
+Link to message composition.
+
+@item @samp{news}
+Usenet links.
+
+@item @samp{shell}
+Execute a shell command upon activation.
+@end table
+
+The following table illustrates the link types above, along with their
+options:
+
+@multitable {aaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa}
+@headitem Link Type
+@tab Example
+@item http
+@tab @samp{http://staff.science.uva.nl/c.dominik/}
+@item https
+@tab @samp{https://orgmode.org/}
+@item doi
+@tab @samp{doi:10.1000/182}
+@item file
+@tab @samp{file:/home/dominik/images/jupiter.jpg}
+@item
+@tab @samp{/home/dominik/images/jupiter.jpg} (same as above)
+@item
+@tab @samp{file:papers/last.pdf}
+@item
+@tab @samp{./papers/last.pdf} (same as above)
+@item
+@tab @samp{file:/ssh:me@@some.where:papers/last.pdf} (remote)
+@item
+@tab @samp{/ssh:me@@some.where:papers/last.pdf} (same as above)
+@item
+@tab @samp{file:sometextfile::NNN} (jump to line number)
+@item
+@tab @samp{file:projects.org}
+@item
+@tab @samp{file:projects.org::some words} (text search) @footnote{The actual behavior of the search depends on the value of the
variable @code{org-link-search-must-match-exact-headline}. If its value is
@code{nil}, then a fuzzy text search is done. If it is @code{t}, then only the
exact headline is matched, ignoring spaces and statistic cookies. If
the value is @code{query-to-create}, then an exact headline is searched; if
it is not found, then the user is queried to create it.}
-@item @samp{file:projects.org::*task title}
-@tab heading search in Org file
-@item @samp{file+sys:/path/to/file}
-@tab open via OS, like double-click
-@item @samp{file+emacs:/path/to/file}
-@tab force opening by Emacs
-@item @samp{docview:papers/last.pdf::NNN}
-@tab open in doc-view mode at page
-@item @samp{id:B7423F4D-2E8A-471B-8810-C40F074717E9}
-@tab link to heading by ID
-@item @samp{news:comp.emacs}
-@tab Usenet link
-@item @samp{mailto:adent@@galaxy.net}
-@tab mail link
-@item @samp{mhe:folder}
-@tab MH-E folder link
-@item @samp{mhe:folder#id}
-@tab MH-E message link
-@item @samp{rmail:folder}
-@tab Rmail folder link
-@item @samp{rmail:folder#id}
-@tab Rmail message link
-@item @samp{gnus:group}
-@tab Gnus group link
-@item @samp{gnus:group#id}
-@tab Gnus article link
-@item @samp{bbdb:R.*Stallman}
-@tab BBDB link (with regexp)
-@item @samp{irc:/irc.com/#emacs/bob}
-@tab IRC link
-@item @samp{info:org#External links}
-@tab Info node link
-@item @samp{shell:ls *.org}
-@tab shell command
-@item @samp{elisp:org-agenda}
-@tab interactive Elisp command
-@item @samp{elisp:(find-file "Elisp.org")}
-@tab Elisp form to evaluate
+@item
+@tab @samp{file:projects.org::*task title} (headline search)
+@item
+@tab @samp{file:projects.org::#custom-id} (headline search)
+@item attachment
+@tab @samp{attachment:projects.org}
+@item
+@tab @samp{attachment:projects.org::some words} (text search)
+@item docview
+@tab @samp{docview:papers/last.pdf::NNN}
+@item id
+@tab @samp{id:B7423F4D-2E8A-471B-8810-C40F074717E9}
+@item news
+@tab @samp{news:comp.emacs}
+@item mailto
+@tab @samp{mailto:adent@@galaxy.net}
+@item mhe
+@tab @samp{mhe:folder} (folder link)
+@item
+@tab @samp{mhe:folder#id} (message link)
+@item rmail
+@tab @samp{rmail:folder} (folder link)
+@item
+@tab @samp{rmail:folder#id} (message link)
+@item gnus
+@tab @samp{gnus:group} (group link)
+@item
+@tab @samp{gnus:group#id} (article link)
+@item bbdb
+@tab @samp{bbdb:R.*Stallman} (record with regexp)
+@item irc
+@tab @samp{irc:/irc.com/#emacs/bob}
+@item help
+@tab @samp{help:org-store-link}
+@item info
+@tab @samp{info:org#External links}
+@item shell
+@tab @samp{shell:ls *.org}
+@item elisp
+@tab @samp{elisp:(find-file "Elisp.org")} (Elisp form to evaluate)
+@item
+@tab @samp{elisp:org-agenda} (interactive Elisp command)
@end multitable
@cindex VM links
@@ -3757,10 +3765,10 @@ image is inlined into the exported HTML file.
@cindex square brackets, around links
@cindex angular brackets, around links
@cindex plain text external links
-Org also finds external links in the normal text and activates them as
-links. If spaces must be part of the link (for example in
-@samp{bbdb:Richard Stallman}), or if you need to remove ambiguities about
-the end of the link, enclose the link in square or angular brackets.
+Org also recognizes external links amid normal text and activates them
+as links. If spaces must be part of the link (for example in
+@samp{bbdb:R.*Stallman}), or if you need to remove ambiguities about the
+end of the link, enclose the link in square or angular brackets.
@node Handling Links
@section Handling Links
@@ -3780,9 +3788,9 @@ current buffer:
@table @asis
@item @emph{Org mode buffers}
-For Org files, if there is a @samp{<<target>>} at point, the link
-points to the target. Otherwise it points to the current
-headline, which is also the description@footnote{If the headline contains a timestamp, it is removed from the
+For Org files, if there is a @samp{<<target>>} at point, the link points
+to the target. Otherwise it points to the current headline, which
+is also the description@footnote{If the headline contains a timestamp, it is removed from the
link, which results in a wrong link---you should avoid putting
a timestamp in the headline.}.
@@ -3790,23 +3798,23 @@ a timestamp in the headline.}.
@cindex @samp{CUSTOM_ID}, property
@cindex @samp{ID}, property
If the headline has a @samp{CUSTOM_ID} property, store a link to this
-custom ID@. In addition or alternatively, depending on the value
-of @code{org-id-link-to-org-use-id}, create and/or use a globally unique
+custom ID@. In addition or alternatively, depending on the value of
+@code{org-id-link-to-org-use-id}, create and/or use a globally unique
@samp{ID} property for the link@footnote{The Org Id library must first be loaded, either through
@code{org-customize}, by enabling @code{id} in @code{org-modules}, or by adding
@samp{(require 'org-id)} in your Emacs init file.}. So using this command in Org
buffers potentially creates two links: a human-readable link from
-the custom ID, and one that is globally unique and works even if
-the entry is moved from file to file. Later, when inserting the
-link, you need to decide which one to use.
+the custom ID, and one that is globally unique and works even if the
+entry is moved from file to file. Later, when inserting the link,
+you need to decide which one to use.
@item @emph{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}
-@vindex org-email-link-description-format
-Pretty much all Emacs mail clients are supported. The link
-points to the current article, or, in some Gnus buffers, to the
-group. The description is constructed according to the variable
-@code{org-email-link-description-format}. By default, it refers to
-the addressee and the subject, possibly truncated.
+@vindex org-link-email-description-format
+Pretty much all Emacs mail clients are supported. The link points
+to the current article, or, in some Gnus buffers, to the group. The
+description is constructed according to the variable
+@code{org-link-email-description-format}. By default, it refers to the
+addressee and the subject.
@item @emph{Web browsers: W3, W3M and EWW}
Here the link is the current URL, with the page title as the
@@ -3817,24 +3825,24 @@ Links created in a BBDB buffer point to the current entry.
@item @emph{Chat: IRC}
@vindex org-irc-links-to-logs
-For IRC links, if the variable @code{org-irc-link-to-logs} is
-non-@code{nil}, create a @samp{file} style link to the relevant point in
-the logs for the current conversation. Otherwise store an @samp{irc}
-style link to the user/channel/server under the point.
+For IRC links, if the variable @code{org-irc-link-to-logs} is non-@code{nil},
+create a @samp{file} style link to the relevant point in the logs for the
+current conversation. Otherwise store an @samp{irc} style link to the
+user/channel/server under the point.
@item @emph{Other files}
For any other file, the link points to the file, with a search
-string (see @ref{Search Options}) pointing to the
-contents of the current line. If there is an active region, the
-selected words form the basis of the search string. You can write
-custom Lisp functions to select the search string and perform the
-search for particular file types (see @ref{Custom Searches}).
+string (see @ref{Search Options}) pointing to the contents
+of the current line. If there is an active region, the selected
+words form the basis of the search string. You can write custom Lisp
+functions to select the search string and perform the search for
+particular file types (see @ref{Custom Searches}).
You can also define dedicated links to other files. See @ref{Adding Hyperlink Types}.
@item @emph{Agenda view}
-When point is in an agenda view, the created link points to
-the entry referenced by the current line.
+When point is in an agenda view, the created link points to the
+entry referenced by the current line.
@end table
From an Org buffer, the following commands create, navigate or, more
@@ -3847,39 +3855,38 @@ generally, act on links.
@cindex link completion
@cindex completion, of links
@cindex inserting links
-@vindex org-keep-stored-link-after-insertion
+@vindex org-link-keep-stored-after-insertion
Insert a link@footnote{Note that you do not have to use this command to insert
a link. Links in Org are plain text, and you can type or paste them
straight into the buffer. By using this command, the links are
automatically enclosed in double brackets, and you will be asked for
-the optional descriptive text.}. This prompts for a link to be inserted
-into the buffer. You can just type a link, using text for an
-internal link, or one of the link type prefixes mentioned in the
-examples above. The link is inserted into the buffer, along with
+the optional descriptive text.}. This prompts for a link to be inserted into
+the buffer. You can just type a link, using text for an internal
+link, or one of the link type prefixes mentioned in the examples
+above. The link is inserted into the buffer, along with
a descriptive text@footnote{After insertion of a stored link, the link will be removed
from the list of stored links. To keep it in the list for later use,
use a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or
-configure the option @code{org-keep-stored-link-after-insertion}.}. If some text was selected at this
-time, it becomes the default description.
+configure the option @code{org-link-keep-stored-after-insertion}.}. If some text was selected at this time,
+it becomes the default description.
@table @asis
@item @emph{Inserting stored links}
All links stored during the current session are part of the
-history for this prompt, so you can access them with
-@kbd{@key{UP}} and @kbd{@key{DOWN}} (or @kbd{M-p},
-@kbd{M-n}).
+history for this prompt, so you can access them with @kbd{@key{UP}}
+and @kbd{@key{DOWN}} (or @kbd{M-p}, @kbd{M-n}).
@item @emph{Completion support}
Completion with @kbd{@key{TAB}} helps you to insert valid link
prefixes like @samp{http} or @samp{ftp}, including the prefixes defined
through link abbreviations (see @ref{Link Abbreviations}). If you
-press @kbd{@key{RET}} after inserting only the prefix, Org
-offers specific completion support for some link types@footnote{This works if a function has been defined in the @code{:complete}
-property of a link in @code{org-link-parameters}.}.
-For example, if you type @kbd{f i l e @key{RET}}---alternative
-access: @kbd{C-u C-c C-l}, see below---Org offers file
-name completion, and after @kbd{b b d b @key{RET}} you can
-complete contact names.
+press @kbd{@key{RET}} after inserting only the prefix, Org offers
+specific completion support for some link types@footnote{This works if a function has been defined in the @code{:complete}
+property of a link in @code{org-link-parameters}.}. For
+example, if you type @kbd{f i l e @key{RET}}---alternative access:
+@kbd{C-u C-c C-l}, see below---Org offers file name
+completion, and after @kbd{b b d b @key{RET}} you can complete
+contact names.
@end table
@item @kbd{C-u C-c C-l}
@@ -3887,62 +3894,60 @@ complete contact names.
@cindex completion, of file names
@kindex C-u C-c C-l
When @kbd{C-c C-l} is called with a @kbd{C-u} prefix
-argument, insert a link to a file. You may use file name
-completion to select the name of the file. The path to the file
-is inserted relative to the directory of the current Org file, if
-the linked file is in the current directory or in a sub-directory
-of it, or if the path is written relative to the current
-directory using @samp{../}. Otherwise an absolute path is used, if
-possible with @samp{~/} for your home directory. You can force an
-absolute path with two @kbd{C-u} prefixes.
+argument, insert a link to a file. You may use file name completion
+to select the name of the file. The path to the file is inserted
+relative to the directory of the current Org file, if the linked
+file is in the current directory or in a sub-directory of it, or if
+the path is written relative to the current directory using @samp{../}.
+Otherwise an absolute path is used, if possible with @samp{~/} for your
+home directory. You can force an absolute path with two
+@kbd{C-u} prefixes.
@item @kbd{C-c C-l} (with point on existing link)
@cindex following links
-When point is on an existing link, @kbd{C-c C-l} allows
-you to edit the link and description parts of the link.
+When point is on an existing link, @kbd{C-c C-l} allows you to
+edit the link and description parts of the link.
@item @kbd{C-c C-o} (@code{org-open-at-point})
@kindex C-c C-o
@findex org-open-at-point
@vindex org-file-apps
Open link at point. This launches a web browser for URL (using
-@code{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB
-for the corresponding links, and execute the command in a shell
-link. When point is on an internal link, this command runs the
-corresponding search. When point is on the tags part of a
-headline, it creates the corresponding tags view (see @ref{Matching tags and properties}). If point is on a timestamp, it compiles
-the agenda for that date. Furthermore, it visits text and remote
-files in @samp{file} links with Emacs and select a suitable
-application for local non-text files. Classification of files is
-based on file extension only. See option @code{org-file-apps}. If
-you want to override the default application and visit the file
-with Emacs, use a @kbd{C-u} prefix. If you want to avoid
-opening in Emacs, use a @kbd{C-u C-u} prefix.
+@code{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
+the corresponding links, and execute the command in a shell link.
+When point is on an internal link, this command runs the
+corresponding search. When point is on the tags part of a headline,
+it creates the corresponding tags view (see @ref{Matching tags and properties}). If point is on a timestamp, it compiles the agenda for
+that date. Furthermore, it visits text and remote files in @samp{file}
+links with Emacs and select a suitable application for local
+non-text files. Classification of files is based on file extension
+only. See option @code{org-file-apps}. If you want to override the
+default application and visit the file with Emacs, use
+a @kbd{C-u} prefix. If you want to avoid opening in Emacs, use
+a @kbd{C-u C-u} prefix.
@vindex org-link-frame-setup
-If point is on a headline, but not on a link, offer all links in
-the headline and entry text. If you want to setup the frame
-configuration for following links, customize
-@code{org-link-frame-setup}.
+If point is on a headline, but not on a link, offer all links in the
+headline and entry text. If you want to setup the frame
+configuration for following links, customize @code{org-link-frame-setup}.
@item @kbd{@key{RET}}
@vindex org-return-follows-link
@kindex RET
-When @code{org-return-follows-link} is set, @kbd{@key{RET}} also
-follows the link at point.
+When @code{org-return-follows-link} is set, @kbd{@key{RET}} also follows
+the link at point.
@item @kbd{mouse-2} or @kbd{mouse-1}
@kindex mouse-2
@kindex mouse-1
-On links, @kbd{mouse-1} and @kbd{mouse-2} opens the
-link just as @kbd{C-c C-o} does.
+On links, @kbd{mouse-1} and @kbd{mouse-2} opens the link
+just as @kbd{C-c C-o} does.
@item @kbd{mouse-3}
-@vindex org-display-internal-link-with-indirect-buffer
+@vindex org-link-use-indirect-buffer-for-internals
@kindex mouse-3
Like @kbd{mouse-2}, but force file links to be opened with
-Emacs, and internal links to be displayed in another
-window@footnote{See the variable @code{org-display-internal-link-with-indirect-buffer}.}.
+Emacs, and internal links to be displayed in another window@footnote{See the variable @code{org-link-use-indirect-buffer-for-internals}.}.
@item @kbd{C-c %} (@code{org-mark-ring-push})
@kindex C-c %
@@ -3957,9 +3962,9 @@ automatically.
@findex org-mark-ring-goto
@cindex links, returning to
Jump back to a recorded position. A position is recorded by the
-commands following internal links, and by @kbd{C-c %}.
-Using this command several times in direct succession moves
-through a ring of previously recorded positions.
+commands following internal links, and by @kbd{C-c %}. Using
+this command several times in direct succession moves through a ring
+of previously recorded positions.
@item @kbd{C-c C-x C-n} (@code{org-next-link})
@itemx @kbd{C-c C-x C-p} (@code{org-previous-link})
@@ -3968,10 +3973,10 @@ through a ring of previously recorded positions.
@kindex C-c C-x C-n
@findex org-next-link
@cindex links, finding next/previous
-Move forward/backward to the next link in the buffer. At the
-limit of the buffer, the search fails once, and then wraps
-around. The key bindings for this are really too long; you might
-want to bind this also to @kbd{M-n} and @kbd{M-p}.
+Move forward/backward to the next link in the buffer. At the limit
+of the buffer, the search fails once, and then wraps around. The
+key bindings for this are really too long; you might want to bind
+this also to @kbd{M-n} and @kbd{M-p}.
@lisp
(add-hook 'org-load-hook
@@ -4071,16 +4076,20 @@ the link completion function like this:
@cindex search option in file links
@cindex file links, searching
+@cindex attachment links, searching
-File links can contain additional information to make Emacs jump to
-a particular location in the file when following a link. This can be
-a line number or a search option after a double colon@footnote{For backward compatibility, line numbers can also follow a
+File links can contain additional information to make Emacs jump to a
+particular location in the file when following a link. This can be a
+line number or a search option after a double colon@footnote{For backward compatibility, line numbers can also follow a
single colon.}. For
example, when the command @code{org-store-link} creates a link (see
@ref{Handling Links}) to a file, it encodes the words in the current line
as a search string that can be used to find this line back later when
following the link with @kbd{C-c C-o}.
+Note that all search options apply for Attachment links in the same
+way that they apply for File links.
+
Here is the syntax of the different ways to attach a search to a file
link, together with explanations for each:
@@ -4090,6 +4099,7 @@ link, together with explanations for each:
[[file:~/xx.org::*My Target]]
[[file:~/xx.org::#my-custom-id]]
[[file:~/xx.org::/regexp/]]
+[[attachment:main.c::255]]
@end example
@table @asis
@@ -4098,10 +4108,9 @@ Jump to line 255.
@item @samp{My Target}
Search for a link target @samp{<<My Target>>}, or do a text search for
-@samp{my target}, similar to the search in internal links, see
-@ref{Internal Links}. In HTML export (see @ref{HTML Export}), such a file
-link becomes a HTML reference to the corresponding named anchor
-in the linked file.
+@samp{my target}, similar to the search in internal links, see @ref{Internal Links}. In HTML export (see @ref{HTML Export}), such a file link becomes
+a HTML reference to the corresponding named anchor in the linked
+file.
@item @samp{*My Target}
In an Org file, restrict search to headlines.
@@ -4110,15 +4119,16 @@ In an Org file, restrict search to headlines.
Link to a heading with a @samp{CUSTOM_ID} property
@item @samp{/REGEXP/}
-Do a regular expression search for @var{REGEXP}. This uses
-the Emacs command @code{occur} to list all matches in a separate
-window. If the target file is in Org mode, @code{org-occur} is used
-to create a sparse tree with the matches.
+Do a regular expression search for @var{REGEXP}. This uses the
+Emacs command @code{occur} to list all matches in a separate window. If
+the target file is in Org mode, @code{org-occur} is used to create
+a sparse tree with the matches.
@end table
As a degenerate case, a file link with an empty file name can be used
to search the current file. For example, @samp{[[file:::find me]]} does
-a search for @samp{find me} in the current file, just as @samp{[[find me]]} would.
+a search for @samp{find me} in the current file, just as @samp{[[find me]]}
+would.
@node Custom Searches
@section Custom Searches
@@ -4142,7 +4152,7 @@ need to be added to the hook variables
@code{org-execute-file-search-functions}. See the docstring for these
variables for more information. Org actually uses this mechanism for
Bib@TeX{} database files, and you can use the corresponding code as an
-implementation example. See the file @samp{org-bibtex.el}.
+implementation example. See the file @samp{ol-bibtex.el}.
@node TODO Items
@chapter TODO Items
@@ -4195,20 +4205,13 @@ Rotate the TODO state of the current item among
'--------------------------------'
@end example
-If TODO keywords have fast access keys (see @ref{Fast access to TODO states}), prompt for a TODO keyword through the fast
-selection interface; this is the default behavior when
+If TODO keywords have fast access keys (see @ref{Fast access to TODO states}), prompt for a TODO keyword through the fast selection
+interface; this is the default behavior when
@code{org-use-fast-todo-selection} is non-@code{nil}.
-The same rotation can also be done ``remotely'' from the agenda
+The same state changing can also be done ``remotely'' from the agenda
buffer with the @kbd{t} command key (see @ref{Agenda Commands}).
-@item @kbd{C-u C-c C-t}
-@kindex C-u C-c C-t
-When TODO keywords have no selection keys, select a specific
-keyword using completion; otherwise force cycling through TODO
-states with no prompt. When @code{org-use-fast-todo-selection} is set
-to @code{prefix}, use the fast selection interface.
-
@item @kbd{S-@key{RIGHT}} @kbd{S-@key{LEFT}}
@kindex S-RIGHT
@kindex S-LEFT
@@ -4216,7 +4219,7 @@ to @code{prefix}, use the fast selection interface.
Select the following/preceding TODO state, similar to cycling.
Useful mostly if more than two TODO states are possible (see
@ref{TODO Extensions}). See also @ref{Conflicts}, for a discussion of the interaction with
-@code{shift-selection-mode}. See also the variable
+shift-selection. See also the variable
@code{org-treat-S-cursor-todo-selection-as-state-change}.
@item @kbd{C-c / t} (@code{org-show-todo-tree})
@@ -4224,24 +4227,23 @@ Useful mostly if more than two TODO states are possible (see
@cindex sparse tree, for TODO
@vindex org-todo-keywords
@findex org-show-todo-tree
-View TODO items in a @emph{sparse tree} (see @ref{Sparse Trees}). Folds
-the entire buffer, but shows all TODO items---with not-DONE
-state---and the headings hierarchy above them. With a prefix
-argument, or by using @kbd{C-c / T}, search for a specific
-TODO@. You are prompted for the keyword, and you can also give
-a list of keywords like @samp{KWD1|KWD2|...} to list entries that
-match any one of these keywords. With a numeric prefix argument
-N, show the tree for the Nth keyword in the variable
-@code{org-todo-keywords}. With two prefix arguments, find all TODO
-states, both un-done and done.
+View TODO items in a @emph{sparse tree} (see @ref{Sparse Trees}). Folds the
+entire buffer, but shows all TODO items---with not-DONE state---and
+the headings hierarchy above them. With a prefix argument, or by
+using @kbd{C-c / T}, search for a specific TODO@. You are
+prompted for the keyword, and you can also give a list of keywords
+like @samp{KWD1|KWD2|...} to list entries that match any one of these
+keywords. With a numeric prefix argument N, show the tree for the
+Nth keyword in the variable @code{org-todo-keywords}. With two prefix
+arguments, find all TODO states, both un-done and done.
@item @kbd{M-x org-agenda t} (@code{org-todo-list})
@kindex t @r{(Agenda dispatcher)}
-Show the global TODO list. Collects the TODO items (with
-not-DONE states) from all agenda files (see @ref{Agenda Views}) into
-a single buffer. The new buffer is in Org Agenda mode, which
-provides commands to examine and manipulate the TODO entries from
-the new buffer (see @ref{Agenda Commands}). See @ref{Global TODO list}, for more information.
+Show the global TODO list. Collects the TODO items (with not-DONE
+states) from all agenda files (see @ref{Agenda Views}) into a single
+buffer. The new buffer is in Org Agenda mode, which provides
+commands to examine and manipulate the TODO entries from the new
+buffer (see @ref{Agenda Commands}). See @ref{Global TODO list}, for more information.
@item @kbd{S-M-@key{RET}} (@code{org-insert-todo-heading})
@kindex S-M-RET
@@ -4284,8 +4286,8 @@ TODO items in particular (see @ref{Tags}).
@cindex TODO workflow
@cindex workflow states as TODO keywords
-You can use TODO keywords to indicate different @emph{sequential} states in
-the process of working on an item, for example@footnote{Changing the variable @code{org-todo-keywords} only becomes
+You can use TODO keywords to indicate different, possibly @emph{sequential}
+states in the process of working on an item, for example@footnote{Changing the variable @code{org-todo-keywords} only becomes
effective after restarting Org mode in a buffer.}:
@lisp
@@ -4303,12 +4305,11 @@ With this setup, the command @kbd{C-c C-t} cycles an entry from
@samp{TODO} to @samp{FEEDBACK}, then to @samp{VERIFY}, and finally to @samp{DONE} and
@samp{DELEGATED}. You may also use a numeric prefix argument to quickly
select a specific state. For example @kbd{C-3 C-c C-t} changes
-the state immediately to @samp{VERIFY}. Or you can use @kbd{S-@key{LEFT}}
-to go backward through the sequence. If you define many keywords, you
-can use in-buffer completion (see @ref{Completion}) or even a special
-one-key selection scheme (see @ref{Fast access to TODO states}) to insert
-these words into the buffer. Changing a TODO state can be logged with
-a timestamp, see @ref{Tracking TODO state changes}, for more information.
+the state immediately to @samp{VERIFY}. Or you can use @kbd{S-@key{RIGHT}}
+and @kbd{S-@key{LEFT}} to go forward and backward through the states.
+If you define many keywords, you can use in-buffer completion (see
+@ref{Completion}) or a special one-key selection scheme (see @ref{Fast access to TODO states}) to insert these words into the buffer.
+Changing a TODO state can be logged with a timestamp, see @ref{Tracking TODO state changes}, for more information.
@node TODO types
@subsection TODO keywords as types
@@ -4321,14 +4322,18 @@ The second possibility is to use TODO keywords to indicate different
@emph{types} of action items. For example, you might want to indicate that
items are for ``work'' or ``home''. Or, when you work with several people
on a single project, you might want to assign action items directly to
-persons, by using their names as TODO keywords. This would be set up
-like this:
+persons, by using their names as TODO keywords. This type of
+functionality is actually much better served by using tags (see
+@ref{Tags}), so the TODO implementation is kept just for backward
+compatibility.
+
+Using TODO types, it would be set up like this:
@lisp
(setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
@end lisp
-In this case, different keywords do not indicate a sequence, but
+In this case, different keywords do not indicate states, but
rather different types. So the normal work flow would be to assign
a task to a person, and later to mark it DONE@. Org mode supports this
style by adapting the workings of the command @kbd{C-c C-t}@footnote{This is also true for the @kbd{t} command in the agenda
@@ -4379,20 +4384,18 @@ correct sequence. In addition to typing a keyword or using completion
@kindex C-u C-u C-c C-t
These keys jump from one TODO sub-sequence to the next. In the
above example, @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{RIGHT}}
-would jump from @samp{TODO} or @samp{DONE} to @samp{REPORT}, and any of the
-words in the second row to @samp{CANCELED}. Note that the
-@kbd{C-S-} key binding conflict with @code{shift-selection-mode}
-(see @ref{Conflicts}).
+would jump from @samp{TODO} or @samp{DONE} to @samp{REPORT}, and any of the words
+in the second row to @samp{CANCELED}. Note that the @kbd{C-S-} key
+binding conflict with shift-selection (see @ref{Conflicts}).
@item @kbd{S-@key{RIGHT}}
@itemx @kbd{S-@key{LEFT}}
@kindex S-RIGHT
@kindex S-LEFT
-@kbd{S-@key{LEFT}} and @kbd{S-@key{RIGHT}} walk through @emph{all}
-keywords from all sub-sequences, so for example
-@kbd{S-@key{RIGHT}} would switch from @samp{DONE} to @samp{REPORT} in the
-example above. For a discussion of the interaction with
-@code{shift-selection-mode}, see @ref{Conflicts}.
+@kbd{S-@key{LEFT}} and @kbd{S-@key{RIGHT}} walk through @emph{all} keywords
+from all sub-sequences, so for example @kbd{S-@key{RIGHT}} would
+switch from @samp{DONE} to @samp{REPORT} in the example above. For
+a discussion of the interaction with shift-selection, see @ref{Conflicts}.
@end table
@node Fast access to TODO states
@@ -4512,15 +4515,15 @@ a background color.
@cindex @samp{ORDERED}, property
The structure of Org files---hierarchy and lists---makes it easy to
define TODO dependencies. Usually, a parent TODO task should not be
-marked DONE until all TODO subtasks, or children tasks, are marked as
-DONE@. Sometimes there is a logical sequence to (sub)tasks, so that
+marked as done until all TODO subtasks, or children tasks, are marked
+as done. Sometimes there is a logical sequence to (sub)tasks, so that
one subtask cannot be acted upon before all siblings above it have
-been marked DONE@. If you customize the variable
+been marked as done. If you customize the variable
@code{org-enforce-todo-dependencies}, Org blocks entries from changing
state to DONE while they have TODO children that are not DONE@.
Furthermore, if an entry has a property @samp{ORDERED}, each of its TODO
-children is blocked until all earlier siblings are marked DONE@. Here
-is an example:
+children is blocked until all earlier siblings are marked as done.
+Here is an example:
@example
* TODO Blocked until (two) is done
@@ -4553,22 +4556,22 @@ property (see @ref{Properties and Columns}):
@kindex C-c C-x o
@findex org-toggle-ordered-property
@vindex org-track-ordered-property-with-tag
-Toggle the @samp{ORDERED} property of the current entry. A property
-is used for this behavior because this should be local to the
-current entry, not inherited from entries above like a tag (see
-@ref{Tags}). However, if you would like to @emph{track} the value of this
-property with a tag for better visibility, customize the variable
+Toggle the @samp{ORDERED} property of the current entry. A property is
+used for this behavior because this should be local to the current
+entry, not inherited from entries above like a tag (see @ref{Tags}).
+However, if you would like to @emph{track} the value of this property
+with a tag for better visibility, customize the variable
@code{org-track-ordered-property-with-tag}.
@item @kbd{C-u C-u C-u C-c C-t}
-@kindex C-u C-u C-u C-c C-t
+@kindex C-u C-u C-u C-u C-c C-t
Change TODO state, regardless of any state blocking.
@end table
@vindex org-agenda-dim-blocked-tasks
If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
-that cannot be marked DONE because of unmarked children are shown in a
-dimmed font or even made invisible in agenda views (see @ref{Agenda Views}).
+that cannot be marked as done because of unmarked children are shown
+in a dimmed font or even made invisible in agenda views (see @ref{Agenda Views}).
@cindex checkboxes and TODO dependencies
@vindex org-enforce-todo-dependencies
@@ -4587,15 +4590,26 @@ the contributed module @samp{org-depend.el}.
@cindex progress logging
@cindex logging, of progress
-Org mode can automatically record a timestamp and optionally a note
-when you mark a TODO item as DONE, or even each time you change the
-state of a TODO item. This system is highly configurable, settings
-can be on a per-keyword basis and can be localized to a file or even a
-subtree. For information on how to clock working time for a task, see
-@ref{Clocking Work Time}.
+To record a timestamp and a note when changing a TODO state, call the
+command @code{org-todo} with a prefix argument.
+
+@table @asis
+@item @kbd{C-u C-c C-t} (@code{org-todo})
+@kindex C-u C-c C-t
+Prompt for a note and record a the time of the TODO state change.
+The note is inserted as a list item below the headline, but can also
+be placed into a drawer, see @ref{Tracking TODO state changes}.
+@end table
+
+If you want to be more systematic, Org mode can automatically record a
+timestamp and optionally a note when you mark a TODO item as DONE, or
+even each time you change the state of a TODO item. This system is
+highly configurable, settings can be on a per-keyword basis and can be
+localized to a file or even a subtree. For information on how to
+clock working time for a task, see @ref{Clocking Work Time}.
@menu
-* Closing items:: When was this entry marked DONE?
+* Closing items:: When was this entry marked as done?
* Tracking TODO state changes:: When did the status change?
* Tracking your habits:: How consistent have you been?
@end menu
@@ -4603,8 +4617,8 @@ subtree. For information on how to clock working time for a task, see
@node Closing items
@subsection Closing items
-The most basic logging is to keep track of @emph{when} a certain TODO item
-was marked DONE@. This can be achieved with@footnote{The corresponding in-buffer setting is: @samp{#+STARTUP: logdone}.}
+The most basic automatic logging is to keep track of @emph{when} a certain
+TODO item was marked as done. This can be achieved with@footnote{The corresponding in-buffer setting is: @samp{#+STARTUP: logdone}.}
@lisp
(setq org-log-done 'time)
@@ -4626,7 +4640,7 @@ lognotedone}.}
@end lisp
@noindent
-You are then be prompted for a note, and that note is stored below the
+You are then prompted for a note, and that note is stored below the
entry with a @samp{Closing Note} heading.
@node Tracking TODO state changes
@@ -4637,17 +4651,17 @@ entry with a @samp{Closing Note} heading.
@vindex org-log-states-order-reversed
@vindex org-log-into-drawer
@cindex @samp{LOG_INTO_DRAWER}, property
-When TODO keywords are used as workflow states (see @ref{Workflow states, , *Workflow states}),
-you might want to keep track of when a state change occurred and maybe
-take a note about this change. You can either record just a
-timestamp, or a time-stamped note. These records are inserted after
-the headline as an itemized list, newest first@footnote{See the variable @code{org-log-states-order-reversed}.}. When taking a
-lot of notes, you might want to get the notes out of the way into a
-drawer (see @ref{Drawers}). Customize the variable @code{org-log-into-drawer}
-to get this behavior---the recommended drawer for this is called
-@samp{LOGBOOK}@footnote{Note that the @samp{LOGBOOK} drawer is unfolded when pressing
-@kbd{@key{SPC}} in the agenda to show an entry---use @kbd{C-u @key{SPC}} to keep it folded here.}. You can also overrule the setting of this variable
-for a subtree by setting a @samp{LOG_INTO_DRAWER} property.
+You might want to automatically keep track of when a state change
+occurred and maybe take a note about this change. You can either
+record just a timestamp, or a time-stamped note. These records are
+inserted after the headline as an itemized list, newest first@footnote{See the variable @code{org-log-states-order-reversed}.}.
+When taking a lot of notes, you might want to get the notes out of the
+way into a drawer (see @ref{Drawers}). Customize the variable
+@code{org-log-into-drawer} to get this behavior---the recommended drawer
+for this is called @samp{LOGBOOK}@footnote{Note that the @samp{LOGBOOK} drawer is unfolded when pressing
+@kbd{@key{SPC}} in the agenda to show an entry---use @kbd{C-u @key{SPC}} to keep it folded here.}. You can also overrule the
+setting of this variable for a subtree by setting a @samp{LOG_INTO_DRAWER}
+property.
Since it is normally too much to record a note for every state, Org
mode expects configuration on a per-keyword basis for this. This is
@@ -4661,7 +4675,7 @@ example, with the setting
@end lisp
@noindent
-to record a timestamp without a note for TODO keywords configured with
+To record a timestamp without a note for TODO keywords configured with
@samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted.
@vindex org-log-done
@@ -4820,8 +4834,9 @@ The number of days after today that appear in consistency graphs.
@item @code{org-habit-show-habits-only-for-today}
@vindex org-habit-show-habits-only-for-today
-If non-@code{nil}, only show habits in today's agenda view. The
-default value is @code{t}.
+If non-@code{nil}, only show habits in today's agenda view. The default
+value is @code{t}. Pressing @kbd{C-u K} in the agenda toggles this
+variable.
@end table
Lastly, pressing @kbd{K} in the agenda buffer causes habits to
@@ -4862,12 +4877,11 @@ TODO items.
@item @kbd{C-c ,} (@code{org-priority})
@kindex C-c ,
@findex org-priority
-Set the priority of the current headline. The command prompts
-for a priority character @samp{A}, @samp{B} or @samp{C}. When you press
-@kbd{@key{SPC}} instead, the priority cookie, if one is set, is
-removed from the headline. The priorities can also be changed
-``remotely'' from the agenda buffer with the @kbd{,} command
-(see @ref{Agenda Commands}).
+Set the priority of the current headline. The command prompts for
+a priority character @samp{A}, @samp{B} or @samp{C}. When you press @kbd{@key{SPC}}
+instead, the priority cookie, if one is set, is removed from the
+headline. The priorities can also be changed ``remotely'' from the
+agenda buffer with the @kbd{,} command (see @ref{Agenda Commands}).
@item @kbd{S-@key{UP}} (@code{org-priority-up})
@itemx @kbd{S-@key{DOWN}} (@code{org-priority-down})
@@ -4876,10 +4890,9 @@ removed from the headline. The priorities can also be changed
@findex org-priority-up
@findex org-priority-down
@vindex org-priority-start-cycle-with-default
-Increase/decrease the priority of the current headline@footnote{See also the option @code{org-priority-start-cycle-with-default}.}.
-Note that these keys are also used to modify timestamps (see
-@ref{Creating Timestamps}). See also @ref{Conflicts}, for a discussion of the interaction with
-@code{shift-selection-mode}.
+Increase/decrease the priority of the current headline@footnote{See also the option @code{org-priority-start-cycle-with-default}.}. Note
+that these keys are also used to modify timestamps (see @ref{Creating Timestamps}). See also @ref{Conflicts}, for
+a discussion of the interaction with shift-selection.
@end table
@vindex org-highest-priority
@@ -4908,7 +4921,7 @@ manageable subtasks. You can do this by creating an outline tree
below a TODO item, with detailed subtasks on the tree@footnote{To keep subtasks out of the global TODO list, see the option
@code{org-agenda-todo-list-sublevels}.}. To keep
an overview of the fraction of subtasks that have already been marked
-DONE, insert either @samp{[/]} or @samp{[%]} anywhere in the headline. These
+as done, insert either @samp{[/]} or @samp{[%]} anywhere in the headline. These
cookies are updated each time the TODO status of a child changes, or
when pressing @kbd{C-c C-c} on the cookie. For example:
@@ -4967,8 +4980,7 @@ a checkbox by starting it with the string @samp{[ ]}. This feature is
similar to TODO items (see @ref{TODO Items}), but is more lightweight.
Checkboxes are not included into the global TODO list, so they are
often great to split a task into a number of simple steps. Or you can
-use them in a shopping list. To toggle a checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
-@samp{org-mouse.el}).
+use them in a shopping list.
Here is an example of a checkbox list.
@@ -5023,60 +5035,57 @@ The following commands work with checkboxes:
@item @kbd{C-c C-c} (@code{org-toggle-checkbox})
@kindex C-c C-c
@findex org-toggle-checkbox
-Toggle checkbox status or---with prefix argument---checkbox
-presence at point. With a single prefix argument, add an empty
-checkbox or remove the current one@footnote{@kbd{C-u C-c C-c} on the @emph{first} item of a list with no
-checkbox adds checkboxes to the rest of the list.}. With a double prefix
-argument, set it to @samp{[-]}, which is considered to be an
-intermediate state.
+Toggle checkbox status or---with prefix argument---checkbox presence
+at point. With a single prefix argument, add an empty checkbox or
+remove the current one@footnote{@kbd{C-u C-c C-c} on the @emph{first} item of a list with no
+checkbox adds checkboxes to the rest of the list.}. With a double prefix argument, set
+it to @samp{[-]}, which is considered to be an intermediate state.
@item @kbd{C-c C-x C-b} (@code{org-toggle-checkbox})
@kindex C-c C-x C-b
-Toggle checkbox status or---with prefix argument---checkbox
-presence at point. With double prefix argument, set it to @samp{[-]},
-which is considered to be an intermediate state.
+Toggle checkbox status or---with prefix argument---checkbox presence
+at point. With double prefix argument, set it to @samp{[-]}, which is
+considered to be an intermediate state.
@itemize
@item
If there is an active region, toggle the first checkbox in the
region and set all remaining boxes to the same status as the
-first. With a prefix argument, add or remove the checkbox for
-all items in the region.
+first. With a prefix argument, add or remove the checkbox for all
+items in the region.
@item
-If point is in a headline, toggle checkboxes in the region
-between this headline and the next---so @emph{not} the entire
-subtree.
+If point is in a headline, toggle checkboxes in the region between
+this headline and the next---so @emph{not} the entire subtree.
@item
-If there is no active region, just toggle the checkbox at
-point.
+If there is no active region, just toggle the checkbox at point.
@end itemize
@item @kbd{M-S-@key{RET}} (@code{org-insert-todo-heading})
@kindex M-S-RET
@findex org-insert-todo-heading
-Insert a new item with a checkbox. This works only if point
-is already in a plain list item (see @ref{Plain Lists}).
+Insert a new item with a checkbox. This works only if point is
+already in a plain list item (see @ref{Plain Lists}).
@item @kbd{C-c C-x o} (@code{org-toggle-ordered-property})
@kindex C-c C-x o
@findex org-toggle-ordered-property
@vindex org-track-ordered-property-with-tag
-Toggle the @samp{ORDERED} property of the entry, to toggle if
-checkboxes must be checked off in sequence. A property is used
-for this behavior because this should be local to the current
-entry, not inherited like a tag. However, if you would like to
-@emph{track} the value of this property with a tag for better
-visibility, customize @code{org-track-ordered-property-with-tag}.
+Toggle the @samp{ORDERED} property of the entry, to toggle if checkboxes
+must be checked off in sequence. A property is used for this
+behavior because this should be local to the current entry, not
+inherited like a tag. However, if you would like to @emph{track} the
+value of this property with a tag for better visibility, customize
+@code{org-track-ordered-property-with-tag}.
@item @kbd{C-c #} (@code{org-update-statistics-cookies})
@kindex C-c #
@findex org-update-statistics-cookies
Update the statistics cookie in the current outline entry. When
called with a @kbd{C-u} prefix, update the entire file.
-Checkbox statistic cookies are updated automatically if you
-toggle checkboxes with @kbd{C-c C-c} and make new ones with
+Checkbox statistic cookies are updated automatically if you toggle
+checkboxes with @kbd{C-c C-c} and make new ones with
@kbd{M-S-@key{RET}}. TODO statistics cookies update when changing
TODO states. If you delete boxes/entries or add/change them by
hand, use this command to get things back into sync.
@@ -5184,13 +5193,12 @@ also a special command for inserting tags:
@cindex completion, of tags
@vindex org-tags-column
Enter new tags for the current headline. Org mode either offers
-completion or a special single-key interface for setting tags,
-see below. After pressing @kbd{@key{RET}}, the tags are inserted
-and aligned to @code{org-tags-column}. When called with
-a @kbd{C-u} prefix, all tags in the current buffer are
-aligned to that column, just to make things look nice. Tags are
-automatically realigned after promotion, demotion, and TODO state
-changes (see @ref{TODO Basics}).
+completion or a special single-key interface for setting tags, see
+below. After pressing @kbd{@key{RET}}, the tags are inserted and
+aligned to @code{org-tags-column}. When called with a @kbd{C-u}
+prefix, all tags in the current buffer are aligned to that column,
+just to make things look nice. Tags are automatically realigned
+after promotion, demotion, and TODO state changes (see @ref{TODO Basics}).
@item @kbd{C-c C-c} (@code{org-set-tags-command})
@kindex C-c C-c
@@ -5346,8 +5354,8 @@ exception) assign several tags from such a group.
@item @kbd{C-c}
@kindex C-c C-c
Toggle auto-exit after the next change (see below). If you are
-using expert mode, the first @kbd{C-c} displays the
-selection window.
+using expert mode, the first @kbd{C-c} displays the selection
+window.
@end table
This method lets you assign tags to a headline with very few keys.
@@ -5510,8 +5518,8 @@ related information into special lists.
@kindex C-c \
@findex org-match-sparse-tree
Create a sparse tree with all headlines matching a tags search.
-With a @kbd{C-u} prefix argument, ignore headlines that are
-not a TODO line.
+With a @kbd{C-u} prefix argument, ignore headlines that are not
+a TODO line.
@item @kbd{M-x org-agenda m} (@code{org-tags-view})
@kindex m @r{(Agenda dispatcher)}
@@ -5522,8 +5530,8 @@ Create a global list of tag matches from all agenda files. See
@item @kbd{M-x org-agenda M} (@code{org-tags-view})
@kindex M @r{(Agenda dispatcher)}
@vindex org-tags-match-list-sublevels
-Create a global list of tag matches from all agenda files, but
-check only TODO items and force checking subitems (see the option
+Create a global list of tag matches from all agenda files, but check
+only TODO items and force checking subitems (see the option
@code{org-tags-match-list-sublevels}).
@end table
@@ -5665,15 +5673,14 @@ The following commands help to work with properties:
@item @kbd{M-@key{TAB}} (@code{pcomplete})
@kindex M-TAB
@findex pcomplete
-After an initial colon in a line, complete property keys. All
-keys used in the current file are offered as possible
-completions.
+After an initial colon in a line, complete property keys. All keys
+used in the current file are offered as possible completions.
@item @kbd{C-c C-x p} (@code{org-set-property})
@kindex C-c C-x p
@findex org-set-property
-Set a property. This prompts for a property name and a value.
-If necessary, the property drawer is created as well.
+Set a property. This prompts for a property name and a value. If
+necessary, the property drawer is created as well.
@item @kbd{C-u M-x org-insert-drawer}
@findex org-insert-drawer
@@ -5689,8 +5696,8 @@ With point in a property drawer, this executes property commands.
@item @kbd{C-c C-c s} (@code{org-set-property})
@kindex C-c C-c s
@findex org-set-property
-Set a property in the current entry. Both the property and the value
-can be inserted using completion.
+Set a property in the current entry. Both the property and the
+value can be inserted using completion.
@item @kbd{S-@key{RIGHT}} (@code{org-property-next-allowed-values})
@itemx @kbd{S-@key{LEFT}} (@code{org-property-previous-allowed-value})
@@ -5711,8 +5718,8 @@ Globally remove a property, from all entries in the current file.
@item @kbd{C-c C-c c} (@code{org-compute-property-at-point})
@kindex C-c C-c c
@findex org-compute-property-at-point
-Compute the property at point, using the operator and scope from
-the nearest column format definition.
+Compute the property at point, using the operator and scope from the
+nearest column format definition.
@end table
@node Special Properties
@@ -5801,15 +5808,14 @@ a TODO line.
@item @kbd{M-x org-agenda m}, @code{org-tags-view}
@kindex m @r{(Agenda dispatcher)}
@findex org-tags-view
-Create a global list of tag/property matches from all agenda
-files.
+Create a global list of tag/property matches from all agenda files.
@item @kbd{M-x org-agenda M} (@code{org-tags-view})
@kindex M @r{(Agenda dispatcher)}
@vindex org-tags-match-list-sublevels
-Create a global list of tag matches from all agenda files, but
-check only TODO items and force checking of subitems (see the
-option @code{org-tags-match-list-sublevels}).
+Create a global list of tag matches from all agenda files, but check
+only TODO items and force checking of subitems (see the option
+@code{org-tags-match-list-sublevels}).
@end table
The syntax for the search string is described in @ref{Matching tags and properties}.
@@ -5820,12 +5826,12 @@ single property:
@table @asis
@item @kbd{C-c / p}
@kindex C-c / p
-Create a sparse tree based on the value of a property. This
-first prompts for the name of a property, and then for a value.
-A sparse tree is created with all entries that define this
-property with the given value. If you enclose the value in curly
-braces, it is interpreted as a regular expression and matched
-against the property values.
+Create a sparse tree based on the value of a property. This first
+prompts for the name of a property, and then for a value. A sparse
+tree is created with all entries that define this property with the
+given value. If you enclose the value in curly braces, it is
+interpreted as a regular expression and matched against the property
+values.
@end table
@node Property Inheritance
@@ -5872,8 +5878,8 @@ location for the entire subtree (see @ref{Moving subtrees}).
@item @code{LOGGING}
@cindex @samp{LOGGING}, property
-The @samp{LOGGING} property may define logging settings for an entry
-or a subtree (see @ref{Tracking TODO state changes}).
+The @samp{LOGGING} property may define logging settings for an entry or
+a subtree (see @ref{Tracking TODO state changes}).
@end table
@node Column View
@@ -5972,8 +5978,8 @@ The header text for the column. If omitted, the property name is
used.
@item @var{SUMMARY-TYPE}
-The summary type. If specified, the column values for parent
-nodes are computed from the children@footnote{If more than one summary type applies to the same property,
+The summary type. If specified, the column values for parent nodes
+are computed from the children@footnote{If more than one summary type applies to the same property,
the parent values are computed according to the first of them.}.
Supported summary types are:
@@ -5998,7 +6004,7 @@ Supported summary types are:
@item @samp{X%}
@tab Checkbox status, @samp{[n%]}.
@item @samp{:}
-@tab Sum times, HH:MM, plain numbers are hours.
+@tab Sum times, HH:MM, plain numbers are minutes.
@item @samp{:min}
@tab Smallest time value in column.
@item @samp{:max}
@@ -6081,16 +6087,16 @@ either for all clocks or just for today.
@kindex C-c C-x C-c
@vindex org-columns
@vindex org-columns-default-format
-Turn on column view. If point is before the first headline in
-the file, column view is turned on for the entire file, using the
-@samp{#+COLUMNS} definition. If point is somewhere inside the
-outline, this command searches the hierarchy, up from point, for
-a @samp{COLUMNS} property that defines a format. When one is found,
-the column view table is established for the tree starting at the
-entry that contains the @samp{COLUMNS} property. If no such property
-is found, the format is taken from the @samp{#+COLUMNS} line or from
-the variable @code{org-columns-default-format}, and column view is
-established for the current entry and its subtree.
+Turn on column view. If point is before the first headline in the
+file, column view is turned on for the entire file, using the
+@samp{#+COLUMNS} definition. If point is somewhere inside the outline,
+this command searches the hierarchy, up from point, for a @samp{COLUMNS}
+property that defines a format. When one is found, the column view
+table is established for the tree starting at the entry that
+contains the @samp{COLUMNS} property. If no such property is found, the
+format is taken from the @samp{#+COLUMNS} line or from the variable
+@code{org-columns-default-format}, and column view is established for the
+current entry and its subtree.
@item @kbd{r} or @kbd{g} (@code{org-columns-redo})
@kindex r
@@ -6125,8 +6131,8 @@ Directly select the Nth allowed value, @kbd{0} selects the
@kindex S-LEFT
@findex org-columns-next-allowed-value
@findex org-columns-previous-allowed-value
-Switch to the next/previous allowed value of the field. For
-this, you have to have specified allowed values for a property.
+Switch to the next/previous allowed value of the field. For this,
+you have to have specified allowed values for a property.
@item @kbd{e} (@code{org-columns-edit-value})
@kindex e
@@ -6144,16 +6150,16 @@ When there is a checkbox at point, toggle it.
@item @kbd{v} (@code{org-columns-show-value})
@kindex v
@findex org-columns-show-value
-View the full value of this property. This is useful if the
-width of the column is smaller than that of the value.
+View the full value of this property. This is useful if the width
+of the column is smaller than that of the value.
@item @kbd{a} (@code{org-columns-edit-allowed})
@kindex a
@findex org-columns-edit-allowed
-Edit the list of allowed values for this property. If the list
-is found in the hierarchy, the modified values is stored there.
-If no list is found, the new value is stored in the first entry
-that is part of the current column view.
+Edit the list of allowed values for this property. If the list is
+found in the hierarchy, the modified values is stored there. If no
+list is found, the new value is stored in the first entry that is
+part of the current column view.
@end table
@anchor{Modifying column view on-the-fly}
@@ -6199,10 +6205,10 @@ This dynamic block has the following parameters:
@table @asis
@item @samp{:id}
-This is the most important parameter. Column view is a feature
-that is often localized to a certain (sub)tree, and the capture
-block might be at a different location in the file. To identify
-the tree whose view to capture, you can use four values:
+This is the most important parameter. Column view is a feature that
+is often localized to a certain (sub)tree, and the capture block
+might be at a different location in the file. To identify the tree
+whose view to capture, you can use four values:
@table @asis
@item @samp{local}
@@ -6216,14 +6222,15 @@ Run column view at the top of the @var{FILENAME} file.
@item @samp{LABEL}
@cindex @samp{ID}, property
-Call column view in the tree that has an @samp{ID} property with
-the value @var{LABEL}. You can use @kbd{M-x org-id-copy} to create a globally unique ID for the
-current entry and copy it to the kill-ring.
+Call column view in the tree that has an @samp{ID} property with the
+value @var{LABEL}. You can use @kbd{M-x org-id-copy} to
+create a globally unique ID for the current entry and copy it to
+the kill-ring.
@end table
@item @samp{:hlines}
-When @code{t}, insert an hline after every line. When a number N,
-insert an hline before each headline with level @code{<= N}.
+When @code{t}, insert an hline after every line. When a number N, insert
+an hline before each headline with level @code{<= N}.
@item @samp{:vlines}
When non-@code{nil}, force column groups to get vertical lines.
@@ -6235,12 +6242,16 @@ When set to a number, do not capture entries below this level.
When non-@code{nil}, skip rows where the only non-empty specifier of
the column view is @samp{ITEM}.
+@item @samp{:exclude-tags}
+List of tags to exclude from column view table: entries with these
+tags will be excluded from the column view.
+
@item @samp{:indent}
When non-@code{nil}, indent each @samp{ITEM} field according to its level.
@item @samp{:format}
-Specify a column attribute (see @ref{Column attributes}) for the
-dynamic block.
+Specify a column attribute (see @ref{Column attributes}) for the dynamic
+block.
@end table
The following commands insert or update the dynamic block:
@@ -6256,14 +6267,14 @@ scope or ID of the view.
@kindex C-c C-c
@kindex C-c C-x C-u
@findex org-dblock-update
-Update dynamic block at point. point needs to be in the
-@samp{#+BEGIN} line of the dynamic block.
+Update dynamic block at point. point needs to be in the @samp{#+BEGIN}
+line of the dynamic block.
@item @kbd{C-u C-c C-x C-u} (@code{org-update-all-dblocks})
@kindex C-u C-c C-x C-u
-Update all dynamic blocks (see @ref{Dynamic Blocks}). This is useful
-if you have several clock table blocks, column-capturing blocks
-or other dynamic blocks in a buffer.
+Update all dynamic blocks (see @ref{Dynamic Blocks}). This is useful if
+you have several clock table blocks, column-capturing blocks or
+other dynamic blocks in a buffer.
@end table
You can add formulas to the column view table and you may add plotting
@@ -6305,7 +6316,7 @@ is used in a much wider sense.
@end menu
@node Timestamps
-@section Timestamps, Deadlines and Scheduling
+@section Timestamps
@cindex timestamps
@cindex ranges, time
@@ -6351,13 +6362,13 @@ a certain interval of N days (d), weeks (w), months (m), or years
<2007-05-16 Wed 12:30 +1w>
@end example
-@item Diary-style sexp entries
+@item Diary-style expression entries
@cindex diary style timestamps
@cindex sexp timestamps
For more complex date specifications, Org mode supports using the
-special sexp diary entries implemented in the Emacs
-calendar/diary package@footnote{When working with the standard diary sexp functions, you need
-to be very careful with the order of the arguments. That order
+special expression diary entries implemented in the Emacs Calendar
+package@footnote{When working with the standard diary expression functions, you
+need to be very careful with the order of the arguments. That order
depends evilly on the variable @code{calendar-date-style}. For example, to
specify a date December 12, 2005, the call might look like
@samp{(diary-date 12 1 2005)} or @samp{(diary-date 1 12 2005)} or @samp{(diary-date
@@ -6377,8 +6388,8 @@ the value of @code{calendar-date-style}.}. For example, with optional time:
@cindex timerange
@cindex date range
Two timestamps connected by @samp{--} denote a range. The headline is
-shown on the first and last day of the range, and on any dates
-that are displayed and fall in the range. Here is an example:
+shown on the first and last day of the range, and on any dates that
+are displayed and fall in the range. Here is an example:
@example
** Meeting in Amsterdam
@@ -6389,8 +6400,8 @@ that are displayed and fall in the range. Here is an example:
@cindex timestamp, inactive
@cindex inactive timestamp
Just like a plain timestamp, but with square brackets instead of
-angular ones. These timestamps are inactive in the sense that
-they do @emph{not} trigger an entry to show up in the agenda.
+angular ones. These timestamps are inactive in the sense that they
+do @emph{not} trigger an entry to show up in the agenda.
@example
* Gillian comes late for the fifth time
@@ -6409,16 +6420,15 @@ format.
@item @kbd{C-c .} (@code{org-time-stamp})
@kindex C-c .
@findex org-time-stamp
-Prompt for a date and insert a corresponding timestamp. When
-point is at an existing timestamp in the buffer, the command is
-used to modify this timestamp instead of inserting a new one.
-When this command is used twice in succession, a time range is
-inserted.
+Prompt for a date and insert a corresponding timestamp. When point
+is at an existing timestamp in the buffer, the command is used to
+modify this timestamp instead of inserting a new one. When this
+command is used twice in succession, a time range is inserted.
@kindex C-u C-c .
@vindex org-time-stamp-rounding-minutes
-When called with a prefix argument, use the alternative format
-which contains date and time. The default time can be rounded to
+When called with a prefix argument, use the alternative format which
+contains date and time. The default time can be rounded to
multiples of 5 minutes. See the option
@code{org-time-stamp-rounding-minutes}.
@@ -6453,8 +6463,8 @@ instead.
@item @kbd{C-c C-o} (@code{org-open-at-point})
@kindex C-c C-o
@findex org-open-at-point
-Access the agenda for the date given by the timestamp or -range
-at point (see @ref{Weekly/daily agenda}).
+Access the agenda for the date given by the timestamp or -range at
+point (see @ref{Weekly/daily agenda}).
@item @kbd{S-@key{LEFT}} (@code{org-timestamp-down-day})
@itemx @kbd{S-@key{RIGHT}} (@code{org-timestamp-up-day})
@@ -6462,31 +6472,30 @@ at point (see @ref{Weekly/daily agenda}).
@kindex S-RIGHT
@findex org-timestamp-down-day
@findex org-timestamp-up-day
-Change date at point by one day. These key bindings conflict
-with shift-selection and related modes (see @ref{Conflicts}).
+Change date at point by one day. These key bindings conflict with
+shift-selection and related modes (see @ref{Conflicts}).
@item @kbd{S-@key{UP}} (@code{org-timestamp-up})
@itemx @kbd{S-@key{DOWN}} (@code{org-timestamp-down})
@kindex S-UP
@kindex S-DOWN
On the beginning or enclosing bracket of a timestamp, change its
-type. Within a timestamp, change the item under point. Point
-can be on a year, month, day, hour or minute. When the timestamp
-contains a time range like @samp{15:30-16:30}, modifying the first
-time also shifts the second, shifting the time block with
-constant length. To change the length, modify the second time.
-Note that if point is in a headline and not at a timestamp, these
-same keys modify the priority of an item (see @ref{Priorities}). The
-key bindings also conflict with shift-selection and related modes
-(see @ref{Conflicts}).
+type. Within a timestamp, change the item under point. Point can
+be on a year, month, day, hour or minute. When the timestamp
+contains a time range like @samp{15:30-16:30}, modifying the first time
+also shifts the second, shifting the time block with constant
+length. To change the length, modify the second time. Note that if
+point is in a headline and not at a timestamp, these same keys
+modify the priority of an item (see @ref{Priorities}). The key bindings
+also conflict with shift-selection and related modes (see @ref{Conflicts}).
@item @kbd{C-c C-y} (@code{org-evaluate-time-range})
@kindex C-c C-y
@findex org-evaluate-time-range
@cindex evaluate time range
-Evaluate a time range by computing the difference between start
-and end. With a prefix argument, insert result after the time
-range (in a table: into the following column).
+Evaluate a time range by computing the difference between start and
+end. With a prefix argument, insert result after the time range (in
+a table: into the following column).
@end table
@menu
@@ -6726,15 +6735,15 @@ immediately after the task they refer to.
@table @asis
@item @samp{DEADLINE}
@cindex @samp{DEADLINE} marker
-Meaning: the task (most likely a TODO item, though not
-necessarily) is supposed to be finished on that date.
+Meaning: the task---most likely a TODO item, though not
+necessarily---is supposed to be finished on that date.
@vindex org-deadline-warning-days
On the deadline date, the task is listed in the agenda. In
addition, the agenda for @emph{today} carries a warning about the
-approaching or missed deadline, starting
-@code{org-deadline-warning-days} before the due date, and continuing
-until the entry is marked DONE@. An example:
+approaching or missed deadline, starting @code{org-deadline-warning-days}
+before the due date, and continuing until the entry is marked as
+done. An example:
@example
*** TODO write article about the Earth for the Guide
@@ -6745,21 +6754,21 @@ until the entry is marked DONE@. An example:
@vindex org-agenda-skip-deadline-prewarning-if-scheduled
You can specify a different lead time for warnings for a specific
deadlines using the following syntax. Here is an example with
-a warning period of 5 days @samp{DEADLINE: <2004-02-29 Sun -5d>}.
-This warning is deactivated if the task gets scheduled and you
-set @code{org-agenda-skip-deadline-prewarning-if-scheduled} to @code{t}.
+a warning period of 5 days @samp{DEADLINE: <2004-02-29 Sun -5d>}. This
+warning is deactivated if the task gets scheduled and you set
+@code{org-agenda-skip-deadline-prewarning-if-scheduled} to @code{t}.
@item @samp{SCHEDULED}
@cindex @samp{SCHEDULED} marker
-Meaning: you are planning to start working on that task on the
-given date.
+Meaning: you are planning to start working on that task on the given
+date.
@vindex org-agenda-skip-scheduled-if-done
The headline is listed under the given date@footnote{It will still be listed on that date after it has been marked
-DONE@. If you do not like this, set the variable
+as done. If you do not like this, set the variable
@code{org-agenda-skip-scheduled-if-done}.}. In addition,
a reminder that the scheduled date has passed is present in the
-compilation for @emph{today}, until the entry is marked DONE, i.e.,
+compilation for @emph{today}, until the entry is marked as done, i.e.,
the task is automatically forwarded until completed.
@example
@@ -6769,24 +6778,23 @@ the task is automatically forwarded until completed.
@vindex org-scheduled-delay-days
@vindex org-agenda-skip-scheduled-delay-if-deadline
-If you want to @emph{delay} the display of this task in the agenda,
-use @samp{SCHEDULED: <2004-12-25 Sat -2d>}: the task is still
-scheduled on the 25th but will appear two days later. In case
-the task contains a repeater, the delay is considered to affect
-all occurrences; if you want the delay to only affect the first
-scheduled occurrence of the task, use @samp{--2d} instead. See
-@code{org-scheduled-delay-days} and
-@code{org-agenda-skip-scheduled-delay-if-deadline} for details on how
-to control this globally or per agenda.
+If you want to @emph{delay} the display of this task in the agenda, use
+@samp{SCHEDULED: <2004-12-25 Sat -2d>}: the task is still scheduled on
+the 25th but will appear two days later. In case the task contains
+a repeater, the delay is considered to affect all occurrences; if
+you want the delay to only affect the first scheduled occurrence of
+the task, use @samp{--2d} instead. See @code{org-scheduled-delay-days} and
+@code{org-agenda-skip-scheduled-delay-if-deadline} for details on how to
+control this globally or per agenda.
@quotation Important
Scheduling an item in Org mode should @emph{not} be understood in the
-same way that we understand @emph{scheduling a meeting}. Setting
-a date for a meeting is just a simple appointment, you should
-mark this entry with a simple plain timestamp, to get this item
-shown on the date where it applies. This is a frequent
-misunderstanding by Org users. In Org mode, @emph{scheduling} means
-setting a date when you want to start working on an action item.
+same way that we understand @emph{scheduling a meeting}. Setting a date
+for a meeting is just a simple appointment, you should mark this
+entry with a simple plain timestamp, to get this item shown on the
+date where it applies. This is a frequent misunderstanding by Org
+users. In Org mode, @emph{scheduling} means setting a date when you want
+to start working on an action item.
@end quotation
@end table
@@ -6794,7 +6802,7 @@ setting a date when you want to start working on an action item.
You may use timestamps with repeaters in scheduling and deadline
entries. Org mode issues early and late warnings based on the
assumption that the timestamp represents the @emph{nearest instance} of the
-repeater. However, the use of diary S-exp entries like
+repeater. However, the use of diary expression entries like
@example
<%%(diary-float t 42)>
@@ -6803,9 +6811,9 @@ repeater. However, the use of diary S-exp entries like
@noindent
in scheduling and deadline timestamps is limited. Org mode does not
-know enough about the internals of each S-exp function to issue early
-and late warnings. However, it shows the item on each day where the
-S-exp entry matches.
+know enough about the internals of each function to issue early and
+late warnings. However, it shows the item on each day where the
+expression entry matches.
@menu
* Inserting deadline/schedule:: Planning items.
@@ -6825,12 +6833,12 @@ the headline.}
@kindex C-c C-d
@findex org-deadline
@vindex org-log-redeadline
-Insert @samp{DEADLINE} keyword along with a stamp. The insertion
-happens in the line directly following the headline. Remove any
-@samp{CLOSED} timestamp . When called with a prefix argument, also
-remove any existing deadline from the entry. Depending on the
-variable @code{org-log-redeadline}, take a note when changing an
-existing deadline@footnote{Note the corresponding @samp{STARTUP} options @samp{logredeadline},
+Insert @samp{DEADLINE} keyword along with a stamp. The insertion happens
+in the line directly following the headline. Remove any @samp{CLOSED}
+timestamp . When called with a prefix argument, also remove any
+existing deadline from the entry. Depending on the variable
+@code{org-log-redeadline}, take a note when changing an existing
+deadline@footnote{Note the corresponding @samp{STARTUP} options @samp{logredeadline},
@samp{lognoteredeadline}, and @samp{nologredeadline}.}.
@item @kbd{C-c C-s} (@code{org-schedule})
@@ -6839,10 +6847,10 @@ existing deadline@footnote{Note the corresponding @samp{STARTUP} options @samp{l
@vindex org-log-reschedule
Insert @samp{SCHEDULED} keyword along with a stamp. The insertion
happens in the line directly following the headline. Remove any
-@samp{CLOSED} timestamp. When called with a prefix argument, also
-remove the scheduling date from the entry. Depending on the
-variable @code{org-log-reschedule}, take a note when changing an
-existing scheduling time@footnote{Note the corresponding @samp{STARTUP} options @samp{logreschedule},
+@samp{CLOSED} timestamp. When called with a prefix argument, also remove
+the scheduling date from the entry. Depending on the variable
+@code{org-log-reschedule}, take a note when changing an existing
+scheduling time@footnote{Note the corresponding @samp{STARTUP} options @samp{logreschedule},
@samp{lognotereschedule}, and @samp{nologreschedule}.}.
@item @kbd{C-c / d} (@code{org-check-deadlines})
@@ -6850,16 +6858,15 @@ existing scheduling time@footnote{Note the corresponding @samp{STARTUP} options
@findex org-check-deadlines
@cindex sparse tree, for deadlines
@vindex org-deadline-warning-days
-Create a sparse tree with all deadlines that are either past-due,
-or which will become due within @code{org-deadline-warning-days}.
-With @kbd{C-u} prefix, show all deadlines in the file. With
+Create a sparse tree with all deadlines that are either past-due, or
+which will become due within @code{org-deadline-warning-days}. With
+@kbd{C-u} prefix, show all deadlines in the file. With
a numeric prefix, check that many days. For example, @kbd{C-1 C-c / d} shows all deadlines due tomorrow.
@item @kbd{C-c / b} (@code{org-check-before-date})
@kindex C-c / b
@findex org-check-before-date
-Sparse tree for deadlines and scheduled items before a given
-date.
+Sparse tree for deadlines and scheduled items before a given date.
@item @kbd{C-c / a} (@code{org-check-after-date})
@kindex C-c / a
@@ -6905,18 +6912,18 @@ DEADLINE: <2005-10-01 Sat +1m -3d>
@vindex org-todo-repeat-to-state
Deadlines and scheduled items produce entries in the agenda when they
are over-due, so it is important to be able to mark such an entry as
-DONE once you have done so. When you mark a @samp{DEADLINE} or a
-@samp{SCHEDULED} with the TODO keyword @samp{DONE}, it no longer produces
+done once you have done so. When you mark a @samp{DEADLINE} or
+a @samp{SCHEDULED} with the TODO keyword @samp{DONE}, it no longer produces
entries in the agenda. The problem with this is, however, is that
then also the @emph{next} instance of the repeated entry will not be
active. Org mode deals with this in the following way: when you try
-to mark such an entry DONE, using @kbd{C-c C-t}, it shifts the
+to mark such an entry as done, using @kbd{C-c C-t}, it shifts the
base date of the repeating timestamp by the repeater interval, and
immediately sets the entry state back to TODO@footnote{In fact, the target state is taken from, in this sequence, the
@samp{REPEAT_TO_STATE} property, the variable @code{org-todo-repeat-to-state} if
it is a string, the previous TODO state if @code{org-todo-repeat-to-state}
is @code{t}, or the first state of the TODO state sequence.}. In the example
-above, setting the state to DONE would actually switch the date like
+above, setting the state to @samp{DONE} would actually switch the date like
this:
@example
@@ -7031,37 +7038,36 @@ prompted about what to do with it.
@vindex org-clock-continuously
@cindex @samp{LOG_INTO_DRAWER}, property
Start the clock on the current item (clock-in). This inserts the
-CLOCK keyword together with a timestamp. If this is not the
-first clocking of this item, the multiple CLOCK lines are wrapped
-into a @samp{LOGBOOK} drawer (see also the variable
-@code{org-clock-into-drawer}). You can also overrule the setting of
-this variable for a subtree by setting a @samp{CLOCK_INTO_DRAWER} or
-@samp{LOG_INTO_DRAWER} property. When called with a @kbd{C-u}
-prefix argument, select the task from a list of recently clocked
-tasks. With two @kbd{C-u C-u} prefixes, clock into the task
-at point and mark it as the default task; the default task is
-always be available with letter @kbd{d} when selecting
-a clocking task. With three @kbd{C-u C-u C-u} prefixes,
-force continuous clocking by starting the clock when the last
-clock stopped.
+@samp{CLOCK} keyword together with a timestamp. If this is not the first
+clocking of this item, the multiple @samp{CLOCK} lines are wrapped into
+a @samp{LOGBOOK} drawer (see also the variable @code{org-clock-into-drawer}).
+You can also overrule the setting of this variable for a subtree by
+setting a @samp{CLOCK_INTO_DRAWER} or @samp{LOG_INTO_DRAWER} property. When
+called with a @kbd{C-u} prefix argument, select the task from
+a list of recently clocked tasks. With two @kbd{C-u C-u}
+prefixes, clock into the task at point and mark it as the default
+task; the default task is always be available with letter
+@kbd{d} when selecting a clocking task. With three @kbd{C-u C-u C-u} prefixes, force continuous clocking by starting the
+clock when the last clock stopped.
@cindex @samp{CLOCK_MODELINE_TOTAL}, property
@cindex @samp{LAST_REPEAT}, property
@vindex org-clock-mode-line-total
@vindex org-clock-in-prepare-hook
-While the clock is running, Org shows the current clocking time
-in the mode line, along with the title of the task. The clock
-time shown is all time ever clocked for this task and its
-children. If the task has an effort estimate (see @ref{Effort Estimates}), the mode line displays the current clocking time
-against it@footnote{To add an effort estimate ``on the fly'', hook a function doing
-this to @code{org-clock-in-prepare-hook}.}. If the task is a repeating one (see @ref{Repeated tasks}), show only the time since the last reset of the
-task@footnote{The last reset of the task is recorded by the @samp{LAST_REPEAT}
-property.}. You can exercise more control over show time with
-the @samp{CLOCK_MODELINE_TOTAL} property. It may have the values
-@samp{current} to show only the current clocking instance, @samp{today} to
-show all time clocked on this tasks today---see also the
-variable @code{org-extend-today-until}, @code{all} to include all time, or
-@code{auto} which is the default@footnote{See also the variable @code{org-clock-mode-line-total}.}. Clicking with
+While the clock is running, Org shows the current clocking time in
+the mode line, along with the title of the task. The clock time
+shown is all time ever clocked for this task and its children. If
+the task has an effort estimate (see @ref{Effort Estimates}), the mode
+line displays the current clocking time against it@footnote{To add an effort estimate ``on the fly'', hook a function doing
+this to @code{org-clock-in-prepare-hook}.}. If the
+task is a repeating one (see @ref{Repeated tasks}), show only the time
+since the last reset of the task@footnote{The last reset of the task is recorded by the @samp{LAST_REPEAT}
+property.}. You can exercise more
+control over show time with the @samp{CLOCK_MODELINE_TOTAL} property. It
+may have the values @samp{current} to show only the current clocking
+instance, @samp{today} to show all time clocked on this tasks today---see
+also the variable @code{org-extend-today-until}, @code{all} to include all
+time, or @code{auto} which is the default@footnote{See also the variable @code{org-clock-mode-line-total}.}. Clicking with
@kbd{mouse-1} onto the mode line entry pops up a menu with
clocking options.
@@ -7069,12 +7075,12 @@ clocking options.
@kindex C-c C-x C-o
@findex org-clock-out
@vindex org-log-note-clock-out
-Stop the clock (clock-out). This inserts another timestamp at
-the same location where the clock was last started. It also
-directly computes the resulting time in inserts it after the time
-range as @samp{=>HH:MM}. See the variable @code{org-log-note-clock-out}
-for the possibility to record an additional note together with
-the clock-out timestamp@footnote{The corresponding in-buffer setting is: @samp{#+STARTUP:
+Stop the clock (clock-out). This inserts another timestamp at the
+same location where the clock was last started. It also directly
+computes the resulting time in inserts it after the time range as
+@samp{=>HH:MM}. See the variable @code{org-log-note-clock-out} for the
+possibility to record an additional note together with the clock-out
+timestamp@footnote{The corresponding in-buffer setting is: @samp{#+STARTUP:
lognoteclock-out}.}.
@item @kbd{C-c C-x C-x} (@code{org-clock-in-last})
@@ -7083,8 +7089,8 @@ lognoteclock-out}.}.
@vindex org-clock-continuously
Re-clock the last clocked task. With one @kbd{C-u} prefix
argument, select the task from the clock history. With two
-@kbd{C-u} prefixes, force continuous clocking by starting
-the clock when the last clock stopped.
+@kbd{C-u} prefixes, force continuous clocking by starting the
+clock when the last clock stopped.
@item @kbd{C-c C-x C-e} (@code{org-clock-modify-effort-estimate})
@kindex C-c C-x C-e
@@ -7096,8 +7102,8 @@ Update the effort estimate for the current clock task.
@kindex C-c C-y
@findex org-evaluate-time-range
Recompute the time interval after changing one of the timestamps.
-This is only necessary if you edit the timestamps directly. If
-you change them with @kbd{S-<cursor>} keys, the update is
+This is only necessary if you edit the timestamps directly. If you
+change them with @kbd{S-<cursor>} keys, the update is
automatic.
@item @kbd{C-S-@key{UP}} (@code{org-clock-timestamps-up})
@@ -7115,42 +7121,41 @@ clock duration keeps the same value.
@findex org-clock-timestamp-up
@kindex S-M-DOWN
@findex org-clock-timestamp-down
-On @samp{CLOCK} log lines, increase/decrease the timestamp at point
-and the one of the previous, or the next, clock timestamp by the
-same duration. For example, if you hit @kbd{S-M-@key{UP}} to
-increase a clocked-out timestamp by five minutes, then the
-clocked-in timestamp of the next clock is increased by five
-minutes.
+On @samp{CLOCK} log lines, increase/decrease the timestamp at point and
+the one of the previous, or the next, clock timestamp by the same
+duration. For example, if you hit @kbd{S-M-@key{UP}} to increase
+a clocked-out timestamp by five minutes, then the clocked-in
+timestamp of the next clock is increased by five minutes.
@item @kbd{C-c C-t} (@code{org-todo})
@kindex C-c C-t
@findex org-todo
-Changing the TODO state of an item to DONE automatically stops
-the clock if it is running in this same item.
+Changing the TODO state of an item to DONE automatically stops the
+clock if it is running in this same item.
@item @kbd{C-c C-x C-q} (@code{org-clock-cancel})
@kindex C-c C-x C-q
@findex org-clock-cancel
-Cancel the current clock. This is useful if a clock was started
-by mistake, or if you ended up working on something else.
+Cancel the current clock. This is useful if a clock was started by
+mistake, or if you ended up working on something else.
@item @kbd{C-c C-x C-j} (@code{org-clock-goto})
@kindex C-c C-x C-j
@findex or-clock-goto
Jump to the headline of the currently clocked in task. With
-a @kbd{C-u} prefix argument, select the target task from
-a list of recently clocked tasks.
+a @kbd{C-u} prefix argument, select the target task from a list
+of recently clocked tasks.
@item @kbd{C-c C-x C-d} (@code{org-clock-display})
@kindex C-c C-x C-d
@findex org-clock-display
@vindex org-remove-highlights-with-change
-Display time summaries for each subtree in the current buffer.
-This puts overlays at the end of each headline, showing the total
-time recorded under that heading, including the time of any
-subheadings. You can use visibility cycling to study the tree,
-but the overlays disappear when you change the buffer (see
-variable @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.
+Display time summaries for each subtree in the current buffer. This
+puts overlays at the end of each headline, showing the total time
+recorded under that heading, including the time of any subheadings.
+You can use visibility cycling to study the tree, but the overlays
+disappear when you change the buffer (see variable
+@code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.
@end table
The @kbd{l} key may be used in the agenda (see @ref{Weekly/daily agenda}) to show which tasks have been worked on or closed during
@@ -7169,16 +7174,12 @@ Org mode can produce quite complex reports based on the time clocking
information. Such a report is called a @emph{clock table}, because it is
formatted as one or several Org tables.
-@table @asis
-@item @kbd{C-c C-x C-r} (@code{org-clock-report})
-@kindex C-c C-x C-r
-@findex org-clock-report
-Insert a dynamic block (see @ref{Dynamic Blocks}) containing a clock
-report as an Org mode table into the current file. When point is
-at an existing clock table, just update it. When called with a
-prefix argument, jump to the first clock report in the current
-document and update it. The clock table includes archived trees.
+You can insert, or update, a clock table through Org dynamic blocks
+insert command (see @ref{Dynamic Blocks}), by pressing @kbd{C-c C-x x c l o c k t a b l e @key{RET}}. When called with a prefix argument,
+jump to the first clock table in the current document and update it.
+The clock table includes archived trees.
+@table @asis
@item @kbd{C-c C-c} or @kbd{C-c C-x C-u} (@code{org-dblock-update})
@kindex C-c C-c
@kindex C-c C-x C-u
@@ -7188,8 +7189,8 @@ line of the dynamic block.
@item @kbd{C-u C-c C-x C-u}
@kindex C-u C-c C-x C-u
-Update all dynamic blocks (see @ref{Dynamic Blocks}). This is useful
-if you have several clock table blocks in a buffer.
+Update all dynamic blocks (see @ref{Dynamic Blocks}). This is useful if
+you have several clock table blocks in a buffer.
@item @kbd{S-@key{LEFT}}
@itemx @kbd{S-@key{RIGHT}} (@code{org-clocktable-try-shift})
@@ -7197,8 +7198,8 @@ if you have several clock table blocks in a buffer.
@kindex S-RIGHT
@findex org-clocktable-try-shift
Shift the current @samp{:block} interval and update the table. Point
-needs to be in the @samp{#+BEGIN: clocktable} line for this command.
-If @samp{:block} is @samp{today}, it is shifted to @samp{today-1}, etc.
+needs to be in the @samp{#+BEGIN: clocktable} line for this command. If
+@samp{:block} is @samp{today}, it is shifted to @samp{today-1}, etc.
@end table
Here is an example of the frame for a clock table as it is inserted
@@ -7221,8 +7222,8 @@ be selected:
@table @asis
@item @samp{:maxlevel}
-Maximum level depth to which times are listed in the table.
-Clocks at deeper levels are summed into the upper level.
+Maximum level depth to which times are listed in the table. Clocks
+at deeper levels are summed into the upper level.
@item @samp{:scope}
The scope to consider. This can be any of the following:
@@ -7252,8 +7253,8 @@ The scope to consider. This can be any of the following:
@item @samp{:block}
The time block to consider. This block is specified either
-absolutely, or relative to the current time and may be any of
-these formats:
+absolutely, or relative to the current time and may be any of these
+formats:
@multitable {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaa}
@item @samp{2007-12-31}
@@ -7288,12 +7289,12 @@ Use @kbd{S-@key{LEFT}} or @kbd{S-@key{RIGHT}} to shift the time
interval.
@item @samp{:tstart}
-A time string specifying when to start considering times.
-Relative times like @samp{"<-2w>"} can also be used. See @ref{Matching tags and properties} for relative time syntax.
+A time string specifying when to start considering times. Relative
+times like @samp{"<-2w>"} can also be used. See @ref{Matching tags and properties} for relative time syntax.
@item @samp{:tend}
-A time string specifying when to stop considering times.
-Relative times like @samp{"<now>"} can also be used. See @ref{Matching tags and properties} for relative time syntax.
+A time string specifying when to stop considering times. Relative
+times like @samp{"<now>"} can also be used. See @ref{Matching tags and properties} for relative time syntax.
@item @samp{:wstart}
The starting day of the week. The default is 1 for Monday.
@@ -7302,15 +7303,16 @@ The starting day of the week. The default is 1 for Monday.
The starting day of the month. The default is 1 for the first.
@item @samp{:step}
-Set to @code{week} or @code{day} to split the table into chunks. To use
-this, @code{:block} or @code{:tstart}, @code{:tend} are needed.
+Set to @samp{day}, @samp{week}, @samp{month} or @samp{year} to split the table into
+chunks. To use this, either @samp{:block}, or @samp{:tstart} and @samp{:tend} are
+required.
@item @samp{:stepskip0}
When non-@code{nil}, do not show steps that have zero time.
@item @samp{:fileskip0}
-When non-@code{nil}, do not show table sections from files which did
-not contribute.
+When non-@code{nil}, do not show table sections from files which did not
+contribute.
@item @samp{:match}
A tags match to select entries that should contribute. See
@@ -7342,6 +7344,10 @@ shortened in export.
@item @samp{:indent}
Indent each headline field according to its level.
+@item @samp{:hidefiles}
+Hide the file column when multiple files are used to produce the
+table.
+
@item @samp{:tcolumns}
Number of columns to be used for times. If this is smaller than
@samp{:maxlevel}, lower levels are lumped into one column.
@@ -7350,8 +7356,8 @@ Number of columns to be used for times. If this is smaller than
Should a level number column be included?
@item @samp{:sort}
-A cons cell containing the column to sort and a sorting type.
-E.g., @samp{:sort (1 . ?a)} sorts the first column alphabetically.
+A cons cell containing the column to sort and a sorting type. E.g.,
+@samp{:sort (1 . ?a)} sorts the first column alphabetically.
@item @samp{:compact}
Abbreviation for @samp{:level nil :indent t :narrow 40! :tcolumns 1}.
@@ -7359,15 +7365,15 @@ All are overwritten except if there is an explicit @samp{:narrow}.
@item @samp{:timestamp}
A timestamp for the entry, when available. Look for @samp{SCHEDULED},
-@samp{DEADLINE}, @samp{TIMESTAMP} and @samp{TIMESTAMP_IA} special properties
-(see @ref{Special Properties}), in this order.
+@samp{DEADLINE}, @samp{TIMESTAMP} and @samp{TIMESTAMP_IA} special properties (see
+@ref{Special Properties}), in this order.
@item @samp{:tags}
When this flag is non-@code{nil}, show the headline's tags.
@item @samp{:properties}
-List of properties shown in the table. Each property gets its
-own column.
+List of properties shown in the table. Each property gets its own
+column.
@item @samp{:inherit-props}
When this flag is non-@code{nil}, the values for @samp{:properties} are
@@ -7375,9 +7381,9 @@ inherited.
@item @samp{:formula}
Content of a @samp{TBLFM} keyword to be added and evaluated. As
-a special case, @samp{:formula %} adds a column with % time. If you
-do not specify a formula here, any existing formula below the
-clock table survives updates and is evaluated.
+a special case, @samp{:formula %} adds a column with % time. If you do
+not specify a formula here, any existing formula below the clock
+table survives updates and is evaluated.
@item @samp{:formatter}
A function to format clock data and insert it into the buffer.
@@ -7476,22 +7482,22 @@ clocking out of the current task.
@item @kbd{s}
@kindex s
To keep none of the minutes, use @kbd{s} to subtract all the
-away time from the clock, and then check back in from the moment
-you returned.
+away time from the clock, and then check back in from the moment you
+returned.
@item @kbd{S}
@kindex S
-To keep none of the minutes and just clock out at the start of
-the away time, use the shift key and press @kbd{S}.
-Remember that using shift always leave you clocked out, no matter
-which option you choose.
+To keep none of the minutes and just clock out at the start of the
+away time, use the shift key and press @kbd{S}. Remember that
+using shift always leave you clocked out, no matter which option you
+choose.
@item @kbd{C}
@kindex C
To cancel the clock altogether, use @kbd{C}. Note that if
-instead of canceling you subtract the away time, and the
-resulting clock amount is less than a minute, the clock is still
-canceled rather than cluttering up the log with an empty entry.
+instead of canceling you subtract the away time, and the resulting
+clock amount is less than a minute, the clock is still canceled
+rather than cluttering up the log with an empty entry.
@end table
What if you subtracted those away minutes from the current clock, and
@@ -7622,23 +7628,22 @@ The relative and countdown are started with separate commands.
@kindex C-c C-x 0
@findex org-timer-start
Start or reset the relative timer. By default, the timer is set
-to 0. When called with a @kbd{C-u} prefix, prompt the user
-for a starting offset. If there is a timer string at point, this
-is taken as the default, providing a convenient way to restart
-taking notes after a break in the process. When called with
-a double prefix argument @kbd{C-u C-u}, change all timer
-strings in the active region by a certain amount. This can be
-used to fix timer strings if the timer was not started at exactly
-the right moment.
+to 0. When called with a @kbd{C-u} prefix, prompt the user for
+a starting offset. If there is a timer string at point, this is
+taken as the default, providing a convenient way to restart taking
+notes after a break in the process. When called with a double
+prefix argument @kbd{C-u C-u}, change all timer strings in the
+active region by a certain amount. This can be used to fix timer
+strings if the timer was not started at exactly the right moment.
@item @kbd{C-c C-x ;} (@code{org-timer-set-timer})
@kindex C-c C-x ;
@findex org-timer-set-timer
@vindex org-timer-default-timer
Start a countdown timer. The user is prompted for a duration.
-@code{org-timer-default-timer} sets the default countdown value.
-Giving a numeric prefix argument overrides this default value.
-This command is available as @kbd{;} in agenda buffers.
+@code{org-timer-default-timer} sets the default countdown value. Giving
+a numeric prefix argument overrides this default value. This
+command is available as @kbd{;} in agenda buffers.
@end table
Once started, relative and countdown timers are controlled with the
@@ -7654,14 +7659,14 @@ this, the timer starts. Using a prefix argument restarts it.
@item @kbd{C-c C-x -} (@code{org-timer-item})
@kindex C-c C-x -
@findex org-timer-item
-Insert a description list item with the current relative time.
-With a prefix argument, first reset the timer to 0.
+Insert a description list item with the current relative time. With
+a prefix argument, first reset the timer to 0.
@item @kbd{M-@key{RET}} (@code{org-insert-heading})
@kindex M-RET
@findex org-insert-heading
-Once the timer list is started, you can also use
-@kbd{M-@key{RET}} to insert new timer items.
+Once the timer list is started, you can also use @kbd{M-@key{RET}} to
+insert new timer items.
@item @kbd{C-c C-x ,} (@code{org-timer-pause-or-continue})
@kindex C-c C-x ,
@@ -7672,30 +7677,289 @@ Pause the timer, or continue it if it is already paused.
@kindex C-c C-x _
@findex org-timer-stop
Stop the timer. After this, you can only start a new timer, not
-continue the old one. This command also removes the timer from
-the mode line.
+continue the old one. This command also removes the timer from the
+mode line.
@end table
-@node Capture Refile Archive
-@chapter Capture, Refile, Archive
+@node Refiling and Archiving
+@chapter Refiling and Archiving
+
+@cindex refiling notes
+@cindex copying notes
+@cindex archiving
+
+Once information is in the system, it may need to be moved around.
+Org provides Refile, Copy and Archive commands for this. Refile and
+Copy helps with moving and copying outlines. Archiving helps to keep
+the system compact and fast.
+
+@menu
+* Refile and Copy:: Moving/copying a tree from one place to another.
+* Archiving:: What to do with finished products.
+@end menu
+
+@node Refile and Copy
+@section Refile and Copy
+
+@cindex refiling notes
+@cindex copying notes
+
+When reviewing the captured data, you may want to refile or to copy
+some of the entries into a different list, for example into a project.
+Cutting, finding the right location, and then pasting the note is
+cumbersome. To simplify this process, you can use the following
+special command:
+
+@table @asis
+@item @kbd{C-c C-w} (@code{org-refile})
+@kindex C-c C-w
+@findex org-refile
+@vindex org-reverse-note-order
+@vindex org-refile-targets
+@vindex org-refile-use-outline-path
+@vindex org-outline-path-complete-in-steps
+@vindex org-refile-allow-creating-parent-nodes
+@vindex org-log-refile
+Refile the entry or region at point. This command offers possible
+locations for refiling the entry and lets you select one with
+completion. The item (or all items in the region) is filed below
+the target heading as a subitem. Depending on
+@code{org-reverse-note-order}, it is either the first or last subitem.
+
+By default, all level 1 headlines in the current buffer are
+considered to be targets, but you can have more complex definitions
+across a number of files. See the variable @code{org-refile-targets} for
+details. If you would like to select a location via
+a file-path-like completion along the outline path, see the
+variables @code{org-refile-use-outline-path} and
+@code{org-outline-path-complete-in-steps}. If you would like to be able
+to create new nodes as new parents for refiling on the fly, check
+the variable @code{org-refile-allow-creating-parent-nodes}. When the
+variable @code{org-log-refile}@footnote{Note the corresponding @samp{STARTUP} options @samp{logrefile},
+@samp{lognoterefile}, and @samp{nologrefile}.} is set, a timestamp or a note is
+recorded whenever an entry is refiled.
+
+@item @kbd{C-u C-c C-w}
+@kindex C-u C-c C-w
+Use the refile interface to jump to a heading.
+
+@item @kbd{C-u C-u C-c C-w} (@code{org-refile-goto-last-stored})
+@kindex C-u C-u C-c C-w
+@findex org-refile-goto-last-stored
+Jump to the location where @code{org-refile} last moved a tree to.
+
+@item @kbd{C-2 C-c C-w}
+@kindex C-2 C-c C-w
+Refile as the child of the item currently being clocked.
+
+@item @kbd{C-3 C-c C-w}
+@kindex C-3 C-c C-w
+@vindex org-refile-keep
+Refile and keep the entry in place. Also see @code{org-refile-keep} to
+make this the default behavior, and beware that this may result in
+duplicated @samp{ID} properties.
+
+@item @kbd{C-0 C-c C-w} or @kbd{C-u C-u C-u C-c C-w} (@code{org-refile-cache-clear})
+@kindex C-u C-u C-u C-c C-w
+@kindex C-0 C-c C-w
+@findex org-refile-cache-clear
+@vindex org-refile-use-cache
+Clear the target cache. Caching of refile targets can be turned on
+by setting @code{org-refile-use-cache}. To make the command see new
+possible targets, you have to clear the cache with this command.
+
+@item @kbd{C-c M-w} (@code{org-copy})
+@kindex C-c M-w
+@findex org-copy
+Copying works like refiling, except that the original note is not
+deleted.
+@end table
+
+@node Archiving
+@section Archiving
+
+@cindex archiving
+
+When a project represented by a (sub)tree is finished, you may want to
+move the tree out of the way and to stop it from contributing to the
+agenda. Archiving is important to keep your working files compact and
+global searches like the construction of agenda views fast.
+
+@table @asis
+@item @kbd{C-c C-x C-a} (@code{org-archive-subtree-default})
+@kindex C-c C-x C-a
+@findex org-archive-subtree-default
+@vindex org-archive-default-command
+Archive the current entry using the command specified in the
+variable @code{org-archive-default-command}.
+@end table
+
+@menu
+* Moving subtrees:: Moving a tree to an archive file.
+* Internal archiving:: Switch off a tree but keep it in the file.
+@end menu
+
+@node Moving subtrees
+@subsection Moving a tree to an archive file
+
+@cindex external archiving
+
+The most common archiving action is to move a project tree to another
+file, the archive file.
+
+@table @asis
+@item @kbd{C-c C-x C-s} or short @kbd{C-c $} (@code{org-archive-subtree})
+@kindex C-c C-x C-s
+@kindex C-c $
+@findex org-archive-subtree
+@vindex org-archive-location
+Archive the subtree starting at point position to the location given
+by @code{org-archive-location}.
+
+@item @kbd{C-u C-c C-x C-s}
+@kindex C-u C-c C-x C-s
+Check if any direct children of the current headline could be moved
+to the archive. To do this, check each subtree for open TODO
+entries. If none is found, the command offers to move it to the
+archive location. If point is @emph{not} on a headline when this command
+is invoked, check level 1 trees.
+
+@item @kbd{C-u C-u C-c C-x C-s}
+@kindex C-u C-u C-c C-x C-s
+As above, but check subtree for timestamps instead of TODO entries.
+The command offers to archive the subtree if it @emph{does} contain
+a timestamp, and that timestamp is in the past.
+@end table
+
+@cindex archive locations
+The default archive location is a file in the same directory as the
+current file, with the name derived by appending @samp{_archive} to the
+current file name. You can also choose what heading to file archived
+items under, with the possibility to add them to a datetree in a file.
+For information and examples on how to specify the file and the
+heading, see the documentation string of the variable
+@code{org-archive-location}.
+
+There is also an in-buffer option for setting this variable, for
+example:
+
+@cindex @samp{ARCHIVE}, keyword
+@example
+#+ARCHIVE: %s_done::
+@end example
+
+
+@cindex ARCHIVE, property
+If you would like to have a special archive location for a single
+entry or a (sub)tree, give the entry an @samp{ARCHIVE} property with the
+location as the value (see @ref{Properties and Columns}).
+
+@vindex org-archive-save-context-info
+When a subtree is moved, it receives a number of special properties
+that record context information like the file from where the entry
+came, its outline path the archiving time etc. Configure the variable
+@code{org-archive-save-context-info} to adjust the amount of information
+added.
+
+@node Internal archiving
+@subsection Internal archiving
+
+@cindex @samp{ARCHIVE}, tag
+If you want to just switch off---for agenda views---certain subtrees
+without moving them to a different file, you can use the @samp{ARCHIVE}
+tag.
+
+A headline that is marked with the @samp{ARCHIVE} tag (see @ref{Tags}) stays at
+its location in the outline tree, but behaves in the following way:
+
+@itemize
+@item
+@vindex org-cycle-open-archived-trees
+It does not open when you attempt to do so with a visibility cycling
+command (see @ref{Visibility Cycling}). You can force cycling archived
+subtrees with @kbd{C-@key{TAB}}, or by setting the option
+@code{org-cycle-open-archived-trees}. Also normal outline commands, like
+@code{outline-show-all}, open archived subtrees.
+
+@item
+@vindex org-sparse-tree-open-archived-trees
+During sparse tree construction (see @ref{Sparse Trees}), matches in
+archived subtrees are not exposed, unless you configure the option
+@code{org-sparse-tree-open-archived-trees}.
+
+@item
+@vindex org-agenda-skip-archived-trees
+During agenda view construction (see @ref{Agenda Views}), the content of
+archived trees is ignored unless you configure the option
+@code{org-agenda-skip-archived-trees}, in which case these trees are
+always included. In the agenda you can press @kbd{v a} to get
+archives temporarily included.
+
+@item
+@vindex org-export-with-archived-trees
+Archived trees are not exported (see @ref{Exporting}), only the headline
+is. Configure the details using the variable
+@code{org-export-with-archived-trees}.
+
+@item
+@vindex org-columns-skip-archived-trees
+Archived trees are excluded from column view unless the variable
+@code{org-columns-skip-archived-trees} is configured to @code{nil}.
+@end itemize
+
+The following commands help manage the @samp{ARCHIVE} tag:
+
+@table @asis
+@item @kbd{C-c C-x a} (@code{org-toggle-archive-tag})
+@kindex C-c C-x a
+@findex org-toggle-archive-tag
+Toggle the archive tag for the current headline. When the tag is
+set, the headline changes to a shadowed face, and the subtree below
+it is hidden.
+
+@item @kbd{C-u C-c C-x a}
+@kindex C-u C-c C-x a
+Check if any direct children of the current headline should be
+archived. To do this, check each subtree for open TODO entries. If
+none is found, the command offers to set the @samp{ARCHIVE} tag for the
+child. If point is @emph{not} on a headline when this command is
+invoked, check the level 1 trees.
+
+@item @kbd{C-@key{TAB}} (@code{org-force-cycle-archived})
+@kindex C-TAB
+Cycle a tree even if it is tagged with @samp{ARCHIVE}.
+
+@item @kbd{C-c C-x A} (@code{org-archive-to-archive-sibling})
+@kindex C-c C-x A
+@findex org-archive-to-archive-sibling
+Move the current entry to the @emph{Archive Sibling}. This is a sibling
+of the entry with the heading @samp{Archive} and the archive tag. The
+entry becomes a child of that sibling and in this way retains a lot
+of its original context, including inherited tags and approximate
+position in the outline.
+@end table
+
+@node Capture and Attachments
+@chapter Capture and Attachments
@cindex capture
+@cindex attachments
+@cindex RSS feeds
+@cindex Atom feeds
+@cindex protocols, for external access
An important part of any organization system is the ability to quickly
capture new ideas and tasks, and to associate reference material with
them. Org does this using a process called @emph{capture}. It also can
store files related to a task (@emph{attachments}) in a special directory.
-Once in the system, tasks and projects need to be moved around.
-Moving completed project trees to an archive file keeps the system
-compact and fast.
+Finally, it can parse RSS feeds for information. To learn how to let
+external programs (for example a web browser) trigger Org to capture
+material, see @ref{Protocols}.
@menu
* Capture:: Capturing new stuff.
-* Attachments:: Add files to tasks.
+* Attachments:: Attach files to outlines.
* RSS Feeds:: Getting input from RSS feeds.
-* Protocols:: External access to Emacs and Org.
-* Refile and Copy:: Moving/copying a tree from one place to another.
-* Archiving:: What to do with finished products.
@end menu
@node Capture
@@ -7733,32 +7997,32 @@ You may also define a global key for capturing new material (see
@item @kbd{M-x org-capture} (@code{org-capture})
@findex org-capture
@cindex date tree
-Display the capture templates menu. If you have templates
-defined (see @ref{Capture templates}), it offers these templates for
-selection or use a new Org outline node as the default template.
-It inserts the template into the target file and switch to an
-indirect buffer narrowed to this new node. You may then insert
-the information you want.
+Display the capture templates menu. If you have templates defined
+(see @ref{Capture templates}), it offers these templates for selection or
+use a new Org outline node as the default template. It inserts the
+template into the target file and switch to an indirect buffer
+narrowed to this new node. You may then insert the information you
+want.
@item @kbd{C-c C-c} (@code{org-capture-finalize})
@kindex C-c C-c @r{(Capture buffer)}
@findex org-capture-finalize
-Once you have finished entering information into the capture
-buffer, @kbd{C-c C-c} returns you to the window
-configuration before the capture process, so that you can resume
-your work without further distraction. When called with a prefix
-argument, finalize and then jump to the captured item.
+Once you have finished entering information into the capture buffer,
+@kbd{C-c C-c} returns you to the window configuration before
+the capture process, so that you can resume your work without
+further distraction. When called with a prefix argument, finalize
+and then jump to the captured item.
@item @kbd{C-c C-w} (@code{org-capture-refile})
@kindex C-c C-w @r{(Capture buffer)}
@findex org-capture-refile
Finalize the capture process by refiling the note to a different
-place (see @ref{Refile and Copy}). Please realize that this is a
-normal refiling command that will be executed---so point position
-at the moment you run this command is important. If you have
-inserted a tree with a parent and children, first move point back
-to the parent. Any prefix argument given to this command is
-passed on to the @code{org-refile} command.
+place (see @ref{Refile and Copy}). Please realize that this is a normal
+refiling command that will be executed---so point position at the
+moment you run this command is important. If you have inserted
+a tree with a parent and children, first move point back to the
+parent. Any prefix argument given to this command is passed on to
+the @code{org-refile} command.
@item @kbd{C-c C-k} (@code{org-capture-kill})
@kindex C-c C-k @r{(Capture buffer)}
@@ -7777,8 +8041,8 @@ with prefix commands:
@table @asis
@item @kbd{C-u M-x org-capture}
-Visit the target location of a capture template. You get to
-select the template in the usual way.
+Visit the target location of a capture template. You get to select
+the template in the usual way.
@item @kbd{C-u C-u M-x org-capture}
Visit the last stored capture item in its buffer.
@@ -7823,7 +8087,6 @@ configuration would look like:
"* %?\nEntered on %U\n %i\n %a")))
@end lisp
-@noindent
If you then press @kbd{t} from the capture menu, Org will prepare
the template for you like this:
@@ -7863,18 +8126,18 @@ Now lets look at the elements of a template definition. Each entry in
@table @asis
@item keys
The keys that selects the template, as a string, characters only,
-for example @samp{"a"}, for a template to be selected with a single
-key, or @samp{"bt"} for selection with two keys. When using several
-keys, keys using the same prefix key must be sequential in the
-list and preceded by a 2-element entry explaining the prefix key,
-for example:
+for example @samp{"a"}, for a template to be selected with a single key,
+or @samp{"bt"} for selection with two keys. When using several keys,
+keys using the same prefix key must be sequential in the list and
+preceded by a 2-element entry explaining the prefix key, for
+example:
@lisp
("b" "Templates for marking stuff to buy")
@end lisp
-If you do not define a template for the @kbd{C} key, this
-key opens the Customize buffer for this complex variable.
+If you do not define a template for the @kbd{C} key, this key
+opens the Customize buffer for this complex variable.
@item description
A short string describing the template, shown during selection.
@@ -7884,18 +8147,17 @@ The type of entry, a symbol. Valid values are:
@table @asis
@item @code{entry}
-An Org mode node, with a headline. Will be filed as the child
-of the target entry or as a top-level entry. The target file
-should be an Org file.
+An Org mode node, with a headline. Will be filed as the child of
+the target entry or as a top-level entry. The target file should
+be an Org file.
@item @code{item}
-A plain list item, placed in the first plain list at the
-target location. Again the target file should be an Org
-file.
+A plain list item, placed in the first plain list at the target
+location. Again the target file should be an Org file.
@item @code{checkitem}
-A checkbox item. This only differs from the plain list item
-by the default template.
+A checkbox item. This only differs from the plain list item by
+the default template.
@item @code{table-line}
A new line in the first table at the target location. Where
@@ -7909,15 +8171,14 @@ Text to be inserted as it is.
@item target
@vindex org-default-notes-file
@vindex org-directory
-Specification of where the captured item should be placed. In
-Org files, targets usually define a node. Entries will become
-children of this node. Other types will be added to the table or
-list in the body of this node. Most target specifications
-contain a file name. If that file name is the empty string, it
-defaults to @code{org-default-notes-file}. A file can also be given
-as a variable or as a function called with no argument. When an
-absolute path is not specified for a target, it is taken as
-relative to @code{org-directory}.
+Specification of where the captured item should be placed. In Org
+files, targets usually define a node. Entries will become children
+of this node. Other types will be added to the table or list in the
+body of this node. Most target specifications contain a file name.
+If that file name is the empty string, it defaults to
+@code{org-default-notes-file}. A file can also be given as a variable or
+as a function called with no argument. When an absolute path is not
+specified for a target, it is taken as relative to @code{org-directory}.
Valid values are:
@@ -7946,9 +8207,9 @@ properties. Please rewrite your date/week-tree targets using
level, months or ISO weeks as sublevels and then dates on the lowest
level. Tags are allowed in the tree structure.} for
today's date. If the optional outline path is given, the tree
-will be built under the node it is pointing to, instead of at
-top level. Check out the @code{:time-prompt} and @code{:tree-type}
-properties below for additional options.
+will be built under the node it is pointing to, instead of at top
+level. Check out the @code{:time-prompt} and @code{:tree-type} properties
+below for additional options.
@item @samp{(file+function "filename" function-finding-location)}
A function to find the right location in the file.
@@ -7963,12 +8224,11 @@ file and moves point to the right location.
@item template
The template for creating the capture item. If you leave this
-empty, an appropriate default template will be used. Otherwise
-this is a string with escape codes, which will be replaced
-depending on time and context of the capture call. The string
-with escapes may be loaded from a template file, using the
-special syntax @samp{(file "template filename")}. See below for more
-details.
+empty, an appropriate default template will be used. Otherwise this
+is a string with escape codes, which will be replaced depending on
+time and context of the capture call. The string with escapes may
+be loaded from a template file, using the special syntax @samp{(file
+ "template filename")}. See below for more details.
@item properties
The rest of the entry is a property list of additional options.
@@ -7976,18 +8236,18 @@ Recognized properties are:
@table @asis
@item @code{:prepend}
-Normally new captured information will be appended at the
-target location (last child, last table line, last list item,
-@dots{}). Setting this property changes that.
+Normally new captured information will be appended at the target
+location (last child, last table line, last list item, @dots{}).
+Setting this property changes that.
@item @code{:immediate-finish}
-When set, do not offer to edit the information, just file it
-away immediately. This makes sense if the template only needs
+When set, do not offer to edit the information, just file it away
+immediately. This makes sense if the template only needs
information that can be added automatically.
@item @code{:empty-lines}
-Set this to the number of lines to insert before and after the
-new item. Default 0, and the only other common value is 1.
+Set this to the number of lines to insert before and after the new
+item. Default 0, and the only other common value is 1.
@item @code{:clock-in}
Start the clock in this item.
@@ -7998,9 +8258,9 @@ Keep the clock running when filing the captured entry.
@item @code{:clock-resume}
If starting the capture interrupted a clock, restart that clock
when finished with the capture. Note that @code{:clock-keep} has
-precedence over @code{:clock-resume}. When setting both to
-non-@code{nil}, the current clock will run and the previous one will
-not be resumed.
+precedence over @code{:clock-resume}. When setting both to non-@code{nil},
+the current clock will run and the previous one will not be
+resumed.
@item @code{:time-prompt}
Prompt for a date/time to be used for date/week trees and when
@@ -8011,22 +8271,22 @@ a @kbd{C-1} prefix argument.
@item @code{:tree-type}
When @code{week}, make a week tree instead of the month tree, i.e.,
-place the headings for each day under a heading with the
-current ISO week.
+place the headings for each day under a heading with the current
+ISO week.
@item @code{:unnarrowed}
-Do not narrow the target buffer, simply show the full buffer. Default
-is to narrow it so that you only see the new material.
+Do not narrow the target buffer, simply show the full buffer.
+Default is to narrow it so that you only see the new material.
@item @code{:table-line-pos}
Specification of the location in the table where the new line
should be inserted. It should be a string like @samp{II-3} meaning
-that the new line should become the third line before the
-second horizontal separator line.
+that the new line should become the third line before the second
+horizontal separator line.
@item @code{:kill-buffer}
-If the target file was not yet visited when capture was invoked, kill
-the buffer again after capture is completed.
+If the target file was not yet visited when capture was invoked,
+kill the buffer again after capture is completed.
@item @code{:no-save}
Do not save the target file after finishing the capture.
@@ -8050,8 +8310,8 @@ Evaluate Elisp expression @var{EXP} and replace it with the
result. The @var{EXP} form must return a string. Only
placeholders pre-existing within the template, or introduced with
@samp{%[file]}, are expanded this way. Since this happens after
-expanding non-interactive ``%-escapes'', those can be used to fill
-the expression.
+expanding non-interactive ``%-escapes'', those can be used to fill the
+expression.
@item @samp{%<FORMAT>}
The result of format-time-string on the @var{FORMAT}
@@ -8067,10 +8327,10 @@ Timestamp, with date and time.
Like @samp{%t}, @samp{%T} above, but inactive timestamps.
@item @samp{%i}
-Initial content, the region when capture is called while the
-region is active. If there is text before @samp{%i} on the same line,
-such as indentation, and @samp{%i} is not inside a @samp{%(exp)} form, that
-prefix is added before every line in the inserted text.
+Initial content, the region when capture is called while the region
+is active. If there is text before @samp{%i} on the same line, such as
+indentation, and @samp{%i} is not inside a @samp{%(exp)} form, that prefix is
+added before every line in the inserted text.
@item @samp{%a}
Annotation, normally the link created with @code{org-store-link}.
@@ -8112,8 +8372,8 @@ Prompt for tags, with completion on tags in target file.
Prompt for tags, with completion all tags in all agenda files.
@item @samp{%^t}
-Like @samp{%t}, but prompt for date. Similarly @samp{%^T}, @samp{%^u}, @samp{%^U}. You may
-define a prompt like @samp{%^@{Birthday@}t}.
+Like @samp{%t}, but prompt for date. Similarly @samp{%^T}, @samp{%^u}, @samp{%^U}. You
+may define a prompt like @samp{%^@{Birthday@}t}.
@item @samp{%^C}
Interactive selection of which kill or clip to use.
@@ -8125,8 +8385,8 @@ Like @samp{%^C}, but insert as link.
Prompt the user for a value for property @var{PROP}.
@item @samp{%^@{PROMPT@}}
-Prompt the user for a string and replace this sequence with it.
-You may specify a default value and a completion table with
+Prompt the user for a string and replace this sequence with it. You
+may specify a default value and a completion table with
@samp{%^@{prompt|default|completion2|completion3...@}}. The arrow keys
access a prompt-specific history.
@@ -8142,7 +8402,7 @@ After completing the template, position point here.
For specific link types, the following keywords are defined@footnote{If you define your own link types (see @ref{Adding Hyperlink Types}), any property you store with @code{org-store-link-props} can be
accessed in capture templates in a similar way.}:
-@vindex org-from-is-user-regexp
+@vindex org-link-from-user-regexp
@multitable {aaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa}
@headitem Link type
@tab Available keywords
@@ -8164,7 +8424,7 @@ accessed in capture templates in a similar way.}:
@tab @samp{%:date-timestamp-inactive} (date as inactive timestamp)
@item
@tab @samp{%:fromto} (either ``to NAME'' or ``from NAME'')@footnote{This is always the other, not the user. See the variable
-@code{org-from-is-user-regexp}.}
+@code{org-link-from-user-regexp}.}
@item gnus
@tab @samp{%:group}, for messages also all email fields
@item w3, w3m
@@ -8206,27 +8466,39 @@ See the docstring of the variable for more information.
@section Attachments
@cindex attachments
-@vindex org-attach-directory
It is often useful to associate reference material with an outline
-node/task. Small chunks of plain text can simply be stored in the
-subtree of a project. Hyperlinks (see @ref{Hyperlinks}) can establish
-associations with files that live elsewhere on your computer or in the
-cloud, like emails or source code files belonging to a project.
-Another method is @emph{attachments}, which are files located in
-a directory belonging to an outline node. Org uses directories named
-by the unique ID of each entry. These directories are located in the
-@samp{data/} directory which lives in the same directory where your Org
-file lives@footnote{If you move entries or Org files from one directory to
-another, you may want to configure @code{org-attach-directory} to contain
-an absolute path.}. If you initialize this directory with @samp{git init},
-Org automatically commits changes when it sees them. The attachment
-system has been contributed to Org by John Wiegley.
-
-In cases where it seems better to do so, you can attach a directory of
-your choice to an entry. You can also make children inherit the
-attachment directory from a parent, so that an entire subtree uses the
-same attached directory.
+node. Small chunks of plain text can simply be stored in the subtree
+of a project. Hyperlinks (see @ref{Hyperlinks}) can establish associations
+with files that live elsewhere on your computer or in the cloud, like
+emails or source code files belonging to a project.
+
+Another method is @emph{attachments}, which are files located in a
+directory belonging to an outline node. Org uses directories either
+named by a unique ID of each entry, or by a @samp{DIR} property.
+
+@menu
+* Attachment defaults and dispatcher:: How to access attachment commands
+* Attachment options:: Configuring the attachment system
+* Attachment links:: Hyperlink access to attachments
+* Automatic version-control with Git:: Everything safely stored away
+* Attach from Dired:: Using dired to select an attachment
+@end menu
+
+@node Attachment defaults and dispatcher
+@subsection Attachment defaults and dispatcher
+
+By default, org-attach will use ID properties when adding attachments
+to outline nodes. This makes working with attachments fully
+automated. There is no decision needed for folder-name or location.
+ID-based directories are by default located in the @samp{data/} directory,
+which lives in the same directory where your Org file lives@footnote{If you move entries or Org files from one directory to
+another, you may want to configure @code{org-attach-id-dir} to contain
+an absolute path.}.
+For more control over the setup, see @ref{Attachment options}.
+
+When attachments are made using @code{org-attach} a default tag @samp{ATTACH} is
+added to the node that gets the attachments.
The following commands deal with attachments:
@@ -8234,26 +8506,32 @@ The following commands deal with attachments:
@item @kbd{C-c C-a} (@code{org-attach})
@kindex C-c C-a
@findex org-attach
-The dispatcher for commands related to the attachment system.
-After these keys, a list of commands is displayed and you must
-press an additional key to select a command:
+The dispatcher for commands related to the attachment system. After
+these keys, a list of commands is displayed and you must press an
+additional key to select a command:
@table @asis
@item @kbd{a} (@code{org-attach-attach})
@kindex C-c C-a a
@findex org-attach-attach
@vindex org-attach-method
-Select a file and move it into the task's attachment
-directory. The file is copied, moved, or linked, depending
-on @code{org-attach-method}. Note that hard links are not
-supported on all systems.
+Select a file and move it into the task's attachment directory.
+The file is copied, moved, or linked, depending on
+@code{org-attach-method}. Note that hard links are not supported on
+all systems.
@item @kbd{c}/@kbd{m}/@kbd{l}
@kindex C-c C-a c
@kindex C-c C-a m
@kindex C-c C-a l
-Attach a file using the copy/move/link method. Note that
-hard links are not supported on all systems.
+Attach a file using the copy/move/link method. Note that hard
+links are not supported on all systems.
+
+@item @kbd{b} (@code{org-attach-buffer})
+@kindex C-c C-a b
+@findex org-attach-buffer
+Select a buffer and save it as a file in the task's attachment
+directory.
@item @kbd{n} (@code{org-attach-new})
@kindex C-c C-a n
@@ -8263,23 +8541,22 @@ Create a new attachment as an Emacs buffer.
@item @kbd{z} (@code{org-attach-sync})
@kindex C-c C-a z
@findex org-attach-sync
-Synchronize the current task with its attachment directory, in case
-you added attachments yourself.
+Synchronize the current task with its attachment directory, in
+case you added attachments yourself.
@item @kbd{o} (@code{org-attach-open})
@kindex C-c C-a o
@findex org-attach-open
@vindex org-file-apps
-Open current task's attachment. If there is more than one,
-prompt for a file name first. Opening follows the rules set
-by @code{org-file-apps}. For more details, see the information
-on following hyperlinks (see @ref{Handling Links}).
+Open current task's attachment. If there is more than one, prompt
+for a file name first. Opening follows the rules set by
+@code{org-file-apps}. For more details, see the information on
+following hyperlinks (see @ref{Handling Links}).
@item @kbd{O} (@code{org-attach-open-in-emacs})
@kindex C-c C-a O
@findex org-attach-open-in-emacs
-Also open the attachment, but force opening the file in
-Emacs.
+Also open the attachment, but force opening the file in Emacs.
@item @kbd{f} (@code{org-attach-reveal})
@kindex C-c C-a f
@@ -8297,24 +8574,153 @@ Select and delete a single attachment.
@item @kbd{D} (@code{org-attach-delete-all})
@kindex C-c C-a D
-Delete all of a task's attachments. A safer way is to open
-the directory in Dired and delete from there.
+Delete all of a task's attachments. A safer way is to open the
+directory in Dired and delete from there.
@item @kbd{s} (@code{org-attach-set-directory})
@kindex C-c C-a s
-@cindex @samp{ATTACH_DIR}, property
-Set a specific directory as the entry's attachment
-directory. This works by putting the directory path into
-the @samp{ATTACH_DIR} property.
-
-@item @kbd{i} (@code{org-attach-set-inherit})
-@kindex C-c C-a i
-@cindex @samp{ATTACH_DIR_INHERIT}, property
-Set the @samp{ATTACH_DIR_INHERIT} property, so that children use
-the same directory for attachments as the parent does.
+@cindex @samp{DIR}, property
+Set a specific directory as the entry's attachment directory.
+This works by putting the directory path into the @samp{DIR}
+property.
+
+@item @kbd{S} (@code{org-attach-unset-directory})
+@kindex C-c C-a S
+@cindex @samp{DIR}, property
+Remove the attachment directory. This command removes the @samp{DIR}
+property and asks the user to either move content inside that
+folder, if an @samp{ID} property is set, delete the content, or to
+leave the attachment directory as is but no longer attached to the
+outline node.
+@end table
@end table
+
+@node Attachment options
+@subsection Attachment options
+
+There are a couple of options for attachments that are worth
+mentioning.
+
+@table @asis
+@item @code{org-attach-id-dir}
+@vindex org-attach-id-dir
+The directory where attachments are stored when @samp{ID} is used as
+method.
+
+@item @code{org-attach-dir-relative}
+@vindex org-attach-dir-relative
+When setting the @samp{DIR} property on a node using @kbd{C-c C-a s}
+(@code{org-attach-set-directory}), absolute links are entered by default.
+This option changes that to relative links.
+
+@item @code{org-attach-use-inheritance}
+@vindex org-attach-use-inheritance
+By default folders attached to an outline node are inherited from
+parents according to @code{org-use-property-inheritance}. If one instead
+want to set inheritance specifically for org-attach that can be done
+using @code{org-attach-use-inheritance}. Inheriting documents through
+the node hierarchy makes a lot of sense in most cases. Especially
+since the introduction of @ref{Attachment links}. The following example
+shows one use case for attachment inheritance:
+
+@example
+* Chapter A ...
+ :PROPERTIES:
+ :DIR: Chapter A/
+ :END:
+** Introduction
+Some text
+
+#+NAME: Image 1
+[[Attachment:image 1.jpg]]
+@end example
+
+Without inheritance one would not be able to resolve the link to
+image @samp{1.jpg}, since the link is inside a sub-heading to @samp{Chapter
+ A}.
+
+Inheritance works the same way for both @samp{ID} and @samp{DIR} property. If
+both properties are defined on the same headline then @samp{DIR} takes
+precedance. This is also true if inheritance is enabled. If @samp{DIR}
+is inherited from a parent node in the outline, that property still
+takes precedence over an @samp{ID} property defined on the node itself.
+
+@item @code{org-attach-method}
+@vindex org-attach-method
+When attaching files using the dispatcher @kbd{C-c C-a} it
+defaults to copying files. The behaviour can be changed by
+customizing @code{org-attach-method}. Options are Copy, Move/Rename,
+Hard link or Symbolic link.
+
+@item @code{org-attach-preferred-new-method}
+@vindex org-attach-preferred-new-method
+This customization lets you choose the default way to attach to
+nodes without existing @samp{ID} and @samp{DIR} property. It defaults to @code{id}
+but can also be set to @code{dir}, @code{ask} or @code{nil}.
+
+@item @code{org-attach-archive-delete}
+@vindex org-attach-archive-delete
+Configure this to determine if attachments should be deleted or not
+when a subtree that has attachments is archived.
+
+@item @code{org-attach-auto-tag}
+@vindex org-attach-auto-tag
+When attaching files to a heading it will be assigned a tag
+according to what is set here.
+
+@item @code{org-attach-id-to-path-function-list}
+@vindex org-attach-id-to-path-function-list
+When @samp{ID} is used for attachments, the ID is parsed into a part of a
+directory-path. See @code{org-attach-id-uuid-folder-format} for the
+default function. Define a new one and add it as first element in
+@code{org-attach-id-to-path-function-list} if you want the folder
+structure in any other way. All functions in this list will be
+tried when resolving existing ID's into paths, to maintain backward
+compatibility with existing folders in your system.
+
+@item @code{org-attach-expert}
+@vindex org-attach-expert
+Do not show the splash buffer with the attach dispatcher when
+@code{org-attach-expert} is set to non-@code{nil}.
@end table
+See customization group @samp{Org Attach} if you want to change the
+default settings.
+
+@node Attachment links
+@subsection Attachment links
+
+Attached files and folders can be referenced using attachment links.
+This makes it easy to refer to the material added to an outline node.
+Especially if it was attached using the unique ID of the entry!
+
+@example
+* TODO Some task
+ :PROPERTIES:
+ :ID: 95d50008-c12e-479f-a4f2-cc0238205319
+ :END:
+See attached document for more information: [[attachment:info.org]]
+@end example
+
+See @ref{External Links} for more information about these links.
+
+@node Automatic version-control with Git
+@subsection Automatic version-control with Git
+
+If the directory attached to an outline node is a Git repository, Org
+can be configured to automatically commit changes to that repository
+when it sees them.
+
+To make Org mode take care of versioning of attachments for you, add
+the following to your Emacs config:
+
+@lisp
+(require 'org-attach-git)
+@end lisp
+
+@node Attach from Dired
+@subsection Attach from Dired
+
@cindex attach from Dired
@findex org-attach-dired-to-subtree
It is possible to attach files to a subtree from a Dired buffer. To
@@ -8377,8 +8783,8 @@ Entries}, whenever the following command is used:
@table @asis
@item @kbd{C-c C-x g} (@code{org-feed-update-all})
@kindex C-c C-x g
-Collect items from the feeds configured in @code{org-feed-alist} and
-act upon them.
+Collect items from the feeds configured in @code{org-feed-alist} and act
+upon them.
@item @kbd{C-c C-x G} (@code{org-feed-goto-inbox})
@kindex C-c C-x G
@@ -8392,452 +8798,6 @@ adding the same item several times.
For more information, including how to read atom feeds, see
@samp{org-feed.el} and the docstring of @code{org-feed-alist}.
-@node Protocols
-@section Protocols for External Access
-
-@cindex protocols, for external access
-
-Org protocol is a means to trigger custom actions in Emacs from
-external applications. Any application that supports calling external
-programs with an URL as argument may be used with this functionality.
-For example, you can configure bookmarks in your web browser to send
-a link to the current page to Org and create a note from it using
-capture (see @ref{Capture}). You can also create a bookmark that tells
-Emacs to open the local source file of a remote website you are
-browsing.
-
-@cindex Org protocol, set-up
-@cindex Installing Org protocol
-In order to use Org protocol from an application, you need to register
-@samp{org-protocol://} as a valid scheme-handler. External calls are
-passed to Emacs through the @samp{emacsclient} command, so you also need to
-ensure an Emacs server is running. More precisely, when the
-application calls
-
-@example
-emacsclient org-protocol://PROTOCOL?key1=val1&key2=val2
-@end example
-
-
-@noindent
-Emacs calls the handler associated to @var{PROTOCOL} with
-argument @samp{(:key1 val1 :key2 val2)}.
-
-@cindex protocol, new protocol
-@cindex defining new protocols
-Org protocol comes with three predefined protocols, detailed in the
-following sections. Configure @code{org-protocol-protocol-alist} to define
-your own.
-
-@menu
-* @code{store-link} protocol:: Store a link, push URL to kill-ring.
-* @code{capture} protocol:: Fill a buffer with external information.
-* @code{open-source} protocol:: Edit published contents.
-@end menu
-
-@node @code{store-link} protocol
-@subsection @code{store-link} protocol
-
-@cindex store-link protocol
-@cindex protocol, store-link
-
-Using @code{store-link} handler, you can copy links, insertable through
-@kbd{M-x org-insert-link} or yanking thereafter. More precisely,
-the command
-
-@example
-emacsclient org-protocol://store-link?url=URL&title=TITLE
-@end example
-
-
-@noindent
-stores the following link:
-
-@example
-[[URL][TITLE]]
-@end example
-
-
-In addition, @var{URL} is pushed on the kill-ring for yanking.
-You need to encode @var{URL} and @var{TITLE} if they contain
-slashes, and probably quote those for the shell.
-
-To use this feature from a browser, add a bookmark with an arbitrary
-name, e.g., @samp{Org: store-link} and enter this as @emph{Location}:
-
-@example
-javascript:location.href='org-protocol://store-link?url='+
- encodeURIComponent(location.href);
-@end example
-
-@node @code{capture} protocol
-@subsection @code{capture} protocol
-
-@cindex capture protocol
-@cindex protocol, capture
-
-Activating ``capture'' handler pops up a @samp{Capture} buffer and fills the
-capture template associated to the @samp{X} key with them.
-
-@example
-emacsclient org-protocol://capture?template=X?url=URL?title=TITLE?body=BODY
-@end example
-
-
-To use this feature, add a bookmark with an arbitrary name, e.g.,
-@samp{Org: capture}, and enter this as @samp{Location}:
-
-@example
-javascript:location.href='org-protocol://capture?template=x'+
- '&url='+encodeURIComponent(window.location.href)+
- '&title='+encodeURIComponent(document.title)+
- '&body='+encodeURIComponent(window.getSelection());
-@end example
-
-@vindex org-protocol-default-template-key
-The result depends on the capture template used, which is set in the
-bookmark itself, as in the example above, or in
-@code{org-protocol-default-template-key}.
-
-The following template placeholders are available:
-
-@example
-%:link The URL
-%:description The webpage title
-%:annotation Equivalent to [[%:link][%:description]]
-%i The selected text
-@end example
-
-@node @code{open-source} protocol
-@subsection @code{open-source} protocol
-
-@cindex open-source protocol
-@cindex protocol, open-source
-
-The @code{open-source} handler is designed to help with editing local
-sources when reading a document. To that effect, you can use
-a bookmark with the following location:
-
-@example
-javascript:location.href='org-protocol://open-source?&url='+
- encodeURIComponent(location.href)
-@end example
-
-@vindex org-protocol-project-alist
-The variable @code{org-protocol-project-alist} maps URLs to local file
-names, by stripping URL parameters from the end and replacing the
-@code{:base-url} with @code{:working-directory} and @code{:online-suffix} with
-@code{:working-suffix}. For example, assuming you own a local copy of
-@samp{https://orgmode.org/worg/} contents at @samp{/home/user/worg}, you can set
-@code{org-protocol-project-alist} to the following
-
-@lisp
-(setq org-protocol-project-alist
- '(("Worg"
- :base-url "https://orgmode.org/worg/"
- :working-directory "/home/user/worg/"
- :online-suffix ".html"
- :working-suffix ".org")))
-@end lisp
-
-@noindent
-If you are now browsing
-@samp{https://orgmode.org/worg/org-contrib/org-protocol.html} and find
-a typo or have an idea about how to enhance the documentation, simply
-click the bookmark and start editing.
-
-@cindex rewritten URL in open-source protocol
-@cindex protocol, open-source rewritten URL
-However, such mapping may not yield the desired results. Suppose you
-maintain an online store located at @samp{http://example.com/}. The local
-sources reside in @samp{/home/user/example/}. It is common practice to
-serve all products in such a store through one file and rewrite URLs
-that do not match an existing file on the server. That way, a request
-to @samp{http://example.com/print/posters.html} might be rewritten on the
-server to something like
-@samp{http://example.com/shop/products.php/posters.html.php}. The
-@code{open-source} handler probably cannot find a file named
-@samp{/home/user/example/print/posters.html.php} and fails.
-
-Such an entry in @code{org-protocol-project-alist} may hold an additional
-property @code{:rewrites}. This property is a list of cons cells, each of
-which maps a regular expression to a path relative to the
-@code{:working-directory}.
-
-Now map the URL to the path @samp{/home/user/example/products.php} by
-adding @code{:rewrites} rules like this:
-
-@lisp
-(setq org-protocol-project-alist
- '(("example.com"
- :base-url "http://example.com/"
- :working-directory "/home/user/example/"
- :online-suffix ".php"
- :working-suffix ".php"
- :rewrites (("example.com/print/" . "products.php")
- ("example.com/$" . "index.php")))))
-@end lisp
-
-@noindent
-Since @samp{example.com/$} is used as a regular expression, it maps
-@samp{http://example.com/}, @samp{https://example.com},
-@samp{http://www.example.com/} and similar to
-@samp{/home/user/example/index.php}.
-
-The @code{:rewrites} rules are searched as a last resort if and only if no
-existing file name is matched.
-
-@cindex protocol, open-source, set-up mapping
-@cindex mappings in open-source protocol
-@findex org-protocol-create
-@findex org-protocol-create-for-org
-Two functions can help you filling @code{org-protocol-project-alist} with
-valid contents: @code{org-protocol-create} and
-@code{org-protocol-create-for-org}. The latter is of use if you're editing
-an Org file that is part of a publishing project.
-
-@node Refile and Copy
-@section Refile and Copy
-
-@cindex refiling notes
-@cindex copying notes
-
-When reviewing the captured data, you may want to refile or to copy
-some of the entries into a different list, for example into a project.
-Cutting, finding the right location, and then pasting the note is
-cumbersome. To simplify this process, you can use the following
-special command:
-
-@table @asis
-@item @kbd{C-c M-w} (@code{org-copy})
-@kindex C-c M-w
-@findex org-copy
-Copying works like refiling, except that the original note is not
-deleted.
-
-@item @kbd{C-c C-w} (@code{org-refile})
-@kindex C-c C-w
-@findex org-refile
-@vindex org-reverse-note-order
-@vindex org-refile-targets
-@vindex org-refile-use-outline-path
-@vindex org-outline-path-complete-in-steps
-@vindex org-refile-allow-creating-parent-nodes
-@vindex org-log-refile
-Refile the entry or region at point. This command offers
-possible locations for refiling the entry and lets you select one
-with completion. The item (or all items in the region) is filed
-below the target heading as a subitem. Depending on
-@code{org-reverse-note-order}, it is either the first or last subitem.
-
-By default, all level 1 headlines in the current buffer are
-considered to be targets, but you can have more complex
-definitions across a number of files. See the variable
-@code{org-refile-targets} for details. If you would like to select
-a location via a file-path-like completion along the outline
-path, see the variables @code{org-refile-use-outline-path} and
-@code{org-outline-path-complete-in-steps}. If you would like to be
-able to create new nodes as new parents for refiling on the fly,
-check the variable @code{org-refile-allow-creating-parent-nodes}.
-When the variable @code{org-log-refile}@footnote{Note the corresponding @samp{STARTUP} options @samp{logrefile},
-@samp{lognoterefile}, and @samp{nologrefile}.} is set, a timestamp or
-a note is recorded whenever an entry is refiled.
-
-@item @kbd{C-u C-c C-w}
-@kindex C-u C-c C-w
-Use the refile interface to jump to a heading.
-
-@item @kbd{C-u C-u C-c C-w} (@code{org-refile-goto-last-stored})
-@kindex C-u C-u C-c C-w
-@findex org-refile-goto-last-stored
-Jump to the location where @code{org-refile} last moved a tree to.
-
-@item @kbd{C-2 C-c C-w}
-@kindex C-2 C-c C-w
-Refile as the child of the item currently being clocked.
-
-@item @kbd{C-3 C-c C-w}
-@kindex C-3 C-c C-w
-@vindex org-refile-keep
-Refile and keep the entry in place. Also see @code{org-refile-keep}
-to make this the default behavior, and beware that this may
-result in duplicated @samp{ID} properties.
-
-@item @kbd{C-0 C-c C-w} or @kbd{C-u C-u C-u C-c C-w} (@code{org-refile-cache-clear})
-@kindex C-u C-u C-u C-c C-w
-@kindex C-0 C-c C-w
-@findex org-refile-cache-clear
-@vindex org-refile-use-cache
-Clear the target cache. Caching of refile targets can be turned
-on by setting @code{org-refile-use-cache}. To make the command see
-new possible targets, you have to clear the cache with this
-command.
-@end table
-
-@node Archiving
-@section Archiving
-
-@cindex archiving
-
-When a project represented by a (sub)tree is finished, you may want to
-move the tree out of the way and to stop it from contributing to the
-agenda. Archiving is important to keep your working files compact and
-global searches like the construction of agenda views fast.
-
-@table @asis
-@item @kbd{C-c C-x C-a} (@code{org-archive-subtree-default})
-@kindex C-c C-x C-a
-@findex org-archive-subtree-default
-@vindex org-archive-default-command
-Archive the current entry using the command specified in the
-variable @code{org-archive-default-command}.
-@end table
-
-@menu
-* Moving subtrees:: Moving a tree to an archive file.
-* Internal archiving:: Switch off a tree but keep it in the file.
-@end menu
-
-@node Moving subtrees
-@subsection Moving a tree to an archive file
-
-@cindex external archiving
-
-The most common archiving action is to move a project tree to another
-file, the archive file.
-
-@table @asis
-@item @kbd{C-c C-x C-s} or short @kbd{C-c $} (@code{org-archive-subtree})
-@kindex C-c C-x C-s
-@kindex C-c $
-@findex org-archive-subtree
-@vindex org-archive-location
-Archive the subtree starting at point position to the location
-given by @code{org-archive-location}.
-
-@item @kbd{C-u C-c C-x C-s}
-@kindex C-u C-c C-x C-s
-Check if any direct children of the current headline could be
-moved to the archive. To do this, check each subtree for open
-TODO entries. If none is found, the command offers to move it to
-the archive location. If point is @emph{not} on a headline when this
-command is invoked, check level 1 trees.
-
-@item @kbd{C-u C-u C-c C-x C-s}
-@kindex C-u C-u C-c C-x C-s
-As above, but check subtree for timestamps instead of TODO
-entries. The command offers to archive the subtree if it @emph{does}
-contain a timestamp, and that timestamp is in the past.
-@end table
-
-@cindex archive locations
-The default archive location is a file in the same directory as the
-current file, with the name derived by appending @samp{_archive} to the
-current file name. You can also choose what heading to file archived
-items under, with the possibility to add them to a datetree in a file.
-For information and examples on how to specify the file and the
-heading, see the documentation string of the variable
-@code{org-archive-location}.
-
-There is also an in-buffer option for setting this variable, for
-example:
-
-@cindex @samp{ARCHIVE}, keyword
-@example
-#+ARCHIVE: %s_done::
-@end example
-
-
-@cindex ARCHIVE, property
-If you would like to have a special archive location for a single
-entry or a (sub)tree, give the entry an @samp{ARCHIVE} property with the
-location as the value (see @ref{Properties and Columns}).
-
-@vindex org-archive-save-context-info
-When a subtree is moved, it receives a number of special properties
-that record context information like the file from where the entry
-came, its outline path the archiving time etc. Configure the variable
-@code{org-archive-save-context-info} to adjust the amount of information
-added.
-
-@node Internal archiving
-@subsection Internal archiving
-
-@cindex @samp{ARCHIVE}, tag
-If you want to just switch off---for agenda views---certain subtrees
-without moving them to a different file, you can use the @samp{ARCHIVE}
-tag.
-
-A headline that is marked with the @samp{ARCHIVE} tag (see @ref{Tags}) stays at
-its location in the outline tree, but behaves in the following way:
-
-@itemize
-@item
-@vindex org-cycle-open-archived-trees
-It does not open when you attempt to do so with a visibility cycling
-command (see @ref{Visibility Cycling}). You can force cycling archived
-subtrees with @kbd{C-@key{TAB}}, or by setting the option
-@code{org-cycle-open-archived-trees}. Also normal outline commands, like
-@code{outline-show-all}, open archived subtrees.
-
-@item
-@vindex org-sparse-tree-open-archived-trees
-During sparse tree construction (see @ref{Sparse Trees}), matches in
-archived subtrees are not exposed, unless you configure the option
-@code{org-sparse-tree-open-archived-trees}.
-
-@item
-@vindex org-agenda-skip-archived-trees
-During agenda view construction (see @ref{Agenda Views}), the content of
-archived trees is ignored unless you configure the option
-@code{org-agenda-skip-archived-trees}, in which case these trees are
-always included. In the agenda you can press @kbd{v a} to get
-archives temporarily included.
-
-@item
-@vindex org-export-with-archived-trees
-Archived trees are not exported (see @ref{Exporting}), only the headline
-is. Configure the details using the variable
-@code{org-export-with-archived-trees}.
-
-@item
-@vindex org-columns-skip-archived-trees
-Archived trees are excluded from column view unless the variable
-@code{org-columns-skip-archived-trees} is configured to @code{nil}.
-@end itemize
-
-The following commands help manage the @samp{ARCHIVE} tag:
-
-@table @asis
-@item @kbd{C-c C-x a} (@code{org-toggle-archive-tag})
-@kindex C-c C-x a
-@findex org-toggle-archive-tag
-Toggle the archive tag for the current headline. When the tag is
-set, the headline changes to a shadowed face, and the subtree
-below it is hidden.
-
-@item @kbd{C-u C-c C-x a}
-@kindex C-u C-c C-x a
-Check if any direct children of the current headline should be
-archived. To do this, check each subtree for open TODO entries.
-If none is found, the command offers to set the @samp{ARCHIVE} tag for
-the child. If point is @emph{not} on a headline when this command is
-invoked, check the level 1 trees.
-
-@item @kbd{C-@key{TAB}} (@code{org-force-cycle-archived})
-@kindex C-TAB
-Cycle a tree even if it is tagged with @samp{ARCHIVE}.
-
-@item @kbd{C-c C-x A} (@code{org-archive-to-archive-sibling})
-@kindex C-c C-x A
-@findex org-archive-to-archive-sibling
-Move the current entry to the @emph{Archive Sibling}. This is
-a sibling of the entry with the heading @samp{Archive} and the archive
-tag. The entry becomes a child of that sibling and in this way
-retains a lot of its original context, including inherited tags
-and approximate position in the outline.
-@end table
-
@node Agenda Views
@chapter Agenda Views
@@ -8933,10 +8893,10 @@ but the easiest way to maintain it is through the following commands
@kindex C-c [
@findex org-agenda-file-to-front
@cindex files, adding to agenda list
-Add current file to the list of agenda files. The file is added
-to the front of the list. If it was already in the list, it is
-moved to the front. With a prefix argument, file is added/moved
-to the end.
+Add current file to the list of agenda files. The file is added to
+the front of the list. If it was already in the list, it is moved
+to the front. With a prefix argument, file is added/moved to the
+end.
@item @kbd{C-c ]} (@code{org-remove-file})
@kindex C-c ]
@@ -8953,8 +8913,8 @@ Cycle through agenda file list, visiting one file after the other.
@item @kbd{M-x org-switchb}
@findex org-switchb
-Command to use an iswitchb-like interface to switch to and
-between Org buffers.
+Command to use an Iswitchb-like interface to switch to and between
+Org buffers.
@end table
@noindent
@@ -8974,11 +8934,12 @@ scope for an extended period, use the following commands:
@findex org-agenda-set-restriction-lock
Restrict the agenda to the current subtree. If there already is
a restriction at point, remove it. When called with a universal
-prefix argument or with point before the first headline in
-a file, set the agenda scope to the entire file. This
-restriction remains in effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<} or @kbd{>} in the
-agenda dispatcher. If there is a window displaying an agenda
-view, the new restriction takes effect immediately.
+prefix argument or with point before the first headline in a file,
+set the agenda scope to the entire file. This restriction remains
+in effect until removed with @kbd{C-c C-x >}, or by typing
+either @kbd{<} or @kbd{>} in the agenda dispatcher. If
+there is a window displaying an agenda view, the new restriction
+takes effect immediately.
@item @kbd{C-c C-x >} (@code{org-agenda-remove-restriction-lock})
@kindex C-c C-x >
@@ -8992,11 +8953,11 @@ Speedbar frame:
@table @asis
@item @kbd{<} (@code{org-speedbar-set-agenda-restriction})
@findex org-speedbar-set-agenda-restriction
-Restrict the agenda to the item---either an Org file or a subtree
-in such a file---at point in the Speedbar frame. If agenda is
-already restricted there, remove the restriction. If there is
-a window displaying an agenda view, the new restriction takes
-effect immediately.
+Restrict the agenda to the item---either an Org file or a subtree in
+such a file---at point in the Speedbar frame. If agenda is already
+restricted there, remove the restriction. If there is a window
+displaying an agenda view, the new restriction takes effect
+immediately.
@item @kbd{>} (@code{org-agenda-remove-restriction-lock})
@findex org-agenda-remove-restriction-lock
@@ -9018,45 +8979,48 @@ commands:
@item @kbd{a}
Create the calendar-like agenda (see @ref{Weekly/daily agenda}).
-@item @kbd{t} or @kbd{T}
+@item @kbd{t}
+@itemx @kbd{T}
Create a list of all TODO items (see @ref{Global TODO list}).
-@item @kbd{m} or @kbd{M}
+@item @kbd{m}
+@itemx @kbd{M}
Create a list of headlines matching a given expression (see
@ref{Matching tags and properties}).
@item @kbd{s}
@kindex s @r{(Agenda dispatcher)}
Create a list of entries selected by a boolean expression of
-keywords and/or regular expressions that must or must not occur
-in the entry.
+keywords and/or regular expressions that must or must not occur in
+the entry.
@item @kbd{/}
@kindex / @r{(Agenda dispatcher)}
@vindex org-agenda-text-search-extra-files
-Search for a regular expression in all agenda files and
-additionally in the files listed in
-@code{org-agenda-text-search-extra-files}. This uses the Emacs
-command @code{multi-occur}. A prefix argument can be used to specify
-the number of context lines for each match, default is
+Search for a regular expression in all agenda files and additionally
+in the files listed in @code{org-agenda-text-search-extra-files}. This
+uses the Emacs command @code{multi-occur}. A prefix argument can be used
+to specify the number of context lines for each match, default is
@enumerate
@item
@end enumerate
-@item @kbd{#} or @kbd{!}
+@item @kbd{#}
+@itemx @kbd{!}
Create a list of stuck projects (see @ref{Stuck projects}).
@item @kbd{<}
@kindex < @r{(Agenda dispatcher)}
Restrict an agenda command to the current buffer@footnote{For backward compatibility, you can also press @kbd{1} to
-restrict to the current buffer.}. After
-pressing @kbd{<}, you still need to press the character
+restrict to the current buffer.}. If
+narrowing is in effect restrict to the narrowed part of the buffer.
+After pressing @kbd{<}, you still need to press the character
selecting the command.
@item @kbd{< <}
@kindex < < @r{(Agenda dispatcher)}
-If there is an active region, restrict the following agenda
-command to the region. Otherwise, restrict it to the current
+If there is an active region, restrict the following agenda command
+to the region. Otherwise, restrict it to the current
subtree@footnote{For backward compatibility, you can also press @kbd{0} to
restrict to the current region/subtree.}. After pressing @kbd{< <}, you still need to
press the character selecting the command.
@@ -9065,16 +9029,15 @@ press the character selecting the command.
@kindex * @r{(Agenda dispatcher)}
@vindex org-agenda-sticky
@findex org-toggle-sticky-agenda
-Toggle sticky agenda views. By default, Org maintains only
-a single agenda buffer and rebuilds it each time you change the
-view, to make sure everything is always up to date. If you
-switch between views often and the build time bothers you, you
-can turn on sticky agenda buffers (make this the default by
-customizing the variable @code{org-agenda-sticky}). With sticky
-agendas, the dispatcher only switches to the selected view, you
-need to update it by hand with @kbd{r} or @kbd{g}. You
-can toggle sticky agenda view any time with
-@code{org-toggle-sticky-agenda}.
+Toggle sticky agenda views. By default, Org maintains only a single
+agenda buffer and rebuilds it each time you change the view, to make
+sure everything is always up to date. If you switch between views
+often and the build time bothers you, you can turn on sticky agenda
+buffers (make this the default by customizing the variable
+@code{org-agenda-sticky}). With sticky agendas, the dispatcher only
+switches to the selected view, you need to update it by hand with
+@kbd{r} or @kbd{g}. You can toggle sticky agenda view any
+time with @code{org-toggle-sticky-agenda}.
@end table
You can also define custom commands that are accessible through the
@@ -9116,8 +9079,8 @@ The agenda shows the entries for each day. With a numeric prefix
argument@footnote{For backward compatibility, the universal prefix argument
@kbd{C-u} causes all TODO entries to be listed before the agenda.
This feature is deprecated, use the dedicated TODO list, or a block
-agenda instead (see @ref{Block agenda}).}---like @kbd{C-u 2 1 M-x org-agenda a}---you
-may set the number of days to be displayed.
+agenda instead (see @ref{Block agenda}).}---like @kbd{C-u 2 1 M-x org-agenda a}---you may
+set the number of days to be displayed.
@end table
@vindex org-agenda-span
@@ -9168,13 +9131,13 @@ buffer, as well as the commands @kbd{S}, @kbd{M}, and
convert to other calendars, respectively. @kbd{c} can be used to
switch back and forth between calendar and agenda.
-If you are using the diary only for S-exp entries and holidays, it is
-faster to not use the above setting, but instead to copy or even move
-the entries into an Org file. Org mode evaluates diary-style sexp
-entries, and does it faster because there is no overhead for first
-creating the diary display. Note that the sexp entries must start at
-the left margin, no whitespace is allowed before them, as seen in the
-following segment of an Org file:@footnote{The variable @code{org-anniversary} used in the example is just
+If you are using the diary only for expression entries and holidays,
+it is faster to not use the above setting, but instead to copy or even
+move the entries into an Org file. Org mode evaluates diary-style
+expression entries, and does it faster because there is no overhead
+for first creating the diary display. Note that the expression
+entries must start at the left margin, no whitespace is allowed before
+them, as seen in the following segment of an Org file:@footnote{The variable @code{org-anniversary} used in the example is just
like @code{diary-anniversary}, but the argument order is always according
to ISO and therefore independent of the value of
@code{calendar-date-style}.}
@@ -9221,7 +9184,7 @@ which contains the date in the format @samp{YYYY-MM-DD} or @samp{MM-DD},
followed by a space and the class of the anniversary (@samp{birthday},
@samp{wedding}, or a format string). If you omit the class, it defaults to
@samp{birthday}. Here are a few examples, the header for the file
-@samp{org-bbdb.el} contains more detailed information.
+@samp{ol-bbdb.el} contains more detailed information.
@example
1973-06-22
@@ -9284,11 +9247,10 @@ collected into a single place.
@kindex t @r{(Agenda dispatcher)}
@findex org-todo-list
Show the global TODO list. This collects the TODO items from all
-agenda files (see @ref{Agenda Views}) into a single buffer. By
-default, this lists items with a state the is not a DONE state.
-The buffer is in @code{agenda-mode}, so there are commands to examine
-and manipulate the TODO entries directly from that buffer (see
-@ref{Agenda Commands}).
+agenda files (see @ref{Agenda Views}) into a single buffer. By default,
+this lists items with a state the is not a DONE state. The buffer
+is in Agenda mode, so there are commands to examine and manipulate
+the TODO entries directly from that buffer (see @ref{Agenda Commands}).
@item @kbd{M-x org-agenda T} (@code{org-todo-list})
@kindex T @r{(Agenda dispatcher)}
@@ -9298,19 +9260,19 @@ and manipulate the TODO entries directly from that buffer (see
Like the above, but allows selection of a specific TODO keyword.
You can also do this by specifying a prefix argument to
@kbd{t}. You are prompted for a keyword, and you may also
-specify several keywords by separating them with @samp{|} as the
-boolean OR operator. With a numeric prefix, the Nth keyword in
+specify several keywords by separating them with @samp{|} as the boolean
+OR operator. With a numeric prefix, the Nth keyword in
@code{org-todo-keywords} is selected.
@kindex r
The @kbd{r} key in the agenda buffer regenerates it, and you
can give a prefix argument to this command to change the selected
TODO keyword, for example @kbd{3 r}. If you often need
-a search for a specific keyword, define a custom command for it
-(see @ref{Agenda Dispatcher}).
+a search for a specific keyword, define a custom command for it (see
+@ref{Agenda Dispatcher}).
-Matching specific TODO keywords can also be done as part of
-a tags search (see @ref{Tag Searches}).
+Matching specific TODO keywords can also be done as part of a tags
+search (see @ref{Tag Searches}).
@end table
Remote editing of TODO items means that you can change the state of
@@ -9329,13 +9291,14 @@ it more compact:
@vindex org-agenda-todo-ignore-timestamp
@vindex org-agenda-todo-ignore-with-date
Some people view a TODO item that has been @emph{scheduled} for execution
-or have a @emph{deadline} (see @ref{Timestamps}) as
-no longer @emph{open}. Configure the variables
-@code{org-agenda-todo-ignore-scheduled},
-@code{org-agenda-todo-ignore-deadlines},
-@code{org-agenda-todo-ignore-timestamp} and/or
-@code{org-agenda-todo-ignore-with-date} to exclude such items from the
-global TODO list.
+or have a @emph{deadline} (see @ref{Timestamps}) as no longer @emph{open}.
+Configure the variables @code{org-agenda-todo-ignore-scheduled} to
+exclude some or all scheduled items from the global TODO list,
+@code{org-agenda-todo-ignore-deadlines} to exclude some or all items with
+a deadline set, @code{org-agenda-todo-ignore-timestamp} to exclude some
+or all items with an active timestamp other than a DEADLINE or
+a SCHEDULED timestamp and/or @code{org-agenda-todo-ignore-with-date} to
+exclude items with at least one active timestamp.
@item
@vindex org-agenda-todo-list-sublevels
@@ -9363,11 +9326,11 @@ sparse trees with @kbd{C-c / m}.
@item @kbd{M-x org-agenda m} (@code{org-tags-view})
@kindex m @r{(Agenda dispatcher)}
@findex org-tags-view
-Produce a list of all headlines that match a given set of tags.
-The command prompts for a selection criterion, which is a boolean
-logic expression with tags, like @samp{+work+urgent-withboss} or
-@samp{work|home} (see @ref{Tags}). If you often need a specific search,
-define a custom command for it (see @ref{Agenda Dispatcher}).
+Produce a list of all headlines that match a given set of tags. The
+command prompts for a selection criterion, which is a boolean logic
+expression with tags, like @samp{+work+urgent-withboss} or @samp{work|home}
+(see @ref{Tags}). If you often need a specific search, define a custom
+command for it (see @ref{Agenda Dispatcher}).
@item @kbd{M-x org-agenda M} (@code{org-tags-view})
@kindex M @r{(Agenda dispatcher)}
@@ -9377,10 +9340,9 @@ define a custom command for it (see @ref{Agenda Dispatcher}).
Like @kbd{m}, but only select headlines that are also TODO
items and force checking subitems (see the variable
@code{org-tags-match-list-sublevels}). To exclude scheduled/deadline
-items, see the variable
-@code{org-agenda-tags-todo-honor-ignore-options}. Matching specific
-TODO keywords together with a tags match is also possible, see
-@ref{Tag Searches}.
+items, see the variable @code{org-agenda-tags-todo-honor-ignore-options}.
+Matching specific TODO keywords together with a tags match is also
+possible, see @ref{Tag Searches}.
@end table
The commands available in the tags list are described in @ref{Agenda Commands}.
@@ -9397,16 +9359,16 @@ optional when @samp{+} or @samp{-} is present. Here are some examples, using
only tags.
@table @asis
-@item @code{+work-boss}
+@item @samp{+work-boss}
Select headlines tagged @samp{work}, but discard those also tagged
@samp{boss}.
-@item @code{work|laptop}
+@item @samp{work|laptop}
Selects lines tagged @samp{work} or @samp{laptop}.
-@item @code{work|laptop+night}
-Like before, but require the @samp{laptop} lines to be tagged
-also @samp{night}.
+@item @samp{work|laptop+night}
+Like before, but require the @samp{laptop} lines to be tagged also
+@samp{night}.
@end table
@cindex regular expressions, with tags search
@@ -9516,8 +9478,7 @@ Select @samp{work}-tagged TODO lines that are neither @samp{WAITING} nor
@samp{NEXT}.
@item @samp{work/!+WAITING|+NEXT}
-Select @samp{work}-tagged TODO lines that are either @samp{WAITING} or
-@samp{NEXT}.
+Select @samp{work}-tagged TODO lines that are either @samp{WAITING} or @samp{NEXT}.
@end table
@node Search view
@@ -9552,7 +9513,8 @@ necessary to turn on boolean search, other @samp{+} characters are
optional. For more details, see the docstring of the command
@code{org-search-view}.
-You can incrementally adjust a boolean search with the following keys
+You can incrementally and conveniently adjust a boolean search from
+the agenda search view with the following keys
@multitable @columnfractions 0.1 0.6
@item @kbd{[}
@@ -9590,8 +9552,8 @@ List projects that are stuck.
@item @kbd{M-x org-agenda !}
@kindex ! @r{(Agenda dispatcher)}
@vindex org-stuck-projects
-Customize the variable @code{org-stuck-projects} to define what
-a stuck project is and how to find it.
+Customize the variable @code{org-stuck-projects} to define what a stuck
+project is and how to find it.
@end table
You almost certainly need to configure this view before it works for
@@ -9641,7 +9603,7 @@ version of the outline headline associated with the item.
* Categories:: Not all tasks are equal.
* Time-of-day specifications:: How the agenda knows the time.
* Sorting of agenda items:: The order of things.
-* Filtering/limiting agenda times:: Dynamically narrow the agenda.
+* Filtering/limiting agenda items:: Dynamically narrow the agenda.
@end menu
@node Categories
@@ -9665,12 +9627,10 @@ If you would like to have a special category for a single entry or
a (sub)tree, give the entry a @samp{CATEGORY} property with the special
category you want to apply as the value.
-The display in the agenda buffer looks best if the category is not
-longer than 10 characters.
-
@vindex org-agenda-category-icon-alist
-You can set up icons for category by customizing the
-@code{org-agenda-category-icon-alist} variable.
+The display in the agenda buffer looks best if the category is not
+longer than 10 characters. You can set up icons for category by
+customizing the @code{org-agenda-category-icon-alist} variable.
@node Time-of-day specifications
@subsection Time-of-day specifications
@@ -9776,16 +9736,31 @@ Sorting can be customized using the variable
@code{org-agenda-sorting-strategy}, and may also include criteria based on
the estimated effort of an entry (see @ref{Effort Estimates}).
-@node Filtering/limiting agenda times
-@subsection Filtering/limiting agenda times
+@node Filtering/limiting agenda items
+@subsection Filtering/limiting agenda items
-Agenda built-in or customized commands are statically defined. Agenda
-filters and limits provide two ways of dynamically narrowing down the
-list of agenda entries: @emph{filters} and @emph{limits}. Filters only act on
-the display of the items, while limits take effect before the list of
-agenda entries is built. Filters are more often used interactively,
-while limits are mostly useful when defined as local variables within
-custom agenda commands.
+@vindex org-agenda-category-filter-preset
+@vindex org-agenda-tag-filter-preset
+@vindex org-agenda-effort-filter-preset
+@vindex org-agenda-regexp-filter-preset
+Agenda built-in or custom commands are statically defined. Agenda
+filters and limits allow to flexibly narrow down the list of agenda
+entries.
+
+@emph{Filters} only change the visibility of items, are very fast and are
+mostly used interactively@footnote{Custom agenda commands can preset a filter by binding one of
+the variables @code{org-agenda-tag-filter-preset},
+@code{org-agenda-category-filter-preset}, @code{org-agenda-effort-filter-preset}
+or @code{org-agenda-regexp-filter-preset} as an option. This filter is
+then applied to the view and persists as a basic filter through
+refreshes and more secondary filtering. The filter is a global
+property of the entire agenda view---in a block agenda, you should
+only set this in the global options section, not in the section of an
+individual block.}. You can switch quickly between
+different filters without having to recreate the agenda. @emph{Limits} on
+the other hand take effect before the agenda buffer is populated, so
+they are mostly useful when defined as local variables within custom
+agenda commands.
@anchor{Filtering in the agenda}
@subsubheading Filtering in the agenda
@@ -9798,91 +9773,45 @@ custom agenda commands.
@cindex effort filtering, in agenda
@cindex query editing, in agenda
+The general filtering command is @code{org-agenda-filter}, bound to
+@kbd{/}. Before we introduce it, we describe commands for
+individual filter types. All filtering commands handle prefix
+arguments in the same way: A single @kbd{C-u} prefix negates the
+filter, so it removes lines selected by the filter. A double prefix
+adds the new filter condition to the one(s) already in place, so
+filter elements are accumulated.
+
@table @asis
-@item @kbd{/} (@code{org-agenda-filter-by-tag})
+@item @kbd{\} (@code{org-agenda-filter-by-tag})
@findex org-agenda-filter-by-tag
-@vindex org-agenda-tag-filter-preset
-Filter the agenda view with respect to a tag and/or effort
-estimates. The difference between this and a custom agenda
-command is that filtering is very fast, so that you can switch
-quickly between different filters without having to recreate the
-agenda.@footnote{Custom commands can preset a filter by binding the variable
-@code{org-agenda-tag-filter-preset} as an option. This filter is then
-applied to the view and persists as a basic filter through refreshes
-and more secondary filtering. The filter is a global property of the
-entire agenda view---in a block agenda, you should only set this in
-the global options section, not in the section of an individual block.}
-
-You are prompted for a tag selection letter; @kbd{@key{SPC}} means
-any tag at all. Pressing @kbd{@key{TAB}} at that prompt offers
-completion to select a tag, including any tags that do not have
-a selection character. The command then hides all entries that
-do not contain or inherit this tag. When called with prefix
-argument, remove the entries that @emph{do} have the tag. A second
-@kbd{/} at the prompt turns off the filter and shows any
-hidden entries. Pressing @kbd{+} or @kbd{-} switches
-between filtering and excluding the next tag.
-
-@vindex org-agenda-auto-exclude-function
-Org also supports automatic, context-aware tag filtering. If the
-variable @code{org-agenda-auto-exclude-function} is set to
-a user-defined function, that function can decide which tags
-should be excluded from the agenda automatically. Once this is
-set, the @kbd{/} command then accepts @kbd{@key{RET}} as
-a sub-option key and runs the auto exclusion logic. For example,
-let's say you use a @samp{Net} tag to identify tasks which need
-network access, an @samp{Errand} tag for errands in town, and a @samp{Call}
-tag for making phone calls. You could auto-exclude these tags
-based on the availability of the Internet, and outside of
-business hours, with something like this:
-
-@lisp
-(defun org-my-auto-exclude-function (tag)
- (and (cond
- ((string= tag "Net")
- (/= 0 (call-process "/sbin/ping" nil nil nil
- "-c1" "-q" "-t1" "mail.gnu.org")))
- ((or (string= tag "Errand") (string= tag "Call"))
- (let ((hour (nth 2 (decode-time))))
- (or (< hour 8) (> hour 21)))))
- (concat "-" tag)))
-
-(setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
-@end lisp
+Filter the agenda view with respect to a tag. You are prompted for
+a tag selection letter; @kbd{@key{SPC}} means any tag at all.
+Pressing @kbd{@key{TAB}} at that prompt offers completion to select a
+tag, including any tags that do not have a selection character. The
+command then hides all entries that do not contain or inherit this
+tag. Pressing @kbd{+} or @kbd{-} at the prompt switches
+between filtering for and against the next tag. To clear the
+filter, press @kbd{\} twice (once to call the command again,
+and once at the prompt).
@item @kbd{<} (@code{org-agenda-filter-by-category})
@findex org-agenda-filter-by-category
-Filter the current agenda view with respect to the category of
-the item at point. Pressing @kbd{<} another time removes
-this filter. When called with a prefix argument exclude the
-category of the item at point from the agenda.
-
-@vindex org-agenda-category-filter-preset
-You can add a filter preset in custom agenda commands through the
-option @code{org-agenda-category-filter-preset}. See @ref{Setting options}.
-
-@item @kbd{^} (@code{org-agenda-filter-by-top-headline})
-@findex org-agenda-filter-by-top-headline
-Filter the current agenda view and only display the siblings and
-the parent headline of the one at point.
+Filter by category of the line at point, and show only entries with
+this category. When called with a prefix argument, hide all entries
+with the category at point. To clear the filter, call this command
+again by pressing @kbd{<}.
@item @kbd{=} (@code{org-agenda-filter-by-regexp})
@findex org-agenda-filter-by-regexp
Filter the agenda view by a regular expression: only show agenda
-entries matching the regular expression the user entered. When
-called with a prefix argument, it filters @emph{out} entries matching
-the regexp. Called in a regexp-filtered agenda view, remove the
-filter, unless there are two universal prefix arguments, in which
-case filters are cumulated.
-
-@vindex org-agenda-regexp-filter-preset
-You can add a filter preset in custom agenda commands through the
-option @code{org-agenda-regexp-filter-preset}. See @ref{Setting options}.
+entries matching the regular expression the user entered. To clear
+the filter, call the command again by pressing @kbd{=}.
@item @kbd{_} (@code{org-agenda-filter-by-effort})
@findex org-agenda-filter-by-effort
-Filter the agenda view with respect to effort estimates. You
-first need to set up allowed efforts globally, for example
+Filter the agenda view with respect to effort estimates, so select
+tasks that take the right amount of time. You first need to set up
+a list of efforts globally, for example
@lisp
(setq org-global-properties
@@ -9890,27 +9819,84 @@ first need to set up allowed efforts globally, for example
@end lisp
@vindex org-sort-agenda-noeffort-is-high
-You can then filter for an effort by first typing an operator,
-one of @kbd{<}, @kbd{>} and @kbd{=}, and then the
+You can then filter for an effort by first typing an operator, one
+of @kbd{<}, @kbd{>} and @kbd{=}, and then the
one-digit index of an effort estimate in your array of allowed
values, where @kbd{0} means the 10th value. The filter then
restricts to entries with effort smaller-or-equal, equal, or
larger-or-equal than the selected value. For application of the
-operator, entries without a defined effort are treated according
-to the value of @code{org-sort-agenda-noeffort-is-high}.
+operator, entries without a defined effort are treated according to
+the value of @code{org-sort-agenda-noeffort-is-high}. To clear the
+filter, press @kbd{_} twice (once to call the command again,
+and once at the first prompt).
-When called with a prefix argument, it removes entries matching
-the condition. With two universal prefix arguments, it clears
-effort filters, which can be accumulated.
+@item @kbd{^} (@code{org-agenda-filter-by-top-headline})
+@findex org-agenda-filter-by-top-headline
+Filter the current agenda view and only display items that fall
+under the same top-level headline as the current entry. To clear
+the filter, call this command again by pressing @kbd{^}.
-@vindex org-agenda-effort-filter-preset
-You can add a filter preset in custom agenda commands through the
-option @code{org-agenda-effort-filter-preset}. See @ref{Setting options}.
+@item @kbd{/} (@code{org-agenda-filter})
+@findex org-agenda-filter
+This is the unified interface to four of the five filter methods
+described above. At the prompt, specify different filter elements
+in a single string, with full completion support. For example,
+
+@example
++work-John+<0:10-/plot/
+@end example
+
+selects entries with category `work' and effort estimates below 10
+minutes, and deselects entries with tag `John' or matching the
+regexp `plot'. `+' can be left out if that does not lead to
+ambiguities. The sequence of elements is arbitrary. The filter
+syntax assumes that there is no overlap between categories and tags
+(tags will take priority). If you reply to the prompt with the
+empty string, all filtering is removed. If a filter is specified,
+it replaces all current filters. But if you call the command with a
+double prefix argument, or if you add an additional `+'
+(e.g. `++work') to the front of the string, the new filter elements
+are added to the active ones. A single prefix argument applies the
+entire filter in a negative sense.
@item @kbd{|} (@code{org-agenda-filter-remove-all})
Remove all filters in the current agenda view.
@end table
+@anchor{Computed tag filtering}
+@subsubheading Computed tag filtering
+
+@vindex org-agenda-auto-exclude-function
+If the variable @code{org-agenda-auto-exclude-function} is set to a
+user-defined function, that function can select tags that should be
+used as a tag filter when requested. The function will be called with
+lower-case versions of all tags represented in the current view. The
+function should the return @samp{"-tag"} if the filter should remove
+entries with that tag, @samp{"+tag"} if only entries with this tag should
+be kept, or @samp{nil} if that tag is irrelevant. For example, let's say
+you use a @samp{Net} tag to identify tasks which need network access, an
+@samp{Errand} tag for errands in town, and a @samp{Call} tag for making phone
+calls. You could auto-exclude these tags based on the availability of
+the Internet, and outside of business hours, with something like this:
+
+@lisp
+(defun org-my-auto-exclude-fn (tag)
+ (if (cond
+ ((string= tag "net")
+ (/= 0 (call-process "/sbin/ping" nil nil nil
+ "-c1" "-q" "-t1" "mail.gnu.org")))
+ ((member tag '("errand" "call"))
+ (let ((hr (nth 2 (decode-time))))
+ (or (< hr 8) (> hr 21)))))
+ (concat "-" tag)))
+
+(setq org-agenda-auto-exclude-function 'org-my-auto-exclude-fn)
+@end lisp
+
+You can apply this self-adapting filter by using a double prefix
+argument to @code{org-agenda-filter}, i.e. press @kbd{C-u C-u /}, or
+by pressing @kbd{@key{RET}} in @code{org-agenda-filter-by-tag}.
+
@anchor{Setting limits for the agenda}
@subsubheading Setting limits for the agenda
@@ -10029,27 +10015,27 @@ Go to the original location of the item and delete other windows.
@kindex F
@findex org-agenda-follow-mode
@vindex org-agenda-start-with-follow-mode
-Toggle Follow mode. In Follow mode, as you move point through
-the agenda buffer, the other window always shows the
-corresponding location in the Org file. The initial setting for
-this mode in new agenda buffers can be set with the variable
+Toggle Follow mode. In Follow mode, as you move point through the
+agenda buffer, the other window always shows the corresponding
+location in the Org file. The initial setting for this mode in new
+agenda buffers can be set with the variable
@code{org-agenda-start-with-follow-mode}.
@item @kbd{C-c C-x b} (@code{org-agenda-tree-to-indirect-buffer})
@kindex C-c C-x b
@findex org-agenda-tree-to-indirect-buffer
Display the entire subtree of the current item in an indirect
-buffer. With a numeric prefix argument N, go up to level N and
-then take that tree. If N is negative, go up that many levels.
-With a @kbd{C-u} prefix, do not remove the previously used
-indirect buffer.
+buffer. With a numeric prefix argument N, go up to level N and then
+take that tree. If N is negative, go up that many levels. With
+a @kbd{C-u} prefix, do not remove the previously used indirect
+buffer.
@item @kbd{C-c C-o} (@code{org-agenda-open-link})
@kindex C-c C-o
@findex org-agenda-open-link
-Follow a link in the entry. This offers a selection of any links
-in the text belonging to the referenced Org node. If there is
-only one link, follow it without a selection prompt.
+Follow a link in the entry. This offers a selection of any links in
+the text belonging to the referenced Org node. If there is only one
+link, follow it without a selection prompt.
@end table
@anchor{Change display}
@@ -10075,46 +10061,44 @@ Delete other windows.
Switch to day view. When switching to day view, this setting
becomes the default for subsequent agenda refreshes. A numeric
prefix argument may be used to jump directly to a specific day of
-the year. For example, @kbd{32 d} jumps to February 1st.
-When setting day view, a year may be encoded in the prefix
-argument as well. For example, @kbd{200712 d} jumps to
-January 12, 2007. If such a year specification has only one or
-two digits, it is expanded into one of the 30 next years or the
-last 69 years.
+the year. For example, @kbd{32 d} jumps to February 1st. When
+setting day view, a year may be encoded in the prefix argument as
+well. For example, @kbd{200712 d} jumps to January 12, 2007.
+If such a year specification has only one or two digits, it is
+expanded into one of the 30 next years or the last 69 years.
@item @kbd{v w} or short @kbd{w} (@code{org-agenda-week-view})
@kindex v w
@kindex w
@findex org-agenda-week-view
-Switch to week view. When switching week view, this setting
-becomes the default for subsequent agenda refreshes. A numeric
-prefix argument may be used to jump directly to a specific day of
-the ISO week. For example @kbd{9 w} to ISO week number 9.
-When setting week view, a year may be encoded in the prefix
-argument as well. For example, @kbd{200712 w} jumps to week
-12 in 2007. If such a year specification has only one or two
-digits, it is expanded into one of the 30 next years or the last
-69 years.
+Switch to week view. When switching week view, this setting becomes
+the default for subsequent agenda refreshes. A numeric prefix
+argument may be used to jump directly to a specific day of the ISO
+week. For example @kbd{9 w} to ISO week number 9. When
+setting week view, a year may be encoded in the prefix argument as
+well. For example, @kbd{200712 w} jumps to week 12 in 2007.
+If such a year specification has only one or two digits, it is
+expanded into one of the 30 next years or the last 69 years.
@item @kbd{v m} (@code{org-agenda-month-view})
@kindex v m
@findex org-agenda-month-view
-Switch to month view. Because month views are slow to create,
-they do not become the default for subsequent agenda refreshes.
-A numeric prefix argument may be used to jump directly to
-a specific day of the month. When setting month view, a year may
-be encoded in the prefix argument as well. For example,
-@kbd{200712 m} jumps to December, 2007. If such a year
-specification has only one or two digits, it is expanded into one
-of the 30 next years or the last 69 years.
+Switch to month view. Because month views are slow to create, they
+do not become the default for subsequent agenda refreshes.
+A numeric prefix argument may be used to jump directly to a specific
+day of the month. When setting month view, a year may be encoded in
+the prefix argument as well. For example, @kbd{200712 m} jumps
+to December, 2007. If such a year specification has only one or two
+digits, it is expanded into one of the 30 next years or the last 69
+years.
@item @kbd{v y} (@code{org-agenda-year-view})
@kindex v y
@findex org-agenda-year-view
-Switch to year view. Because year views are slow to create, they
-do not become the default for subsequent agenda refreshes.
-A numeric prefix argument may be used to jump directly to
-a specific day of the year.
+Switch to year view. Because year views are slow to create, they do
+not become the default for subsequent agenda refreshes. A numeric
+prefix argument may be used to jump directly to a specific day of
+the year.
@item @kbd{v @key{SPC}} (@code{org-agenda-reset-view})
@kindex v SPC
@@ -10126,8 +10110,8 @@ Reset the current view to @code{org-agenda-span}.
@kindex f
@findex org-agenda-later
Go forward in time to display the span following the current one.
-For example, if the display covers a week, switch to the
-following week. With a prefix argument, repeat that many times.
+For example, if the display covers a week, switch to the following
+week. With a prefix argument, repeat that many times.
@item @kbd{b} (@code{org-agenda-earlier})
@kindex b
@@ -10161,14 +10145,15 @@ Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
@findex org-agenda-log-mode
@vindex org-log-done
@vindex org-agenda-log-mode-items
-Toggle Logbook mode. In Logbook mode, entries that were marked
-DONE while logging was on (see the variable @code{org-log-done}) are
-shown in the agenda, as are entries that have been clocked on
-that day. You can configure the entry types that should be
-included in log mode using the variable
-@code{org-agenda-log-mode-items}. When called with a @kbd{C-u}
-prefix, show all possible logbook entries, including state
-changes. When called with two prefix arguments @kbd{C-u C-u}, show only logging information, nothing else. @kbd{v L} is equivalent to @kbd{C-u v l}.
+Toggle Logbook mode. In Logbook mode, entries that were marked as
+done while logging was on (see the variable @code{org-log-done}) are
+shown in the agenda, as are entries that have been clocked on that
+day. You can configure the entry types that should be included in
+log mode using the variable @code{org-agenda-log-mode-items}. When
+called with a @kbd{C-u} prefix argument, show all possible
+logbook entries, including state changes. When called with two
+prefix arguments @kbd{C-u C-u}, show only logging information,
+nothing else. @kbd{v L} is equivalent to @kbd{C-u v l}.
@item @kbd{v [} or short @kbd{[} (@code{org-agenda-manipulate-query-add})
@kindex v [
@@ -10195,25 +10180,26 @@ Toggle Archives mode. Include all archive files as well.
@vindex org-agenda-start-with-clockreport-mode
@vindex org-clock-report-include-clocking-task
Toggle Clockreport mode. In Clockreport mode, the daily/weekly
-agenda always shows a table with the clocked times for the time
-span and file scope covered by the current agenda view. The
-initial setting for this mode in new agenda buffers can be set
-with the variable @code{org-agenda-start-with-clockreport-mode}. By
-using a prefix argument when toggling this mode (i.e., @kbd{C-u R}), the clock table does not show contributions from entries
-that are hidden by agenda filtering@footnote{Only tags filtering is respected here, effort filtering is
-ignored.}. See also the
-variable @code{org-clock-report-include-clocking-task}.
+agenda always shows a table with the clocked times for the time span
+and file scope covered by the current agenda view. The initial
+setting for this mode in new agenda buffers can be set with the
+variable @code{org-agenda-start-with-clockreport-mode}. By using
+a prefix argument when toggling this mode (i.e., @kbd{C-u R}),
+the clock table does not show contributions from entries that are
+hidden by agenda filtering@footnote{Only tags filtering is respected here, effort filtering is
+ignored.}. See also the variable
+@code{org-clock-report-include-clocking-task}.
@item @kbd{v c}
@kindex v c
@vindex org-agenda-clock-consistency-checks
Show overlapping clock entries, clocking gaps, and other clocking
-problems in the current agenda range. You can then visit
-clocking lines and fix them manually. See the variable
+problems in the current agenda range. You can then visit clocking
+lines and fix them manually. See the variable
@code{org-agenda-clock-consistency-checks} for information on how to
-customize the definition of what constituted a clocking problem.
-To return to normal agenda display, press @kbd{l} to exit
-Logbook mode.
+customize the definition of what constituted a clocking problem. To
+return to normal agenda display, press @kbd{l} to exit Logbook
+mode.
@item @kbd{v E} or short @kbd{E} (@code{org-agenda-entry-text-mode})
@kindex v E
@@ -10221,12 +10207,12 @@ Logbook mode.
@findex org-agenda-entry-text-mode
@vindex org-agenda-start-with-entry-text-mode
@vindex org-agenda-entry-text-maxlines
-Toggle entry text mode. In entry text mode, a number of lines
-from the Org outline node referenced by an agenda line are
-displayed below the line. The maximum number of lines is given
-by the variable @code{org-agenda-entry-text-maxlines}. Calling this
-command with a numeric prefix argument temporarily modifies that
-number to the prefix value.
+Toggle entry text mode. In entry text mode, a number of lines from
+the Org outline node referenced by an agenda line are displayed
+below the line. The maximum number of lines is given by the
+variable @code{org-agenda-entry-text-maxlines}. Calling this command
+with a numeric prefix argument temporarily modifies that number to
+the prefix value.
@item @kbd{G} (@code{org-agenda-toggle-time-grid})
@kindex G
@@ -10240,11 +10226,11 @@ Toggle the time grid on and off. See also the variables
@kindex r
@kindex g
@findex org-agenda-redo
-Recreate the agenda buffer, for example to reflect the changes
-after modification of the timestamps of items with
-@kbd{S-@key{LEFT}} and @kbd{S-@key{RIGHT}}. When the
-buffer is the global TODO list, a prefix argument is interpreted
-to create a selective list for a specific TODO keyword.
+Recreate the agenda buffer, for example to reflect the changes after
+modification of the timestamps of items with @kbd{S-@key{LEFT}} and
+@kbd{S-@key{RIGHT}}. When the buffer is the global TODO list,
+a prefix argument is interpreted to create a selective list for
+a specific TODO keyword.
@item @kbd{C-x C-s} or short @kbd{s} (@code{org-save-all-org-buffers})
@kindex C-x C-s
@@ -10258,11 +10244,11 @@ locations of IDs.
@findex org-agenda-columns
@vindex org-columns-default-format
Invoke column view (see @ref{Column View}) in the agenda buffer. The
-column view format is taken from the entry at point, or, if there
-is no entry at point, from the first entry in the agenda view.
-So whatever the format for that entry would be in the original
-buffer (taken from a property, from a @samp{COLUMNS} keyword, or from
-the default variable @code{org-columns-default-format}) is used in the
+column view format is taken from the entry at point, or, if there is
+no entry at point, from the first entry in the agenda view. So
+whatever the format for that entry would be in the original buffer
+(taken from a property, from a @samp{COLUMNS} keyword, or from the
+default variable @code{org-columns-default-format}) is used in the
agenda.
@item @kbd{C-c C-x >} (@code{org-agenda-remove-restriction-lock})
@@ -10301,14 +10287,16 @@ Digit argument.
@findex org-agenda-undo
@cindex undoing remote-editing events
@cindex remote editing, undo
-Undo a change due to a remote editing command. The change is
-undone both in the agenda buffer and in the remote buffer.
+Undo a change due to a remote editing command. The change is undone
+both in the agenda buffer and in the remote buffer.
@item @kbd{t} (@code{org-agenda-todo})
@kindex t
@findex org-agenda-todo
Change the TODO state of the item, both in the agenda and in the
-original Org file.
+original Org file. A prefix arg is passed through to the @code{org-todo}
+command, so for example a @kbd{C-u} prefix are will trigger
+taking a note to document the state change.
@item @kbd{C-S-@key{RIGHT}} (@code{org-agenda-todo-nextset})
@kindex C-S-RIGHT
@@ -10324,9 +10312,9 @@ Switch to the previous set of TODO keywords.
@findex org-agenda-kill
@vindex org-agenda-confirm-kill
Delete the current agenda item along with the entire subtree
-belonging to it in the original Org file. If the text to be
-deleted remotely is longer than one line, the kill needs to be
-confirmed by the user. See variable @code{org-agenda-confirm-kill}.
+belonging to it in the original Org file. If the text to be deleted
+remotely is longer than one line, the kill needs to be confirmed by
+the user. See variable @code{org-agenda-confirm-kill}.
@item @kbd{C-c C-w} (@code{org-agenda-refile})
@kindex C-c C-w
@@ -10351,8 +10339,8 @@ headline.
@item @kbd{C-c C-x A} (@code{org-agenda-archive-to-archive-sibling})
@kindex C-c C-x A
@findex org-agenda-archive-to-archive-sibling
-Move the subtree corresponding to the current entry to its
-@emph{archive sibling}.
+Move the subtree corresponding to the current entry to its @emph{archive
+sibling}.
@item @kbd{C-c C-x C-s} or short @kbd{$} (@code{org-agenda-archive})
@kindex C-c C-x C-s
@@ -10366,22 +10354,22 @@ likely a different file.
@kindex T
@findex org-agenda-show-tags
@vindex org-agenda-show-inherited-tags
-Show all tags associated with the current item. This is useful
-if you have turned off @code{org-agenda-show-inherited-tags}, but
-still want to see all tags of a headline occasionally.
+Show all tags associated with the current item. This is useful if
+you have turned off @code{org-agenda-show-inherited-tags}, but still want
+to see all tags of a headline occasionally.
@item @kbd{:} (@code{org-agenda-set-tags})
@kindex :
@findex org-agenda-set-tags
-Set tags for the current headline. If there is an active region
-in the agenda, change a tag for all headings in the region.
+Set tags for the current headline. If there is an active region in
+the agenda, change a tag for all headings in the region.
@item @kbd{,} (@code{org-agenda-priority})
@kindex ,
@findex org-agenda-priority
Set the priority for the current item. Org mode prompts for the
-priority character. If you reply with @kbd{@key{SPC}}, the
-priority cookie is removed from the entry.
+priority character. If you reply with @kbd{@key{SPC}}, the priority
+cookie is removed from the entry.
@item @kbd{P} (@code{org-agenda-show-priority})
@kindex P
@@ -10392,9 +10380,9 @@ Display weighted priority of current item.
@kindex +
@kindex S-UP
@findex org-agenda-priority-up
-Increase the priority of the current item. The priority is
-changed in the original buffer, but the agenda is not resorted.
-Use the @kbd{r} key for this.
+Increase the priority of the current item. The priority is changed
+in the original buffer, but the agenda is not resorted. Use the
+@kbd{r} key for this.
@item @kbd{-} or @kbd{S-@key{DOWN}} (@code{org-agenda-priority-down})
@kindex -
@@ -10407,9 +10395,9 @@ Decrease the priority of the current item.
@kindex C-c C-z
@findex org-agenda-add-note
@vindex org-log-into-drawer
-Add a note to the entry. This note is recorded, and then filed
-to the same location where state change notes are put. Depending
-on @code{org-log-into-drawer}, this may be inside a drawer.
+Add a note to the entry. This note is recorded, and then filed to
+the same location where state change notes are put. Depending on
+@code{org-log-into-drawer}, this may be inside a drawer.
@item @kbd{C-c C-a} (@code{org-attach})
@kindex C-c C-a
@@ -10432,15 +10420,16 @@ deadline.
@kindex S-RIGHT
@findex org-agenda-do-date-later
Change the timestamp associated with the current line by one day
-into the future. If the date is in the past, the first call to
-this command moves it to today. With a numeric prefix argument,
-change it by that many days. For example, @kbd{3 6 5 S-@key{RIGHT}} changes it by a year. With a @kbd{C-u}
-prefix, change the time by one hour. If you immediately repeat
-the command, it will continue to change hours even without the
-prefix argument. With a double @kbd{C-u C-u} prefix, do the
-same for changing minutes. The stamp is changed in the original
-Org file, but the change is not directly reflected in the agenda
-buffer. Use @kbd{r} or @kbd{g} to update the buffer.
+into the future. If the date is in the past, the first call to this
+command moves it to today. With a numeric prefix argument, change
+it by that many days. For example, @kbd{3 6 5 S-@key{RIGHT}} changes
+it by a year. With a @kbd{C-u} prefix, change the time by one
+hour. If you immediately repeat the command, it will continue to
+change hours even without the prefix argument. With a double
+@kbd{C-u C-u} prefix, do the same for changing minutes. The
+stamp is changed in the original Org file, but the change is not
+directly reflected in the agenda buffer. Use @kbd{r} or
+@kbd{g} to update the buffer.
@item @kbd{S-@key{LEFT}} (@code{org-agenda-do-date-earlier})
@kindex S-LEFT
@@ -10458,8 +10447,8 @@ Change the timestamp associated with the current line. The key
@item @kbd{I} (@code{org-agenda-clock-in})
@kindex I
@findex org-agenda-clock-in
-Start the clock on the current item. If a clock is running
-already, it is stopped first.
+Start the clock on the current item. If a clock is running already,
+it is stopped first.
@item @kbd{O} (@code{org-agenda-clock-out})
@kindex O
@@ -10482,8 +10471,8 @@ Jump to the running clock in another window.
@cindex capturing, from agenda
@vindex org-capture-use-agenda-date
Like @code{org-capture}, but use the date at point as the default date
-for the capture template. See @code{org-capture-use-agenda-date} to
-make this the default behavior of @code{org-capture}.
+for the capture template. See @code{org-capture-use-agenda-date} to make
+this the default behavior of @code{org-capture}.
@end table
@anchor{Bulk remote editing selected entries}
@@ -10498,8 +10487,8 @@ make this the default behavior of @code{org-capture}.
@findex org-agenda-bulk-mark
Mark the entry at point for bulk action. If there is an active
-region in the agenda, mark the entries in the region. With
-numeric prefix argument, mark that many successive entries.
+region in the agenda, mark the entries in the region. With numeric
+prefix argument, mark that many successive entries.
@item @kbd{*} (@code{org-agenda-bulk-mark-all})
@kindex *
@@ -10542,17 +10531,16 @@ Mark entries matching a regular expression for bulk action.
@findex org-agenda-bulk-action
@vindex org-agenda-bulk-persistent-marks
-Bulk action: act on all marked entries in the agenda. This
-prompts for another key to select the action to be applied. The
-prefix argument to @kbd{B} is passed through to the
-@kbd{s} and @kbd{d} commands, to bulk-remove these
-special timestamps. By default, marks are removed after the
-bulk. If you want them to persist, set
-@code{org-agenda-bulk-persistent-marks} to @code{t} or hit @kbd{p} at
-the prompt.
+Bulk action: act on all marked entries in the agenda. This prompts
+for another key to select the action to be applied. The prefix
+argument to @kbd{B} is passed through to the @kbd{s} and
+@kbd{d} commands, to bulk-remove these special timestamps. By
+default, marks are removed after the bulk. If you want them to
+persist, set @code{org-agenda-bulk-persistent-marks} to @code{t} or hit
+@kbd{p} at the prompt.
@table @asis
-@item @kbd{*}
+@item @kbd{p}
Toggle persistent marks.
@item @kbd{$}
@@ -10564,8 +10552,8 @@ siblings.
@item @kbd{t}
Change TODO state. This prompts for a single TODO keyword and
-changes the state of all selected entries, bypassing blocking
-and suppressing logging notes---but not timestamps.
+changes the state of all selected entries, bypassing blocking and
+suppressing logging notes---but not timestamps.
@item @kbd{+}
Add a tag to all selected entries.
@@ -10588,8 +10576,8 @@ bring them back.
@item @kbd{S}
Reschedule randomly into the coming N days. N is prompted for.
-With a prefix argument (@kbd{C-u B S}), scatter only
-across weekdays.
+With a prefix argument (@kbd{C-u B S}), scatter only across
+weekdays.
@item @kbd{f}
@vindex org-agenda-bulk-custom-functions
@@ -10619,39 +10607,37 @@ function below sets the @samp{CATEGORY} property of the entries to
@item @kbd{c} (@code{org-agenda-goto-calendar})
@kindex c
@findex org-agenda-goto-calendar
-Open the Emacs calendar and go to the date at point in the
-agenda.
+Open the Emacs calendar and go to the date at point in the agenda.
@item @kbd{c} (@code{org-calendar-goto-agenda})
@kindex c
@findex org-calendar-goto-agenda
-When in the calendar, compute and show the Org agenda for the
-date at point.
+When in the calendar, compute and show the Org agenda for the date
+at point.
@item @kbd{i} (@code{org-agenda-diary-entry})
@kindex i
@findex org-agenda-diary-entry
@cindex diary entries, creating from agenda
-Insert a new entry into the diary, using the date at point and
-(for block entries) the date at the mark. This adds to the Emacs
-diary file@footnote{This file is parsed for the agenda when
-@code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i} command
-in the calendar. The diary file pops up in another window, where
-you can add the entry.
+Insert a new entry into the diary, using the date at point and (for
+block entries) the date at the mark. This adds to the Emacs diary
+file@footnote{This file is parsed for the agenda when
+@code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i} command in the
+calendar. The diary file pops up in another window, where you can
+add the entry.
@vindex org-agenda-diary-file
If you configure @code{org-agenda-diary-file} to point to an Org file,
-Org creates entries in that file instead. Most entries are
-stored in a date-based outline tree that will later make it easy
-to archive appointments from previous months/years. The tree is
-built under an entry with a @samp{DATE_TREE} property, or else with
-years as top-level entries. Emacs prompts you for the entry
-text---if you specify it, the entry is created in
-@code{org-agenda-diary-file} without further interaction. If you
-directly press @kbd{@key{RET}} at the prompt without typing text,
-the target file is shown in another window for you to finish the
-entry there. See also the @kbd{k r} command.
+Org creates entries in that file instead. Most entries are stored
+in a date-based outline tree that will later make it easy to archive
+appointments from previous months/years. The tree is built under an
+entry with a @samp{DATE_TREE} property, or else with years as top-level
+entries. Emacs prompts you for the entry text---if you specify it,
+the entry is created in @code{org-agenda-diary-file} without further
+interaction. If you directly press @kbd{@key{RET}} at the prompt
+without typing text, the target file is shown in another window for
+you to finish the entry there. See also the @kbd{k r} command.
@item @kbd{M} (@code{org-agenda-phases-of-moon})
@kindex M
@@ -10757,10 +10743,9 @@ views:
("hk" tags "+home+Kim")))
@end lisp
-@noindent
The initial string in each entry defines the keys you have to press
after the dispatcher command in order to access the command. Usually
-this will be just a single character, but if you have many similar
+this is just a single character, but if you have many similar
commands, you can also define two-letter combinations where the first
character is the same in several combinations and serves as a prefix
key@footnote{You can provide a description for a prefix key by inserting
@@ -10773,12 +10758,11 @@ above will therefore define:
as a global search for agenda entries planned@footnote{@emph{Planned} means here that these entries have some planning
information attached to them, like a time-stamp, a scheduled or
a deadline string. See @code{org-agenda-entry-types} on how to set what
-planning information is taken into account.} this
-week/day.
+planning information is taken into account.} this week/day.
@item @kbd{y}
-as the same search, but only for entries with an hour
-specification like @samp{[h]h:mm}---think of them as appointments.
+as the same search, but only for entries with an hour specification
+like @samp{[h]h:mm}---think of them as appointments.
@item @kbd{w}
as a global search for TODO entries with @samp{WAITING} as the TODO
@@ -10805,10 +10789,9 @@ to create a sparse tree (again, current buffer only) with all
entries containing the word @samp{FIXME}.
@item @kbd{h}
-as a prefix command for a @samp{HOME} tags search where you have to
-press an additional key (@kbd{l}, @kbd{p} or
-@kbd{k}) to select a name (Lisa, Peter, or Kim) as
-additional tag to match.
+as a prefix command for a @samp{HOME} tags search where you have to press
+an additional key (@kbd{l}, @kbd{p} or @kbd{k}) to
+select a name (Lisa, Peter, or Kim) as additional tag to match.
@end table
Note that @code{*-tree} agenda views need to be called from an Org buffer
@@ -10944,7 +10927,7 @@ See the docstring of the variable for more information.
If you are away from your computer, it can be very useful to have
a printed version of some agenda views to carry around. Org mode can
export custom agenda views as plain text, HTML@footnote{For HTML you need to install Hrvoje Nikšić's @samp{htmlize.el}
-from @uref{https://github.com/hniksic/emacs-htmlize, Hrvoje Nikšić's repository}.}, Postscript,
+as an Emacs package from MELPA or from @uref{https://github.com/hniksic/emacs-htmlize, Hrvoje Nikšić's repository}.}, Postscript,
PDF@footnote{To create PDF output, the Ghostscript ps2pdf utility must be
installed on the system. Selecting a PDF file also creates the
postscript file.}, and iCalendar files. If you want to do this only
@@ -11007,8 +10990,8 @@ files in one step:
@item @kbd{e} (@code{org-store-agenda-views})
@kindex e @r{(Agenda dispatcher)}
@findex org-store-agenda-views
-Export all agenda views that have export file names associated
-with them.
+Export all agenda views that have export file names associated with
+them.
@end table
You can use the options section of the custom agenda commands to also
@@ -11099,17 +11082,19 @@ environment. This causes the following issues:
@enumerate
@item
+@vindex org-columns-default-format-for-agenda
@vindex org-columns-default-format
-@vindex org-overriding-columns-format
Org needs to make a decision which columns format to use. Since
the entries in the agenda are collected from different files, and
-different files may have different columns formats, this is
-a non-trivial problem. Org first checks if the variable
+different files may have different columns formats, this is a
+non-trivial problem. Org first checks if
@code{org-overriding-columns-format} is currently set, and if so, takes
-the format from there. Otherwise it takes the format associated
-with the first item in the agenda, or, if that item does not have
-a specific format (defined in a property, or in its file), it uses
-@code{org-columns-default-format}.
+the format from there. You should set this variable only in the
+@emph{local settings section} of a custom agenda command (see @ref{Custom Agenda Views}) to make it valid for that specific agenda view. If
+no such binding exists, it checks, in sequence,
+@code{org-columns-default-format-for-agenda}, the format associated with
+the first item in the agenda (through a property or a @samp{#+COLUMNS}
+setting in that buffer) and finally @code{org-columns-default-format}.
@item
@cindex @samp{CLOCKSUM}, special property
@@ -11169,6 +11154,7 @@ manual you are currently reading.
* Images:: Display an image.
* Captions:: Describe tables, images...
* Horizontal Rules:: Make a line.
+* Creating Footnotes:: Edit and read footnotes.
@end menu
@node Paragraphs
@@ -11232,8 +11218,8 @@ but not any simpler
You can make words @samp{*bold*}, @samp{/italic/}, @samp{_underlined_}, @samp{=verbatim=}
and @samp{~code~}, and, if you must, @samp{+strike-through+}. Text in the code
-and verbatim string is not processed for Org mode specific syntax; it
-is exported verbatim.
+and verbatim string is not processed for Org specific syntax; it is
+exported verbatim.
@vindex org-fontify-emphasized-text
To turn off fontification for marked up text, you can set
@@ -11314,8 +11300,8 @@ the following command@footnote{You can turn this on by default by setting the va
@findex org-toggle-pretty-entities
Toggle display of entities as UTF-8 characters. This does not
-change the buffer content which remains plain ASCII, but it
-overlays the UTF-8 character for display purposes only.
+change the buffer content which remains plain ASCII, but it overlays
+the UTF-8 character for display purposes only.
@end table
@cindex shy hyphen, special symbol
@@ -11435,16 +11421,18 @@ property of the former can be used to adjust the size of the preview
images.
@table @asis
-@item @kbd{C-c C-x C-l} (@code{org-toggle-latex-fragment})
+@item @kbd{C-c C-x C-l} (@code{org-latex-preview})
@kindex C-c C-x C-l
-@findex org-toggle-latex-fragment
-
-Produce a preview image of the @LaTeX{} fragment at point and
-overlay it over the source code. If there is no fragment at
-point, process all fragments in the current entry (between two
-headlines). When called with a prefix argument, process the
-entire subtree. When called with two prefix arguments, or when
-point is before the first headline, process the entire buffer.
+@findex org-latex-preview
+
+Produce a preview image of the @LaTeX{} fragment at point and overlay
+it over the source code. If there is no fragment at point, process
+all fragments in the current entry---between two headlines.
+
+When called with a single prefix argument, clear all images in the
+current entry. Two prefix arguments produce a preview image for all
+fragments in the buffer, while three of them clear all the images in
+that buffer.
@end table
@vindex org-startup-with-latex-preview
@@ -11471,9 +11459,10 @@ a major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
environments and math templates. Inside Org mode, you can make use of
some of the features of CD@LaTeX{} mode. You need to install
@samp{cdlatex.el} and @samp{texmathp.el} (the latter comes also with AUC@TeX{})
-from @uref{http://www.astro.uva.nl/~dominik/Tools/cdlatex}. Do not use
-CD@LaTeX{} mode itself under Org mode, but use the light version
-@code{org-cdlatex-mode} that comes as part of Org mode. Turn it on for the
+using @uref{https://melpa.org/, MELPA} with the @uref{https://www.gnu.org/software/emacs/manual/html_node/emacs/Package-Installation.html, Emacs packaging system} or alternatively from
+@uref{https://staff.fnwi.uva.nl/c.dominik/Tools/cdlatex/}. Do not use
+CD@LaTeX{} mode itself under Org mode, but use the special version Org
+CD@LaTeX{} minor mode that comes as part of Org. Turn it on for the
current buffer with @kbd{M-x org-cdlatex-mode}, or for all Org
files with
@@ -11496,15 +11485,15 @@ Insert an environment template.
The @kbd{@key{TAB}} key expands the template if point is inside
a @LaTeX{} fragment@footnote{Org mode has a method to test if point is inside such
a fragment, see the documentation of the function
-@code{org-inside-LaTeX-fragment-p}.}. For example, @kbd{@key{TAB}} expands
-@samp{fr} to @samp{\frac@{@}@{@}} and position point correctly inside the first
-brace. Another @kbd{@key{TAB}} gets you into the second brace.
+@code{org-inside-LaTeX-fragment-p}.}. For example, @kbd{@key{TAB}} expands @samp{fr}
+to @samp{\frac@{@}@{@}} and position point correctly inside the first brace.
+Another @kbd{@key{TAB}} gets you into the second brace.
Even outside fragments, @kbd{@key{TAB}} expands environment
-abbreviations at the beginning of a line. For example, if you
-write @samp{equ} at the beginning of a line and press @kbd{@key{TAB}},
-this abbreviation is expanded to an @samp{equation} environment. To
-get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
+abbreviations at the beginning of a line. For example, if you write
+@samp{equ} at the beginning of a line and press @kbd{@key{TAB}}, this
+abbreviation is expanded to an @samp{equation} environment. To get
+a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
@item @kbd{^}
@itemx @kbd{_}
@@ -11513,26 +11502,26 @@ get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
@vindex cdlatex-simplify-sub-super-scripts
Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment
-inserts these characters together with a pair of braces. If you
-use @kbd{@key{TAB}} to move out of the braces, and if the braces
-surround only a single character or macro, they are removed again
-(depending on the variable @code{cdlatex-simplify-sub-super-scripts}).
+inserts these characters together with a pair of braces. If you use
+@kbd{@key{TAB}} to move out of the braces, and if the braces surround
+only a single character or macro, they are removed again (depending
+on the variable @code{cdlatex-simplify-sub-super-scripts}).
@item @kbd{`}
@kindex `
-Pressing the backquote followed by a character inserts math
-macros, also outside @LaTeX{} fragments. If you wait more than 1.5
-seconds after the backquote, a help window pops up.
+Pressing the backquote followed by a character inserts math macros,
+also outside @LaTeX{} fragments. If you wait more than 1.5 seconds
+after the backquote, a help window pops up.
@item @kbd{'}
@kindex '
-Pressing the single-quote followed by another character modifies
-the symbol before point with an accent or a font. If you wait
-more than 1.5 seconds after the single-quote, a help window pops
-up. Character modification works only inside @LaTeX{} fragments;
-outside the quote is normal.
+Pressing the single-quote followed by another character modifies the
+symbol before point with an accent or a font. If you wait more than
+1.5 seconds after the single-quote, a help window pops up.
+Character modification works only inside @LaTeX{} fragments; outside
+the quote is normal.
@end table
@node Literal Examples
@@ -11553,11 +11542,22 @@ suited for source code and similar examples.
#+END_EXAMPLE
@end example
-Note that such blocks may be @emph{indented} in order to align nicely with
-indented text and in particular with plain list structure (see
-@ref{Plain Lists}). For simplicity when using small examples, you can
-also start the example lines with a colon followed by a space. There
-may also be additional whitespace before the colon:
+@cindex comma escape, in literal examples
+There is one limitation, however. You must insert a comma right
+before lines starting with either @samp{*}, @samp{,*}, @samp{#+} or @samp{,#+}, as those
+may be interpreted as outlines nodes or some other special syntax.
+Org transparently strips these additional commas whenever it accesses
+the contents of the block.
+
+@example
+#+BEGIN_EXAMPLE
+,* I am no real headline
+#+END_EXAMPLE
+@end example
+
+For simplicity when using small examples, you can also start the
+example lines with a colon followed by a space. There may also be
+additional whitespace before the colon:
@example
Here is an example
@@ -11633,8 +11633,12 @@ jumps to point-min.
@end example
@cindex indentation, in source blocks
-Finally, you can use @samp{-i} to preserve the indentation of a specific
-code block (see @ref{Editing Source Code}).
+Source code and examples may be @emph{indented} in order to align nicely
+with the surrounding text, and in particular with plain list structure
+(see @ref{Plain Lists}). By default, Org only retains the relative
+indentation between lines, e.g., when exporting the contents of the
+block. However, you can use the @samp{-i} switch to also preserve the
+global indentation, if it does matter. See @ref{Editing Source Code}.
@vindex org-coderef-label-format
If the syntax for the label format conflicts with the language syntax,
@@ -11659,17 +11663,14 @@ a shortcut is provided (see @ref{Structure Templates}).
@kindex C-c '
@findex org-edit-special
Edit the source code example at point in its native mode. This
-works by switching to a temporary buffer with the source code.
-You need to exit by pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*}, @samp{,*}, @samp{#+} and @samp{,#+} get
-a comma prepended, to keep them from being interpreted by Org as
-outline nodes or special syntax. These commas are stripped when
-editing with @kbd{C-c '}, and also before export.}. The
-edited version then replaces the old version in the Org buffer.
-Fixed-width regions---where each line starts with a colon
-followed by a space---are edited using @code{artist-mode}@footnote{You may select a different-mode with the variable
-@code{org-edit-fixed-width-region-mode}.} to
-allow creating ASCII drawings easily. Using this command in an
-empty line creates a new fixed-width region.
+works by switching to a temporary buffer with the source code. You
+need to exit by pressing @kbd{C-c '} again. The edited version
+then replaces the old version in the Org buffer. Fixed-width
+regions---where each line starts with a colon followed by
+a space---are edited using Artist mode@footnote{You may select a different mode with the variable
+@code{org-edit-fixed-width-region-mode}.} to allow creating
+ASCII drawings easily. Using this command in an empty line creates
+a new fixed-width region.
@end table
@cindex storing link, in a source code buffer
@@ -11705,7 +11706,6 @@ make sure that the link is on a line by itself and precede it with
[[./img/a.jpg]]
@end example
-@noindent
Such images can be displayed within the buffer with the following
command:
@@ -11757,6 +11757,102 @@ export back-end, those may or may not be handled.
A line consisting of only dashes, and at least 5 of them, is exported
as a horizontal line.
+@node Creating Footnotes
+@section Creating Footnotes
+
+@cindex footnotes
+
+A footnote is started by a footnote marker in square brackets in
+column 0, no indentation allowed. It ends at the next footnote
+definition, headline, or after two consecutive empty lines. The
+footnote reference is simply the marker in square brackets, inside
+text. Markers always start with @samp{fn:}. For example:
+
+@example
+The Org homepage[fn:1] now looks a lot better than it used to.
+...
+[fn:1] The link is: https://orgmode.org
+@end example
+
+Org mode extends the number-based syntax to @emph{named} footnotes and
+optional inline definition. Here are the valid references:
+
+@table @asis
+@item @samp{[fn:NAME]}
+A named footnote reference, where @var{NAME} is a unique
+label word, or, for simplicity of automatic creation, a number.
+
+@item @samp{[fn:: This is the inline definition of this footnote]}
+An anonymous footnote where the definition is given directly at the
+reference point.
+
+@item @samp{[fn:NAME: a definition]}
+An inline definition of a footnote, which also specifies a name for
+the note. Since Org allows multiple references to the same note,
+you can then use @samp{[fn:NAME]} to create additional references.
+@end table
+
+@vindex org-footnote-auto-label
+Footnote labels can be created automatically, or you can create names
+yourself. This is handled by the variable @code{org-footnote-auto-label}
+and its corresponding @samp{STARTUP} keywords. See the docstring of that
+variable for details.
+
+The following command handles footnotes:
+
+@table @asis
+@item @kbd{C-c C-x f}
+The footnote action command.
+
+@kindex C-c C-x f
+When point is on a footnote reference, jump to the definition. When
+it is at a definition, jump to the---first---reference.
+
+@vindex org-footnote-define-inline
+@vindex org-footnote-section
+Otherwise, create a new footnote. Depending on the variable
+@code{org-footnote-define-inline}@footnote{The corresponding in-buffer setting is: @samp{#+STARTUP: fninline}
+or @samp{#+STARTUP: nofninline}.}, the definition is placed right
+into the text as part of the reference, or separately into the
+location determined by the variable @code{org-footnote-section}.
+
+When this command is called with a prefix argument, a menu of
+additional options is offered:
+
+@multitable @columnfractions 0.1 0.9
+@item @kbd{s}
+@tab Sort the footnote definitions by reference sequence.
+@item @kbd{r}
+@tab Renumber the simple @samp{fn:N} footnotes.
+@item @kbd{S}
+@tab Short for first @kbd{r}, then @kbd{s} action.
+@item @kbd{n}
+@tab Rename all footnotes into a @samp{fn:1} @dots{} @samp{fn:n} sequence.
+@item @kbd{d}
+@tab Delete the footnote at point, including definition and references.
+@end multitable
+
+@vindex org-footnote-auto-adjust
+Depending on the variable @code{org-footnote-auto-adjust}@footnote{The corresponding in-buffer options are @samp{#+STARTUP: fnadjust}
+and @samp{#+STARTUP: nofnadjust}.},
+renumbering and sorting footnotes can be automatic after each
+insertion or deletion.
+
+@item @kbd{C-c C-c}
+@kindex C-c C-c
+If point is on a footnote reference, jump to the definition. If it
+is at the definition, jump back to the reference. When called at
+a footnote location with a prefix argument, offer the same menu as
+@kbd{C-c C-x f}.
+
+@item @kbd{C-c C-o} or @kbd{mouse-1/2}
+@kindex C-c C-o
+@kindex mouse-1
+@kindex mouse-2
+Footnote labels are also links to the corresponding definition or
+reference, and you can use the usual commands to follow these links.
+@end table
+
@node Exporting
@chapter Exporting
@@ -11820,7 +11916,7 @@ example, to load the Markdown back-end, add this to your Emacs config:
* Macro Replacement:: Use macros to create templates.
* Comment Lines:: What will not be exported.
* ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding.
-* Beamer Export::
+* Beamer Export:: Producing presentations and slides.
* HTML Export:: Exporting to HTML.
* @LaTeX{} Export:: Exporting to @LaTeX{} and processing to PDF.
* Markdown Export:: Exporting to Markdown.
@@ -11854,10 +11950,9 @@ the hierarchical menu, press @kbd{?}.
@kindex C-c C-e
@findex org-export
-Invokes the export dispatcher interface. The options show
-default settings. The @kbd{C-u} prefix argument preserves
-options from the previous export, including any sub-tree
-selections.
+Invokes the export dispatcher interface. The options show default
+settings. The @kbd{C-u} prefix argument preserves options from
+the previous export, including any sub-tree selections.
@end table
Org exports the entire buffer by default. If the Org buffer has an
@@ -11875,10 +11970,10 @@ Emacs process with a specially configured initialization file to
complete the exporting process in the background, without tying-up
Emacs. This is particularly useful when exporting long documents.
-Output from an asynchronous export is saved on the @emph{export
-stack}. To view this stack, call the export dispatcher with
-a double @kbd{C-u} prefix argument. If already in the
-export dispatcher menu, @kbd{&} displays the stack.
+Output from an asynchronous export is saved on the @emph{export stack}.
+To view this stack, call the export dispatcher with a double
+@kbd{C-u} prefix argument. If already in the export dispatcher
+menu, @kbd{&} displays the stack.
@vindex org-export-in-background
You can make asynchronous export the default by setting
@@ -11891,19 +11986,19 @@ by setting @code{org-export-async-init-file}.
@item @kbd{C-b}
@kindex C-c C-e C-b
-Toggle body-only export. Useful for excluding headers and
-footers in the export. Affects only those back-end formats that
-have sections like @samp{<head>...</head>} in HTML@.
+Toggle body-only export. Useful for excluding headers and footers
+in the export. Affects only those back-end formats that have
+sections like @samp{<head>...</head>} in HTML@.
@item @kbd{C-s}
@kindex C-c C-e C-s
Toggle sub-tree export. When turned on, Org exports only the
sub-tree starting from point position at the time the export
-dispatcher was invoked. Org uses the top heading of this
-sub-tree as the document's title. If point is not on a heading,
-Org uses the nearest enclosing header. If point is in the
-document preamble, Org signals an error and aborts export.
+dispatcher was invoked. Org uses the top heading of this sub-tree
+as the document's title. If point is not on a heading, Org uses the
+nearest enclosing header. If point is in the document preamble, Org
+signals an error and aborts export.
@vindex org-export-initial-scope
To make sub-tree export the default, customize the variable
@@ -11912,9 +12007,9 @@ To make sub-tree export the default, customize the variable
@item @kbd{C-v}
@kindex C-c C-e C-v
-Toggle visible-only export. This is useful for exporting only certain
-parts of an Org document by adjusting the visibility
-of particular headings.
+Toggle visible-only export. This is useful for exporting only
+certain parts of an Org document by adjusting the visibility of
+particular headings.
@end table
@node Export Settings
@@ -11972,8 +12067,8 @@ The email address (@code{user-mail-address}).
@vindex org-export-default-language
Language to use for translating certain strings
(@code{org-export-default-language}). With @samp{#+LANGUAGE: fr}, for
-example, Org translates @samp{Table of contents} to the French @samp{Table
- des matières}@footnote{For export to @LaTeX{} format---or @LaTeX{}-related formats such as
+example, Org translates @samp{Table of contents} to the French @samp{Table des
+ matières}@footnote{For export to @LaTeX{} format---or @LaTeX{}-related formats such as
Beamer---, the @samp{org-latex-package-alist} variable needs further
configuration. See @ref{@LaTeX{} specific export settings}.}.
@@ -11981,21 +12076,20 @@ configuration. See @ref{@LaTeX{} specific export settings}.}.
@cindex @samp{SELECT_TAGS}, keyword
@vindex org-export-select-tags
The default value is @samp{("export")}. When a tree is tagged with
-@samp{export} (@code{org-export-select-tags}), Org selects that tree and
-its sub-trees for export. Org excludes trees with @samp{noexport}
-tags, see below. When selectively exporting files with @samp{export}
-tags set, Org does not export any text that appears before the
-first headline.
+@samp{export} (@code{org-export-select-tags}), Org selects that tree and its
+sub-trees for export. Org excludes trees with @samp{noexport} tags, see
+below. When selectively exporting files with @samp{export} tags set, Org
+does not export any text that appears before the first headline.
@item @samp{EXCLUDE_TAGS}
@cindex @samp{EXCLUDE_TAGS}, keyword
@vindex org-export-exclude-tags
The default value is @samp{("noexport")}. When a tree is tagged with
-@samp{noexport} (@code{org-export-exclude-tags}), Org excludes that tree
-and its sub-trees from export. Entries tagged with @samp{noexport}
-are unconditionally excluded from the export, even if they have
-an @samp{export} tag. Even if a sub-tree is not exported, Org
-executes any code blocks contained there.
+@samp{noexport} (@code{org-export-exclude-tags}), Org excludes that tree and
+its sub-trees from export. Entries tagged with @samp{noexport} are
+unconditionally excluded from the export, even if they have an
+@samp{export} tag. Even if a sub-tree is not exported, Org executes any
+code blocks contained there.
@item @samp{TITLE}
@cindex @samp{TITLE}, keyword
@@ -12006,8 +12100,8 @@ lines.
@item @samp{EXPORT_FILE_NAME}
@cindex @samp{EXPORT_FILE_NAME}, keyword
The name of the output file to be generated. Otherwise, Org
-generates the file name based on the buffer name and the
-extension based on the back-end format.
+generates the file name based on the buffer name and the extension
+based on the back-end format.
@end table
The @samp{OPTIONS} keyword is a compact form. To configure multiple
@@ -12017,10 +12111,10 @@ following arguments.
@table @asis
@item @code{'}
@vindex org-export-with-smart-quotes
-Toggle smart quotes (@code{org-export-with-smart-quotes}). Depending
-on the language used, when activated, Org treats pairs of double
-quotes as primary quotes, pairs of single quotes as secondary
-quotes, and single quote marks as apostrophes.
+Toggle smart quotes (@code{org-export-with-smart-quotes}). Depending on
+the language used, when activated, Org treats pairs of double quotes
+as primary quotes, pairs of single quotes as secondary quotes, and
+single quote marks as apostrophes.
@item @code{*}
@vindex org-export-with-emphasize
@@ -12048,14 +12142,14 @@ Toggles whether to preserve line breaks
@item @code{^}
@vindex org-export-with-sub-superscripts
Toggle @TeX{}-like syntax for sub- and superscripts. If you write
-@samp{^:@{@}}, @samp{a_@{b@}} is interpreted, but the simple @samp{a_b} is left as
-it is (@code{org-export-with-sub-superscripts}).
+@samp{^:@{@}}, @samp{a_@{b@}} is interpreted, but the simple @samp{a_b} is left as it
+is (@code{org-export-with-sub-superscripts}).
@item @code{arch}
@vindex org-export-with-archived-trees
-Configure how archived trees are exported. When set to
-@code{headline}, the export process skips the contents and processes
-only the headlines (@code{org-export-with-archived-trees}).
+Configure how archived trees are exported. When set to @code{headline},
+the export process skips the contents and processes only the
+headlines (@code{org-export-with-archived-trees}).
@item @code{author}
@vindex org-export-with-author
@@ -12070,7 +12164,7 @@ link in the output (@code{org-export-with-broken-links}).
@item @code{c}
@vindex org-export-with-clocks
-Toggle inclusion of CLOCK keywords (@code{org-export-with-clocks}).
+Toggle inclusion of @samp{CLOCK} keywords (@code{org-export-with-clocks}).
@item @code{creator}
@vindex org-export-with-creator
@@ -12079,8 +12173,8 @@ Toggle inclusion of creator information in the exported file
@item @code{d}
@vindex org-export-with-drawers
-Toggles inclusion of drawers, or list of drawers to include, or
-list of drawers to exclude (@code{org-export-with-drawers}).
+Toggles inclusion of drawers, or list of drawers to include, or list
+of drawers to exclude (@code{org-export-with-drawers}).
@item @code{date}
@vindex org-export-with-date
@@ -12115,18 +12209,17 @@ Toggle inclusion of inlinetasks (@code{org-export-with-inlinetasks}).
@cindex @samp{UNNUMBERED}, property
Toggle section-numbers (@code{org-export-with-section-numbers}). When
set to number N, Org numbers only those headlines at level N or
-above. Set @samp{UNNUMBERED} property to non-@code{nil} to disable
-numbering of heading and subheadings entirely. Moreover, when
-the value is @samp{notoc} the headline, and all its children, do not
-appear in the table of contents either (see @ref{Table of Contents}).
+above. Set @samp{UNNUMBERED} property to non-@code{nil} to disable numbering
+of heading and subheadings entirely. Moreover, when the value is
+@samp{notoc} the headline, and all its children, do not appear in the
+table of contents either (see @ref{Table of Contents}).
@item @code{p}
@vindex org-export-with-planning
-Toggle export of planning information
-(@code{org-export-with-planning}). ``Planning information'' comes from
-lines located right after the headline and contain any
-combination of these cookies: @samp{SCHEDULED}, @samp{DEADLINE}, or
-@samp{CLOSED}.
+Toggle export of planning information (@code{org-export-with-planning}).
+``Planning information'' comes from lines located right after the
+headline and contain any combination of these cookies: @samp{SCHEDULED},
+@samp{DEADLINE}, or @samp{CLOSED}.
@item @code{pri}
@vindex org-export-with-priority
@@ -12151,13 +12244,13 @@ Toggle inclusion of tags, may also be @code{not-in-toc}
@item @code{tasks}
@vindex org-export-with-tasks
Toggle inclusion of tasks (TODO items); or @code{nil} to remove all
-tasks; or @code{todo} to remove DONE tasks; or list the keywords to
-keep (@code{org-export-with-tasks}).
+tasks; or @code{todo} to remove done tasks; or list the keywords to keep
+(@code{org-export-with-tasks}).
@item @code{tex}
@vindex org-export-with-latex
-@code{nil} does not export; @code{t} exports; @code{verbatim} keeps everything
-in verbatim (@code{org-export-with-latex}).
+@code{nil} does not export; @code{t} exports; @code{verbatim} keeps everything in
+verbatim (@code{org-export-with-latex}).
@item @code{timestamp}
@vindex org-export-time-stamp-file
@@ -12261,6 +12354,22 @@ file requires the inclusion of the titletoc package. Because of
compatibility issues, titletoc has to be loaded @emph{before} hyperref.
Customize the @code{org-latex-default-packages-alist} variable.
+The following example inserts a table of contents that links to the
+children of the specified target.
+
+@example
+* Target
+ :PROPERTIES:
+ :CUSTOM_ID: TargetSection
+ :END:
+** Heading A
+** Heading B
+* Another section
+#+TOC: headlines 1 :target #TargetSection
+@end example
+
+The @samp{:target} attribute is supported in HTML, Markdown, ODT, and ASCII export.
+
Use the @samp{TOC} keyword to generate list of tables---respectively, all
listings---with captions.
@@ -12360,8 +12469,7 @@ with the custom ID @samp{theory}, you can use
@end example
-The following command allows navigating back and forth to the included
-document:
+The following command allows navigating to the included document:
@table @asis
@item @kbd{C-c '} (@code{org-edit~special})
@@ -12446,9 +12554,9 @@ respectively, @samp{@{@{@{keyword(TITLE)@}@}@}}, @samp{@{@{@{keyword(AUTHOR)@}@}
@itemx @samp{@{@{@{date(FORMAT)@}@}@}}
@cindex @samp{date}, macro
This macro refers to the @samp{DATE} keyword. @var{FORMAT} is an
-optional argument to the @samp{date} macro that is used only if @samp{DATE}
-is a single timestamp. @var{FORMAT} should be a format
-string understood by @code{format-time-string}.
+optional argument to the @samp{date} macro that is used only if @samp{DATE} is
+a single timestamp. @var{FORMAT} should be a format string
+understood by @code{format-time-string}.
@item @samp{@{@{@{time(FORMAT)@}@}@}}
@itemx @samp{@{@{@{modification-time(FORMAT, VC)@}@}@}}
@@ -12456,10 +12564,10 @@ string understood by @code{format-time-string}.
@cindex @samp{modification-time}, macro
These macros refer to the document's date and time of export and
date and time of modification. @var{FORMAT} is a string
-understood by @code{format-time-string}. If the second argument to
-the @code{modification-time} macro is non-@code{nil}, Org uses @samp{vc.el} to
-retrieve the document's modification time from the version
-control system. Otherwise Org reads the file attributes.
+understood by @code{format-time-string}. If the second argument to the
+@code{modification-time} macro is non-@code{nil}, Org uses @samp{vc.el} to retrieve
+the document's modification time from the version control system.
+Otherwise Org reads the file attributes.
@item @samp{@{@{@{input-file@}@}@}}
@cindex @samp{input-file}, macro
@@ -12468,8 +12576,8 @@ This macro refers to the filename of the exported file.
@item @samp{@{@{@{property(PROPERTY-NAME)@}@}@}}
@itemx @samp{@{@{@{property(PROPERTY-NAME, SEARCH OPTION)@}@}@}}
@cindex @samp{property}, macro
-This macro returns the value of property @var{PROPERTY-NAME}
-in the current entry. If @var{SEARCH-OPTION} (see @ref{Search Options}) refers to a remote entry, use it instead.
+This macro returns the value of property @var{PROPERTY-NAME} in
+the current entry. If @var{SEARCH-OPTION} (see @ref{Search Options}) refers to a remote entry, use it instead.
@item @samp{@{@{@{n@}@}@}}
@itemx @samp{@{@{@{n(NAME)@}@}@}}
@@ -12477,14 +12585,14 @@ in the current entry. If @var{SEARCH-OPTION} (see @ref{Search Options}) refers
@cindex @samp{n}, macro
@cindex counter, macro
This macro implements custom counters by returning the number of
-times the macro has been expanded so far while exporting the
-buffer. You can create more than one counter using different
-@var{NAME} values. If @var{ACTION} is @samp{-}, previous
-value of the counter is held, i.e., the specified counter is not
-incremented. If the value is a number, the specified counter is
-set to that value. If it is any other non-empty string, the
-specified counter is reset to 1. You may leave @var{NAME}
-empty to reset the default counter.
+times the macro has been expanded so far while exporting the buffer.
+You can create more than one counter using different @var{NAME}
+values. If @var{ACTION} is @samp{-}, previous value of the counter
+is held, i.e., the specified counter is not incremented. If the
+value is a number, the specified counter is set to that value. If
+it is any other non-empty string, the specified counter is reset
+to 1. You may leave @var{NAME} empty to reset the default
+counter.
@end table
@cindex @samp{results}, macro
@@ -12564,20 +12672,18 @@ See the variable @code{org-ascii-links-to-notes} for details.
@kindex C-c C-e t u
@findex org-ascii-export-to-ascii
-Export as an ASCII file with a @samp{.txt} extension. For
-@samp{myfile.org}, Org exports to @samp{myfile.txt}, overwriting without
-warning. For @samp{myfile.txt}, Org exports to @samp{myfile.txt.txt} in
-order to prevent data loss.
-@end table
+Export as an ASCII file with a @samp{.txt} extension. For @samp{myfile.org},
+Org exports to @samp{myfile.txt}, overwriting without warning. For
+@samp{myfile.txt}, Org exports to @samp{myfile.txt.txt} in order to prevent
+data loss.
-@table @asis
@item @kbd{C-c C-e t A} (@code{org-ascii-export-to-ascii})
@itemx @kbd{C-c C-e t L}
@itemx @kbd{C-c C-e t U}
@kindex C-c C-e t A
@kindex C-c C-e t L
@kindex C-c C-e t U
-@findex org-ascii-export-to-ascii
+@findex org-ascii-export-as-ascii
Export to a temporary buffer. Does not create a file.
@end table
@@ -12684,8 +12790,8 @@ popular display formats.
@kindex C-c C-e l b
@findex org-beamer-export-to-latex
-Export as @LaTeX{} file with a @samp{.tex} extension. For @samp{myfile.org},
-Org exports to @samp{myfile.tex}, overwriting without warning.
+Export as @LaTeX{} file with a @samp{.tex} extension. For @samp{myfile.org}, Org
+exports to @samp{myfile.tex}, overwriting without warning.
@item @kbd{C-c C-e l B} (@code{org-beamer-export-as-latex})
@kindex C-c C-e l B
@@ -12717,8 +12823,8 @@ settings (see @ref{Export Settings}).
@item @samp{BEAMER_THEME}
@cindex @samp{BEAMER_THEME}, keyword
@vindex org-beamer-theme
-The Beamer layout theme (@code{org-beamer-theme}). Use square
-brackets for options. For example:
+The Beamer layout theme (@code{org-beamer-theme}). Use square brackets
+for options. For example:
@example
#+BEAMER_THEME: Rochester [height=20pt]
@@ -12738,8 +12844,8 @@ The Beamer outer theme.
@item @samp{BEAMER_HEADER}
@cindex @samp{BEAMER_HEADER}, keyword
-Arbitrary lines inserted in the preamble, just before the
-@samp{hyperref} settings.
+Arbitrary lines inserted in the preamble, just before the @samp{hyperref}
+settings.
@item @samp{DESCRIPTION}
@cindex @samp{DESCRIPTION}, keyword
@@ -12753,18 +12859,17 @@ configure typesetting of description as part of front matter.
@cindex @samp{KEYWORDS}, keyword
The keywords for defining the contents of the document. Use
multiple @samp{KEYWORDS} lines if necessary. By default, @samp{hyperref}
-inserts @samp{KEYWORDS} as metadata. Use
-@code{org-latex-hyperref-template} to configure document metadata.
-Use @code{org-latex-title-command} to configure typesetting of
-keywords as part of front matter.
+inserts @samp{KEYWORDS} as metadata. Use @code{org-latex-hyperref-template}
+to configure document metadata. Use @code{org-latex-title-command} to
+configure typesetting of keywords as part of front matter.
@item @samp{SUBTITLE}
@cindex @samp{SUBTITLE}, keyword
Document's subtitle. For typesetting, use
@code{org-beamer-subtitle-format} string. Use
-@code{org-latex-hyperref-template} to configure document metadata.
-Use @code{org-latex-title-command} to configure typesetting of
-subtitle as part of front matter.
+@code{org-latex-hyperref-template} to configure document metadata. Use
+@code{org-latex-title-command} to configure typesetting of subtitle as
+part of front matter.
@end table
@node Frames and Blocks in Beamer
@@ -12909,8 +13014,8 @@ a subgroup of $G$. Then the order of $H$ divides the order of $G$.
@node Editing support
@subsection Editing support
-The @code{org-beamer-mode} is a special minor mode for faster editing of
-Beamer documents.
+Org Beamer mode is a special minor mode for faster editing of Beamer
+documents.
@example
#+STARTUP: beamer
@@ -12922,9 +13027,8 @@ Beamer documents.
@kindex C-c C-b
@findex org-beamer-select-environment
-The @code{org-beamer-mode} provides this key for quicker selections in
-Beamer normal environments, and for selecting the @samp{BEAMER_COL}
-property.
+Org Beamer mode provides this key for quicker selections in Beamer
+normal environments, and for selecting the @samp{BEAMER_COL} property.
@end table
@node A Beamer example
@@ -12980,6 +13084,7 @@ compatible with XHTML 1.0 strict standard.
* HTML doctypes:: Exporting various (X)HTML flavors.
* HTML preamble and postamble:: Inserting preamble and postamble.
* Quoting HTML tags:: Using direct HTML in Org files.
+* Headlines in HTML export:: Formatting headlines.
* Links in HTML export:: Inserting and formatting links.
* Tables in HTML export:: How to modify the formatting of tables.
* Images in HTML export:: How to insert figures into HTML output.
@@ -12998,10 +13103,9 @@ compatible with XHTML 1.0 strict standard.
@kindex C-c C-e h o
@findex org-html-export-to-html
-Export as HTML file with a @samp{.html} extension. For @samp{myfile.org},
-Org exports to @samp{myfile.html}, overwriting without warning.
-@{@{@{kbd@{C-c C-e h o)@}@}@} exports to HTML and opens it in a web
-browser.
+Export as HTML file with a @samp{.html} extension. For @samp{myfile.org}, Org
+exports to @samp{myfile.html}, overwriting without warning. @{@{@{kbd@{C-c
+C-e h o)@}@}@} exports to HTML and opens it in a web browser.
@item @kbd{C-c C-e h H} (@code{org-html-export-as-html})
@kindex C-c C-e h H
@@ -13019,22 +13123,21 @@ settings described in @ref{Export Settings}.
@table @asis
@item @samp{DESCRIPTION}
@cindex @samp{DESCRIPTION}, keyword
-This is the document's description, which the HTML exporter
-inserts it as a HTML meta tag in the HTML file. For long
-descriptions, use multiple @samp{DESCRIPTION} lines. The exporter
-takes care of wrapping the lines properly.
+This is the document's description, which the HTML exporter inserts
+it as a HTML meta tag in the HTML file. For long descriptions, use
+multiple @samp{DESCRIPTION} lines. The exporter takes care of wrapping
+the lines properly.
@item @samp{HTML_DOCTYPE}
@cindex @samp{HTML_DOCTYPE}, keyword
@vindex org-html-doctype
-Specify the document type, for example: HTML5
-(@code{org-html-doctype}).
+Specify the document type, for example: HTML5 (@code{org-html-doctype}).
@item @samp{HTML_CONTAINER}
@cindex @samp{HTML_CONTAINER}, keyword
@vindex org-html-container-element
-Specify the HTML container, such as @samp{div}, for wrapping sections
-and elements (@code{org-html-container-element}).
+Specify the HTML container, such as @samp{div}, for wrapping sections and
+elements (@code{org-html-container-element}).
@item @samp{HTML_LINK_HOME}
@cindex @samp{HTML_LINK_HOME}, keyword
@@ -13044,14 +13147,13 @@ The URL for home link (@code{org-html-link-home}).
@item @samp{HTML_LINK_UP}
@cindex @samp{HTML_LINK_UP}, keyword
@vindex org-html-link-up
-The URL for the up link of exported HTML pages
-(@code{org-html-link-up}).
+The URL for the up link of exported HTML pages (@code{org-html-link-up}).
@item @samp{HTML_MATHJAX}
@cindex @samp{HTML_MATHJAX}, keyword
@vindex org-html-mathjax-options
-Options for MathJax (@code{org-html-mathjax-options}). MathJax is
-used to typeset @LaTeX{} math in HTML documents. See @ref{Math formatting in HTML export}, for an example.
+Options for MathJax (@code{org-html-mathjax-options}). MathJax is used
+to typeset @LaTeX{} math in HTML documents. See @ref{Math formatting in HTML export}, for an example.
@item @samp{HTML_HEAD}
@cindex @samp{HTML_HEAD}, keyword
@@ -13067,19 +13169,19 @@ More arbitrary lines for appending to the HTML document's head
@item @samp{KEYWORDS}
@cindex @samp{KEYWORDS}, keyword
-Keywords to describe the document's content. HTML exporter
-inserts these keywords as HTML meta tags. For long keywords, use
-multiple @samp{KEYWORDS} lines.
+Keywords to describe the document's content. HTML exporter inserts
+these keywords as HTML meta tags. For long keywords, use multiple
+@samp{KEYWORDS} lines.
@item @samp{LATEX_HEADER}
@cindex @samp{LATEX_HEADER}, keyword
-Arbitrary lines for appending to the preamble; HTML exporter
-appends when transcoding @LaTeX{} fragments to images (see @ref{Math formatting in HTML export}).
+Arbitrary lines for appending to the preamble; HTML exporter appends
+when transcoding @LaTeX{} fragments to images (see @ref{Math formatting in HTML export}).
@item @samp{SUBTITLE}
@cindex @samp{SUBTITLE}, keyword
-The document's subtitle. HTML exporter formats subtitle if
-document type is @samp{HTML5} and the CSS has a @samp{subtitle} class.
+The document's subtitle. HTML exporter formats subtitle if document
+type is @samp{HTML5} and the CSS has a @samp{subtitle} class.
@end table
Some of these keywords are explained in more detail in the following
@@ -13213,7 +13315,6 @@ insert a postamble if @code{org-html-postamble} is set to @code{nil}.
@subsection Quoting HTML tags
The HTML export back-end transforms @samp{<} and @samp{>} to @samp{&lt;} and @samp{&gt;}.
-
To include raw HTML code in the Org file so the HTML export back-end
can insert that HTML code in the output, use this inline syntax:
@samp{@@@@html:...@@@@}. For example:
@@ -13235,6 +13336,20 @@ For larger raw HTML code blocks, use these HTML export code blocks:
#+END_EXPORT
@end example
+@node Headlines in HTML export
+@subsection Headlines in HTML export
+
+@cindex headlines, in HTML export
+
+Headlines are exported to @samp{<h1>}, @samp{<h2>}, etc. Each headline gets the
+@samp{id} attribute from @samp{CUSTOM_ID} property, or a unique generated value,
+see @ref{Internal Links}.
+
+@vindex org-html-self-link-headlines
+When @code{org-html-self-link-headlines} is set to a non-@code{nil} value, the
+text of the headlines is also wrapped in @samp{<a>} tags. These tags have
+a @samp{href} attribute making the headlines link to themselves.
+
@node Links in HTML export
@subsection Links in HTML export
@@ -13567,10 +13682,12 @@ around them. Both of these approaches can avoid referring to an
external file.
@cindex @samp{HTML_CONTAINER_CLASS}, property
+@cindex @samp{HTML_HEADLINE_CLASS}, property
In order to add styles to a sub-tree, use the @samp{HTML_CONTAINER_CLASS}
property to assign a class to the tree. In order to specify CSS
styles for a particular headline, you can use the ID specified in
-a @samp{CUSTOM_ID} property.
+a @samp{CUSTOM_ID} property. You can also assign a specific class to
+a headline with the @samp{HTML_HEADLINE_CLASS} property.
Never change the @code{org-html-style-default} constant. Instead use other
simpler ways of customizing as described above.
@@ -13607,8 +13724,8 @@ options described below:
@table @asis
@item @samp{path:}
The path to the script. The default is to grab the script from
-@uref{https://orgmode.org/org-info.js}, but you might want to have
-a local copy and use a path like @samp{../scripts/org-info.js}.
+@uref{https://orgmode.org/org-info.js}, but you might want to have a local
+copy and use a path like @samp{../scripts/org-info.js}.
@item @samp{view:}
Initial view when the website is first shown. Possible values are:
@@ -13627,8 +13744,8 @@ Initial view when the website is first shown. Possible values are:
@item @samp{sdepth:}
Maximum headline level still considered as an independent section
for info and folding modes. The default is taken from
-@code{org-export-headline-levels}, i.e., the @samp{H} switch in @samp{OPTIONS}.
-If this is smaller than in @code{org-export-headline-levels}, each
+@code{org-export-headline-levels}, i.e., the @samp{H} switch in @samp{OPTIONS}. If
+this is smaller than in @code{org-export-headline-levels}, each
info/folding section can still contain child headlines.
@item @samp{toc:}
@@ -13636,13 +13753,12 @@ Should the table of contents @emph{initially} be visible? Even when
@samp{nil}, you can always get to the ``toc'' with @kbd{i}.
@item @samp{tdepth:}
-The depth of the table of contents. The defaults are taken from
-the variables @code{org-export-headline-levels} and
-@code{org-export-with-toc}.
+The depth of the table of contents. The defaults are taken from the
+variables @code{org-export-headline-levels} and @code{org-export-with-toc}.
@item @samp{ftoc:}
-Does the CSS of the page specify a fixed position for the ``toc''?
-If yes, the toc is displayed as a section.
+Does the CSS of the page specify a fixed position for the ``toc''? If
+yes, the toc is displayed as a section.
@item @samp{ltoc:}
Should there be short contents (children) in each section? Make
@@ -13653,8 +13769,8 @@ Headings are highlighted when the mouse is over them. Should be
@samp{underline} (default) or a background color like @samp{#cccccc}.
@item @samp{buttons:}
-Should view-toggle buttons be everywhere? When @samp{nil} (the
-default), only one such button is present.
+Should view-toggle buttons be everywhere? When @samp{nil} (the default),
+only one such button is present.
@end table
@vindex org-infojs-options
@@ -13706,9 +13822,8 @@ on blank lines to tell apart syntactical elements, such as paragraphs.
@item @kbd{C-c C-e l l} (@code{org-latex-export-to-latex})
@kindex C-c C-e l l
@findex org-latex-export-to-latex~
-Export to a @LaTeX{} file with a @samp{.tex} extension. For
-@samp{myfile.org}, Org exports to @samp{myfile.tex}, overwriting without
-warning.
+Export to a @LaTeX{} file with a @samp{.tex} extension. For @samp{myfile.org},
+Org exports to @samp{myfile.tex}, overwriting without warning.
@item @kbd{C-c C-e l L} (@code{org-latex-export-as-latex})
@kindex C-c C-e l L
@@ -13722,8 +13837,8 @@ Export as @LaTeX{} file and convert it to PDF file.
@item @kbd{C-c C-e l o}
@kindex C-c C-e l o
-Export as @LaTeX{} file and convert it to PDF, then open the PDF
-using the default viewer.
+Export as @LaTeX{} file and convert it to PDF, then open the PDF using
+the default viewer.
@item @kbd{M-x org-export-region-as-latex}
Convert the region to @LaTeX{} under the assumption that it was in Org
@@ -13762,22 +13877,21 @@ general options (see @ref{Export Settings}).
@cindex @samp{DESCRIPTION}, keyword
@vindex org-latex-hyperref-template
@vindex org-latex-title-command
-The document's description. The description along with author
-name, keywords, and related file metadata are inserted in the
-output file by the hyperref package. See
-@code{org-latex-hyperref-template} for customizing metadata items.
-See @code{org-latex-title-command} for typesetting description into
-the document's front matter. Use multiple @samp{DESCRIPTION} keywords
-for long descriptions.
+The document's description. The description along with author name,
+keywords, and related file metadata are inserted in the output file
+by the hyperref package. See @code{org-latex-hyperref-template} for
+customizing metadata items. See @code{org-latex-title-command} for
+typesetting description into the document's front matter. Use
+multiple @samp{DESCRIPTION} keywords for long descriptions.
@item @samp{LANGUAGE}
@cindex @samp{LANGUAGE}, keyword
-@vindex org-latex-package-alist
+@vindex org-latex-packages-alist
In order to be effective, the @samp{babel} or @samp{polyglossia}
packages---according to the @LaTeX{} compiler used---must be loaded
-with the appropriate language as argument. This can be
-accomplished by modifying the @code{org-latex-packages-alist} variable,
-e.g., with the following snippet:
+with the appropriate language as argument. This can be accomplished
+by modifying the @code{org-latex-packages-alist} variable, e.g., with the
+following snippet:
@lisp
(add-to-list 'org-latex-packages-alist
@@ -13790,12 +13904,12 @@ e.g., with the following snippet:
@cindex @samp{LATEX_CLASS}, keyword
@vindex org-latex-default-class
@vindex org-latex-classes
-This is @LaTeX{} document class, such as @emph{article}, @emph{report},
-@emph{book}, and so on, which contain predefined preamble and headline
-level mapping that the @LaTeX{} export back-end needs. The back-end
-reads the default class name from the @code{org-latex-default-class}
-variable. Org has @emph{article} as the default class. A valid
-default class must be an element of @code{org-latex-classes}.
+This is @LaTeX{} document class, such as @emph{article}, @emph{report}, @emph{book},
+and so on, which contain predefined preamble and headline level
+mapping that the @LaTeX{} export back-end needs. The back-end reads
+the default class name from the @code{org-latex-default-class} variable.
+Org has @emph{article} as the default class. A valid default class must
+be an element of @code{org-latex-classes}.
@item @samp{LATEX_CLASS_OPTIONS}
@cindex @samp{LATEX_CLASS_OPTIONS}, keyword
@@ -13822,12 +13936,11 @@ structure and order of the @LaTeX{} headers.
@vindex org-latex-hyperref-template
@vindex org-latex-title-command
The keywords for the document. The description along with author
-name, keywords, and related file metadata are inserted in the
-output file by the hyperref package. See
-@code{org-latex-hyperref-template} for customizing metadata items.
-See @code{org-latex-title-command} for typesetting description into
-the document's front matter. Use multiple @samp{KEYWORDS} lines if
-necessary.
+name, keywords, and related file metadata are inserted in the output
+file by the hyperref package. See @code{org-latex-hyperref-template} for
+customizing metadata items. See @code{org-latex-title-command} for
+typesetting description into the document's front matter. Use
+multiple @samp{KEYWORDS} lines if necessary.
@item @samp{SUBTITLE}
@cindex @samp{SUBTITLE}, keyword
@@ -13835,10 +13948,10 @@ necessary.
@vindex org-latex-subtitle-format
The document's subtitle. It is typeset as per
@code{org-latex-subtitle-format}. If @code{org-latex-subtitle-separate} is
-non-@code{nil}, it is typed as part of the @code{\title} macro. See
-@code{org-latex-hyperref-template} for customizing metadata items.
-See @code{org-latex-title-command} for typesetting description
-into the document's front matter.
+non-@code{nil}, it is typed outside of the @code{\title} macro. See
+@code{org-latex-hyperref-template} for customizing metadata items. See
+@code{org-latex-title-command} for typesetting description into the
+document's front matter.
@end table
The following sections have further details.
@@ -13955,53 +14068,50 @@ include:
@table @asis
@item @samp{:mode}
@vindex org-latex-default-table-mode
-The @LaTeX{} export back-end wraps the table differently depending
-on the mode for accurate rendering of math symbols. Mode is
-either @samp{table}, @samp{math}, @samp{inline-math} or @samp{verbatim}.
+The @LaTeX{} export back-end wraps the table differently depending on
+the mode for accurate rendering of math symbols. Mode is either
+@samp{table}, @samp{math}, @samp{inline-math} or @samp{verbatim}.
For @samp{math} or @samp{inline-math} mode, @LaTeX{} export back-end wraps the
-table in a math environment, but every cell in it is exported
-as-is. The @LaTeX{} export back-end determines the default mode
-from @code{org-latex-default-table-mode}. The @LaTeX{} export back-end
-merges contiguous tables in the same mode into a single
-environment.
+table in a math environment, but every cell in it is exported as-is.
+The @LaTeX{} export back-end determines the default mode from
+@code{org-latex-default-table-mode}. The @LaTeX{} export back-end merges
+contiguous tables in the same mode into a single environment.
@item @samp{:environment}
@vindex org-latex-default-table-environment
Set the default @LaTeX{} table environment for the @LaTeX{} export
back-end to use when exporting Org tables. Common @LaTeX{} table
environments are provided by these packages: tabularx, longtable,
-array, tabu, and bmatrix. For packages, such as tabularx and
-tabu, or any newer replacements, include them in the
-@code{org-latex-packages-alist} variable so the @LaTeX{} export back-end
-can insert the appropriate load package headers in the converted
-@LaTeX{} file. Look in the docstring for the
-@code{org-latex-packages-alist} variable for configuring these
-packages for @LaTeX{} snippet previews, if any.
+array, tabu, and bmatrix. For packages, such as tabularx and tabu,
+or any newer replacements, include them in the
+@code{org-latex-packages-alist} variable so the @LaTeX{} export back-end can
+insert the appropriate load package headers in the converted @LaTeX{}
+file. Look in the docstring for the @code{org-latex-packages-alist}
+variable for configuring these packages for @LaTeX{} snippet previews,
+if any.
@item @samp{:caption}
Use @samp{CAPTION} keyword to set a simple caption for a table (see
@ref{Captions}). For custom captions, use @samp{:caption} attribute, which
-accepts raw @LaTeX{} code. @samp{:caption} value overrides @samp{CAPTION}
-value.
+accepts raw @LaTeX{} code. @samp{:caption} value overrides @samp{CAPTION} value.
@item @samp{:float}
@itemx @samp{:placement}
-The table environments by default are not floats in @LaTeX{}. To
-make them floating objects use @samp{:float} with one of the following
+The table environments by default are not floats in @LaTeX{}. To make
+them floating objects use @samp{:float} with one of the following
options: @samp{sideways}, @samp{multicolumn}, @samp{t}, and @samp{nil}.
@LaTeX{} floats can also have additional layout @samp{:placement}
attributes. These are the usual @samp{[h t b p ! H]} permissions
specified in square brackets. Note that for @samp{:float sideways}
-tables, the @LaTeX{} export back-end ignores @samp{:placement}
-attributes.
+tables, the @LaTeX{} export back-end ignores @samp{:placement} attributes.
@item @samp{:align}
@itemx @samp{:font}
@itemx @samp{:width}
-The @LaTeX{} export back-end uses these attributes for regular
-tables to set their alignments, fonts, and widths.
+The @LaTeX{} export back-end uses these attributes for regular tables
+to set their alignments, fonts, and widths.
@item @samp{:spread}
When @samp{:spread} is non-@code{nil}, the @LaTeX{} export back-end spreads or
@@ -14015,21 +14125,21 @@ environments. @samp{:spread} has no effect if @samp{:width} is not set.
@vindex org-latex-tables-centered
All three commands are toggles. @samp{:booktabs} brings in modern
typesetting enhancements to regular tables. The booktabs package
-has to be loaded through @code{org-latex-packages-alist}. @samp{:center}
-is for centering the table. @samp{:rmlines} removes all but the very
-first horizontal line made of ASCII characters from ``table.el''
-tables only.
+has to be loaded through @code{org-latex-packages-alist}. @samp{:center} is
+for centering the table. @samp{:rmlines} removes all but the very first
+horizontal line made of ASCII characters from ``table.el'' tables
+only.
@item @samp{:math-prefix}
@itemx @samp{:math-suffix}
@itemx @samp{:math-arguments}
The @LaTeX{} export back-end inserts @samp{:math-prefix} string value in
a math environment before the table. The @LaTeX{} export back-end
-inserts @samp{:math-suffix} string value in a math environment after
-the table. The @LaTeX{} export back-end inserts @samp{:math-arguments}
-string value between the macro name and the table's contents.
-@samp{:math-arguments} comes in use for matrix macros that require
-more than one argument, such as @samp{qbordermatrix}.
+inserts @samp{:math-suffix} string value in a math environment after the
+table. The @LaTeX{} export back-end inserts @samp{:math-arguments} string
+value between the macro name and the table's contents.
+@samp{:math-arguments} comes in use for matrix macros that require more
+than one argument, such as @samp{qbordermatrix}.
@end table
@LaTeX{} table attributes help formatting tables for a wide range of
@@ -14073,14 +14183,16 @@ insert the image. But for TikZ (@uref{http://sourceforge.net/projects/pgf/})
images, the back-end uses an @code{\input} macro wrapped within
a @code{tikzpicture} environment.
-For specifying image @samp{:width}, @samp{:height}, and other @samp{:options}, use
-this syntax:
+For specifying image @samp{:width}, @samp{:height}, @samp{:scale} and other @samp{:options},
+use this syntax:
@example
#+ATTR_LATEX: :width 5cm :options angle=90
[[./img/sed-hr4049.pdf]]
@end example
+A @samp{:scale} attribute overrides both @samp{:width} and @samp{:height} attributes.
+
For custom commands for captions, use the @samp{:caption} attribute. It
overrides the default @samp{#+CAPTION} value:
@@ -14104,13 +14216,12 @@ To span the image across multiple columns of a page; the back-end
wraps the image in a @samp{figure*} environment.
@item @samp{wrap}
-For text to flow around the image on the right; the figure
-occupies the left half of the page.
+For text to flow around the image on the right; the figure occupies
+the left half of the page.
@item @samp{sideways}
-For a new page with the image sideways, rotated ninety degrees,
-in a @samp{sidewaysfigure} environment; overrides @samp{:placement}
-setting.
+For a new page with the image sideways, rotated ninety degrees, in
+a @samp{sidewaysfigure} environment; overrides @samp{:placement} setting.
@item @samp{nil}
To avoid a @samp{:float} even if using a caption.
@@ -14179,8 +14290,8 @@ objects through the attributes @samp{:float} and @samp{:options}. For @samp{:fl
@table @asis
@item @samp{t}
-Makes a source block float; by default floats any source block
-with a caption.
+Makes a source block float; by default floats any source block with
+a caption.
@item @samp{multicolumn}
Spans the source block across multiple columns of a page.
@@ -14320,8 +14431,8 @@ tables, to HTML@.
@item @kbd{C-c C-e m m} (@code{org-md-export-to-markdown})
@kindex C-c C-c m m
@findex org-md-export-to-markdown
-Export to a text file with Markdown syntax. For @samp{myfile.org},
-Org exports to @samp{myfile.md}, overwritten without warning.
+Export to a text file with Markdown syntax. For @samp{myfile.org}, Org
+exports to @samp{myfile.md}, overwritten without warning.
@item @kbd{C-c C-e m M} (@code{org-md-export-as-markdown})
@kindex C-c C-c m M
@@ -14396,22 +14507,22 @@ Export as OpenDocument Text file.
If @code{org-odt-preferred-output-format} is specified, the ODT export
back-end automatically converts the exported file to that format.
-For @samp{myfile.org}, Org exports to @samp{myfile.odt}, overwriting
-without warning. The ODT export back-end exports a region only
-if a region was active.
+For @samp{myfile.org}, Org exports to @samp{myfile.odt}, overwriting without
+warning. The ODT export back-end exports a region only if a region
+was active.
If the selected region is a single tree, the ODT export back-end
-makes the tree head the document title. Incidentally, @kbd{C-c @@} selects the current sub-tree. If the tree head entry has,
-or inherits, an @samp{EXPORT_FILE_NAME} property, the ODT export
-back-end uses that for file name.
+makes the tree head the document title. Incidentally, @kbd{C-c @@} selects the current sub-tree. If the tree head entry has, or
+inherits, an @samp{EXPORT_FILE_NAME} property, the ODT export back-end
+uses that for file name.
@item @kbd{C-c C-e o O}
@kindex C-c C-e o O
Export as an OpenDocument Text file and open the resulting file.
@vindex org-export-odt-preferred-output-format
-If @code{org-export-odt-preferred-output-format} is specified, open
-the converted file instead. See @ref{Automatically exporting to other formats}.
+If @code{org-export-odt-preferred-output-format} is specified, open the
+converted file instead. See @ref{Automatically exporting to other formats}.
@end table
@node ODT specific export settings
@@ -14425,21 +14536,21 @@ general options (see @ref{Export Settings}).
@item @samp{DESCRIPTION}
@cindex @samp{DESCRIPTION}, keyword
This is the document's description, which the ODT export back-end
-inserts as document metadata. For long descriptions, use
-multiple lines, prefixed with @samp{DESCRIPTION}.
+inserts as document metadata. For long descriptions, use multiple
+lines, prefixed with @samp{DESCRIPTION}.
@item @samp{KEYWORDS}
@cindex @samp{KEYWORDS}, keyword
-The keywords for the document. The ODT export back-end inserts
-the description along with author name, keywords, and related
-file metadata as metadata in the output file. Use multiple
-@samp{KEYWORDS} if necessary.
+The keywords for the document. The ODT export back-end inserts the
+description along with author name, keywords, and related file
+metadata as metadata in the output file. Use multiple @samp{KEYWORDS} if
+necessary.
@item @samp{ODT_STYLES_FILE}
@cindex @samp{ODT_STYLES_FILE}, keyword
@vindex org-odt-styles-file
-The ODT export back-end uses the @code{org-odt-styles-file} by
-default. See @ref{Applying custom styles} for details.
+The ODT export back-end uses the @code{org-odt-styles-file} by default.
+See @ref{Applying custom styles} for details.
@item @samp{SUBTITLE}
@cindex @samp{SUBTITLE}, keyword
@@ -14747,9 +14858,9 @@ a per-file basis.
With this option, @LaTeX{} fragments are first converted into MathML
-fragments using an external @LaTeX{}-to-MathML converter program.
-The resulting MathML fragments are then embedded as an
-OpenDocument Formula in the exported document.
+fragments using an external @LaTeX{}-to-MathML converter program. The
+resulting MathML fragments are then embedded as an OpenDocument
+Formula in the exported document.
@vindex org-latex-to-mathml-convert-command
@vindex org-latex-to-mathml-jar-file
@@ -14780,13 +14891,13 @@ converter, use the following commands:
@table @asis
@item @kbd{M-x org-export-as-odf}
-Convert a @LaTeX{} math snippet to an OpenDocument formula
-(@samp{.odf}) file.
+Convert a @LaTeX{} math snippet to an OpenDocument formula (@samp{.odf})
+file.
@item @kbd{M-x org-export-as-odf-and-open}
-Convert a @LaTeX{} math snippet to an OpenDocument formula
-(@samp{.odf}) file and open the formula file with the
-system-registered application.
+Convert a @LaTeX{} math snippet to an OpenDocument formula (@samp{.odf})
+file and open the formula file with the system-registered
+application.
@end table
@item PNG images
@@ -14918,21 +15029,20 @@ for unsupported converters or tweaking existing defaults.
@item Register the converter
@vindex org-export-odt-convert-processes
Add the name of the converter to the @code{org-odt-convert-processes}
-variable. Note that it also requires how the converter is
-invoked on the command line. See the variable's docstring for
-details.
+variable. Note that it also requires how the converter is invoked
+on the command line. See the variable's docstring for details.
@item Configure its capabilities
@vindex org-export-odt-convert-capabilities
Specify which formats the converter can handle by customizing the
variable @code{org-odt-convert-capabilities}. Use the entry for the
-default values in this variable for configuring the new
-converter. Also see its docstring for details.
+default values in this variable for configuring the new converter.
+Also see its docstring for details.
@item Choose the converter
@vindex org-export-odt-convert-process
-Select the newly added converter as the preferred one by
-customizing the option @code{org-odt-convert-process}.
+Select the newly added converter as the preferred one by customizing
+the option @code{org-odt-convert-process}.
@end table
@anchor{Working with OpenDocument style files}
@@ -14990,9 +15100,9 @@ factory styles used by the exporter.
@table @asis
@item @code{org-odt-styles-file}
-The ODT export back-end uses the file pointed to by this
-variable, such as @samp{styles.xml}, for the final output. It can
-take one of the following values:
+The ODT export back-end uses the file pointed to by this variable,
+such as @samp{styles.xml}, for the final output. It can take one of the
+following values:
@table @asis
@item @samp{FILE.xml}
@@ -15003,9 +15113,9 @@ Use the @samp{styles.xml} contained in the specified OpenDocument
Text or Template file
@item @samp{FILE.odt} or @samp{FILE.ott} and a subset of included files
-Use the @samp{styles.xml} contained in the specified OpenDocument
-Text or Template file. Additionally extract the specified
-member files and embed those within the final ODT document.
+Use the @samp{styles.xml} contained in the specified OpenDocument Text
+or Template file. Additionally extract the specified member files
+and embed those within the final ODT document.
Use this option if the @samp{styles.xml} file references additional
files like header and footer images.
@@ -15027,8 +15137,8 @@ the Org file. Such direct formatting is useful for one-off instances.
@table @asis
@item Embedding ODT tags as part of regular text
-Enclose OpenDocument syntax in @samp{@@@@odt:...@@@@} for inline markup.
-For example, to highlight a region of text do the following:
+Enclose OpenDocument syntax in @samp{@@@@odt:...@@@@} for inline markup. For
+example, to highlight a region of text do the following:
@example
@@@@odt:<text:span text:style-name="Highlight">This is highlighted
@@ -15047,8 +15157,8 @@ below:
@item Embedding a one-line OpenDocument XML
@cindex @samp{ODT}, keyword
-The ODT export back-end can read one-liner options with @samp{#+ODT:}
-in the Org file. For example, to force a page break:
+The ODT export back-end can read one-liner options with @samp{#+ODT:} in
+the Org file. For example, to force a page break:
@example
#+ODT: <text:p text:style-name="PageBreak"/>
@@ -15070,8 +15180,8 @@ The ODT export back-end can also read ODT export blocks for
OpenDocument XML@. Such blocks use the @samp{#+BEGIN_EXPORT odt}
@dots{} @samp{#+END_EXPORT} constructs.
-For example, to create a one-off paragraph that uses bold text,
-do the following:
+For example, to create a one-off paragraph that uses bold text, do
+the following:
@example
#+BEGIN_EXPORT odt
@@ -15259,8 +15369,7 @@ OpenDocument Relax NG Compact (RNC) syntax schema. But first the
@samp{.odt} files have to be decompressed using @samp{zip}. Note that @samp{.odt}
files are ZIP archives: @ref{File Archives,,,emacs,}. The contents of
ODT files are in XML@. For general help with validation---and
-schema-sensitive editing---of XML files:
-@ref{Introduction,,,nxml-mode,}.
+schema-sensitive editing---of XML files: @ref{Introduction,,,nxml-mode,}.
@vindex org-export-odt-schema-dir
Customize @code{org-odt-schema-dir} to point to a directory with
@@ -15317,17 +15426,16 @@ Export to an Org file, then open it.
@item @kbd{C-c C-e i t} (@code{org-texinfo-export-to-texinfo})
@kindex C-c C-e i t
@findex org-texinfo-export-to-texinfo
-Export as a Texinfo file with @samp{.texi} extension. For
-@samp{myfile.org}, Org exports to @samp{myfile.texi}, overwriting without
-warning.
+Export as a Texinfo file with @samp{.texi} extension. For @samp{myfile.org},
+Org exports to @samp{myfile.texi}, overwriting without warning.
@item @kbd{C-c C-e i i} (@code{org-texinfo-export-to-info})
@kindex C-c C-e i i
@findex org-texinfo-export-to-info
@vindex org-texinfo-info-process
-Export to Texinfo format first and then process it to make an
-Info file. To generate other formats, such as DocBook, customize
-the @code{org-texinfo-info-process} variable.
+Export to Texinfo format first and then process it to make an Info
+file. To generate other formats, such as DocBook, customize the
+@code{org-texinfo-info-process} variable.
@end table
@node Texinfo specific export settings
@@ -15353,8 +15461,8 @@ The Texinfo filename.
@item @samp{TEXINFO_CLASS}
@cindex @samp{TEXINFO_CLASS}, keyword
@vindex org-texinfo-default-class
-The default document class (@code{org-texinfo-default-class}), which
-must be a member of @code{org-texinfo-classes}.
+The default document class (@code{org-texinfo-default-class}), which must
+be a member of @code{org-texinfo-classes}.
@item @samp{TEXINFO_HEADER}
@cindex @samp{TEXINFO_HEADER}, keyword
@@ -15585,21 +15693,22 @@ This paragraph is preceded by...
@cindex @samp{ATTR_TEXINFO}, keyword
@cindex two-column tables, in Texinfo export
-
-@cindex table types, in Texinfo export
+@cindex table-type, Texinfo attribute
The Texinfo export back-end by default converts description lists in
the Org file using the default command @samp{@@table}, which results in
-a table with two columns. To change this behavior, specify
-@samp{:table-type} with @samp{ftable} or @samp{vtable} attributes. For more
-information, see @ref{Two-column Tables,,,texinfo,}.
+a table with two columns. To change this behavior, set @samp{:table-type}
+attribute to either @samp{ftable} or @samp{vtable} value. For more information,
+see @ref{Two-column Tables,,,texinfo,}.
@vindex org-texinfo-table-default-markup
+@cindex indic, Texinfo attribute
The Texinfo export back-end by default also applies a text highlight
based on the defaults stored in @code{org-texinfo-table-default-markup}.
To override the default highlight command, specify another one with
the @samp{:indic} attribute.
@cindex multiple items in Texinfo lists
+@cindex sep, Texinfo attribute
Org syntax is limited to one entry per list item. Nevertheless, the
Texinfo export back-end can split that entry according to any text
provided through the @samp{:sep} attribute. Each part then becomes a new
@@ -15623,6 +15732,20 @@ This is the common text for variables foo and bar.
@@end table
@end example
+@cindex lettered lists, in Texinfo export
+@cindex enum, Texinfo attribute
+Ordered lists are numbered when exported to Texinfo format. Such
+numbering obeys any counter (see @ref{Plain Lists}) in the first item of
+the list. The @samp{:enum} attribute also let you start the list at
+a specific number, or switch to a lettered list, as illustrated here
+
+@example
+#+ATTR_TEXINFO: :enum A
+1. Alpha
+2. Bravo
+3. Charlie
+@end example
+
@node Tables in Texinfo export
@subsection Tables in Texinfo export
@@ -15768,7 +15891,7 @@ This manual is for GNU Sample (version @{@{@{version@}@}@},
:APPENDIX: t
:END:
- #+TEXINFO: @@include fdl.texi
+ #+INCLUDE: fdl.org
* Index
:PROPERTIES:
@@ -15826,8 +15949,8 @@ connections.
@item @kbd{C-c C-e c f} (@code{org-icalendar-export-to-ics})
@kindex C-c C-e c f
@findex org-icalendar-export-to-ics
-Create iCalendar entries from the current Org buffer and store
-them in the same directory, using a file extension @samp{.ics}.
+Create iCalendar entries from the current Org buffer and store them
+in the same directory, using a file extension @samp{.ics}.
@item @kbd{C-c C-e c a} (@code{org-icalendar-export-agenda-files})
@kindex C-c C-e c a
@@ -15848,18 +15971,20 @@ Create a combined iCalendar file from Org files in
@cindex @samp{DESCRIPTION}, property
@cindex @samp{LOCATION}, property
@cindex @samp{TIMEZONE}, property
+@cindex @samp{CLASS}, property
The iCalendar export back-end includes @samp{SUMMARY}, @samp{DESCRIPTION},
-@samp{LOCATION} and @samp{TIMEZONE} properties from the Org entries when
-exporting. To force the back-end to inherit the @samp{LOCATION} and
-@samp{TIMEZONE} properties, configure the @code{org-use-property-inheritance}
-variable.
+@samp{LOCATION}, @samp{TIMEZONE} and @samp{CLASS} properties from the Org entries
+when exporting. To force the back-end to inherit the @samp{LOCATION},
+@samp{TIMEZONE} and @samp{CLASS} properties, configure the
+@code{org-use-property-inheritance} variable.
@vindex org-icalendar-include-body
-When Org entries do not have @samp{SUMMARY}, @samp{DESCRIPTION} and @samp{LOCATION}
-properties, the iCalendar export back-end derives the summary from the
-headline, and derives the description from the body of the Org item.
-The @code{org-icalendar-include-body} variable limits the maximum number of
-characters of the content are turned into its description.
+When Org entries do not have @samp{SUMMARY}, @samp{DESCRIPTION}, @samp{LOCATION} and
+@samp{CLASS} properties, the iCalendar export back-end derives the summary
+from the headline, and derives the description from the body of the
+Org item. The @code{org-icalendar-include-body} variable limits the
+maximum number of characters of the content are turned into its
+description.
The @samp{TIMEZONE} property can be used to specify a per-entry time zone,
and is applied to any entry with timestamp information. Time zones
@@ -15867,6 +15992,21 @@ should be specified as per the IANA time zone database format, e.g.,
@samp{Asia/Almaty}. Alternately, the property value can be @samp{UTC}, to force
UTC time for this entry only.
+The @samp{CLASS} property can be used to specify a per-entry visibility
+class or access restrictions, and is applied to any entry with class
+information. The iCalendar standard defines three visibility classes:
+@table @asis
+@item @samp{PUBLIC}
+The entry is publicly visible (this is the default).
+@item @samp{CONFIDENTIAL}
+Only a limited group of clients get access to the
+event.
+@item @samp{PRIVATE}
+The entry can be retrieved only by its owner.
+@end table
+The server should treat unknown class properties the same as
+@samp{PRIVATE}.
+
Exporting to iCalendar format depends in large part on the
capabilities of the destination application. Some are more lenient
than others. Consult the Org mode FAQ for advice on specific
@@ -16218,21 +16358,21 @@ Directory containing publishing source files.
@item @code{:publishing-directory}
Directory where output files are published. You can directly
-publish to a webserver using a file name syntax appropriate for
-the Emacs tramp package. Or you can publish to a local directory
-and use external tools to upload your website (see @ref{Uploading Files}).
+publish to a webserver using a file name syntax appropriate for the
+Emacs tramp package. Or you can publish to a local directory and
+use external tools to upload your website (see @ref{Uploading Files}).
@item @code{:preparation-function}
Function or list of functions to be called before starting the
-publishing process, for example, to run @samp{make} for updating files
-to be published. Each preparation function is called with
-a single argument, the project property list.
+publishing process, for example, to run @samp{make} for updating files to
+be published. Each preparation function is called with a single
+argument, the project property list.
@item @code{:completion-function}
-Function or list of functions called after finishing the
-publishing process, for example, to change permissions of the
-resulting files. Each completion function is called with
-a single argument, the project property list.
+Function or list of functions called after finishing the publishing
+process, for example, to change permissions of the resulting files.
+Each completion function is called with a single argument, the
+project property list.
@end table
@node Selecting files
@@ -16246,10 +16386,9 @@ following properties
@table @asis
@item @code{:base-extension}
-Extension---without the dot---of source files. This actually
-is a regular expression. Set this to the symbol @code{any} if you
-want to get all files in @code{:base-directory}, even without
-extension.
+Extension---without the dot---of source files. This actually is
+a regular expression. Set this to the symbol @code{any} if you want to
+get all files in @code{:base-directory}, even without extension.
@item @code{:exclude}
Regular expression to match file names that should not be published,
@@ -16526,6 +16665,8 @@ any, during publishing. Options set within a file (see @ref{Export Settings}),
@tab @code{org-html-preamble-format}
@item @code{:html-preamble}
@tab @code{org-html-preamble}
+@item @code{:html-self-link-headlines}
+@tab @code{org-html-self-link-headlines}
@item @code{:html-table-align-individual-field}
@tab @code{de@{org-html-table-align-individual-fields}
@item @code{:html-table-attributes}
@@ -16554,6 +16695,8 @@ any, during publishing. Options set within a file (see @ref{Export Settings}),
@tab @code{org-html-validation-link}
@item @code{:html-viewport}
@tab @code{org-html-viewport}
+@item @code{:html-wrap-src-lines}
+@tab @code{org-html-wrap-src-lines}
@item @code{:html-xml-declaration}
@tab @code{org-html-xml-declaration}
@end multitable
@@ -16770,58 +16913,54 @@ Title of sitemap page. Defaults to name of file.
@findex org-publish-find-date
@findex org-publish-find-property
@findex org-publish-find-title
-With this option one can tell how a site-map entry is formatted
-in the site-map. It is a function called with three arguments:
-the file or directory name relative to base directory of the
-project, the site-map style and the current project. It is
-expected to return a string. Default value turns file names into
-links and use document titles as descriptions. For specific
-formatting needs, one can use @code{org-publish-find-date},
-@code{org-publish-find-title} and @code{org-publish-find-property}, to
-retrieve additional information about published documents.
+With this option one can tell how a site-map entry is formatted in
+the site-map. It is a function called with three arguments: the
+file or directory name relative to base directory of the project,
+the site-map style and the current project. It is expected to
+return a string. Default value turns file names into links and use
+document titles as descriptions. For specific formatting needs, one
+can use @code{org-publish-find-date}, @code{org-publish-find-title} and
+@code{org-publish-find-property}, to retrieve additional information
+about published documents.
@item @code{:sitemap-function}
-Plug-in function to use for generation of the sitemap. It is
-called with two arguments: the title of the site-map and
-a representation of the files and directories involved in the
-project as a nested list, which can further be transformed using
-@code{org-list-to-generic}, @code{org-list-to-subtree} and alike. Default
-value generates a plain list of links to all files in the
-project.
+Plug-in function to use for generation of the sitemap. It is called
+with two arguments: the title of the site-map and a representation
+of the files and directories involved in the project as a nested
+list, which can further be transformed using @code{org-list-to-generic},
+@code{org-list-to-subtree} and alike. Default value generates a plain
+list of links to all files in the project.
@item @code{:sitemap-sort-folders}
Where folders should appear in the sitemap. Set this to @code{first}
-(default) or @code{last} to display folders first or last,
-respectively. When set to @code{ignore}, folders are ignored
-altogether. Any other value mixes files and folders. This
-variable has no effect when site-map style is @code{tree}.
+(default) or @code{last} to display folders first or last, respectively.
+When set to @code{ignore}, folders are ignored altogether. Any other
+value mixes files and folders. This variable has no effect when
+site-map style is @code{tree}.
@item @code{:sitemap-sort-files}
How the files are sorted in the site map. Set this to
@code{alphabetically} (default), @code{chronologically} or
@code{anti-chronologically}. @code{chronologically} sorts the files with
-older date first while @code{anti-chronologically} sorts the files
-with newer date first. @code{alphabetically} sorts the files
-alphabetically. The date of a file is retrieved with
-@code{org-publish-find-date}.
+older date first while @code{anti-chronologically} sorts the files with
+newer date first. @code{alphabetically} sorts the files alphabetically.
+The date of a file is retrieved with @code{org-publish-find-date}.
@item @code{:sitemap-ignore-case}
Should sorting be case-sensitive? Default @code{nil}.
@item @code{:sitemap-file-entry-format}
-With this option one can tell how a sitemap's entry is formatted
-in the sitemap. This is a format string with some escape
-sequences: @code{%t} stands for the title of the file, @code{%a} stands for
-the author of the file and @code{%d} stands for the date of the file.
-The date is retrieved with the @code{org-publish-find-date} function
-and formatted with @code{org-publish-sitemap-date-format}. Default
-@code{%t}.
+With this option one can tell how a sitemap's entry is formatted in
+the sitemap. This is a format string with some escape sequences:
+@code{%t} stands for the title of the file, @code{%a} stands for the author of
+the file and @code{%d} stands for the date of the file. The date is
+retrieved with the @code{org-publish-find-date} function and formatted
+with @code{org-publish-sitemap-date-format}. Default @code{%t}.
@item @code{:sitemap-date-format}
-Format string for the @code{format-time-string} function that tells
-how a sitemap entry's date is to be formatted. This property
-bypasses @code{org-publish-sitemap-date-format} which defaults to
-@code{%Y-%m-%d}.
+Format string for the @code{format-time-string} function that tells how
+a sitemap entry's date is to be formatted. This property bypasses
+@code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
@end table
@node Generating an index
@@ -16975,24 +17114,24 @@ place on the web server, and publishing images to it.
Once properly configured, Org can publish with the following commands:
@table @asis
-@item @kbd{C-c C-e X} (@code{org-publish})
-@kindex C-c C-e X
+@item @kbd{C-c C-e P x} (@code{org-publish})
+@kindex C-c C-e P x
@findex org-publish
-Prompt for a specific project and publish all files that belong
-to it.
+Prompt for a specific project and publish all files that belong to
+it.
-@item @kbd{C-c C-e P} (@code{org-publish-current-project})
-@kindex C-c C-e P
+@item @kbd{C-c C-e P p} (@code{org-publish-current-project})
+@kindex C-c C-e P p
@findex org-publish-current-project
Publish the project containing the current file.
-@item @kbd{C-c C-e F} (@code{org-publish-current-file})
-@kindex C-c C-e F
+@item @kbd{C-c C-e P f} (@code{org-publish-current-file})
+@kindex C-c C-e P f
@findex org-publish-current-file
Publish only the current file.
-@item @kbd{C-c C-e E} (@code{org-publish-all})
-@kindex C-c C-e E
+@item @kbd{C-c C-e P a} (@code{org-publish-all})
+@kindex C-c C-e P a
@findex org-publish-all
Publish every project.
@end table
@@ -17149,12 +17288,12 @@ src_<language>[<header arguments>]@{<body>@}
@table @asis
@item @samp{#+NAME: <name>}
Optional. Names the source block so it can be called, like
-a function, from other source blocks or inline code to evaluate
-or to capture the results. Code from other blocks, other files,
-and from table formulas (see @ref{The Spreadsheet}) can use the name
-to reference a source block. This naming serves the same purpose
-as naming Org tables. Org mode requires unique names. For
-duplicate names, Org mode's behavior is undefined.
+a function, from other source blocks or inline code to evaluate or
+to capture the results. Code from other blocks, other files, and
+from table formulas (see @ref{The Spreadsheet}) can use the name to
+reference a source block. This naming serves the same purpose as
+naming Org tables. Org mode requires unique names. For duplicate
+names, Org mode's behavior is undefined.
@item @samp{#+BEGIN_SRC} @dots{} @samp{#+END_SRC}
Mandatory. They mark the start and end of a block that Org
@@ -17163,9 +17302,8 @@ described next.
@item @samp{<language>}
@cindex language, in code blocks
-Mandatory. It is the identifier of the source code language in
-the block. See @ref{Languages}, for identifiers of supported
-languages.
+Mandatory. It is the identifier of the source code language in the
+block. See @ref{Languages}, for identifiers of supported languages.
@item @samp{<switches>}
@cindex switches, in code blocks
@@ -17176,9 +17314,9 @@ export, and format (see the discussion of switches in @ref{Literal Examples}).
@cindex header arguments, in code blocks
Optional. Heading arguments control many aspects of evaluation,
export and tangling of code blocks (see @ref{Using Header Arguments}).
-Using Org's properties feature, header arguments can be
-selectively applied to the entire buffer or specific sub-trees of
-the Org document.
+Using Org's properties feature, header arguments can be selectively
+applied to the entire buffer or specific sub-trees of the Org
+document.
@item @samp{<body>}
Source code in the dialect of the specified language identifier.
@@ -17434,14 +17572,14 @@ column, containing labels for the columns, or the rows, in the
table.
@cindex @samp{colnames}, header argument
-The @samp{colnames} header argument accepts @samp{yes}, @samp{no}, or @samp{nil}
-values. The default value is @samp{nil}: if an input table has column
+The @samp{colnames} header argument accepts @samp{yes}, @samp{no}, or @samp{nil} values.
+The default value is @samp{nil}: if an input table has column
names---because the second row is a horizontal rule---then Org
-removes the column names, processes the table, puts back the
-column names, and then writes the table to the results block.
-Using @samp{yes}, Org does the same to the first row, even if the
-initial table does not contain any horizontal rule. When set to
-@samp{no}, Org does not pre-process column names at all.
+removes the column names, processes the table, puts back the column
+names, and then writes the table to the results block. Using @samp{yes},
+Org does the same to the first row, even if the initial table does
+not contain any horizontal rule. When set to @samp{no}, Org does not
+pre-process column names at all.
@example
#+NAME: less-cols
@@ -17462,13 +17600,13 @@ initial table does not contain any horizontal rule. When set to
@end example
@cindex @samp{rownames}, header argument
-Similarly, the @samp{rownames} header argument can take two values:
-@samp{yes} or @samp{no}. When set to @samp{yes}, Org removes the first column,
-processes the table, puts back the first column, and then writes
-the table to the results block. The default is @samp{no}, which means
-Org does not pre-process the first column. Note that Emacs Lisp
-code blocks ignore @samp{rownames} header argument because of the ease
-of table-handling in Emacs.
+Similarly, the @samp{rownames} header argument can take two values: @samp{yes}
+or @samp{no}. When set to @samp{yes}, Org removes the first column, processes
+the table, puts back the first column, and then writes the table to
+the results block. The default is @samp{no}, which means Org does not
+pre-process the first column. Note that Emacs Lisp code blocks
+ignore @samp{rownames} header argument because of the ease of
+table-handling in Emacs.
@example
#+NAME: with-rownames
@@ -17694,19 +17832,19 @@ interpreter process.
@table @asis
@item @samp{none}
-Default. Each code block gets a new interpreter process to
-execute. The process terminates once the block is evaluated.
+Default. Each code block gets a new interpreter process to execute.
+The process terminates once the block is evaluated.
@item @var{STRING}
Any string besides @samp{none} turns that string into the name of that
session. For example, @samp{:session STRING} names it @samp{STRING}. If
@samp{session} has no value, then the session name is derived from the
-source language identifier. Subsequent blocks with the same
-source code language use the same session. Depending on the
-language, state variables, code from other blocks, and the
-overall interpreted environment may be shared. Some interpreted
-languages support concurrent sessions when subsequent source code
-language blocks change session names.
+source language identifier. Subsequent blocks with the same source
+code language use the same session. Depending on the language,
+state variables, code from other blocks, and the overall interpreted
+environment may be shared. Some interpreted languages support
+concurrent sessions when subsequent source code language blocks
+change session names.
@end table
Only languages that provide interactive evaluation can have session
@@ -17721,13 +17859,15 @@ for those code blocks running in a session.
@cindex working directory, in a code block
@cindex @samp{dir}, header argument
+@cindex @samp{mkdirp}, header argument
The @samp{dir} header argument specifies the default directory during code
block execution. If it is absent, then the directory associated with
-the current buffer is used. In other words, supplying @samp{:dir PATH}
-temporarily has the same effect as changing the current directory with
-@kbd{M-x cd PATH}, and then not setting @samp{dir}. Under the
-surface, @samp{dir} simply sets the value of the Emacs variable
-@code{default-directory}.
+the current buffer is used. In other words, supplying @samp{:dir
+DIRECTORY} temporarily has the same effect as changing the current
+directory with @kbd{M-x cd @key{RET} DIRECTORY}, and then not setting
+@samp{dir}. Under the surface, @samp{dir} simply sets the value of the Emacs
+variable @code{default-directory}. Setting @samp{mkdirp} header argument to
+a non-@code{nil} value creates the directory, if necessary.
For example, to save the plot file in the @samp{Work/} folder of the home
directory---notice tilde is expanded:
@@ -17846,20 +17986,21 @@ variable @code{org-babel-inline-result-wrap}, which by default is set to
@table @asis
@item @samp{<name>}
-This is the name of the code block (see @ref{Structure of Code Blocks}) to be evaluated in the current document. If the block is
-located in another file, start @samp{<name>} with the file name
-followed by a colon. For example, in order to execute a block
-named @samp{clear-data} in @samp{file.org}, you can write the following:
+This is the name of the code block (see @ref{Structure of Code Blocks})
+to be evaluated in the current document. If the block is located in
+another file, start @samp{<name>} with the file name followed by
+a colon. For example, in order to execute a block named @samp{clear-data}
+in @samp{file.org}, you can write the following:
@example
#+CALL: file.org:clear-data()
@end example
@item @samp{<arguments>}
-Org passes arguments to the code block using standard function
-call syntax. For example, a @samp{#+CALL:} line that passes @samp{4} to
-a code block named @samp{double}, which declares the header argument
-@samp{:var n=2}, would be written as:
+Org passes arguments to the code block using standard function call
+syntax. For example, a @samp{#+CALL:} line that passes @samp{4} to a code
+block named @samp{double}, which declares the header argument @samp{:var n=2},
+would be written as:
@example
#+CALL: double(n=4)
@@ -17871,18 +18012,17 @@ Note how this function call syntax is different from the header
argument syntax.
@item @samp{<inside header arguments>}
-Org passes inside header arguments to the named code block using
-the header argument syntax. Inside header arguments apply to
-code block evaluation. For example, @samp{[:results output]} collects
-results printed to stdout during code execution of that block.
-Note how this header argument syntax is different from the
-function call syntax.
+Org passes inside header arguments to the named code block using the
+header argument syntax. Inside header arguments apply to code block
+evaluation. For example, @samp{[:results output]} collects results
+printed to stdout during code execution of that block. Note how
+this header argument syntax is different from the function call
+syntax.
@item @samp{<end header arguments>}
-End header arguments affect the results returned by the code
-block. For example, @samp{:results html} wraps the results in
-a @samp{#+BEGIN_EXPORT html} block before inserting the results in the
-Org buffer.
+End header arguments affect the results returned by the code block.
+For example, @samp{:results html} wraps the results in a @samp{#+BEGIN_EXPORT
+ html} block before inserting the results in the Org buffer.
@end table
@anchor{Limit code block evaluation}
@@ -17902,8 +18042,8 @@ Org never evaluates the source code.
Org prompts the user for permission to evaluate the source code.
@item @samp{never-export} or @samp{no-export}
-Org does not evaluate the source code when exporting, yet the
-user can evaluate it interactively.
+Org does not evaluate the source code when exporting, yet the user
+can evaluate it interactively.
@item @samp{query-export}
Org prompts the user for permission to evaluate the source code
@@ -17948,17 +18088,16 @@ The @samp{cache} header argument can have one of two values: @samp{yes} or @samp
@table @asis
@item @samp{no}
-Default. No caching of results; code block evaluated every
-time.
+Default. No caching of results; code block evaluated every time.
@item @samp{yes}
-Whether to run the code or return the cached results is
-determined by comparing the SHA1 hash value of the combined code
-block and arguments passed to it. This hash value is packed on
-the @samp{#+RESULTS:} line from previous evaluation. When hash values
-match, Org does not evaluate the code block. When hash values
-mismatch, Org evaluates the code block, inserts the results,
-recalculates the hash value, and updates @samp{#+RESULTS:} line.
+Whether to run the code or return the cached results is determined
+by comparing the SHA1 hash value of the combined code block and
+arguments passed to it. This hash value is packed on the
+@samp{#+RESULTS:} line from previous evaluation. When hash values match,
+Org does not evaluate the code block. When hash values mismatch,
+Org evaluates the code block, inserts the results, recalculates the
+hash value, and updates @samp{#+RESULTS:} line.
@end table
In this example, both functions are cached. But @samp{caller} runs only if
@@ -17995,19 +18134,18 @@ is the @samp{results} header argument. It accepts four classes of options.
Each code block can take only one option per class:
@table @asis
-@item collection
+@item Collection
For how the results should be collected from the code block;
-@item type
-For which type of result the code block will return; affects how
-Org processes and inserts results in the Org buffer;
+@item Type
+For which type of result the code block will return; affects how Org
+processes and inserts results in the Org buffer;
-@item format
-For the result; affects how Org processes and inserts results in
-the Org buffer;
+@item Format
+For the result; affects how Org processes results;
-@item handling
-For processing results after evaluation of the code block;
+@item Handling
+For inserting results once they are properly formatted.
@end table
@anchor{Collection}
@@ -18018,34 +18156,33 @@ they are mutually exclusive.
@table @asis
@item @samp{value}
-Default. Functional mode. Org gets the value by wrapping the
-code in a function definition in the language of the source
-block. That is why when using @samp{:results value}, code should
-execute like a function and return a value. For languages like
-Python, an explicit @code{return} statement is mandatory when using
-@samp{:results value}. Result is the value returned by the last
-statement in the code block.
-
-When evaluating the code block in a session (see @ref{Environment of a Code Block}), Org passes the code to an interpreter running as
-an interactive Emacs inferior process. Org gets the value from
-the source code interpreter's last statement output. Org has to
-use language-specific methods to obtain the value. For example,
-from the variable @code{_} in Python and Ruby, and the value of
-@code{.Last.value} in R@.
+Default. Functional mode. Org gets the value by wrapping the code
+in a function definition in the language of the source block. That
+is why when using @samp{:results value}, code should execute like
+a function and return a value. For languages like Python, an
+explicit @code{return} statement is mandatory when using @samp{:results
+ value}. Result is the value returned by the last statement in the
+code block.
+
+When evaluating the code block in a session (see @ref{Environment of a Code Block}), Org passes the code to an interpreter running as an
+interactive Emacs inferior process. Org gets the value from the
+source code interpreter's last statement output. Org has to use
+language-specific methods to obtain the value. For example, from
+the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
+in R@.
@item @samp{output}
-Scripting mode. Org passes the code to an external process
-running the interpreter. Org returns the contents of the
-standard output stream as text results.
+Scripting mode. Org passes the code to an external process running
+the interpreter. Org returns the contents of the standard output
+stream as text results.
-When using a session, Org passes the code to the interpreter
-running as an interactive Emacs inferior process. Org
-concatenates any text output from the interpreter and returns the
-collection as a result.
+When using a session, Org passes the code to the interpreter running
+as an interactive Emacs inferior process. Org concatenates any text
+output from the interpreter and returns the collection as a result.
-Note that this collection is not the same as that would be
-collected from stdout of a non-interactive interpreter running as
-an external process. Compare for example these two blocks:
+Note that this collection is not the same as that would be collected
+from stdout of a non-interactive interpreter running as an external
+process. Compare for example these two blocks:
@example
#+BEGIN_SRC python :results output
@@ -18090,17 +18227,16 @@ default behavior is to automatically determine the result type.
@item @samp{table}
@itemx @samp{vector}
Interpret the results as an Org table. If the result is a single
-value, create a table with one row and one column. Usage
-example: @samp{:results value table}.
+value, create a table with one row and one column. Usage example:
+@samp{:results value table}.
@cindex @samp{hlines}, header argument
In-between each table row or below the table headings, sometimes
results have horizontal lines, which are also known as ``hlines''.
-The @samp{hlines} argument with the default @samp{no} value strips such
-lines from the input table. For most code, this is desirable, or
-else those @samp{hline} symbols raise unbound variable errors.
-A @samp{yes} accepts such lines, as demonstrated in the following
-example.
+The @samp{hlines} argument with the default @samp{no} value strips such lines
+from the input table. For most code, this is desirable, or else
+those @samp{hline} symbols raise unbound variable errors. A @samp{yes}
+accepts such lines, as demonstrated in the following example.
@example
#+NAME: many-cols
@@ -18143,10 +18279,9 @@ Interpret literally and insert as quoted text. Do not create
a table. Usage example: @samp{:results value verbatim}.
@item @samp{file}
-Interpret as a filename. Save the results of execution of the
-code block to that file, then insert a link to it. You can
-control both the filename and the description associated to the
-link.
+Interpret as a filename. Save the results of execution of the code
+block to that file, then insert a link to it. You can control both
+the filename and the description associated to the link.
@cindex @samp{file}, header argument
@cindex @samp{output-dir}, header argument
@@ -18163,16 +18298,10 @@ Org assumes it is the current directory.
@end example
@cindex @samp{file-ext}, header argument
-If @samp{file} is missing, Org generates the base name of the output
-file from the name of the code block, and its extension from the
-@samp{file-ext} header argument. In that case, both the name and the
-extension are mandatory@footnote{Due to the way this header argument is implemented, it
-implies ``:results file''. Therefore if it is set for multiple blocks
-at once (by a subtree or buffer property for example), all blocks are
-forced to produce file results. This is seldom desired behavior, so
-it is recommended to set this header only on a per-block basis. It is
-possible that this aspect of the implementation might change in the
-future.}.
+If @samp{file} header argument is missing, Org generates the base name of
+the output file from the name of the code block, and its extension
+from the @samp{file-ext} header argument. In that case, both the name
+and the extension are mandatory.
@example
#+name: circle
@@ -18207,9 +18336,9 @@ Result enclosed in a code block. Useful for parsing. Usage
example: @samp{:results value code}.
@item @samp{drawer}
-Result wrapped in a @samp{RESULTS} drawer. Useful for containing
-@samp{raw} or @samp{org} results for later scripting and automated
-processing. Usage example: @samp{:results value drawer}.
+Result wrapped in a @samp{RESULTS} drawer. Useful for containing @samp{raw}
+or @samp{org} results for later scripting and automated processing.
+Usage example: @samp{:results value drawer}.
@item @samp{html}
Results enclosed in a @samp{BEGIN_EXPORT html} block. Usage example:
@@ -18221,10 +18350,10 @@ Results enclosed in a @samp{BEGIN_EXPORT latex} block. Usage example:
@item @samp{link}
@itemx @samp{graphics}
-Result is a link to the file specified in @samp{:file} header
-argument. However, unlike plain @samp{:file}, nothing is written to
-the disk. The block is used for its side-effects only, as in the
-following example:
+Result is a link to the file specified in @samp{:file} header argument.
+However, unlike plain @samp{:file}, nothing is written to the disk. The
+block is used for its side-effects only, as in the following
+example:
@example
#+begin_src shell :results link :file "download.tar.gz"
@@ -18248,7 +18377,7 @@ Aligned if it is a table. Usage example: @samp{:results value raw}.
@end table
@cindex @samp{wrap}, header argument
-The @samp{wrap} header argument unconditionnally marks the results block by
+The @samp{wrap} header argument unconditionally marks the results block by
appending strings to @samp{#+BEGIN_} and @samp{#+END_}. If no string is
specified, Org wraps the results in a @samp{#+BEGIN_results}
@dots{} @samp{#+END_results} block. It takes precedent over the @samp{results}
@@ -18272,22 +18401,22 @@ Handling options after collecting the results.
@table @asis
@item @samp{silent}
-Do not insert results in the Org mode buffer, but echo them in
-the minibuffer. Usage example: @samp{:results output silent}.
+Do not insert results in the Org mode buffer, but echo them in the
+minibuffer. Usage example: @samp{:results output silent}.
@item @samp{replace}
Default. Insert results in the Org buffer. Remove previous
results. Usage example: @samp{:results output replace}.
@item @samp{append}
-Append results to the Org buffer. Latest results are at the
-bottom. Does not remove previous results. Usage example:
-@samp{:results output append}.
+Append results to the Org buffer. Latest results are at the bottom.
+Does not remove previous results. Usage example: @samp{:results output
+ append}.
@item @samp{prepend}
-Prepend results to the Org buffer. Latest results are at the
-top. Does not remove previous results. Usage example: @samp{:results
- output prepend}.
+Prepend results to the Org buffer. Latest results are at the top.
+Does not remove previous results. Usage example: @samp{:results output
+ prepend}.
@end table
@anchor{Post-processing}
@@ -18374,16 +18503,16 @@ file is exported to, say, HTML or @LaTeX{} formats.
@table @asis
@item @samp{code}
-The default. The body of code is included into the exported
-file. Example: @samp{:exports code}.
+The default. The body of code is included into the exported file.
+Example: @samp{:exports code}.
@item @samp{results}
The results of evaluation of the code is included in the exported
file. Example: @samp{:exports results}.
@item @samp{both}
-Both the code and results of evaluation are included in the
-exported file. Example: @samp{:exports both}.
+Both the code and results of evaluation are included in the exported
+file. Example: @samp{:exports both}.
@item @samp{none}
Neither the code nor the results of evaluation is included in the
@@ -18441,26 +18570,26 @@ to source file(s).
@table @asis
@item @samp{yes}
-Export the code block to source file. The file name for the
-source file is derived from the name of the Org file, and the
-file extension is derived from the source code language
-identifier. Example: @samp{:tangle yes}.
+Export the code block to source file. The file name for the source
+file is derived from the name of the Org file, and the file
+extension is derived from the source code language identifier.
+Example: @samp{:tangle yes}.
@item @samp{no}
The default. Do not extract the code in a source code file.
Example: @samp{:tangle no}.
@item @var{FILENAME}
-Export the code block to source file whose file name is derived
-from any string passed to the @samp{tangle} header argument. Org
-derives the file name as being relative to the directory of the
-Org file's location. Example: @samp{:tangle FILENAME}.
+Export the code block to source file whose file name is derived from
+any string passed to the @samp{tangle} header argument. Org derives the
+file name as being relative to the directory of the Org file's
+location. Example: @samp{:tangle FILENAME}.
@end table
@cindex @samp{mkdirp}, header argument
The @samp{mkdirp} header argument creates parent directories for tangled
-files if the directory does not exist. @samp{yes} enables directory
-creation and @samp{no} inhibits directory creation.
+files if the directory does not exist. A @samp{yes} value enables
+directory creation whereas @samp{no} inhibits it.
@cindex @samp{comments}, header argument
The @samp{comments} header argument controls inserting comments into
@@ -18472,8 +18601,8 @@ already exist in the code block.
The default. Do not insert any extra comments during tangling.
@item @samp{link}
-Wrap the code block in comments. Include links pointing back to
-the place in the Org file from where the code was tangled.
+Wrap the code block in comments. Include links pointing back to the
+place in the Org file from where the code was tangled.
@item @samp{yes}
Kept for backward compatibility; same as @samp{link}.
@@ -18487,8 +18616,8 @@ the source block.
Includes both @samp{link} and @samp{org} options.
@item @samp{noweb}
-Includes @samp{link} option, expands Noweb references (see @ref{Noweb Reference Syntax}), and wraps them in link comments inside the
-body of the code block.
+Includes @samp{link} option, expands Noweb references (see @ref{Noweb Reference Syntax}), and wraps them in link comments inside the body
+of the code block.
@end table
@cindex @samp{padline}, header argument
@@ -18497,8 +18626,8 @@ source code in the tangled file.
@table @asis
@item @samp{yes}
-Default. Insert a newline before and after each code block in
-the tangled file.
+Default. Insert a newline before and after each code block in the
+tangled file.
@item @samp{no}
Do not insert newlines to pad the tangled code blocks.
@@ -18594,46 +18723,50 @@ Code blocks in the following languages are supported.
@tab Identifier
@item Asymptote
@tab @samp{asymptote}
-@tab Lua
-@tab @samp{lua}
+@tab Lisp
+@tab @samp{lisp}
@item Awk
@tab @samp{awk}
-@tab MATLAB
-@tab @samp{matlab}
+@tab Lua
+@tab @samp{lua}
@item C
@tab @samp{C}
-@tab Mscgen
-@tab @samp{mscgen}
+@tab MATLAB
+@tab @samp{matlab}
@item C++
@tab @samp{C++}@footnote{C++ language is handled in @samp{ob-C.el}. Even though the
identifier for such source blocks is @samp{C++}, you activate it by loading
the C language.}
-@tab OCaml
-@tab @samp{ocaml}
+@tab Mscgen
+@tab @samp{mscgen}
@item Clojure
@tab @samp{clojure}
-@tab Octave
-@tab @samp{octave}
+@tab Objective Caml
+@tab @samp{ocaml}
@item CSS
@tab @samp{css}
-@tab Org mode
-@tab @samp{org}
+@tab Octave
+@tab @samp{octave}
@item D
@tab @samp{D}@footnote{D language is handled in @samp{ob-C.el}. Even though the
identifier for such source blocks is @samp{D}, you activate it by loading
the C language.}
-@tab Oz
-@tab @samp{oz}
+@tab Org mode
+@tab @samp{org}
@item ditaa
@tab @samp{ditaa}
-@tab Perl
-@tab @samp{perl}
+@tab Oz
+@tab @samp{oz}
@item Emacs Calc
@tab @samp{calc}
-@tab Plantuml
-@tab @samp{plantuml}
+@tab Perl
+@tab @samp{perl}
@item Emacs Lisp
@tab @samp{emacs-lisp}
+@tab Plantuml
+@tab @samp{plantuml}
+@item Eshell
+@tab @samp{eshell}
@tab Processing.js
@tab @samp{processing}
@item Fortran
@@ -18676,10 +18809,6 @@ the C language.}
@tab @samp{lilypond}
@tab Vala
@tab @samp{vala}
-@item Lisp
-@tab @samp{lisp}
-@tab
-@tab
@end multitable
Additional documentation for some languages is at
@@ -18717,7 +18846,7 @@ the following enables execution of Clojure code blocks:
@kindex C-c '
Use @kbd{C-c '} to edit the current code block. It opens a new
-major-mode edit buffer containing the body of the source code block,
+major mode edit buffer containing the body of the source code block,
ready for any edits. Use @kbd{C-c '} again to close the buffer
and return to the Org buffer.
@@ -18745,23 +18874,23 @@ variable to arbitrarily map language identifiers to major modes.
@item @code{org-src-window-setup}
@vindex org-src-window-setup
-For specifying Emacs window arrangement when the new edit buffer
-is created.
+For specifying Emacs window arrangement when the new edit buffer is
+created.
@item @code{org-src-preserve-indentation}
@cindex indentation, in code blocks
@vindex org-src-preserve-indentation
Default is @code{nil}. Source code is indented. This indentation
-applies during export or tangling, and depending on the context,
-may alter leading spaces and tabs. When non-@code{nil}, source code
-is aligned with the leftmost column. No lines are modified
-during export or tangling, which is very useful for white-space
-sensitive languages, such as Python.
+applies during export or tangling, and depending on the context, may
+alter leading spaces and tabs. When non-@code{nil}, source code is
+aligned with the leftmost column. No lines are modified during
+export or tangling, which is very useful for white-space sensitive
+languages, such as Python.
@item @code{org-src-ask-before-returning-to-edit-buffer}
@vindex org-src-ask-before-returning-to-edit-buffer
-When @code{nil}, Org returns to the edit buffer without further
-prompts. The default prompts for a confirmation.
+When @code{nil}, Org returns to the edit buffer without further prompts.
+The default prompts for a confirmation.
@end table
@vindex org-src-fontify-natively
@@ -18809,29 +18938,29 @@ tangled, or exported.
@table @asis
@item @samp{no}
-Default. No expansion of Noweb syntax references in the body of
-the code when evaluating, tangling, or exporting.
+Default. No expansion of Noweb syntax references in the body of the
+code when evaluating, tangling, or exporting.
@item @samp{yes}
-Expansion of Noweb syntax references in the body of the code
-block when evaluating, tangling, or exporting.
+Expansion of Noweb syntax references in the body of the code block
+when evaluating, tangling, or exporting.
@item @samp{tangle}
-Expansion of Noweb syntax references in the body of the code
-block when tangling. No expansion when evaluating or exporting.
+Expansion of Noweb syntax references in the body of the code block
+when tangling. No expansion when evaluating or exporting.
@item @samp{no-export}
-Expansion of Noweb syntax references in the body of the code
-block when evaluating or tangling. No expansion when exporting.
+Expansion of Noweb syntax references in the body of the code block
+when evaluating or tangling. No expansion when exporting.
@item @samp{strip-export}
-Expansion of Noweb syntax references in the body of the code
-block when expanding prior to evaluating or tangling. Removes
-Noweb syntax references when exporting.
+Expansion of Noweb syntax references in the body of the code block
+when expanding prior to evaluating or tangling. Removes Noweb
+syntax references when exporting.
@item @samp{eval}
-Expansion of Noweb syntax references in the body of the code
-block only before evaluating.
+Expansion of Noweb syntax references in the body of the code block
+only before evaluating.
@end table
In the following example,
@@ -19227,19 +19356,20 @@ emacs -Q --batch --eval "
@menu
* Completion:: @kbd{M-@key{TAB}} guesses completions.
* Structure Templates:: Quick insertion of structural elements.
-* Escape Character::
* Speed Keys:: Electric commands at the beginning of a headline.
-* Code Evaluation Security:: Org files evaluate in-line code.
-* Customization:: Adapting Org to your taste.
-* In-buffer Settings:: Overview of keywords.
-* The Very Busy @kbd{C-c C-c} Key:: When in doubt, press @kbd{C-c C-c}.
* Clean View:: Getting rid of leading stars in the outline.
-* TTY Keys:: Using Org on a tty.
+* Dynamic Headline Numbering:: Display and update outline numbering.
+* The Very Busy @kbd{C-c C-c} Key:: When in doubt, press @kbd{C-c C-c}.
+* In-buffer Settings:: Overview of keywords.
+* Org Syntax:: Formal description of Org's syntax.
* Documentation Access:: Read documentation about current syntax.
+* Escape Character::
+* Code Evaluation Security:: Org files evaluate in-line code.
* Interaction:: With other Emacs packages.
+* TTY Keys:: Using Org on a tty.
+* Protocols:: External access to Emacs and Org.
* Org Crypt:: Encrypting Org files.
* Org Mobile:: Viewing and capture on a mobile device.
-* Org Syntax:: Formal description of Org's syntax.
@end menu
@node Completion
@@ -19276,29 +19406,25 @@ Complete word at point.
@itemize
@item
-At the beginning of a headline, complete TODO keywords.
+At the beginning of an empty headline, complete TODO keywords.
@item
After @samp{\}, complete @TeX{} symbols supported by the exporter.
@item
-After @samp{*}, complete headlines in the current buffer so that
-they can be used in search links like:
-
-@example
-[[*find this headline]]
-@end example
+After @samp{*}, complete headlines in the current buffer so that they
+can be used in search links like: @samp{[[*find this headline]]}
@item
-After @samp{:} in a headline, complete tags. Org deduces the list
-of tags from the @samp{TAGS} in-buffer option (see @ref{Setting Tags}),
-the variable @code{org-tag-alist}, or from all tags used in the
-current buffer.
+After @samp{:} in a headline, complete tags. Org deduces the list of
+tags from the @samp{TAGS} in-buffer option (see @ref{Setting Tags}), the
+variable @code{org-tag-alist}, or from all tags used in the current
+buffer.
@item
-After @samp{:} and not in a headline, complete property keys. The
-list of keys is constructed dynamically from all keys used in
-the current buffer.
+After @samp{:} and not in a headline, complete property keys. The list
+of keys is constructed dynamically from all keys used in the
+current buffer.
@item
After @samp{[}, complete link abbreviations (see @ref{Link Abbreviations}).
@@ -19306,8 +19432,8 @@ After @samp{[}, complete link abbreviations (see @ref{Link Abbreviations}).
@item
After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
file-specific @samp{OPTIONS}. After option keyword is complete,
-pressing @kbd{M-@key{TAB}} again inserts example settings for
-this keyword.
+pressing @kbd{M-@key{TAB}} again inserts example settings for this
+keyword.
@item
After @samp{STARTUP} keyword, complete startup items.
@@ -19332,12 +19458,11 @@ text in such a block.
@item @kbd{C-c C-,} (@code{org-insert-structure-template})
@findex org-insert-structure-template
@kindex C-c C-,
-Prompt for a type of block structure, and insert the block at
-point. If the region is active, it is wrapped in the block.
-First prompts the user for keys, which are used to look up
-a structure type from the variable below. If the key is
-@kbd{@key{TAB}}, @kbd{@key{RET}}, or @kbd{@key{SPC}}, the user is
-prompted to enter a block type.
+Prompt for a type of block structure, and insert the block at point.
+If the region is active, it is wrapped in the block. First prompts
+the user for keys, which are used to look up a structure type from
+the variable below. If the key is @kbd{@key{TAB}}, @kbd{@key{RET}},
+or @kbd{@key{SPC}}, the user is prompted to enter a block type.
@end table
@vindex org-structure-template-alist
@@ -19379,29 +19504,6 @@ in @samp{org-tempo.el}.}.
@tab @samp{#+BEGIN_VERSE} @dots{} @samp{#+END_VERSE}
@end multitable
-@node Escape Character
-@section Escape Character
-
-@cindex escape character
-@cindex zero width space
-You may sometimes want to write text that looks like Org syntax, but
-should really read as plain text. Org may use a specific escape
-character in some situations, e.g., a backslash in macros (see @ref{Macro Replacement}). In the general case, however, we suggest to use the
-zero width space. You can get it with one of the following:
-
-@example
-C-x 8 <RET> zero width space <RET>
-C-x 8 <RET> 200B <RET>
-@end example
-
-
-For example, in order to write @samp{[[1,2]]} as-is in your document, you can
-write this, where @samp{X} denotes the zero width space character:
-
-@example
-[[X1,2]]
-@end example
-
@node Speed Keys
@section Speed Keys
@@ -19430,82 +19532,210 @@ activated, @kbd{M-x org-speed-command-help}, or @kbd{?} when
point is at the beginning of an Org headline, shows currently active
Speed Keys, including the user-defined ones.
-@node Code Evaluation Security
-@section Code Evaluation and Security Issues
+@node Clean View
+@section A Cleaner Outline View
-Unlike plain text, running code comes with risk. Each source code
-block, in terms of risk, is equivalent to an executable file. Org
-therefore puts a few confirmation prompts by default. This is to
-alert the casual user from accidentally running untrusted code.
+@cindex hiding leading stars
+@cindex dynamic indentation
+@cindex odd-levels-only outlines
+@cindex clean outline view
-For users who do not run code blocks or write code regularly, Org's
-default settings should suffice. However, some users may want to
-tweak the prompts for fewer interruptions. To weigh the risks of
-automatic execution of code blocks, here are some details about code
-evaluation.
+Org's outline with stars and no indents can look cluttered for short
+documents. For @emph{book-like} long documents, the effect is not as
+noticeable. Org provides an alternate stars and indentation scheme,
+as shown on the right in the following table. It displays only one
+star and indents text to line up with the heading:
-Org evaluates code in the following circumstances:
+@example
+* Top level headline | * Top level headline
+** Second level | * Second level
+*** Third level | * Third level
+some text | some text
+*** Third level | * Third level
+more text | more text
+* Another top level headline | * Another top level headline
+@end example
-@table @asis
-@item @emph{Source code blocks}
-Org evaluates source code blocks in an Org file during export.
-Org also evaluates a source code block with the @kbd{C-c C-c} key chord. Users exporting or running code blocks must
-load files only from trusted sources. Be wary of customizing
-variables that remove or alter default security measures.
+Org can achieve this in two ways, (1) by just displaying the buffer in
+this way without changing it, or (2) by actually indenting every line
+in the desired amount with hard spaces and hiding leading stars.
-@defopt org-confirm-babel-evaluate
-When @code{t}, Org prompts the user for confirmation before executing
-each code block. When @code{nil}, Org executes code blocks without
-prompting the user for confirmation. When this option is set to
-a custom function, Org invokes the function with these two
-arguments: the source code language and the body of the code
-block. The custom function must return either a @code{t} or @code{nil},
-which determines if the user is prompted. Each source code
-language can be handled separately through this function
-argument.
-@end defopt
+@menu
+* Org Indent Mode::
+* Hard indentation::
+@end menu
-For example, here is how to execute ditaa code blocks without
-prompting:
+@node Org Indent Mode
+@subsection Org Indent Mode
+
+@cindex Indent mode
+@findex org-indent-mode
+To display the buffer in the indented view, activate Org Indent minor
+mode, using @kbd{M-x org-indent-mode}. Text lines that are not
+headlines are prefixed with virtual spaces to vertically align with
+the headline text@footnote{Org Indent mode also sets @code{wrap-prefix} correctly for
+indenting and wrapping long lines of headlines or text. This minor
+mode also handles Visual Line mode and directly applied settings
+through @code{word-wrap}.}.
+
+@vindex org-indent-indentation-per-level
+To make more horizontal space, the headlines are shifted by two
+characters. Configure @code{org-indent-indentation-per-level} variable for
+a different number. Only one star on each headline is visible, the
+rest are masked with the same font color as the background@footnote{Note that turning on Org Indent mode sets
+@code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to @code{nil}.}.
+
+@vindex org-startup-indented
+To globally turn on Org Indent mode for all files, customize the
+variable @code{org-startup-indented}. To control it for individual files,
+use @samp{STARTUP} keyword as follows:
+
+@example
+#+STARTUP: indent
+#+STARTUP: noindent
+@end example
+
+@node Hard indentation
+@subsection Hard indentation
+
+It is possible to use hard spaces to achieve the indentation instead,
+if the bare ASCII file should have the indented look also outside
+Emacs@footnote{This works, but requires extra effort. Org Indent mode is
+more convenient for most applications.}. With Org's support, you have to indent all lines to
+line up with the outline headers. You would use these settings:
@lisp
-(defun my-org-confirm-babel-evaluate (lang body)
- (not (string= lang "ditaa"))) ;don't ask for ditaa
-(setq org-confirm-babel-evaluate #'my-org-confirm-babel-evaluate)
+(setq org-adapt-indentation t
+ org-hide-leading-stars t
+ org-odd-levels-only t)
@end lisp
-@item @emph{Following @samp{shell} and @samp{elisp} links}
-Org has two link types that can directly evaluate code (see
-@ref{External Links}). Because such code is not visible, these links
-have a potential risk. Org therefore prompts the user when it
-encounters such links. The customization variables are:
+@table @asis
+@item @emph{Indentation of text below headlines} (@code{org-adapt-indentation})
+@vindex org-adapt-indentation
+The first setting modifies paragraph filling, line wrapping, and
+structure editing commands to preserving or adapting the indentation
+as appropriate.
-@defopt org-confirm-shell-link-function
-Function that prompts the user before executing a shell link.
-@end defopt
+@item @emph{Hiding leading stars} (@code{org-hide-leading-stars})
+@vindex org-hide-leading-stars
+@vindex org-hide, face
+The second setting makes leading stars invisible by applying the
+face @code{org-hide} to them. For per-file preference, use these file
+@samp{STARTUP} options:
-@defopt org-confirm-elisp-link-function
-Function that prompts the user before executing an Emacs Lisp link.
-@end defopt
+@example
+#+STARTUP: hidestars
+#+STARTUP: showstars
+@end example
-@item @emph{Formulas in tables}
-Formulas in tables (see @ref{The Spreadsheet}) are code that is
-evaluated either by the Calc interpreter, or by the Emacs Lisp
-interpreter.
+@item @emph{Odd levels} (@code{org-odd-levels-only})
+@vindex org-odd-levels-only
+The third setting makes Org use only odd levels, 1, 3, 5, @dots{}, in
+the outline to create more indentation. On a per-file level,
+control this with:
+
+@example
+#+STARTUP: odd
+#+STARTUP: oddeven
+@end example
+
+To convert a file between single and double stars layouts, use
+@kbd{M-x org-convert-to-odd-levels} and @kbd{M-x org-convert-to-oddeven-levels}.
@end table
-@node Customization
-@section Customization
+@node Dynamic Headline Numbering
+@section Dynamic Headline Numbering
+
+@cindex Org Num mode
+@cindex number headlines
+The Org Num minor mode, toggled with @kbd{M-x org-num-mode},
+displays outline numbering on top of headlines. It also updates it
+automatically upon changes to the structure of the document.
+
+@vindex org-num-max-level
+@vindex org-num-skip-tags
+@vindex org-num-skip-commented
+@vindex org-num-skip-unnumbered
+By default, all headlines are numbered. You can limit numbering to
+specific headlines according to their level, tags, @samp{COMMENT} keyword,
+or @samp{UNNUMBERED} property. Set @code{org-num-max-level},
+@code{org-num-skip-tags}, @code{org-num-skip-commented},
+@code{org-num-skip-unnumbered}, or @code{org-num-skip-footnotes} accordingly.
+
+@vindex org-num-skip-footnotes
+If @code{org-num-skip-footnotes} is non-@code{nil}, footnotes sections (see
+@ref{Creating Footnotes}) are not numbered either.
+
+@vindex org-num-face
+@vindex org-num-format-function
+You can control how the numbering is displayed by setting
+@code{org-num-face} and @code{org-num-format-function}.
-@cindex customization
-@cindex options, for customization
-@cindex variables, for customization
+@node The Very Busy @kbd{C-c C-c} Key
+@section The Very Busy @kbd{C-c C-c} Key
-Org has more than 500 variables for customization. They can be
-accessed through the usual @kbd{M-x org-customize} command. Or
-through the Org menu: Org @arrow{} Customization @arrow{} Browse Org Group.
+@kindex C-c C-c
+@cindex @kbd{C-c C-c}, overview
-Org also has per-file settings for some variables (see @ref{In-buffer Settings}).
+The @kbd{C-c C-c} key in Org serves many purposes depending on
+the context. It is probably the most over-worked, multi-purpose key
+combination in Org. Its uses are well documented throughout this
+manual, but here is a consolidated list for easy reference.
+
+@itemize
+@item
+If any highlights shown in the buffer from the creation of a sparse
+tree, or from clock display, remove such highlights.
+
+@item
+If point is in one of the special @samp{KEYWORD} lines, scan the buffer
+for these lines and update the information. Also reset the Org file
+cache used to temporary store the contents of URLs used as values
+for keywords like @samp{SETUPFILE}.
+
+@item
+If point is inside a table, realign the table.
+
+@item
+If point is on a @samp{TBLFM} keyword, re-apply the formulas to the
+entire table.
+
+@item
+If the current buffer is a capture buffer, close the note and file
+it. With a prefix argument, also jump to the target location after
+saving the note.
+
+@item
+If point is on a @samp{<<<target>>>}, update radio targets and
+corresponding links in this buffer.
+
+@item
+If point is on a property line or at the start or end of a property
+drawer, offer property commands.
+
+@item
+If point is at a footnote reference, go to the corresponding
+definition, and @emph{vice versa}.
+
+@item
+If point is on a statistics cookie, update it.
+
+@item
+If point is in a plain list item with a checkbox, toggle the status
+of the checkbox.
+
+@item
+If point is on a numbered item in a plain list, renumber the ordered
+list.
+
+@item
+If point is on the @samp{#+BEGIN} line of a dynamic block, the block is
+updated.
+
+@item
+If point is at a timestamp, fix the day name in the timestamp.
+@end itemize
@node In-buffer Settings
@section Summary of In-Buffer Settings
@@ -19537,9 +19767,9 @@ document.
@item @samp{#+COLUMNS: %25ITEM ...}
@cindex @samp{COLUMNS}, property
-Set the default format for columns view. This format applies
-when columns view is invoked in locations where no @samp{COLUMNS}
-property applies.
+Set the default format for columns view. This format applies when
+columns view is invoked in locations where no @samp{COLUMNS} property
+applies.
@item @samp{#+CONSTANTS: name1=value1 ...}
@cindex @samp{CONSTANTS}, keyword
@@ -19567,10 +19797,9 @@ corresponding variable is @code{org-link-abbrev-alist}.
@vindex org-highest-priority
@vindex org-lowest-priority
@vindex org-default-priority
-This line sets the limits and the default for the priorities.
-All three must be either letters A--Z or numbers 0--9. The
-highest priority must have a lower ASCII number than the lowest
-priority.
+This line sets the limits and the default for the priorities. All
+three must be either letters A--Z or numbers 0--9. The highest
+priority must have a lower ASCII number than the lowest priority.
@item @samp{#+PROPERTY: Property_Name Value}
@cindex @samp{PROPERTY}, keyword
@@ -19585,12 +19814,12 @@ in-buffer settings. Org loads this file and parses it for any
settings in it only when Org opens the main file. If URL is
specified, the contents are downloaded and stored in a temporary
file cache. @kbd{C-c C-c} on the settings line parses and
-loads the file, and also resets the temporary file cache. Org
-also parses and loads the document during normal exporting
-process. Org parses the contents of this document as if it was
-included in the buffer. It can be another Org file. To visit
-the file---not a URL---use @kbd{C-c '} while point is on the
-line with the file name.
+loads the file, and also resets the temporary file cache. Org also
+parses and loads the document during normal exporting process. Org
+parses the contents of this document as if it was included in the
+buffer. It can be another Org file. To visit the file---not
+a URL---use @kbd{C-c '} while point is on the line with the
+file name.
@item @samp{#+STARTUP:}
@cindex @samp{STARTUP}, keyword
@@ -19599,67 +19828,62 @@ Startup options Org uses when first visiting a file.
@vindex org-startup-folded
The first set of options deals with the initial visibility of the
outline tree. The corresponding variable for global default
-settings is @code{org-startup-folded} with a default value of @code{t},
-which is the same as @code{overview}.
+settings is @code{org-startup-folded} with a default value of @code{t}, which
+is the same as @code{overview}.
-@table @asis
+@multitable {aaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaa}
@item @samp{overview}
-Top-level headlines only.
-
+@tab Top-level headlines only.
@item @samp{content}
-All headlines.
-
+@tab All headlines.
@item @samp{showall}
-No folding on any entry.
-
+@tab No folding on any entry.
@item @samp{showeverything}
-Show even drawer contents.
-@end table
+@tab Show even drawer contents.
+@end multitable
@vindex org-startup-indented
Dynamic virtual indentation is controlled by the variable
-@code{org-startup-indented}@footnote{Note that @code{org-indent-mode} also sets the @code{wrap-prefix}
-property, such that @code{visual-line-mode} (or purely setting @code{word-wrap})
-wraps long lines (including headlines) correctly indented.}.
+@code{org-startup-indented}@footnote{Note that Org Indent mode also sets the @code{wrap-prefix}
+property, such that Visual Line mode (or purely setting @code{word-wrap})
+wraps long lines, including headlines, correctly indented.}.
-@table @asis
+@multitable {aaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa}
@item @samp{indent}
-Start with @code{org-indent-mode} turned on.
-
+@tab Start with Org Indent mode turned on.
@item @samp{noindent}
-Start with @code{org-indent-mode} turned off.
-@end table
+@tab Start with Org Indent mode turned off.
+@end multitable
@vindex org-startup-align-all-tables
-Aligns tables consistently upon visiting a file. The corresponding
-variable is @code{org-startup-align-all-tables} with @code{nil} as default
-value.
+Aligns tables consistently upon visiting a file. The
+corresponding variable is @code{org-startup-align-all-tables} with
+@code{nil} as default value.
-@table @asis
+@multitable {aaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa}
@item @samp{align}
-Align all tables.
-
+@tab Align all tables.
@item @samp{noalign}
-Do not align tables on startup.
-@end table
+@tab Do not align tables on startup.
+@end multitable
@vindex org-startup-shrink-all-tables
Shrink table columns with a width cookie. The corresponding
-variable is @code{org-startup-shrink-all-tables} with @code{nil} as default
-value.
+variable is @code{org-startup-shrink-all-tables} with @code{nil} as
+default value.
@vindex org-startup-with-inline-images
-When visiting a file, inline images can be automatically displayed.
-The corresponding variable is @code{org-startup-with-inline-images},
-with a default value @code{nil} to avoid delays when visiting a file.
+When visiting a file, inline images can be automatically
+displayed. The corresponding variable is
+@code{org-startup-with-inline-images}, with a default value @code{nil} to
+avoid delays when visiting a file.
-@table @asis
+@multitable {aaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa}
@item @samp{inlineimages}
-Show inline images.
-
+@tab Show inline images.
@item @samp{noinlineimages}
-Do not show inline images on startup.
-@end table
+@tab Do not show inline images on startup.
+@end multitable
@vindex org-log-done
@vindex org-log-note-clock-out
@@ -19668,108 +19892,87 @@ Logging the closing and reopening of TODO items and clock
intervals can be configured using these options (see variables
@code{org-log-done}, @code{org-log-note-clock-out}, and @code{org-log-repeat}).
-@table @asis
+@multitable {aaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa}
@item @samp{logdone}
-Record a timestamp when an item is marked DONE@.
-
+@tab Record a timestamp when an item is marked as done.
@item @samp{lognotedone}
-Record timestamp and a note when DONE@.
-
+@tab Record timestamp and a note when DONE@.
@item @samp{nologdone}
-Do not record when items are marked DONE@.
-
+@tab Do not record when items are marked as done.
@item @samp{logrepeat}
-Record a time when reinstating a repeating item.
-
+@tab Record a time when reinstating a repeating item.
@item @samp{lognoterepeat}
-Record a note when reinstating a repeating item.
-
+@tab Record a note when reinstating a repeating item.
@item @samp{nologrepeat}
-Do not record when reinstating repeating item.
-
+@tab Do not record when reinstating repeating item.
@item @samp{lognoteclock-out}
-Record a note when clocking out.
-
+@tab Record a note when clocking out.
@item @samp{nolognoteclock-out}
-Do not record a note when clocking out.
-
+@tab Do not record a note when clocking out.
@item @samp{logreschedule}
-Record a timestamp when scheduling time changes.
-
+@tab Record a timestamp when scheduling time changes.
@item @samp{lognotereschedule}
-Record a note when scheduling time changes.
-
+@tab Record a note when scheduling time changes.
@item @samp{nologreschedule}
-Do not record when a scheduling date changes.
-
+@tab Do not record when a scheduling date changes.
@item @samp{logredeadline}
-Record a timestamp when deadline changes.
-
+@tab Record a timestamp when deadline changes.
@item @samp{lognoteredeadline}
-Record a note when deadline changes.
-
+@tab Record a note when deadline changes.
@item @samp{nologredeadline}
-Do not record when a deadline date changes.
-
+@tab Do not record when a deadline date changes.
@item @samp{logrefile}
-Record a timestamp when refiling.
-
+@tab Record a timestamp when refiling.
@item @samp{lognoterefile}
-Record a note when refiling.
-
+@tab Record a note when refiling.
@item @samp{nologrefile}
-Do not record when refiling.
-@end table
+@tab Do not record when refiling.
+@end multitable
@vindex org-hide-leading-stars
@vindex org-odd-levels-only
-Here are the options for hiding leading stars in outline headings,
-and for indenting outlines. The corresponding variables are
-@code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with
-a default setting @code{nil} (meaning @samp{showstars} and @samp{oddeven}).
+Here are the options for hiding leading stars in outline
+headings, and for indenting outlines. The corresponding
+variables are @code{org-hide-leading-stars} and
+@code{org-odd-levels-only}, both with a default setting @code{nil}
+(meaning @samp{showstars} and @samp{oddeven}).
-@table @asis
+@multitable {aaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa}
@item @samp{hidestars}
-Make all but one of the stars starting a headline invisible.
-
+@tab Make all but one of the stars starting a headline invisible.
@item @samp{showstars}
-Show all stars starting a headline.
-
+@tab Show all stars starting a headline.
@item @samp{indent}
-Virtual indentation according to outline level.
-
+@tab Virtual indentation according to outline level.
@item @samp{noindent}
-No virtual indentation according to outline level.
-
+@tab No virtual indentation according to outline level.
@item @samp{odd}
-Allow only odd outline levels (1, 3, @dots{}).
-
+@tab Allow only odd outline levels (1, 3, @dots{}).
@item @samp{oddeven}
-Allow all outline levels.
-@end table
+@tab Allow all outline levels.
+@end multitable
@vindex org-put-time-stamp-overlays
@vindex org-time-stamp-overlay-formats
To turn on custom format overlays over timestamps (variables
-@code{org-put-time-stamp-overlays} and @code{org-time-stamp-overlay-formats}),
-use:
+@code{org-put-time-stamp-overlays} and
+@code{org-time-stamp-overlay-formats}), use:
-@table @asis
+@multitable {aaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaa}
@item @samp{customtime}
-Overlay custom time format.
-@end table
+@tab Overlay custom time format.
+@end multitable
@vindex constants-unit-system
The following options influence the table spreadsheet (variable
@code{constants-unit-system}).
-@table @asis
+@multitable {aaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa}
@item @samp{constcgs}
-@samp{constants.el} should use the c-g-s unit system.
-
+@tab @samp{constants.el} should use the c-g-s unit system.
@item @samp{constSI}
-@samp{constants.el} should use the SI unit system.
-@end table
+@tab @samp{constants.el} should use the SI unit system.
+@end multitable
@vindex org-footnote-define-inline
@vindex org-footnote-auto-label
@@ -19778,61 +19981,52 @@ To influence footnote settings, use the following keywords. The
corresponding variables are @code{org-footnote-define-inline},
@code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
-@table @asis
+@multitable {aaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa}
@item @samp{fninline}
-Define footnotes inline.
-
+@tab Define footnotes inline.
@item @samp{fnnoinline}
-Define footnotes in separate section.
-
+@tab Define footnotes in separate section.
@item @samp{fnlocal}
-Define footnotes near first reference, but not inline.
-
+@tab Define footnotes near first reference, but not inline.
@item @samp{fnprompt}
-Prompt for footnote labels.
-
+@tab Prompt for footnote labels.
@item @samp{fnauto}
-Create @samp{[fn:1]}-like labels automatically (default).
-
+@tab Create @samp{[fn:1]}-like labels automatically (default).
@item @samp{fnconfirm}
-Offer automatic label for editing or confirmation.
-
+@tab Offer automatic label for editing or confirmation.
@item @samp{fnadjust}
-Automatically renumber and sort footnotes.
-
+@tab Automatically renumber and sort footnotes.
@item @samp{nofnadjust}
-Do not renumber and sort automatically.
-@end table
+@tab Do not renumber and sort automatically.
+@end multitable
@vindex org-hide-block-startup
-To hide blocks on startup, use these keywords. The corresponding
-variable is @code{org-hide-block-startup}.
+To hide blocks on startup, use these keywords. The
+corresponding variable is @code{org-hide-block-startup}.
-@table @asis
+@multitable {aaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa}
@item @samp{hideblocks}
-Hide all begin/end blocks on startup.
-
+@tab Hide all begin/end blocks on startup.
@item @samp{nohideblocks}
-Do not hide blocks on startup.
-@end table
+@tab Do not hide blocks on startup.
+@end multitable
@vindex org-pretty-entities
The display of entities as UTF-8 characters is governed by the
variable @code{org-pretty-entities} and the keywords
-@table @asis
+@multitable {aaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa}
@item @samp{entitiespretty}
-Show entities as UTF-8 characters where possible.
-
+@tab Show entities as UTF-8 characters where possible.
@item @samp{entitiesplain}
-Leave entities plain.
-@end table
+@tab Leave entities plain.
+@end multitable
@item @samp{#+TAGS: TAG1(c1) TAG2(c2)}
@cindex @samp{TAGS}, keyword
@vindex org-tag-alist
-These lines (several such lines are allowed) specify the valid
-tags in this file, and (potentially) the corresponding @emph{fast tag
+These lines (several such lines are allowed) specify the valid tags
+in this file, and (potentially) the corresponding @emph{fast tag
selection} keys. The corresponding variable is @code{org-tag-alist}.
@item @samp{#+TODO:}
@@ -19846,291 +20040,164 @@ These lines set the TODO keywords and their interpretation in the
current file. The corresponding variable is @code{org-todo-keywords}.
@end table
-@node The Very Busy @kbd{C-c C-c} Key
-@section The Very Busy @kbd{C-c C-c} Key
-
-@kindex C-c C-c
-@cindex @kbd{C-c C-c}, overview
-
-The @kbd{C-c C-c} key in Org serves many purposes depending on
-the context. It is probably the most over-worked, multi-purpose key
-combination in Org. Its uses are well documented throughout this
-manual, but here is a consolidated list for easy reference.
-
-@itemize
-@item
-If any highlights shown in the buffer from the creation of a sparse
-tree, or from clock display, remove such highlights.
-
-@item
-If point is in one of the special @samp{KEYWORD} lines, scan the buffer
-for these lines and update the information. Also reset the Org file
-cache used to temporary store the contents of URLs used as values
-for keywords like @samp{SETUPFILE}.
-
-@item
-If point is inside a table, realign the table. The table realigns
-even if automatic table editor is turned off.
-
-@item
-If point is on a @samp{TBLFM} keyword, re-apply the formulas to the
-entire table.
-
-@item
-If the current buffer is a capture buffer, close the note and file
-it. With a prefix argument, also jump to the target location after
-saving the note.
-
-@item
-If point is on a @samp{<<<target>>>}, update radio targets and
-corresponding links in this buffer.
-
-@item
-If point is on a property line or at the start or end of a property
-drawer, offer property commands.
-
-@item
-If point is at a footnote reference, go to the corresponding
-definition, and @emph{vice versa}.
-
-@item
-If point is on a statistics cookie, update it.
-
-@item
-If point is in a plain list item with a checkbox, toggle the status
-of the checkbox.
+@node Org Syntax
+@section Org Syntax
-@item
-If point is on a numbered item in a plain list, renumber the ordered
-list.
+A reference document providing a formal description of Org's syntax is
+available as @uref{https://orgmode.org/worg/dev/org-syntax.html, a draft on Worg}, written and maintained by Nicolas
+Goaziou. It defines Org's core internal concepts such as ``headlines'',
+``sections'', ``affiliated keywords'', ``(greater) elements'' and ``objects''.
+Each part of an Org document belongs to one of the previous
+categories.
-@item
-If point is on the @samp{#+BEGIN} line of a dynamic block, the block is
-updated.
+To explore the abstract structure of an Org buffer, run this in
+a buffer:
-@item
-If point is at a timestamp, fix the day name in the timestamp.
-@end itemize
+@example
+M-: (org-element-parse-buffer) <RET>
+@end example
-@node Clean View
-@section A Cleaner Outline View
-@cindex hiding leading stars
-@cindex dynamic indentation
-@cindex odd-levels-only outlines
-@cindex clean outline view
+@noindent
+It outputs a list containing the buffer's content represented as an
+abstract structure. The export engine relies on the information
+stored in this list. Most interactive commands---e.g., for structure
+editing---also rely on the syntactic meaning of the surrounding
+context.
-Org's default outline with stars and no indents can become too
-cluttered for short documents. For @emph{book-like} long documents, the
-effect is not as noticeable. Org provides an alternate stars and
-indentation scheme, as shown on the right in the following table. It
-uses only one star and indents text to line with the heading:
+@cindex syntax checker
+@cindex linter
+@findex org-lint
+You can probe the syntax of your documents with the command
@example
-* Top level headline | * Top level headline
-** Second level | * Second level
-*** Third level | * Third level
- some text | some text
-*** Third level | * Third level
- more text | more text
-* Another top level headline | * Another top level headline
+M-x org-lint <RET>
@end example
-@cindex Indent mode
-@findex org-indent-mode
-To turn this mode on, use the minor mode, @code{org-indent-mode}. Text
-lines that are not headlines are prefixed with spaces to vertically
-align with the headline text@footnote{The @code{org-indent-mode} also sets the @code{wrap-prefix} correctly
-for indenting and wrapping long lines of headlines or text. This
-minor mode handles @code{visual-line-mode} and directly applied settings
-through @code{word-wrap}.}.
-@vindex org-indent-indentation-per-level
-To make more horizontal space, the headlines are shifted by two stars.
-This can be configured by the @code{org-indent-indentation-per-level}
-variable. Only one star on each headline is visible, the rest are
-masked with the same font color as the background.
+@noindent
+It runs a number of checks to find common mistakes. It then displays
+their location in a dedicated buffer, along with a description and
+a ``trust level'', since false-positive are possible. From there, you
+can operate on the reports with the following keys:
-Note that turning on @code{org-indent-mode} sets @code{org-hide-leading-stars}
-to @code{t} and @code{org-adapt-indentation} to @code{nil}.
+@multitable @columnfractions 0.22 0.78
+@item @kbd{C-j}, @kbd{@key{TAB}}
+@tab Display the offending line
+@item @kbd{@key{RET}}
+@tab Move point to the offending line
+@item @kbd{g}
+@tab Check the document again
+@item @kbd{h}
+@tab Hide all reports from the same checker
+@item @kbd{i}
+@tab Also remove them from all subsequent checks
+@item @kbd{S}
+@tab Sort reports by the column at point
+@end multitable
-@vindex org-startup-indented
-To globally turn on @code{org-indent-mode} for all files, customize the
-variable @code{org-startup-indented}.
+@node Documentation Access
+@section Context Dependent Documentation
-To turn on indenting for individual files, use @samp{STARTUP} keyword as
-follows:
+@cindex documentation
+@cindex Info
-@example
-#+STARTUP: indent
-@end example
+@findex org-info-find-node
+@kindex C-c C-x I
+@kbd{C-c C-x I} in an Org file tries to open a suitable section
+of the Org manual depending on the syntax at point. For example,
+using it on a headline displays ``Document Structure'' section.
+@kbd{q} closes the Info window.
-Indent on startup makes Org use hard spaces to align text with
-headings as shown in examples below.
+@node Escape Character
+@section Escape Character
-@table @asis
-@item @emph{Indentation of text below headlines}
-Indent text to align with the headline.
+@cindex escape character
+@cindex zero width space
+You may sometimes want to write text that looks like Org syntax, but
+should really read as plain text. Org may use a specific escape
+character in some situations, e.g., a backslash in macros (see @ref{Macro Replacement}) or a comma in source and example blocks (see @ref{Literal Examples}). In the general case, however, we suggest to use the zero
+width space. You can insert one with any of the following:
@example
-*** Third level
- more text, now indented
+C-x 8 <RET> zero width space <RET>
+C-x 8 <RET> 200B <RET>
@end example
-@vindex org-adapt-indentation
-Org supports this with paragraph filling, line wrapping, and
-structure editing, preserving or adapting the indentation as
-appropriate@footnote{Also see the variable @code{org-adapt-indentation}.}.
-@item @emph{Hiding leading stars}
-@vindex org-hide-leading-stars
-Org can make leading stars invisible. For global preference,
-configure the variable @code{org-hide-leading-stars}. For per-file
-preference, use these file @samp{STARTUP} options:
+For example, in order to write @samp{[[1,2]]} as-is in your document, you
+may write instead
@example
-#+STARTUP: hidestars
-#+STARTUP: showstars
+[X[1,2]]
@end example
-With stars hidden, the tree is shown as:
-@example
-* Top level headline
- * Second level
- * Third level
- ...
-@end example
+where @samp{X} denotes the zero width space character.
-@vindex org-hide, face
-Because Org makes the font color the same as the background color
-to hide to stars, sometimes @code{org-hide} face may need tweaking to
-get the effect right. For some black and white combinations,
-@code{grey90} on a white background might mask the stars better.
+@node Code Evaluation Security
+@section Code Evaluation and Security Issues
-@item @emph{Odd levels}
-@vindex org-odd-levels-only
-Using stars for only odd levels, 1, 3, 5, @dots{}, can also clean up
-the clutter. This removes two stars from each level@footnote{Because @samp{LEVEL=2} has 3 stars, @samp{LEVEL=3} has 5 stars, and so
-on.}.
-For Org to properly handle this cleaner structure during edits
-and exports, configure the variable @code{org-odd-levels-only}. To
-set this per-file, use either one of the following lines:
+Unlike plain text, running code comes with risk. Each source code
+block, in terms of risk, is equivalent to an executable file. Org
+therefore puts a few confirmation prompts by default. This is to
+alert the casual user from accidentally running untrusted code.
-@example
-#+STARTUP: odd
-#+STARTUP: oddeven
-@end example
+For users who do not run code blocks or write code regularly, Org's
+default settings should suffice. However, some users may want to
+tweak the prompts for fewer interruptions. To weigh the risks of
+automatic execution of code blocks, here are some details about code
+evaluation.
-To switch between single and double stars layouts, use @kbd{M-x org-convert-to-odd-levels} and @kbd{M-x org-convert-to-oddeven-levels}.
-@end table
+Org evaluates code in the following circumstances:
-@node TTY Keys
-@section Using Org on a TTY
+@table @asis
+@item @emph{Source code blocks}
+Org evaluates source code blocks in an Org file during export. Org
+also evaluates a source code block with the @kbd{C-c C-c} key
+chord. Users exporting or running code blocks must load files only
+from trusted sources. Be wary of customizing variables that remove
+or alter default security measures.
-@cindex tty key bindings
+@defopt org-confirm-babel-evaluate
+When @code{t}, Org prompts the user for confirmation before executing
+each code block. When @code{nil}, Org executes code blocks without
+prompting the user for confirmation. When this option is set to
+a custom function, Org invokes the function with these two
+arguments: the source code language and the body of the code block.
+The custom function must return either a @code{t} or @code{nil}, which
+determines if the user is prompted. Each source code language can
+be handled separately through this function argument.
+@end defopt
-Org provides alternative key bindings for TTY and modern mobile
-devices that cannot perform movement commands on point and key
-bindings with modifier keys. Some of these workarounds may be more
-cumbersome than necessary. Users should look into customizing these
-further based on their usage needs. For example, the normal
-@kbd{S-<cursor>} for editing timestamp might be better with
-@kbd{C-c .} chord.
+For example, here is how to execute ditaa code blocks without
+prompting:
-@multitable @columnfractions 0.2 0.28 0.15 0.21
-@headitem Default
-@tab Alternative 1
-@tab Speed key
-@tab Alternative 2
-@item @kbd{S-@key{TAB}}
-@tab @kbd{C-u @key{TAB}}
-@tab @kbd{C}
-@tab
-@item @kbd{M-@key{LEFT}}
-@tab @kbd{C-c C-x l}
-@tab @kbd{l}
-@tab @kbd{Esc @key{LEFT}}
-@item @kbd{M-S-@key{LEFT}}
-@tab @kbd{C-c C-x L}
-@tab @kbd{L}
-@tab
-@item @kbd{M-@key{RIGHT}}
-@tab @kbd{C-c C-x r}
-@tab @kbd{r}
-@tab @kbd{Esc @key{RIGHT}}
-@item @kbd{M-S-@key{RIGHT}}
-@tab @kbd{C-c C-x R}
-@tab @kbd{R}
-@tab
-@item @kbd{M-@key{UP}}
-@tab @kbd{C-c C-x u}
-@tab
-@tab @kbd{Esc @key{UP}}
-@item @kbd{M-S-@key{UP}}
-@tab @kbd{C-c C-x U}
-@tab @kbd{U}
-@tab
-@item @kbd{M-@key{DOWN}}
-@tab @kbd{C-c C-x d}
-@tab
-@tab @kbd{Esc @key{DOWN}}
-@item @kbd{M-S-@key{DOWN}}
-@tab @kbd{C-c C-x D}
-@tab @kbd{D}
-@tab
-@item @kbd{S-@key{RET}}
-@tab @kbd{C-c C-x c}
-@tab
-@tab
-@item @kbd{M-@key{RET}}
-@tab @kbd{C-c C-x m}
-@tab
-@tab @kbd{Esc @key{RET}}
-@item @kbd{M-S-@key{RET}}
-@tab @kbd{C-c C-x M}
-@tab
-@tab
-@item @kbd{S-@key{LEFT}}
-@tab @kbd{C-c @key{LEFT}}
-@tab
-@tab
-@item @kbd{S-@key{RIGHT}}
-@tab @kbd{C-c @key{RIGHT}}
-@tab
-@tab
-@item @kbd{S-@key{UP}}
-@tab @kbd{C-c @key{UP}}
-@tab
-@tab
-@item @kbd{S-@key{DOWN}}
-@tab @kbd{C-c @key{DOWN}}
-@tab
-@tab
-@item @kbd{C-S-@key{LEFT}}
-@tab @kbd{C-c C-x @key{LEFT}}
-@tab
-@tab
-@item @kbd{C-S-@key{RIGHT}}
-@tab @kbd{C-c C-x @key{RIGHT}}
-@tab
-@tab
-@end multitable
+@lisp
+(defun my-org-confirm-babel-evaluate (lang body)
+ (not (string= lang "ditaa"))) ;don't ask for ditaa
+(setq org-confirm-babel-evaluate #'my-org-confirm-babel-evaluate)
+@end lisp
-@node Documentation Access
-@section Context Dependent Documentation
+@item @emph{Following @samp{shell} and @samp{elisp} links}
+Org has two link types that can directly evaluate code (see
+@ref{External Links}). Because such code is not visible, these links
+have a potential risk. Org therefore prompts the user when it
+encounters such links. The customization variables are:
-@cindex documentation
-@cindex Info
+@defopt org-link-shell-confirm-function
+Function that prompts the user before executing a shell link.
+@end defopt
-@findex org-info-find-node
-@kindex C-c C-x I
-@kbd{C-c C-x I} in an Org file tries to open a suitable section
-of the Org manual depending on the syntax at point. For example,
-using it on a headline displays ``Document Structure'' section.
+@defopt org-link-elisp-confirm-function
+Function that prompts the user before executing an Emacs Lisp link.
+@end defopt
-@kbd{q} closes the Info window.
+@item @emph{Formulas in tables}
+Formulas in tables (see @ref{The Spreadsheet}) are code that is evaluated
+either by the Calc interpreter, or by the Emacs Lisp interpreter.
+@end table
@node Interaction
@section Interaction with Other Packages
@@ -20152,21 +20219,21 @@ packages are documented here.
@item @samp{calc.el} by Dave Gillespie
@cindex @file{calc.el}
-Org uses the Calc package for implementing spreadsheet
-functionality in its tables (see @ref{The Spreadsheet}). Org also
-uses Calc for embedded calculations. See @ref{Embedded Mode,GNU Emacs Calc Manual,,calc,}.
+Org uses the Calc package for implementing spreadsheet functionality
+in its tables (see @ref{The Spreadsheet}). Org also uses Calc for
+embedded calculations. See @ref{Embedded Mode,GNU Emacs Calc Manual,,calc,}.
@item @samp{constants.el} by Carsten Dominik
@cindex @file{constants.el}
@vindex org-table-formula-constants
-Org can use names for constants in formulas in tables. Org can
-also use calculation suffixes for units, such as @samp{M} for @samp{Mega}.
-For a standard collection of such constants, install the
-@samp{constants} package. Install version 2.0 of this package,
-available at @uref{http://www.astro.uva.nl/~dominik/Tools}. Org checks
-if the function @code{constants-get} has been autoloaded.
-Installation instructions are in the file @samp{constants.el}.
+Org can use names for constants in formulas in tables. Org can also
+use calculation suffixes for units, such as @samp{M} for @samp{Mega}. For
+a standard collection of such constants, install the @samp{constants}
+package. Install version 2.0 of this package, available at
+@uref{http://www.astro.uva.nl/~dominik/Tools}. Org checks if the function
+@code{constants-get} has been autoloaded. Installation instructions are
+in the file @samp{constants.el}.
@item @samp{cdlatex.el} by Carsten Dominik
@cindex @file{cdlatex.el}
@@ -20193,11 +20260,11 @@ depth using the option @code{org-imenu-depth}.
@item @samp{speedbar.el} by Eric@tie{}M@.@tie{}Ludlam
@cindex @file{speedbar.el}
-Speedbar package creates a special Emacs frame for displaying
-files and index items in files. Org mode supports Speedbar;
-users can drill into Org files directly from the Speedbar. The
-@kbd{<} in the Speedbar frame tweaks the agenda commands to
-that file or to a subtree.
+Speedbar package creates a special Emacs frame for displaying files
+and index items in files. Org mode supports Speedbar; users can
+drill into Org files directly from the Speedbar. The @kbd{<}
+in the Speedbar frame tweaks the agenda commands to that file or to
+a subtree.
@item @samp{table.el} by Takaaki Ota
@cindex table editor, @file{table.el}
@@ -20205,45 +20272,45 @@ that file or to a subtree.
Complex ASCII tables with automatic line wrapping, column- and
row-spanning, and alignment can be created using the Emacs table
-package by Takaaki Ota. Org mode recognizes such tables and
-exports them properly. @kbd{C-c '} to edit these tables in
-a special buffer, much like Org's code blocks. Because of
-interference with other Org mode functionality, Takaaki Ota
-tables cannot be edited directly in the Org buffer.
+package by Takaaki Ota. Org mode recognizes such tables and exports
+them properly. @kbd{C-c '} to edit these tables in a special
+buffer, much like Org's code blocks. Because of interference with
+other Org mode functionality, Takaaki Ota tables cannot be edited
+directly in the Org buffer.
@table @asis
@item @kbd{C-c '} (@code{org-edit-special})
@kindex C-c '
@findex org-edit-special
-Edit a @samp{table.el} table. Works when point is in
-a @samp{table.el} table.
+Edit a @samp{table.el} table. Works when point is in a @samp{table.el}
+table.
@item @kbd{C-c ~​} (@code{org-table-create-with-table.el})
@kindex C-c ~
@findex org-table-create-with-table.el
-Insert a @samp{table.el} table. If there is already a table at
-point, this command converts it between the @samp{table.el}
-format and the Org mode format. See the documentation
-string of the command @code{org-convert-table} for the
-restrictions under which this is possible.
+Insert a @samp{table.el} table. If there is already a table at point,
+this command converts it between the @samp{table.el} format and the Org
+mode format. See the documentation string of the command
+@code{org-convert-table} for the restrictions under which this is
+possible.
@end table
@end table
@node Conflicts
@subsection Packages that conflict with Org mode
-@cindex shift-selection-mode
+@cindex shift-selection
@vindex org-support-shift-select
-In Emacs, @code{shift-selection-mode} combines motions of point with shift
-key to enlarge regions. Emacs sets this mode by default. This
-conflicts with Org's use of @kbd{S-<cursor>} commands to change
-timestamps, TODO keywords, priorities, and item bullet types, etc.
-Since @kbd{S-<cursor>} commands outside of specific contexts do
-not do anything, Org offers the variable @code{org-support-shift-select}
-for customization. Org mode accommodates shift selection by (i)
-making it available outside of the special contexts where special
-commands apply, and (ii) extending an existing active region even if
-point moves across a special context.
+In Emacs, shift-selection combines motions of point with shift key to
+enlarge regions. Emacs sets this mode by default. This conflicts
+with Org's use of @kbd{S-<cursor>} commands to change timestamps,
+TODO keywords, priorities, and item bullet types, etc. Since
+@kbd{S-<cursor>} commands outside of specific contexts do not do
+anything, Org offers the variable @code{org-support-shift-select} for
+customization. Org mode accommodates shift selection by (i) making it
+available outside of the special contexts where special commands
+apply, and (ii) extending an existing active region even if point
+moves across a special context.
@table @asis
@item @samp{cua.el} by Kim@tie{}F@.@tie{}Storm
@@ -20251,9 +20318,9 @@ point moves across a special context.
@vindex org-replace-disputed-keys
Org key bindings conflict with @kbd{S-<cursor>} keys used by
CUA mode. For Org to relinquish these bindings to CUA mode,
-configure the variable @code{org-replace-disputed-keys}. When set,
-Org moves the following key bindings in Org files, and in the
-agenda buffer---but not during date selection.
+configure the variable @code{org-replace-disputed-keys}. When set, Org
+moves the following key bindings in Org files, and in the agenda
+buffer---but not during date selection.
@multitable @columnfractions 0.4 0.4
@item @kbd{S-@key{UP}} @result{} @kbd{M-p}
@@ -20271,22 +20338,21 @@ want to have other replacement keys, look at the variable
@item @samp{ecomplete.el} by Lars Magne Ingebrigtsen
@cindex @file{ecomplete.el}
-Ecomplete provides ``electric'' address completion in address
-header lines in message buffers. Sadly Orgtbl mode cuts
-Ecomplete's power supply: no completion happens when Orgtbl mode
-is enabled in message buffers while entering text in address
-header lines. If one wants to use ecomplete one should @emph{not}
-follow the advice to automagically turn on Orgtbl mode in message
-buffers (see @ref{Orgtbl Mode}), but instead---after
-filling in the message headers---turn on Orgtbl mode manually
-when needed in the messages body.
+Ecomplete provides ``electric'' address completion in address header
+lines in message buffers. Sadly Orgtbl mode cuts Ecomplete's power
+supply: no completion happens when Orgtbl mode is enabled in message
+buffers while entering text in address header lines. If one wants
+to use ecomplete one should @emph{not} follow the advice to automagically
+turn on Orgtbl mode in message buffers (see @ref{Orgtbl Mode}),
+but instead---after filling in the message headers---turn on Orgtbl
+mode manually when needed in the messages body.
@item @samp{filladapt.el} by Kyle Jones
@cindex @file{filladapt.el}
-Org mode tries to do the right thing when filling paragraphs,
-list items and other elements. Many users reported problems
-using both @samp{filladapt.el} and Org mode, so a safe thing to do is
-to disable filladapt like this:
+Org mode tries to do the right thing when filling paragraphs, list
+items and other elements. Many users reported problems using both
+@samp{filladapt.el} and Org mode, so a safe thing to do is to disable
+filladapt like this:
@lisp
(add-hook 'org-mode-hook 'turn-off-filladapt-mode)
@@ -20296,9 +20362,9 @@ to disable filladapt like this:
@cindex @file{viper.el}
@kindex C-c /
-Viper uses @kbd{C-c /} and therefore makes this key not
-access the corresponding Org mode command @code{org-sparse-tree}. You
-need to find another key for this command, or override the key in
+Viper uses @kbd{C-c /} and therefore makes this key not access
+the corresponding Org mode command @code{org-sparse-tree}. You need to
+find another key for this command, or override the key in
@code{viper-vi-global-user-map} with
@lisp
@@ -20308,11 +20374,11 @@ need to find another key for this command, or override the key in
@item @samp{windmove.el} by Hovav Shacham
@cindex @file{windmove.el}
-This package also uses the @kbd{S-<cursor>} keys, so
-everything written in the paragraph above about CUA mode also
-applies here. If you want to make the windmove function active
-in locations where Org mode does not have special functionality
-on @kbd{S-<cursor>}, add this to your configuration:
+This package also uses the @kbd{S-<cursor>} keys, so everything
+written in the paragraph above about CUA mode also applies here. If
+you want to make the windmove function active in locations where Org
+mode does not have special functionality on @kbd{S-<cursor>},
+add this to your configuration:
@lisp
;; Make windmove work in Org mode:
@@ -20356,6 +20422,301 @@ Then, tell Org mode to use that function:
@end lisp
@end table
+@node TTY Keys
+@section Using Org on a TTY
+
+@cindex tty key bindings
+
+Org provides alternative key bindings for TTY and modern mobile
+devices that cannot perform movement commands on point and key
+bindings with modifier keys. Some of these workarounds may be more
+cumbersome than necessary. Users should look into customizing these
+further based on their usage needs. For example, the normal
+@kbd{S-<cursor>} for editing timestamp might be better with
+@kbd{C-c .} chord.
+
+@multitable @columnfractions 0.2 0.28 0.15 0.21
+@headitem Default
+@tab Alternative 1
+@tab Speed key
+@tab Alternative 2
+@item @kbd{S-@key{TAB}}
+@tab @kbd{C-u @key{TAB}}
+@tab @kbd{C}
+@tab
+@item @kbd{M-@key{LEFT}}
+@tab @kbd{C-c C-x l}
+@tab @kbd{l}
+@tab @kbd{Esc @key{LEFT}}
+@item @kbd{M-S-@key{LEFT}}
+@tab @kbd{C-c C-x L}
+@tab @kbd{L}
+@tab
+@item @kbd{M-@key{RIGHT}}
+@tab @kbd{C-c C-x r}
+@tab @kbd{r}
+@tab @kbd{Esc @key{RIGHT}}
+@item @kbd{M-S-@key{RIGHT}}
+@tab @kbd{C-c C-x R}
+@tab @kbd{R}
+@tab
+@item @kbd{M-@key{UP}}
+@tab @kbd{C-c C-x u}
+@tab
+@tab @kbd{Esc @key{UP}}
+@item @kbd{M-S-@key{UP}}
+@tab @kbd{C-c C-x U}
+@tab @kbd{U}
+@tab
+@item @kbd{M-@key{DOWN}}
+@tab @kbd{C-c C-x d}
+@tab
+@tab @kbd{Esc @key{DOWN}}
+@item @kbd{M-S-@key{DOWN}}
+@tab @kbd{C-c C-x D}
+@tab @kbd{D}
+@tab
+@item @kbd{S-@key{RET}}
+@tab @kbd{C-c C-x c}
+@tab
+@tab
+@item @kbd{M-@key{RET}}
+@tab @kbd{C-c C-x m}
+@tab
+@tab @kbd{Esc @key{RET}}
+@item @kbd{M-S-@key{RET}}
+@tab @kbd{C-c C-x M}
+@tab
+@tab
+@item @kbd{S-@key{LEFT}}
+@tab @kbd{C-c @key{LEFT}}
+@tab
+@tab
+@item @kbd{S-@key{RIGHT}}
+@tab @kbd{C-c @key{RIGHT}}
+@tab
+@tab
+@item @kbd{S-@key{UP}}
+@tab @kbd{C-c @key{UP}}
+@tab
+@tab
+@item @kbd{S-@key{DOWN}}
+@tab @kbd{C-c @key{DOWN}}
+@tab
+@tab
+@item @kbd{C-S-@key{LEFT}}
+@tab @kbd{C-c C-x @key{LEFT}}
+@tab
+@tab
+@item @kbd{C-S-@key{RIGHT}}
+@tab @kbd{C-c C-x @key{RIGHT}}
+@tab
+@tab
+@end multitable
+
+@node Protocols
+@section Protocols for External Access
+
+@cindex protocols, for external access
+
+Org protocol is a tool to trigger custom actions in Emacs from
+external applications. Any application that supports calling external
+programs with an URL as argument may be used with this functionality.
+For example, you can configure bookmarks in your web browser to send a
+link to the current page to Org and create a note from it using
+capture (see @ref{Capture}). You can also create a bookmark that tells
+Emacs to open the local source file of a remote website you are
+browsing.
+
+@cindex Org protocol, set-up
+@cindex Installing Org protocol
+In order to use Org protocol from an application, you need to register
+@samp{org-protocol://} as a valid scheme-handler. External calls are
+passed to Emacs through the @samp{emacsclient} command, so you also need to
+ensure an Emacs server is running. More precisely, when the
+application calls
+
+@example
+emacsclient org-protocol://PROTOCOL?key1=val1&key2=val2
+@end example
+
+
+@noindent
+Emacs calls the handler associated to @var{PROTOCOL} with
+argument @samp{(:key1 val1 :key2 val2)}.
+
+@cindex protocol, new protocol
+@cindex defining new protocols
+Org protocol comes with three predefined protocols, detailed in the
+following sections. Configure @code{org-protocol-protocol-alist} to define
+your own.
+
+@menu
+* The @code{store-link} protocol:: Store a link, push URL to kill-ring.
+* The @code{capture} protocol:: Fill a buffer with external information.
+* The @code{open-source} protocol:: Edit published contents.
+@end menu
+
+@node The @code{store-link} protocol
+@subsection The @code{store-link} protocol
+
+@cindex store-link protocol
+@cindex protocol, store-link
+
+Using the @code{store-link} handler, you can copy links, to that they can
+be inserted using @kbd{M-x org-insert-link} or yanking. More
+precisely, the command
+
+@example
+emacsclient org-protocol://store-link?url=URL&title=TITLE
+@end example
+
+
+@noindent
+stores the following link:
+
+@example
+[[URL][TITLE]]
+@end example
+
+
+In addition, @var{URL} is pushed on the kill-ring for yanking.
+You need to encode @var{URL} and @var{TITLE} if they contain
+slashes, and probably quote those for the shell.
+
+To use this feature from a browser, add a bookmark with an arbitrary
+name, e.g., @samp{Org: store-link} and enter this as @emph{Location}:
+
+@example
+javascript:location.href='org-protocol://store-link?url='+
+ encodeURIComponent(location.href);
+@end example
+
+@node The @code{capture} protocol
+@subsection The @code{capture} protocol
+
+@cindex capture protocol
+@cindex protocol, capture
+
+Activating the ``capture'' handler pops up a @samp{Capture} buffer in Emacs,
+using acapture template.
+
+@example
+emacsclient org-protocol://capture?template=X?url=URL?title=TITLE?body=BODY
+@end example
+
+
+To use this feature, add a bookmark with an arbitrary name, e.g.,
+@samp{Org: capture}, and enter this as @samp{Location}:
+
+@example
+javascript:location.href='org-protocol://capture?template=x'+
+ '&url='+encodeURIComponent(window.location.href)+
+ '&title='+encodeURIComponent(document.title)+
+ '&body='+encodeURIComponent(window.getSelection());
+@end example
+
+@vindex org-protocol-default-template-key
+The capture template to be used can be specified in the bookmark (like
+@samp{X} above). If unspecified, the template key is set in the variable
+@code{org-protocol-default-template-key}. The following template
+placeholders are available:
+
+@example
+%:link The URL
+%:description The webpage title
+%:annotation Equivalent to [[%:link][%:description]]
+%i The selected text
+@end example
+
+@node The @code{open-source} protocol
+@subsection The @code{open-source} protocol
+
+@cindex open-source protocol
+@cindex protocol, open-source
+
+The @code{open-source} handler is designed to help with editing local
+sources when reading a document. To that effect, you can use
+a bookmark with the following location:
+
+@example
+javascript:location.href='org-protocol://open-source?&url='+
+ encodeURIComponent(location.href)
+@end example
+
+@vindex org-protocol-project-alist
+The variable @code{org-protocol-project-alist} maps URLs to local file
+names, by stripping URL parameters from the end and replacing the
+@code{:base-url} with @code{:working-directory} and @code{:online-suffix} with
+@code{:working-suffix}. For example, assuming you own a local copy of
+@samp{https://orgmode.org/worg/} contents at @samp{/home/user/worg}, you can set
+@code{org-protocol-project-alist} to the following
+
+@lisp
+(setq org-protocol-project-alist
+ '(("Worg"
+ :base-url "https://orgmode.org/worg/"
+ :working-directory "/home/user/worg/"
+ :online-suffix ".html"
+ :working-suffix ".org")))
+@end lisp
+
+@noindent
+If you are now browsing
+@samp{https://orgmode.org/worg/org-contrib/org-protocol.html} and find
+a typo or have an idea about how to enhance the documentation, simply
+click the bookmark and start editing.
+
+@cindex rewritten URL in open-source protocol
+@cindex protocol, open-source rewritten URL
+However, such mapping may not always yield the desired results.
+Suppose you maintain an online store located at @samp{http://example.com/}.
+The local sources reside in @samp{/home/user/example/}. It is common
+practice to serve all products in such a store through one file and
+rewrite URLs that do not match an existing file on the server. That
+way, a request to @samp{http://example.com/print/posters.html} might be
+rewritten on the server to something like
+@samp{http://example.com/shop/products.php/posters.html.php}. The
+@code{open-source} handler probably cannot find a file named
+@samp{/home/user/example/print/posters.html.php} and fails.
+
+Such an entry in @code{org-protocol-project-alist} may hold an additional
+property @code{:rewrites}. This property is a list of cons cells, each of
+which maps a regular expression to a path relative to the
+@code{:working-directory}.
+
+Now map the URL to the path @samp{/home/user/example/products.php} by
+adding @code{:rewrites} rules like this:
+
+@lisp
+(setq org-protocol-project-alist
+ '(("example.com"
+ :base-url "http://example.com/"
+ :working-directory "/home/user/example/"
+ :online-suffix ".php"
+ :working-suffix ".php"
+ :rewrites (("example.com/print/" . "products.php")
+ ("example.com/$" . "index.php")))))
+@end lisp
+
+@noindent
+Since @samp{example.com/$} is used as a regular expression, it maps
+@samp{http://example.com/}, @samp{https://example.com},
+@samp{http://www.example.com/} and similar to
+@samp{/home/user/example/index.php}.
+
+The @code{:rewrites} rules are searched as a last resort if and only if no
+existing file name is matched.
+
+@cindex protocol, open-source, set-up mapping
+@cindex mappings in open-source protocol
+@findex org-protocol-create
+@findex org-protocol-create-for-org
+Two functions can help you filling @code{org-protocol-project-alist} with
+valid contents: @code{org-protocol-create} and
+@code{org-protocol-create-for-org}. The latter is of use if you're editing
+an Org file that is part of a publishing project.
+
@node Org Crypt
@section Org Crypt
@@ -20529,12 +20890,13 @@ agenda item.
@table @asis
@item @kbd{?}
-Pressing @kbd{?} displays the entire flagged note in
-another window. Org also pushes it to the kill ring. To
-store flagged note as a normal note, use @kbd{? z C-y C-c C-c}. Pressing @kbd{?} twice does these things: first
-it removes the @samp{FLAGGED} tag; second, it removes the flagged
-note from the property drawer; third, it signals that manual
-editing of the flagged entry is now finished.
+Pressing @kbd{?} displays the entire flagged note in another
+window. Org also pushes it to the kill ring. To store flagged
+note as a normal note, use @kbd{? z C-y C-c C-c}. Pressing
+@kbd{?} twice does these things: first it removes the
+@samp{FLAGGED} tag; second, it removes the flagged note from the
+property drawer; third, it signals that manual editing of the
+flagged entry is now finished.
@end table
@end enumerate
@@ -20545,62 +20907,6 @@ most recent since the mobile application searches files that were last
pulled. To get an updated agenda view with changes since the last
pull, pull again.
-@node Org Syntax
-@section Org Syntax
-
-A reference document providing a formal description of Org's syntax is
-available as @uref{https://orgmode.org/worg/dev/org-syntax.html, a draft on Worg}, written and maintained by Nicolas
-Goaziou. It defines Org's core internal concepts such as ``headlines'',
-``sections'', ``affiliated keywords'', ``(greater) elements'' and ``objects''.
-Each part of an Org document belongs to one of the previous
-categories.
-
-To explore the abstract structure of an Org buffer, run this in
-a buffer:
-
-@example
-M-: (org-element-parse-buffer) <RET>
-@end example
-
-
-@noindent
-It outputs a list containing the buffer's content represented as an
-abstract structure. The export engine relies on the information
-stored in this list. Most interactive commands---e.g., for structure
-editing---also rely on the syntactic meaning of the surrounding
-context.
-
-@cindex syntax checker
-@cindex linter
-@findex org-lint
-You can probe the syntax of your documents with the command
-
-@example
-M-x org-lint <RET>
-@end example
-
-
-@noindent
-It runs a number of checks to find common mistakes. It then displays
-their location in a dedicated buffer, along with a description and
-a ``trust level'', since false-positive are possible. From there, you
-can operate on the reports with the following keys:
-
-@multitable @columnfractions 0.22 0.78
-@item @kbd{C-j}, @kbd{@key{TAB}}
-@tab Display the offending line
-@item @kbd{@key{RET}}
-@tab Move point to the offending line
-@item @kbd{g}
-@tab Check the document again
-@item @kbd{h}
-@tab Hide all reports from the same checker
-@item @kbd{i}
-@tab Also remove them from all subsequent checks
-@item @kbd{S}
-@tab Sort reports by the column at point
-@end multitable
-
@node Hacking
@appendix Hacking
@@ -20739,7 +21045,7 @@ The rest of the file implements necessary variables and functions.
For example, @code{org-man-store-link} is responsible for storing a link
when @code{org-store-link} (see @ref{Handling Links}) is called from a buffer
-displaying a man page. It first checks if the @code{major-mode} is
+displaying a man page. It first checks if the major mode is
appropriate. If check fails, the function returns @code{nil}, which
means it isn't responsible for creating a link to the current
buffer. Otherwise the function makes a link string by combining
@@ -20845,8 +21151,8 @@ called:
@table @asis
@item @samp{:skip N}
-Skip the first N lines of the table. Hlines do count; include
-them if they are to be skipped.
+Skip the first N lines of the table. Hlines do count; include them
+if they are to be skipped.
@item @samp{:skipcols (n1 n2 ...)}
List of columns to be skipped. First Org automatically discards
@@ -20956,28 +21262,26 @@ control output, see @ref{Translator functions}:
@table @asis
@item @samp{:splice BOOLEAN}
-When @{@{@{var(BOOLEAN@}@}@} is non-@code{nil}, return only table body
-lines; i.e., not wrapped in @samp{tabular} environment. Default is
-@code{nil}.
+When @{@{@{var(BOOLEAN@}@}@} is non-@code{nil}, return only table body lines;
+i.e., not wrapped in @samp{tabular} environment. Default is @code{nil}.
@item @samp{:fmt FMT}
Format string to warp each field. It should contain @samp{%s} for the
original field value. For example, to wrap each field value in
dollar symbol, you could use @samp{:fmt "$%s$"}. Format can also wrap
-a property list with column numbers and formats, for example
-@samp{:fmt (2 "$%s$" 4 "%s\\%%")}. In place of a string, a function
-of one argument can be used; the function must return a formatted
-string.
+a property list with column numbers and formats, for example @samp{:fmt
+ (2 "$%s$" 4 "%s\\%%")}. In place of a string, a function of one
+argument can be used; the function must return a formatted string.
@item @samp{:efmt EFMT}
-Format numbers as exponentials. The spec should have @samp{%s} twice
-for inserting mantissa and exponent, for example @samp{"%s\\times10^@{%s@}"}.
-This may also be a property list with column numbers and formats,
-for example @samp{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
+Format numbers as exponentials. The spec should have @samp{%s} twice for
+inserting mantissa and exponent, for example @samp{"%s\\times10^@{%s@}"}. This
+may also be a property list with column numbers and formats, for
+example @samp{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
@var{EFMT} has been applied to a value, @var{FMT}---see
above---is also applied. Functions with two arguments can be
-supplied instead of strings. By default, no special formatting
-is applied.
+supplied instead of strings. By default, no special formatting is
+applied.
@end table
@node Translator functions
@@ -21048,8 +21352,14 @@ users mailing list, at @email{emacs-orgmode@@gnu.org}.
Org supports @emph{dynamic blocks} in Org documents. They are inserted
with begin and end markers like any other code block, but the contents
-are updated automatically by a user function. For example, @kbd{C-c C-x C-r} inserts a dynamic table that updates the work time (see
-@ref{Clocking Work Time}).
+are updated automatically by a user function.
+
+@kindex C-c C-x x
+@findex org-dynamic-block-insert-dblock
+You can insert a dynamic block with @code{org-dynamic-block-insert-dblock},
+which is bound to @kbd{C-c C-x x} by default. For example,
+@kbd{C-c C-x x c l o c k t a b l e @key{RET}} inserts a table that
+updates the work time (see @ref{Clocking Work Time}).
Dynamic blocks can have names and function parameters. The syntax is
similar to source code block specifications:
@@ -21075,13 +21385,12 @@ Update all dynamic blocks in the current file.
Before updating a dynamic block, Org removes content between the
@samp{BEGIN} and @samp{END} markers. Org then reads the parameters on the
-@samp{BEGIN} line for passing to the writer function. If the function
-expects to access the removed content, then Org expects an extra
-parameter, @samp{:content}, on the @samp{BEGIN} line.
+@samp{BEGIN} line for passing to the writer function as a plist. The
+previous content of the dynamic block becomes erased from the buffer
+and appended to the plist under @code{:content}.
The syntax for naming a writer function with a dynamic block labelled
-@samp{myblock} is: @code{org-dblock-write:myblock}. Parameters come from the
-@samp{BEGIN} line.
+@samp{myblock} is: @code{org-dblock-write:myblock}.
The following is an example of a dynamic block and a block writer function
that updates the time when the function was last run:
@@ -21190,12 +21499,11 @@ Skip current entry if the TODO keyword is TODO or WAITING@.
Skip current entry if the TODO keyword marks a DONE state.
@item @samp{(org-agenda-skip-entry-if 'timestamp)}
-Skip current entry if it has any timestamp, may also be deadline
-or scheduled.
+Skip current entry if it has any timestamp, may also be deadline or
+scheduled.
@item @samp{(org-agenda-skip-entry-if 'regexp "regular expression")}
-Skip current entry if the regular expression matches in the
-entry.
+Skip current entry if the regular expression matches in the entry.
@item @samp{(org-agenda-skip-entry-if 'notregexp "regular expression")}
Skip current entry unless the regular expression matches.
@@ -21562,8 +21870,8 @@ Skip trees with the COMMENT keyword.
@item function or Lisp form
@vindex org-agenda-skip-function
Used as value for @code{org-agenda-skip-function}, so whenever the
-function returns @code{t}, @var{FUNC} is called for that entry
-and search continues from the point where the function leaves it.
+function returns @code{t}, @var{FUNC} is called for that entry and
+search continues from the point where the function leaves it.
@end table
@end defun
@@ -21649,36 +21957,34 @@ Before I get to this list, a few special mentions are in order:
@table @asis
@item Bastien Guerry
Bastien has written a large number of extensions to Org (most of
-them integrated into the core by now), including the @LaTeX{}
-exporter and the plain list parser. His support during the early
-days was central to the success of this project. Bastien also
-invented Worg, helped establishing the Web presence of Org, and
-sponsored hosting costs for the orgmode.org website. Bastien
-stepped in as maintainer of Org between 2011 and 2013, at a time
-when I desperately needed a break.
+them integrated into the core by now), including the @LaTeX{} exporter
+and the plain list parser. His support during the early days was
+central to the success of this project. Bastien also invented Worg,
+helped establishing the Web presence of Org, and sponsored hosting
+costs for the orgmode.org website. Bastien stepped in as maintainer
+of Org between 2011 and 2013, at a time when I desperately needed
+a break.
@item Eric Schulte and Dan Davison
-Eric and Dan are jointly responsible for the Org Babel system,
-which turns Org into a multi-language environment for evaluating
-code and doing literate programming and reproducible research.
-This has become one of Org's killer features that define what Org
-is today.
+Eric and Dan are jointly responsible for the Org Babel system, which
+turns Org into a multi-language environment for evaluating code and
+doing literate programming and reproducible research. This has
+become one of Org's killer features that define what Org is today.
@item John Wiegley
-John has contributed a number of great ideas and patches directly
-to Org, including the attachment system (@samp{org-attach.el}),
-integration with Apple Mail (@samp{org-mac-message.el}), hierarchical
-dependencies of TODO items, habit tracking (@samp{org-habits.el}), and
-encryption (@samp{org-crypt.el}). Also, the capture system is really
-an extended copy of his great @samp{remember.el}.
+John has contributed a number of great ideas and patches directly to
+Org, including the attachment system (@samp{org-attach.el}), integration
+with Apple Mail (@samp{org-mac-message.el}), hierarchical dependencies of
+TODO items, habit tracking (@samp{org-habits.el}), and encryption
+(@samp{org-crypt.el}). Also, the capture system is really an extended
+copy of his great @samp{remember.el}.
@item Sebastian Rose
Without Sebastian, the HTML/XHTML publishing of Org would be the
-pitiful work of an ignorant amateur. Sebastian has pushed this
-part of Org onto a much higher level. He also wrote
-@samp{org-info.js}, a Java script for displaying webpages derived from
-Org using an Info-like or a folding interface with single-key
-navigation.
+pitiful work of an ignorant amateur. Sebastian has pushed this part
+of Org onto a much higher level. He also wrote @samp{org-info.js},
+a JavaScript program for displaying webpages derived from Org using
+an Info-like or a folding interface with single-key navigation.
@end table
See below for the full list of contributions! Again, please let me
@@ -21705,30 +22011,28 @@ considered co-maintainers, either of the code or the community:
@table @asis
@item Eric Schulte
Eric is maintaining the Babel parts of Org. His reactivity here
-kept me away from worrying about possible bugs here and let me
-focus on other parts.
+kept me away from worrying about possible bugs here and let me focus
+on other parts.
@item Nicolas Goaziou
-Nicolas is maintaining the consistency of the deepest parts of
-Org. His work on @samp{org-element.el} and @samp{ox.el} has been
-outstanding, and it opened the doors for many new ideas and
-features. He rewrote many of the old exporters to use the new
-export engine, and helped with documenting this major change.
-More importantly (if that's possible), he has been more than
-reliable during all the work done for Org 8.0, and always very
-reactive on the mailing list.
+Nicolas is maintaining the consistency of the deepest parts of Org.
+His work on @samp{org-element.el} and @samp{ox.el} has been outstanding, and
+it opened the doors for many new ideas and features. He rewrote
+many of the old exporters to use the new export engine, and helped
+with documenting this major change. More importantly (if that's
+possible), he has been more than reliable during all the work done
+for Org 8.0, and always very reactive on the mailing list.
@item Achim Gratz
Achim rewrote the building process of Org, turning some @emph{ad hoc}
-tools into a flexible and conceptually clean process. He
-patiently coped with the many hiccups that such a change can
-create for users.
+tools into a flexible and conceptually clean process. He patiently
+coped with the many hiccups that such a change can create for users.
@item Nick Dokos
The Org mode mailing list would not be such a nice place without
-Nick, who patiently helped users so many times. It is impossible
-to overestimate such a great help, and the list would not be so
-active without him.
+Nick, who patiently helped users so many times. It is impossible to
+overestimate such a great help, and the list would not be so active
+without him.
@end table
I received support from so many users that it is clearly impossible to
@@ -21743,7 +22047,7 @@ be complete if the ones above were not mentioned in this manual.
Russel Adams came up with the idea for drawers.
@item
-Thomas Baumann wrote @samp{org-bbdb.el} and @samp{org-mhe.el}.
+Thomas Baumann wrote @samp{ol-bbdb.el} and @samp{ol-mhe.el}.
@item
Christophe Bataillon created the great unicorn logo that we use on
@@ -21753,7 +22057,7 @@ the Org mode website.
Alex Bochannek provided a patch for rounding timestamps.
@item
-Jan Böcker wrote @samp{org-docview.el}.
+Jan Böcker wrote @samp{ol-docview.el}.
@item
Brad Bozarth showed how to pull RSS feed data into Org files.
@@ -21858,7 +22162,7 @@ Manuel Hermenegildo has contributed various ideas, small fixes and
patches.
@item
-Phil Jackson wrote @samp{org-irc.el}.
+Phil Jackson wrote @samp{ol-irc.el}.
@item
Scott Jaderholm proposed footnotes, control over whitespace between
@@ -22002,7 +22306,7 @@ Ulf Stegemann created the table to translate special symbols to
HTML, @LaTeX{}, UTF-8, Latin-1 and ASCII@.
@item
-Andy Stewart contributed code to @samp{org-w3m.el}, to copy
+Andy Stewart contributed code to @samp{ol-w3m.el}, to copy
HTML content with links transformation to Org syntax.
@item
@@ -22048,13 +22352,524 @@ Piotr Zielinski wrote @samp{org-mouse.el}, proposed agenda
blocks and contributed various ideas and code snippets.
@item
-Marco Wahl wrote @samp{org-eww.el}.
+Marco Wahl wrote @samp{ol-eww.el}.
@end itemize
@node GNU Free Documentation License
@appendix GNU Free Documentation License
-@include doclicense.texi
+@center Version 1.3, 3 November 2008
+
+@display
+Copyright @copyright{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
+@uref{http://fsf.org/}
+
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+@end display
+
+@enumerate 0
+@item
+PREAMBLE
+
+The purpose of this License is to make a manual, textbook, or other
+functional and useful document @dfn{free}
+in the sense of freedom: to assure everyone the effective freedom
+to copy and redistribute it, with or without modifying it, either
+commercially or noncommercially. Secondarily, this License
+preserves for the author and publisher a way to get credit for
+their work, while not being considered responsible for
+modifications made by others.
+
+This License is a kind of ``copyleft'', which means that derivative
+works of the document must themselves be free in the same sense.
+It complements the GNU General Public License, which is a copyleft
+license designed for free software.
+
+We have designed this License in order to use it for manuals for
+free software, because free software needs free documentation:
+a free program should come with manuals providing the same freedoms
+that the software does. But this License is not limited to
+software manuals; it can be used for any textual work, regardless
+of subject matter or whether it is published as a printed book. We
+recommend this License principally for works whose purpose is
+instruction or reference.
+
+@item
+APPLICABILITY AND DEFINITIONS
+
+This License applies to any manual or other work, in any medium,
+that contains a notice placed by the copyright holder saying it can
+be distributed under the terms of this License. Such a notice
+grants a world-wide, royalty-free license, unlimited in duration,
+to use that work under the conditions stated herein. The
+``Document'', below, refers to any such manual or work. Any member
+of the public is a licensee, and is addressed as ``you''. You accept
+the license if you copy, modify or distribute the work in a way
+requiring permission under copyright law.
+
+A ``Modified Version'' of the Document means any work containing the
+Document or a portion of it, either copied verbatim, or with
+modifications and/or translated into another language.
+
+A ``Secondary Section'' is a named appendix or a front-matter section
+of the Document that deals exclusively with the relationship of the
+publishers or authors of the Document to the Document's overall
+subject (or to related matters) and contains nothing that could
+fall directly within that overall subject. (Thus, if the Document
+is in part a textbook of mathematics, a Secondary Section may not
+explain any mathematics.) The relationship could be a matter of
+historical connection with the subject or with related matters, or
+of legal, commercial, philosophical, ethical or political position
+regarding them.
+
+The ``Invariant Sections'' are certain Secondary Sections whose
+titles are designated, as being those of Invariant Sections, in the
+notice that says that the Document is released under this License.
+If a section does not fit the above definition of Secondary then it
+is not allowed to be designated as Invariant. The Document may
+contain zero Invariant Sections. If the Document does not identify
+any Invariant Sections then there are none.
+
+The ``Cover Texts'' are certain short passages of text that are
+listed, as Front-Cover Texts or Back-Cover Texts, in the notice
+that says that the Document is released under this License.
+A Front-Cover Text may be at most 5 words, and a Back-Cover Text
+may be at most 25 words.
+
+A ``Transparent'' copy of the Document means a machine-readable copy,
+represented in a format whose specification is available to the
+general public, that is suitable for revising the document
+straightforwardly with generic text editors or (for images composed
+of pixels) generic paint programs or (for drawings) some widely
+available drawing editor, and that is suitable for input to text
+formatters or for automatic translation to a variety of formats
+suitable for input to text formatters. A copy made in an otherwise
+Transparent file format whose markup, or absence of markup, has
+been arranged to thwart or discourage subsequent modification by
+readers is not Transparent. An image format is not Transparent if
+used for any substantial amount of text. A copy that is not
+``Transparent'' is called ``Opaque''.
+
+Examples of suitable formats for Transparent copies include plain
+ASCII without markup, Texinfo input format, @LaTeX{} input format,
+SGML or XML using a publicly available DTD, and standard-conforming
+simple HTML, PostScript or PDF designed for human modification.
+Examples of transparent image formats include PNG, XCF and JPG@.
+Opaque formats include proprietary formats that can be read and
+edited only by proprietary word processors, SGML or XML for which
+the DTD and/or processing tools are not generally available, and
+the machine-generated HTML, PostScript or PDF produced by some word
+processors for output purposes only.
+
+The ``Title Page'' means, for a printed book, the title page itself,
+plus such following pages as are needed to hold, legibly, the
+material this License requires to appear in the title page. For
+works in formats which do not have any title page as such, ``Title
+Page'' means the text near the most prominent appearance of the
+work's title, preceding the beginning of the body of the text.
+
+The ``publisher'' means any person or entity that distributes copies
+of the Document to the public.
+
+A section ``Entitled XYZ'' means a named subunit of the Document
+whose title either is precisely XYZ or contains XYZ in parentheses
+following text that translates XYZ in another language. (Here XYZ
+stands for a specific section name mentioned below, such as
+``Acknowledgements'', ``Dedications'', ``Endorsements'', or ``History''.)
+To ``Preserve the Title'' of such a section when you modify the
+Document means that it remains a section ``Entitled XYZ'' according
+to this definition.
+
+The Document may include Warranty Disclaimers next to the notice
+which states that this License applies to the Document. These
+Warranty Disclaimers are considered to be included by reference in
+this License, but only as regards disclaiming warranties: any other
+implication that these Warranty Disclaimers may have is void and
+has no effect on the meaning of this License.
+
+@item
+VERBATIM COPYING
+
+You may copy and distribute the Document in any medium, either
+commercially or noncommercially, provided that this License, the
+copyright notices, and the license notice saying this License
+applies to the Document are reproduced in all copies, and that you
+add no other conditions whatsoever to those of this License. You
+may not use technical measures to obstruct or control the reading
+or further copying of the copies you make or distribute. However,
+you may accept compensation in exchange for copies. If you
+distribute a large enough number of copies you must also follow the
+conditions in section 3.
+
+You may also lend copies, under the same conditions stated above,
+and you may publicly display copies.
+
+@item
+COPYING IN QUANTITY
+
+If you publish printed copies (or copies in media that commonly
+have printed covers) of the Document, numbering more than 100, and
+the Document's license notice requires Cover Texts, you must
+enclose the copies in covers that carry, clearly and legibly, all
+these Cover Texts: Front-Cover Texts on the front cover, and
+Back-Cover Texts on the back cover. Both covers must also clearly
+and legibly identify you as the publisher of these copies. The
+front cover must present the full title with all words of the title
+equally prominent and visible. You may add other material on the
+covers in addition. Copying with changes limited to the covers, as
+long as they preserve the title of the Document and satisfy these
+conditions, can be treated as verbatim copying in other respects.
+
+If the required texts for either cover are too voluminous to fit
+legibly, you should put the first ones listed (as many as fit
+reasonably) on the actual cover, and continue the rest onto
+adjacent pages.
+
+If you publish or distribute Opaque copies of the Document
+numbering more than 100, you must either include a machine-readable
+Transparent copy along with each Opaque copy, or state in or with
+each Opaque copy a computer-network location from which the general
+network-using public has access to download using public-standard
+network protocols a complete Transparent copy of the Document, free
+of added material. If you use the latter option, you must take
+reasonably prudent steps, when you begin distribution of Opaque
+copies in quantity, to ensure that this Transparent copy will
+remain thus accessible at the stated location until at least one
+year after the last time you distribute an Opaque copy (directly or
+through your agents or retailers) of that edition to the public.
+
+It is requested, but not required, that you contact the authors of
+the Document well before redistributing any large number of copies,
+to give them a chance to provide you with an updated version of the
+Document.
+
+@item
+MODIFICATIONS
+
+You may copy and distribute a Modified Version of the Document
+under the conditions of sections 2 and 3 above, provided that you
+release the Modified Version under precisely this License, with the
+Modified Version filling the role of the Document, thus licensing
+distribution and modification of the Modified Version to whoever
+possesses a copy of it. In addition, you must do these things in
+the Modified Version:
+
+@enumerate A
+@item
+Use in the Title Page (and on the covers, if any) a title
+distinct from that of the Document, and from those of previous
+versions (which should, if there were any, be listed in the
+History section of the Document). You may use the same title as
+a previous version if the original publisher of that version
+gives permission.
+
+@item
+List on the Title Page, as authors, one or more persons or
+entities responsible for authorship of the modifications in the
+Modified Version, together with at least five of the principal
+authors of the Document (all of its principal authors, if it has
+fewer than five), unless they release you from this requirement.
+
+@item
+State on the Title page the name of the publisher of the
+Modified Version, as the publisher.
+
+@item
+Preserve all the copyright notices of the Document.
+
+@item
+Add an appropriate copyright notice for your modifications
+adjacent to the other copyright notices.
+
+@item
+Include, immediately after the copyright notices, a license
+notice giving the public permission to use the Modified Version
+under the terms of this License, in the form shown in the
+Addendum below.
+
+@item
+Preserve in that license notice the full lists of Invariant
+Sections and required Cover Texts given in the Document's
+license notice.
+
+@item
+Include an unaltered copy of this License.
+
+@item
+Preserve the section Entitled ``History'', Preserve its Title, and
+add to it an item stating at least the title, year, new authors,
+and publisher of the Modified Version as given on the Title
+Page. If there is no section Entitled ``History'' in the Document,
+create one stating the title, year, authors, and publisher of
+the Document as given on its Title Page, then add an item
+describing the Modified Version as stated in the previous
+sentence.
+
+@item
+Preserve the network location, if any, given in the Document
+for public access to a Transparent copy of the Document, and
+likewise the network locations given in the Document for
+previous versions it was based on. These may be placed in the
+``History'' section. You may omit a network location for a work
+that was published at least four years before the Document
+itself, or if the original publisher of the version it refers
+to gives permission.
+
+@item
+For any section Entitled ``Acknowledgements'' or ``Dedications'',
+Preserve the Title of the section, and preserve in the section
+all the substance and tone of each of the contributor
+acknowledgements and/or dedications given therein.
+
+@item
+Preserve all the Invariant Sections of the Document, unaltered
+in their text and in their titles. Section numbers or the
+equivalent are not considered part of the section titles.
+
+@item
+Delete any section Entitled ``Endorsements''. Such a section may
+not be included in the Modified Version.
+
+@item
+Do not retitle any existing section to be Entitled
+``Endorsements'' or to conflict in title with any Invariant
+Section.
+
+@item
+Preserve any Warranty Disclaimers.
+@end enumerate
+
+If the Modified Version includes new front-matter sections or
+appendices that qualify as Secondary Sections and contain no material
+copied from the Document, you may at your option designate some or all
+of these sections as invariant. To do this, add their titles to the
+list of Invariant Sections in the Modified Version's license notice.
+These titles must be distinct from any other section titles.
+
+You may add a section Entitled ``Endorsements'', provided it contains
+nothing but endorsements of your Modified Version by various
+parties---for example, statements of peer review or that the text has
+been approved by an organization as the authoritative definition of a
+standard.
+
+You may add a passage of up to five words as a Front-Cover Text, and a
+passage of up to 25 words as a Back-Cover Text, to the end of the list
+of Cover Texts in the Modified Version. Only one passage of
+Front-Cover Text and one of Back-Cover Text may be added by (or
+through arrangements made by) any one entity. If the Document already
+includes a cover text for the same cover, previously added by you or
+by arrangement made by the same entity you are acting on behalf of,
+you may not add another; but you may replace the old one, on explicit
+permission from the previous publisher that added the old one.
+
+The author(s) and publisher(s) of the Document do not by this License
+give permission to use their names for publicity for or to assert or
+imply endorsement of any Modified Version.
+
+@item
+COMBINING DOCUMENTS
+
+You may combine the Document with other documents released under
+this License, under the terms defined in section 4 above for
+modified versions, provided that you include in the combination all
+of the Invariant Sections of all of the original documents,
+unmodified, and list them all as Invariant Sections of your
+combined work in its license notice, and that you preserve all
+their Warranty Disclaimers.
+
+The combined work need only contain one copy of this License, and
+multiple identical Invariant Sections may be replaced with a single
+copy. If there are multiple Invariant Sections with the same name
+but different contents, make the title of each such section unique
+by adding at the end of it, in parentheses, the name of the
+original author or publisher of that section if known, or else
+a unique number. Make the same adjustment to the section titles in
+the list of Invariant Sections in the license notice of the
+combined work.
+
+In the combination, you must combine any sections Entitled
+``History'' in the various original documents, forming one section
+Entitled ``History''; likewise combine any sections Entitled
+``Acknowledgements'', and any sections Entitled ``Dedications''. You
+must delete all sections Entitled ``Endorsements.''
+
+@item
+COLLECTIONS OF DOCUMENTS
+
+You may make a collection consisting of the Document and other
+documents released under this License, and replace the individual
+copies of this License in the various documents with a single copy
+that is included in the collection, provided that you follow the
+rules of this License for verbatim copying of each of the documents
+in all other respects.
+
+You may extract a single document from such a collection, and
+distribute it individually under this License, provided you insert
+a copy of this License into the extracted document, and follow this
+License in all other respects regarding verbatim copying of that
+document.
+
+@item
+AGGREGATION WITH INDEPENDENT WORKS
+
+A compilation of the Document or its derivatives with other
+separate and independent documents or works, in or on a volume of
+a storage or distribution medium, is called an ``aggregate'' if the
+copyright resulting from the compilation is not used to limit the
+legal rights of the compilation's users beyond what the individual
+works permit. When the Document is included in an aggregate, this
+License does not apply to the other works in the aggregate which
+are not themselves derivative works of the Document.
+
+If the Cover Text requirement of section 3 is applicable to these
+copies of the Document, then if the Document is less than one half
+of the entire aggregate, the Document's Cover Texts may be placed
+on covers that bracket the Document within the aggregate, or the
+electronic equivalent of covers if the Document is in electronic
+form. Otherwise they must appear on printed covers that bracket
+the whole aggregate.
+
+@item
+TRANSLATION
+
+Translation is considered a kind of modification, so you may
+distribute translations of the Document under the terms of
+section 4. Replacing Invariant Sections with translations requires
+special permission from their copyright holders, but you may
+include translations of some or all Invariant Sections in addition
+to the original versions of these Invariant Sections. You may
+include a translation of this License, and all the license notices
+in the Document, and any Warranty Disclaimers, provided that you
+also include the original English version of this License and the
+original versions of those notices and disclaimers. In case of
+a disagreement between the translation and the original version of
+this License or a notice or disclaimer, the original version will
+prevail.
+
+If a section in the Document is Entitled ``Acknowledgements'',
+``Dedications'', or ``History'', the requirement (section 4) to
+Preserve its Title (section 1) will typically require changing the
+actual title.
+
+@item
+TERMINATION
+
+You may not copy, modify, sublicense, or distribute the Document
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense, or distribute it is void,
+and will automatically terminate your rights under this License.
+
+However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the
+copyright holder fails to notify you of the violation by some
+reasonable means prior to 60 days after the cessation.
+
+Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from
+that copyright holder, and you cure the violation prior to 30 days
+after your receipt of the notice.
+
+Termination of your rights under this section does not terminate
+the licenses of parties who have received copies or rights from you
+under this License. If your rights have been terminated and not
+permanently reinstated, receipt of a copy of some or all of the
+same material does not give you any rights to use it.
+
+@item
+FUTURE REVISIONS OF THIS LICENSE
+
+The Free Software Foundation may publish new, revised versions of
+the GNU Free Documentation License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns. See
+@uref{http://www.gnu.org/copyleft/}.
+
+Each version of the License is given a distinguishing version
+number. If the Document specifies that a particular numbered
+version of this License ``or any later version'' applies to it, you
+have the option of following the terms and conditions either of
+that specified version or of any later version that has been
+published (not as a draft) by the Free Software Foundation. If
+the Document does not specify a version number of this License,
+you may choose any version ever published (not as a draft) by the
+Free Software Foundation. If the Document specifies that a proxy
+can decide which future versions of this License can be used, that
+proxy's public statement of acceptance of a version permanently
+authorizes you to choose that version for the Document.
+
+@item
+RELICENSING
+
+``Massive Multiauthor Collaboration Site'' (or ``MMC Site'') means any
+World Wide Web server that publishes copyrightable works and also
+provides prominent facilities for anybody to edit those works.
+A public wiki that anybody can edit is an example of such
+a server. A ``Massive Multiauthor Collaboration'' (or ``MMC'')
+contained in the site means any set of copyrightable works thus
+published on the MMC site.
+
+``CC-BY-SA'' means the Creative Commons Attribution-Share Alike 3.0
+license published by Creative Commons Corporation,
+a not-for-profit corporation with a principal place of business in
+San Francisco, California, as well as future copyleft versions of
+that license published by that same organization.
+
+``Incorporate'' means to publish or republish a Document, in whole
+or in part, as part of another Document.
+
+An MMC is ``eligible for relicensing'' if it is licensed under this
+License, and if all works that were first published under this
+License somewhere other than this MMC, and subsequently
+incorporated in whole or in part into the MMC, (1) had no cover
+texts or invariant sections, and (2) were thus incorporated prior
+to November 1, 2008.
+
+The operator of an MMC Site may republish an MMC contained in the
+site under CC-BY-SA on the same site at any time before August 1,
+2009, provided the MMC is eligible for relicensing.
+@end enumerate
+
+@page
+
+@anchor{ADDENDUM How to use this License for your documents}
+@appendixsec ADDENDUM: How to use this License for your documents
+
+To use this License in a document you have written, include a copy of
+the License in the document and put the following copyright and
+license notices just after the title page:
+
+@example
+Copyright (C) YEAR YOUR NAME.
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.3
+or any later version published by the Free Software Foundation;
+with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
+Texts. A copy of the license is included in the section entitled ``GNU
+Free Documentation License''.
+@end example
+
+If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
+replace the ``with@dots{}Texts.''@tie{}line with this:
+
+@example
+with the Invariant Sections being LIST THEIR TITLES, with
+the Front-Cover Texts being LIST, and with the Back-Cover Texts
+being LIST.
+@end example
+
+If you have Invariant Sections without Cover Texts, or some other
+combination of the three, merge those two alternatives to suit the
+situation.
+
+If your document contains nontrivial examples of program code, we
+recommend releasing these examples in parallel under your choice of
+free software license, such as the GNU General Public License, to
+permit their use in free software.
@node Main Index
@chapter Main Index